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: 

<?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\Model;

trait Connection {
    
    /**
     * @inheritDocs
     * @param string|int|array|\stdClass|NULL $connectionNameOrConfig
     * @param bool $strict  If `TRUE` and no connection under given name or given
     *                      index found, exception is thrown. `TRUE` by default.
     *                      If `FALSE`, there could be returned connection by
     *                      first available configuration.
     * @throws \InvalidArgumentException
     * @return \PDO
     */
    public static function GetConnection ($connectionNameOrConfig = NULL, $strict = TRUE) {
        $connectionName = (is_string($connectionNameOrConfig) || is_int($connectionNameOrConfig))
            ? $connectionNameOrConfig
            : static::resolveConnectionName($connectionNameOrConfig, $strict);
        // if no connection exists under connection name key - connect to database
        if (isset(self::$connections[$connectionName])) 
            return self::$connections[$connectionName];

        // get system config 'db' data
        // and get predefined constructor arguments by driver value from config
        $cfg = static::GetConfig($connectionName);
        if ($cfg === NULL) throw new \InvalidArgumentException(
            "[".get_called_class()."] No connection found under given name/index: `{$connectionName}`."
        );
        // connect:
        $connection = static::connect($cfg);
        // store new connection under config index for all other model classes:
        self::$connections[$connectionName] = $connection;
        return $connection;
    }

    /**
     * Resolve connection name or connection index or connection 
     * configuration into single string or integer coresponding to 
     * database config record.
     * @param string|int|array|\stdClass|NULL $connectionNameOrConfig 
     * @param bool $strict 
     * @throws \InvalidArgumentException 
     * @return string|int
     */
    protected static function resolveConnectionName ($connectionNameOrConfig = NULL, $strict = TRUE) {
        if (is_array($connectionNameOrConfig) || $connectionNameOrConfig instanceof \stdClass) {
            // if first argument is database connection configuration - set it up and return new connection name
            if (self::$configs === NULL) static::loadConfigs(FALSE, $strict);
            $connectionName = static::SetConfig((array) $connectionNameOrConfig);
        } else {
            // if no connection index specified, try to get from class or from base model
            if (self::$configs === NULL) static::loadConfigs(TRUE, TRUE);
            $connectionName = $connectionNameOrConfig;
            if ($connectionName === NULL && isset(static::$connectionName)) 
                $connectionName = static::$connectionName;
            if ($connectionName === NULL && isset(self::$connectionName)) 
                $connectionName = self::$connectionName;
            if ($connectionName === NULL) 
                $connectionName = self::$defaultConnectionName;
        }
        if ($connectionName === NULL) 
            throw new \InvalidArgumentException(
                "[".get_called_class()."] No connection name or connection config specified."
            );
        return $connectionName;
    }

    /**
     * Always create new `\PDO` database connection.
     * @param \stdClass $dbConfig `\stdClass` with members:
     *                            driver, host, user, password, database, options, class
     * @return \PDO
     */
    protected static function connect ($dbConfig) {
        $sysCfgProps = (object) static::$sysConfigProperties;
        $conArgsKey = isset(self::$connectionArguments[$dbConfig->{$sysCfgProps->driver}])
            ? $dbConfig->{$sysCfgProps->driver}
            : 'default';
        $conArgs = (object) self::$connectionArguments[$conArgsKey];
        $connection = NULL;
        // If database is file system based, complete app root and extend
        // relative path in $cfg->database to absolute path
        if ($conArgs->fileDb) {
            $appRoot = \MvcCore\Application::GetInstance()->GetRequest()->GetAppRoot();
            if (strpos($appRoot, 'phar://') !== FALSE) {
                $lastSlashPos = strrpos($appRoot, '/');
                $appRoot = substr($appRoot, 7, $lastSlashPos - 7);
            }
            $dbConfig = (object) array_merge([], (array) $dbConfig); // clone the `\stdClass` before change
            $dbFileFullPath = realpath($appRoot . $dbConfig->{$sysCfgProps->database});
            if ($dbFileFullPath === FALSE) throw new \InvalidArgumentException(
                "[".get_called_class()."] Database file doesn't exists: `{$dbFileFullPath}`."
            );
            $dbConfig->{$sysCfgProps->database} = str_replace('\\', '/', realpath($dbFileFullPath));
        }
        // Process connection string (dsn) with config replacements
        $dsn = $conArgs->dsn;
        $cfgArr = array_merge($conArgs->defaults, (array) $dbConfig);
        $credentialsInDsn = (
            mb_strpos($dsn, '{user}') !== FALSE &&
            mb_strpos($dsn, '{password}') !== FALSE
        );
        foreach ($cfgArr as $key => $value) {
            if (
                is_numeric($key) || 
                mb_strpos($key, '\\PDO::') === 0 ||
                $key == 'options'
            ) continue;
            if (isset($sysCfgProps->{$key})) {
                $prop = $sysCfgProps->{$key};
                $value = isset($dbConfig->{$prop})
                    ? $dbConfig->{$prop}
                    : $value;
            }
            $dsn = str_replace('{'.$key.'}', $value, $dsn);
        }
        // If database required user and password credentials,
        // connect with full arguments count or only with one (sqlite only)
        $connectionClass = isset($dbConfig->{$sysCfgProps->class})
            ? $dbConfig->{$sysCfgProps->class}
            : self::$defaultConnectionClass;
        $defaultOptions = self::$connectionArguments['default']['options'];
        $rawOptions = isset($dbConfig->{$sysCfgProps->options})
            ? array_merge([], $defaultOptions, $conArgs->options, $dbConfig->{$sysCfgProps->options} ?: [])
            : array_merge([], $defaultOptions, $conArgs->options);
        $options = [];
        foreach ($rawOptions as $optionKey => $optionValue) {
            if (is_string($optionValue) && mb_strpos($optionValue, '\\PDO::') === 0)
                if (defined($optionValue))
                    $optionValue = constant($optionValue);
            if (is_string($optionKey) && mb_strpos($optionKey, '\\PDO::') === 0) {
                if (defined($optionKey))
                    $options[constant($optionKey)] = $optionValue;
            } else {
                $options[$optionKey] = $optionValue;
            }
        }
        if ($conArgs->auth && !$credentialsInDsn) {
            $connection = new $connectionClass(
                $dsn,
                $dbConfig->{$sysCfgProps->user},
                (string) $dbConfig->{$sysCfgProps->password},
                $options
            );
        } else {
            $connection = new $connectionClass(
                $dsn, NULL, NULL, $options
            );
        }
        return $connection;
    }
}