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
{
        var $got_data = false;
        
        static $active_plugins = array();

        static $plugin_objects = array();
        
        
        function __construct()
        {
        }
        
        private final function getPluginData($a_ctype, $a_cname, $a_slot_id, $a_pname)
        {
                global $ilDB, $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";
                                
                        $rec = ilPlugin::getPluginRecord($a_ctype, $a_cname, $a_slot_id, $a_pname);
                        
                        if (is_file($plugin_php_file))
                        {
                                include_once($plugin_php_file);
                                $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname] =
                                        array("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);
                        }
                        
                        $active = $rec["active"];
                        $needs_update = false;
                        $activation_possible = !$active;
                        $inactive_reason = "";
                        
                        // version checks
                        if (ilComponent::isVersionGreaterString($ilias_min_version, ILIAS_VERSION_NUMERIC))
                        {
                                $active = false;
                                if (is_object($lng))
                                {
                                        $inactive_reason = $lng->txt("cmps_needs_newer_ilias_version");
                                }
                                else
                                {
                                        $inactive_reason = "Plugin needs a newer version of ILIAS.";
                                }
                                $activation_possible = false;
                        }
                        else if (ilComponent::isVersionGreaterString(ILIAS_VERSION_NUMERIC, $ilias_max_version))
                        {
                                $active = false;
                                if (is_object($lng))
                                {
                                        $inactive_reason = $lng->txt("cmps_needs_newer_plugin_version");
                                }
                                else
                                {
                                        $inactive_reason = "Plugin does not support current version of ILIAS. Newer version of plugin needed.";
                                }
                                $activation_possible = false;
                        }
                        else if ($rec["last_update_version"] == "")
                        {
                                $active = false;
                                if (is_object($lng))
                                {
                                        $inactive_reason = $lng->txt("cmps_needs_update");
                                }
                                else
                                {
                                        $inactive_reason = "Update needed.";
                                }
                                $needs_update = true;
                                $activation_possible = false;
                        }
                        else if (ilComponent::isVersionGreaterString($rec["last_update_version"], $version))
                        {
                                $active = false;
                                if (is_object($lng))
                                {
                                        $inactive_reason = $lng->txt("cmps_needs_upgrade");
                                }
                                else
                                {
                                        $inactive_reason = "Upgrade needed.";
                                }
                                $activation_possible = false;
                        }
                        else if ($rec["last_update_version"] != $version)
                        {
                                $active = false;
                                if (is_object($lng))
                                {
                                        $inactive_reason = $lng->txt("cmps_needs_update");
                                }
                                else
                                {
                                        $inactive_reason = "Update needed.";
                                }
                                $needs_update = true;
                                $activation_possible = false;
                        }
                        
                        $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["is_active"] = $active;
                        $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["inactive_reason"] = $inactive_reason;
                        $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["needs_update"] = $needs_update;
                        $this->data[$a_ctype][$a_cname][$a_slot_id][$a_pname]["activation_possible"] = $activation_possible;

                        $this->got_data[$a_ctype][$a_cname][$a_slot_id][$a_pname] = true;
                }
        }
        
        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"];
        }

        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"];
        }

        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"];
        }

        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"];
        }

        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"];
        }

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

        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"];
        }

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

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

?>