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: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 

<?php

namespace Core\Providers;

/**
 * Loads and sets <b>*.ini</b> files, which are the configuration files for the Framework.
 * @package Core
 */
class Config
{

    /**
     * @var mixed $instance A class instance
     * @internal
     */
    private static $instance;

    /**
     * @var array The key under which to store all quick-access information.
     */
    private $vars;

    /**
     * @var array An auxiliary key to store ("remember") the already-loaded <b>*.ini</b> files.
     */
    private $ini;

    /**
     * @var array An auxiliary key to store ("remember") all details that must be cached. After the execution, <b>$cacheIni</b>
     * contains all such information.
     */
    private $cacheIni;

    /**
     * @var string The <b>/app/config/config.ini</b> key that contains the <b>Global</b> variables to set.
     */
    private $globalsKey = 'Globals';

    /**
     * @var string The <b>/app/config/config.ini</b> key that contains the <b>ini_set()</b> directives.
     */
    private $phpiniKey = 'PHP_ini';

    private function __construct()
    {
        $this->vars = array();
    }

    /**
     * Returns the Config instance, creating it if it did not exist.
     * @return Config
     */
    public static function singleton()
    {
        if (!self::$instance) {
            $c = __CLASS__;
            self::$instance = new $c();
        }
        return self::$instance;
    }

    /**
     * Sets a $value to a given $key
     * @param string $key
     * @param mixed $value
     *
     * @return Config
     */
    public function set($key, $value = NULL)
    {
        if (array_key_exists($key, $this->vars)) {
            $this->vars[$key] = array_merge($this->vars[$key], $value);
        } else {
            $this->vars[$key] = $value;
        }
        return self::$instance;
    }

    /**
     * Gets the $value of a given $key
     * @param string $key
     * @param string|bool $subKey
     * @return mixed|null $value associated to the $key or NULL
     */
    public function get($key, $subKey = FALSE)
    {
        if (isset($this->vars[$key])) {
            if ($subKey) {
                if (isset($this->vars[$key][$subKey])) {
                    return $this->vars[$key][$subKey];
                } else {
                    return NULL;
                }
            }
            return $this->vars[$key];
        } else {
            return NULL;
        }
    }

    /**
     * Loads an ini file
     * @param string|bool $path The file (path+file) to load
     * @param string|bool $absolute If not specified, the file will be searched inside /config folder
     * @param string|bool $iniKey = FALSE If specified, all the ini file will be saved under that key
     * @param string|bool $namespace = FALSE If specified, the globals will be defined inside the namespace
     *
     * @return Config
     */
    public function load($path = FALSE, $absolute = FALSE, $iniKey = FALSE, $namespace = FALSE)
    {
        $vars = $this->getIni($path, $absolute);

        if (!$iniKey) {
            foreach ($vars as $key => $value) {
                if ($key === $this->globalsKey) {
                    $this->setGlobals($value, (string)$namespace);
                } elseif ($key === $this->phpiniKey) {
                    $this->setPHPIniParams($path);
                } else {
                    $this->set($key, $value, TRUE);
                }
            }
        } else {
            $this->set($iniKey, $vars);
        }
        return self::$instance;
    }

    /**
     * Loads global vars from an .ini file
     * @param array $globals The globals to load
     * @param string| $namespace If specified, the globals will be defined inside the namespace
     *
     * @return Config
     */
    public function setGlobals($globals, $namespace = "")
    {
        foreach ($globals as $key => $value) {
            if (!defined($namespace . $key)) {
                DEFINE($namespace . $key, $value);
            }
        }
        return self::$instance;
    }

    /**
     * Loads the ini_set parameters from an .ini file
     * @param string|bool $path
     * @return Config
     */
    public function setPHPIniParams($path = FALSE)
    {
        $vars = $this->getIni($path);
        foreach ($vars['PHP_ini'] as $key => $value) {
            ini_set($key, $value);
        }
        return self::$instance;
    }

    /**
     * Loads the extra permission.ini and routing.ini from /src/vendor folders
     *
     * @param bool|FALSE $saveToCache Save in /app/cache a config which loads all vendor *.ini and includes.
     *
     * @throws \Exception if directory doesn't exist
     * @return Config
     */
    public function loadVendors ($saveToCache = FALSE)
    {
        if (isProd() &&
            (!$saveToCache)) {
            $this->loadCacheIni();
            return self::$instance;
        }

        if ($this->get('Vendor', 'VENDOR_ENABLED') == '0') {
            return self::$instance;
        }
        // else: we load the Vendor directory from the config file
        $vendorFolderConfig = __ROOT__ . $this->get('Vendor', 'VENDOR_FOLDER');

        if (!file_exists($vendorFolderConfig)) {
            throw new \Exception($this->get('Exceptions', str_replace('[[DIR]]', $vendorFolderConfig, 'VENDOR_DIR_NOT_FOUND')));
        }
        $files = scandir($vendorFolderConfig);
        foreach ($files as $f) {
            if ($f[0] == '.') {
                continue;
            }
            $vendorFolder = $vendorFolderConfig . '/' . $f;
            $this->load($vendorFolder . '/config/config.ini', TRUE, FALSE, "Vendor\\$f\\")
                 ->load($vendorFolder . '/config/permissions.ini', TRUE, 'Permissions')
                 ->load($vendorFolder . '/config/routing.ini', TRUE, 'Routing')
                 ->includeVendorLogic($vendorFolder . '/controllers')
                 ->includeVendorLogic($vendorFolder . '/models');

            $this->cacheIni['Config'][$f] = $vendorFolder . '/config/config.ini';
            $this->cacheIni['Permissions'][$f] = $vendorFolder . '/config/permissions.ini';
            $this->cacheIni['Routing'][$f] = $vendorFolder . '/config/routing.ini';

        }

        // we leave it for now. We want each "dev" execution to save the vendor_ini configuration.
        $saved = $this->saveVendorCache();

        if ($saveToCache) {
            return $saved;
        }

        return self::$instance;
    }

    /**
     * Scans the given $folder and "includes" its content.
     * @param string $folder The folder where to scan for Controllers or Models
     *
     * @return Config
     */
    private function includeVendorLogic($folder)
    {
        $files = scandir($folder);
        foreach ($files as $f) {
            if ($f[0] == '.') {
                continue;
            }
            // We include each Logic file (*Controller.php, *Model.php) from the vendor folder
            include_once $folder . '/' . $f;
            $this->cacheIni['Includes'][] = $folder . '/' . $f;
        }
        return self::$instance;
    }

    /**
     * Reads an .ini file
     * @param string $path
     * @param string|bool $absolute If not specified, the file will be searched inside /config folder
     * @return array INI file, array-like
     */
    private function getIni ($path, $absolute = FALSE)
    {
        if (!$path) {
            return array();
        }
        if (!$absolute) {
            $path = __ROOT__ . '/app/config/' . $path;
        }

        // there's no file, so we return "[]"
        if (!file_exists($path)) {
            return [];
        }
        // If the file exists, we parse_ini_file it and return its contents (as array[])
        if (empty($this->ini[$path])) {
            $this->ini[$path] = parse_ini_file($path, TRUE);
        }
        return $this->ini[$path];
    }

    /**
     * Saves the private global var $this->cacheIni to the <b>vendor_ini.ini</b> file
     *
     * @return array With information about success or failure
     */
    public function saveVendorCache ()
    {
        $saved = save_ini_file($this->cacheIni, TRUE, __ROOT__ . '/app/cache/vendor_ini.ini');
        if ($saved['success'] == 1) {
            $this->cacheIni = [];
        }
        return $saved;
    }

    /**
     * Loads the vendor_ini.ini cache file
     *
     * @return Config
     */
    private function loadCacheIni ()
    {
        $vendorIniFile = __ROOT__ . '/app/cache/vendor_ini.ini';
        $vendorIniExists = file_exists($vendorIniFile);
        if (!$vendorIniExists) {
            die('You must run your web app at least once with <b>__ENVIRONMENT__</b> = "<b>dev</b>"
                 (currently set to "<b>' . __ENVIRONMENT__ . '</b>")');
        }
        $vendorIni = $this->getIni($vendorIniFile, TRUE);

        if (empty($vendorIni)) {
            die('There was a problem when reading the file: it seems to be <b>empty</b>.<br/>
                 You must manually set <b>__ENVIRONMENT__</b> = "<b>dev</b>" and refresh the page');
        }

        foreach ($vendorIni['Includes'] as $i) {
            include_once $i;
        }
        foreach ($vendorIni['Config'] as $namespace => $r) {
            $this->load($r, TRUE, FALSE, "Vendor\\$namespace\\");
        }
        foreach ($vendorIni['Routing'] as $r) {
            $this->load($r, TRUE, 'Routing');
        }
        foreach ($vendorIni['Permissions'] as $p) {
            $this->load($p, TRUE, 'Permissions');
        }
        return self::$instance;
    }

    /**
     * Returns the private $vars
     * @return array $vars
     */
    public function getLoadedConfig () {
        return $this->vars;
    }
}