1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Configs;

class Cached extends \MvcCore\Config {
    
    /**
     * MvcCore Extension - Config - Cached - version:
     * Comparison by PHP function version_compare();
     * @see http://php.net/manual/en/function.version-compare.php
     */
    const VERSION = '5.0.0';

    /**
     * Cache instance pointer.
     * @var \MvcCore\Ext\ICache
     */
    protected static $cache = NULL;

    /**
     * Cache ttl used to cache config files,
     * `NULL` means unlimited time, by default.
     * @var int|NULL
     */
    protected static $ttl = NULL;

    /**
     * Cache tags used to cache config files,
     * `['config']` as default.
     * @var \string[]
     */
    protected static $tags = ['config'];

    /**
     * Array with each key as environment name
     * and values as another environment names necessary
     * to also keep in cached config.
     * @var array
     */
    protected static $environmentGroups = [];

    /**
     * Set cache ttl used to cache config files,
     * `NULL` means unlimited time, by default.
     * @param int|NULL $ttl
     * @return void
     */
    public static function SetTtl ($ttl) {
        static::$ttl = $ttl;
    }

    /**
     * Get cache ttl used to cache config files,
     * `NULL` means unlimited time, by default.
     * @return int|NULL
     */
    public static function GetTtl () {
        return static::$ttl;
    }

    /**
     * Set cache tags used to cache config files,
     * `['config']` as default.
     * @param \string[] $tags
     * @return void
     */
    public static function SetTags ($tags) {
        static::$tags = $tags;
    }

    /**
     * Get cache tags used to cache config files,
     * `['config']` as default.
     * @return \string[]
     */
    public static function GetTags () {
        return static::$tags;
    }

    /**
     * Set array with each key as environment name
     * and values as another environment names necessary
     * to also keep in cached config.
     * @param array $environmentGroups
     * @return void
     */
    public static function SetEnvironmentGroups (array $environmentGroups = []) {
        static::$environmentGroups = $environmentGroups;
    }

    /**
     * Get array with each key as environment name
     * and values as another environment names necessary
     * to also keep in cached config.
     * @return array
     */
    public static function GetEnvironmentGroups () {
        return static::$environmentGroups;
    }

    /**
     * Try to load from cache or from hdd and parse config file by app root relative path.
     * If config contains system data, try to detect environment.
     * @param string $configFullPath
     * @param string $systemConfigClass
     * @param bool   $isSystemConfig
     * @return \MvcCore\Config|bool
     */
    protected static function getConfigInstance ($configFullPath, $systemConfigClass, $isSystemConfig = FALSE) {
        $cache = static::getCache();
        if ($cache === NULL)
            return parent::getConfigInstance($configFullPath, $systemConfigClass, $isSystemConfig);
        $cacheKey = static::getCacheKey($configFullPath);

        /** @var $config \MvcCore\Config|NULL */
        $config = $cache->Load($cacheKey);

        if (!$config) {
            $config = parent::getConfigInstance($configFullPath, $systemConfigClass, $isSystemConfig);
            $environment = static::detectEnvironment($config, FALSE);
            static::computeEnvironmentData($config, $environment->GetName());
            static::cacheConfig($cache, $cacheKey, $config);

        } else {
            $environment = static::detectEnvironment($config, FALSE);
            if ($environment->IsDevelopment()) {
                clearstatcache(TRUE, $configFullPath);
                $lastModTime = filemtime($configFullPath);
                if ($lastModTime > $config->GetLastChanged()) {
                    $config = parent::getConfigInstance($configFullPath, $systemConfigClass, $isSystemConfig);
                    $environment = static::detectEnvironment($config, TRUE);
                    static::computeEnvironmentData($config, $environment->GetName());
                    static::cacheConfig($cache, $cacheKey, $config);
                }
            }
        }

        return $config;
    }

    /**
     * Complete config merged data collection records for all necessary environments.
     * @param \MvcCore\Config $config
     * @param string|NULL $envName
     */
    protected static function computeEnvironmentData (\MvcCore\IConfig $config, $envName) {
        if ($envName === NULL) return;
        $envNamesToCache = [$envName];
        if (isset(static::$environmentGroups[$envName]))
            $envNamesToCache = array_unique(array_merge(
                $envNamesToCache, static::$environmentGroups[$envName]
            ));
        foreach ($envNamesToCache as $envNameToCache)
            $config->GetData($envNameToCache);
    }

    /**
     * Cache completed configuration file.
     * @param \MvcCore\Ext\Cache    $cache
     * @param string                $cacheKey
     * @param \MvcCore\Config       $config
     * @return bool
     */
    protected static function cacheConfig (\MvcCore\Ext\ICache $cache, $cacheKey, \MvcCore\IConfig $config) {
        return $cache->Save($cacheKey, $config, static::$ttl, static::$tags);
    }

    /**
     * Detect environment if necessary and returns it's name.
     * @param \MvcCore\Config $config
     * @param bool           $force
     * @return \MvcCore\Environment
     */
    protected static function detectEnvironment (\MvcCore\IConfig $config, $force = FALSE) {
        $app = parent::$app ?: parent::$app = \MvcCore\Application::GetInstance();
        $environment = $app->GetEnvironment();
        $envClass = $app->GetEnvironmentClass();
        $isDetected = $environment->IsDetected();
        if ($config && (!$isDetected || $force)) {
            $envDetectionData = & static::GetEnvironmentDetectionData($config);
            $envName = $envClass::DetectBySystemConfig((array) $envDetectionData);
            $environment->SetName($envName);
        }
        return $environment;
    }

    /**
     * Get cache key by config fullpath.
     * @param string $configFullPath
     * @return string
     */
    protected static function getCacheKey ($configFullPath) {
        $app = parent::$app ?: parent::$app = \MvcCore\Application::GetInstance();
        $appRoot = $app->GetRequest()->GetAppRoot();
        if (mb_strpos($configFullPath, $appRoot) === 0) {
            $cacheKey = mb_substr($configFullPath, mb_strlen($appRoot));
        } else {
            $cacheKey = str_replace([':', '/'], ['', '_'], $configFullPath);
        }
        return $cacheKey;
    }

    /**
     * Get cache store registered as default.
     * @param string|NULL $storeName
     * @return \MvcCore\Ext\Cache|NULL
     */
    protected static function getCache ($storeName = NULL) {
        if (static::$cache === NULL) {
            $cacheClass = '\\MvcCore\\Ext\\Cache';
            static::$cache = $cacheClass::GetStore($storeName);
        }
        return static::$cache;
    }
}