ConfigCache.class.php

Go to the documentation of this file.

<?php
include_once("core/system/JBaseObject.class.php");
include_once("core/utils/JSession.class.php");
include_once("core/config/ConfigPetition.class.php");

/* Constants */
define(CONFIG_PATH, "config/");
define(STORAGE_METHOD_FILE, "storage-method.php");
define(CORE_CONFIG_FILE, "core-config.php");
define(CONFIGCACHE_SESSION_VAR, "james-configcache");
define(CONFIG_DEFAULT_BACKEND, "DB");

class ConfigCache extends JBaseObject
{
        var $system;    
        var $systemgroup;       
        
        var $module;    
        var $modulegroup;       
        
        function ConfigCache()
        {
                // Initializes all arrays
                $this->system = array();
                $this->systemgroup = array();
                $this->module = array();
                $this->modulegroup = array();   
        }
        
        function &GetInstance()
        {
                static $ob;
                
                if (! isset($ob))
                {
                        // We look if it is in session
                        if (JSession::ExistsVar(CONFIGCACHE_SESSION_VAR))
                        {
                                $ob = JSession::GetVar(CONFIGCACHE_SESSION_VAR);
                        }
                        else
                        {
                                $ob = new ConfigCache();
                                $ob->_UpdateSession();
                        }
                        
                        // Doing that thing, we make sure that 
                        // $ob->_UpdateSession will be called just before the
                        // scripts ends its execution, and the changes made in
                        // the object will be stored in session.
                        register_shutdown_function(array(&$ob, _UpdateSession));
                }
                return $ob;
        }
        
        function _UpdateSession()
        {
                JSession::SetVar(CONFIGCACHE_SESSION_VAR, $this);
        }
        
        function &_ConfigBackendFactory($petition)
        {               
                $backend = $this->_GetBackendMethod($petition);
                
                // If there isn't any established method, we'll use the default
                // one.
                if (empty($backend))
                        $backend = CONFIG_DEFAULT_BACKEND;
                
                // We include the file that contains the class that implements
                // the backend.
                $class = "Config" . $backend . "Backend";
                @include_once "core/config/backends/" . $class . ".class.php";
                
                if (class_exists($class))
                {                       
                        return new $class($petition);
                }
        }

        function _GetBackendMethod($petition)
        {
                // The file where the storage method is established.
                include(CONFIG_PATH.STORAGE_METHOD_FILE);
                
                if ($petition->GetUser() != null)
                        $method = $UserConfig;
                else if ($petition->GetGroup() != null)
                        $method = $SystemConfig["groups"];
                else if ($petition->GetModule() != null)
                        $method = $SystemConfig["modules"];
                else
                        $method = $SystemConfig["system"];

                return $method;
        }
        
        function GetPetition($petition)
        {
                $idM = $petition->GetModule();
                $idG = $petition->GetGroup();
                
                // It is a system config petition.
                if ($idM == null) 
                {
                        if ($idG == null)
                                $res = $this->_GetPetitionUser(
                                                $petition, $this->system);
                        else
                        {
                                $res = $this->_GetPetitionGroup(
                                                $petition,
                                                $this->systemgroup);
                        }
                }
                else
                {
                        $res = $this->_GetPetitionModule($petition);
                }
                
                return $res;
        }
        
        function _GetPetitionModule($petition)
        {
                $idG = $petition->GetGroup();
                $idM = $petition->GetModule();
                
                if ($idG == null)
                {
                        if (!isset($this->module[$idM]))
                                $this->module[$idM] = array();
                        
                        $res = $this->_GetPetitionUser(
                                        $petition,
                                        $this->module[$idM]);
                }
                else
                {
                        if (!isset($this->modulegroup[$idM]))
                                $this->modulegroup[$idM] = array();
                                
                        $res = $this->_GetPetitionGroup(
                                        $petition,
                                        $this->modulegroup[$idM]);
                }
                
                return $res;
        }
                
        function _GetPetitionGroup($petition, &$cache)
        {
                $idG = $petition->GetGroup();
                
                if (!isset($cache[$idG]))
                        $cache[$idG] = array();

                $res = $this->_GetPetitionUser($petition,$cache[$idG]);
                
                return $res;
        }
                        
        function _GetPetitionUser($petition, &$cache)
        {
                $idU = $petition->GetUser();
                
                if ($idU == null)
                {
                        if (!isset($cache["system"]))
                        {
                                $backend =& $this->_ConfigBackendFactory($petition);                            
                                $cache["system"] = $backend->GetConfig();
                        }

                        $res = $cache["system"];
                }
                else
                {
                        if (!isset($cache["user"][$idU]))
                        {
                                $backend =& $this->_ConfigBackendFactory($petition);
                                $cache["user"][$idU] = $backend->GetConfig();
                        }
                        $res = $cache["user"][$idU];
                }
                return $res;
        }
        
        function SetPetition($petition, $values)
        {
                // Get the backend object.
                $backend =& $this->_ConfigBackendFactory($petition);

                // Save the changes
                $backend->SetConfig($values);
        }
}
?>

---