CacheManager.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

namespace Xoops\Core\Cache;

use Stash\Pool;
use Stash\Interfaces\DriverInterface;
use Xoops\Core\Cache\DriverList;
use Xoops\Core\Cache\Access;
use Xoops\Core\Yaml;

class CacheManager
{
    protected $pools = array();

    protected $poolDefs = array(
        );

    protected $xoops;

    public function __construct()
    {
        $this->xoops = \Xoops::getInstance();
        $defaults = $this->getDefaults();
                $xoops_var_path = \XoopsBaseConfig::get('var-path');
                $cache_file = $xoops_var_path . '/configs/cache.php';
        $poolDefs = Yaml::readWrapped($cache_file);
        if (empty($poolDefs)) {
            Yaml::saveWrapped($defaults, $cache_file);
        }
        $poolDefs = is_array($poolDefs) ? $poolDefs : array();
        $this->poolDefs = array_merge($defaults, $poolDefs);
    }

    private static function getDefaults()
    {
        $defaults = array(
            'default' => array(
                'driver' => 'FileSystem',
                'options' => array(
                    'path' => \XoopsBaseConfig::get('var-path') . '/stash/',
                    ),
                    'dirSplit' => 1,
                ),
            'temp' => array(
                'driver' => 'Ephemeral',
                'options' => array(),
                ),
            );
        return $defaults;
    }

    public static function createDefaultConfig()
    {
        $configFile = \XoopsBaseConfig::get('var-path') . '/configs/cache.php';
        if (file_exists($configFile)) {
            return;
        }
        $defaults = self::getDefaults();
        if (false !== stripos(PHP_OS, 'WIN')) {
            $pathLen = strlen($defaults['default']['options']['path']);
            if (260 <= ($pathLen+202)) {
                // try alternative driver as filesystem has max path length issues on Windows
                if (array_key_exists("SQLite", \Stash\DriverList::getAvailableDrivers())) {
                    $defaults['default']['driver'] = 'SQLite';
                    unset($defaults['default']['options']['dirSplit']);
                    @mkdir($defaults['default']['options']['path']);
                } else {
                    trigger_error("Manual cache configuration required.");
                }
            }
        }
        Yaml::saveWrapped($defaults, $configFile);
    }

    public function getCache($name)
    {
        $pool = false;
        if (array_key_exists($name, $this->pools)) {
            $pool =  $this->pools[$name];
        } elseif (array_key_exists($name, $this->poolDefs)) {
            $pool =  $this->startPoolAccess($name);
        }
        if ($pool === false) {
            $pool = $this->getDefaultPool($name);
        }

        $this->pools[$name] = $pool;

        return $pool;
    }

    protected function startPoolAccess($name)
    {
        $pool = false;
        $options = false;
        if (isset($this->poolDefs[$name]['options'])) {
            $options = $this->poolDefs[$name]['options'];
        }
        $driverName = $this->poolDefs[$name]['driver'];
        if (0 === strcasecmp($driverName, 'Composite')) {
            $drivers = array();
            foreach ($this->poolDefs[$name]['options']['drivers'] as $subDriver) {
                $drivers[] = $this->getDriver($subDriver['driver'], $subDriver['options']);
            }
            $options['drivers'] = $drivers;
        }

        $driver = $this->getDriver($driverName, $options);
        if ($driver!==false) {
            $pool = new Pool($driver);
            if (is_object($pool)) {
                $pool->setLogger($this->xoops->logger());
            }
        }
        if (!$pool) {
            $this->xoops->logger()->warn('Could not create cache pool '.$name);
            return $pool;
        }

        return new Access($pool);
    }

    protected function getDriver($driverName, $options)
    {
        $driver = false;
        $driverClass = DriverList::getDriverClass($driverName);

        if ($driverClass!==false && $driverClass::isAvailable()) {
            $options = is_array($options) ? $options : array();
            $driver = new $driverClass();
            $driver->setOptions($options);
        }
        return ($driver instanceof DriverInterface) ? $driver : false;
    }

    protected function getDefaultPool($originalName)
    {
        $this->xoops->events()->triggerEvent('debug.log', 'Substituting default cache pool for '.$originalName);
        $name = 'default';
        if (array_key_exists($name, $this->pools)) {
            return $this->pools[$name];
        }
        $pool = $this->startPoolAccess($name);
        if ($pool===false) {
            $this->xoops->logger()->error('Could not create default cache pool');
            $pool = new Access(new \Stash\Pool());
        }
        $this->pools[$name] = $pool;
        return $pool;
    }
}