class.ilGlobalCacheSettings.php

Go to the documentation of this file.

<?php
require_once('./Services/GlobalCache/classes/class.ilGlobalCache.php');

use ILIAS\Setup;

class ilGlobalCacheSettings implements Setup\Config
{
    const LOG_LEVEL_FORCED = -1;
    const LOG_LEVEL_NONE = 0;
    const LOG_LEVEL_SHY = 1;
    const LOG_LEVEL_NORMAL = 2;
    const LOG_LEVEL_CHATTY = 3;
    const INI_HEADER_CACHE = 'cache';
    const INI_FIELD_ACTIVATE_GLOBAL_CACHE = 'activate_global_cache';
    const INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE = 'global_cache_service_type';
    const INI_HEADER_CACHE_ACTIVATED_COMPONENTS = 'cache_activated_components';
    const INI_FIELD_LOG_LEVEL = 'log_level';
    protected $service = ilGlobalCache::TYPE_STATIC;
    protected $activated_components = array();
    protected $active = false;
    protected $log_level = self::LOG_LEVEL_NONE;
    protected $memcached_nodes = [];


    public function readFromIniFile(ilIniFile $ilIniFile)
    {
        $this->checkIniHeader($ilIniFile);
        $this->setActive($ilIniFile->readVariable(self::INI_HEADER_CACHE, self::INI_FIELD_ACTIVATE_GLOBAL_CACHE));
        $this->setService($ilIniFile->readVariable(self::INI_HEADER_CACHE, self::INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE));
        $this->setLogLevel($ilIniFile->readVariable(self::INI_HEADER_CACHE, self::INI_FIELD_LOG_LEVEL));
        if (!$this->isActive()) {
            $this->resetActivatedComponents();
        } else {
            $cache_components = $ilIniFile->readGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
            if (is_array($cache_components)) {
                foreach ($cache_components as $comp => $v) {
                    if ($v) {
                        $this->addActivatedComponent($comp);
                    }
                }
            }
        }
    }


    public function writeToIniFile(ilIniFile $ilIniFile)
    {
        $ilIniFile->setVariable(self::INI_HEADER_CACHE, self::INI_FIELD_ACTIVATE_GLOBAL_CACHE, $this->isActive() ? '1' : '0');
        $ilIniFile->setVariable(self::INI_HEADER_CACHE, self::INI_FIELD_GLOBAL_CACHE_SERVICE_TYPE, $this->getService());
        $ilIniFile->setVariable(self::INI_HEADER_CACHE, self::INI_FIELD_LOG_LEVEL, $this->getLogLevel());

        $ilIniFile->removeGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
        $ilIniFile->addGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
        foreach (ilGlobalCache::getAvailableComponents() as $comp) {
            $ilIniFile->setVariable(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS, $comp, $this->isComponentActivated($comp) ? '1' : '0');
        }
        if ($ilIniFile->write()) {
            ilGlobalCache::log('saved new settings: ' . $this->__toString(), self::LOG_LEVEL_FORCED);
        }
    }


    public function activateAll()
    {
        foreach (ilGlobalCache::getAvailableComponents() as $comp) {
            $this->addActivatedComponent($comp);
        }
    }


    public function addActivatedComponent($component)
    {
        $this->activated_components[] = $component;
        $this->activated_components = array_unique($this->activated_components);
    }


    public function resetActivatedComponents()
    {
        $this->activated_components = array();
    }


    public function isComponentActivated($component)
    {
        return in_array($component, $this->activated_components);
    }


    public function areAllComponentActivated()
    {
        return count($this->activated_components) == count(ilGlobalCache::getAvailableComponents());
    }


    public function getService()
    {
        return $this->service;
    }


    public function setService($service)
    {
        $this->service = $service;
    }


    public function getActivatedComponents()
    {
        return $this->activated_components;
    }


    public function setActivatedComponents($activated_components)
    {
        $this->activated_components = $activated_components;
    }


    public function isActive()
    {
        return $this->active;
    }


    public function setActive($active)
    {
        $this->active = $active;
    }


    protected function checkIniHeader(ilIniFile $ilIniFile)
    {
        if (!$ilIniFile->readGroup(self::INI_HEADER_CACHE)) {
            $ilIniFile->addGroup(self::INI_HEADER_CACHE);
        }
        if (!$ilIniFile->readGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS)) {
            $ilIniFile->addGroup(self::INI_HEADER_CACHE_ACTIVATED_COMPONENTS);
        }
    }


    public function getLogLevel()
    {
        return $this->log_level;
    }


    public function setLogLevel($log_level)
    {
        $this->log_level = $log_level;
    }


    public function __toString()
    {
        $service = 'Service: ' . ($this->getService() > 0 ? ilGlobalCache::lookupServiceClassName($this->getService()) : 'none');
        $activated = 'Activated Components: ' . implode(', ', $this->getActivatedComponents());
        $log_level = 'Log Level: ' . $this->getLogLevelName();

        return implode("\n", array( '', '', $service, $activated, $log_level, '' ));
    }


    protected function getLogLevelName()
    {
        return $this->lookupLogLevelName($this->getLogLevel());
    }


    protected function lookupLogLevelName($level)
    {
        $r = new ReflectionClass($this);
        foreach ($r->getConstants() as $k => $v) {
            if (strpos($k, 'LOG_LEVEL') === 0 and $v == $level) {
                return $k;
            }
        }

        return '';
    }

    public function addMemcachedNode(ilMemcacheServer $node_id) : void
    {
        $this->memcached_nodes[] = $node_id;
    }

    public function getMemcachedNodes() : array
    {
        return $this->memcached_nodes;
    }
}