Platine\Database\Connection

Complexity

Total Complexity

80

Size/Duplication

Total Lines	764
Duplicated Lines	0 %

Importance

Changes	11
Bugs	0	Features	0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	getSchema()	0	3	1
A	commit()	0	13	2
A	__construct()	0	17	2
A	count()	0	9	1
A	transaction()	0	29	4
A	getDsn()	0	3	1
A	createPDO()	0	22	3
B	replaceParameters()	0	22	7
C	setConnectionParams()	0	109	16
A	getParams()	0	3	1
A	startTransaction()	0	12	2
A	getLogs()	0	3	1
A	resetSqlValues()	0	6	1
A	createDriver()	0	8	1
A	column()	0	9	1
A	getSql()	0	3	1
A	persistent()	0	5	1
A	query()	0	6	1
A	setEmulate()	0	4	1
A	__wakeup()	0	3	1
A	__sleep()	0	9	1
A	getPDO()	0	3	1
A	getConfig()	0	3	1
A	exec()	0	3	1
B	connect()	0	35	7
A	execute()	0	49	5
A	bindValues()	0	13	6
A	rollback()	0	12	2
A	isEmulate()	0	3	1
A	getDriver()	0	3	1
A	setLogger()	0	5	1
A	prepare()	0	30	3
A	getValues()	0	3	1

<?php

/**
 * Platine Database
 *
 * Platine Database is the abstraction layer using PDO with support of query and schema builder
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Database
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file Connection.php
 *
 *  The Database Connection class
 *
 *  @package    Platine\Database
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */
declare(strict_types=1);

namespace Platine\Database;

use InvalidArgumentException;
use PDO;
use PDOException;
use PDOStatement;
use Platine\Database\Driver\Driver;
use Platine\Database\Exception\ConnectionException;
use Platine\Database\Exception\QueryException;
use Platine\Database\Exception\QueryPrepareException;
use Platine\Database\Exception\TransactionException;
use Platine\Logger\Logger;
use Platine\Logger\LoggerInterface;

/**
 * @class Connection
 * @package Platine\Database
 */
class Connection
{
    /**
     * The PDO instance
     * @var PDO
     */
    protected PDO $pdo;

    /**
     * The PDO data source name
     * @var string
     */
    protected string $dsn = '';

    /**
     * The list of execution query logs
     * @var array<int, array<string, mixed>>
     */
    protected array $logs = [];

    /**
     * The driver to use
     * @var Driver
     */
    protected Driver $driver;

    /**
     * The Schema instance to use
     * @var Schema
     */
    protected Schema $schema;

    /**
     * The connection configuration
     * @var Configuration
     */
    protected Configuration $config;

    /**
     * The connection parameters
     * @var array<int|string, mixed>
     */
    protected array $params = [];

    /**
     * The logger interface test
     * @var LoggerInterface
     */
    protected LoggerInterface $logger;

    /**
     * The last execution SQL queries
     * @var array<int, string>
     */
    protected array $sql = [];

    /**
     * The last execution query parameters values
     * @var array<int, array<mixed>>
     */
    protected array $values = [];

    /**
     * Emulate instead of execute the query
     * @var bool
     */
    protected bool $emulate = false;

    /**
     * Connection constructor.
     * @param Configuration $config
     * @param LoggerInterface|null $logger
     * @throws ConnectionException
     */
    public function __construct(
        Configuration $config,
        ?LoggerInterface $logger = null
    ) {
        $this->config = $config;

        $this->logger = $logger ?? new Logger();
        if ($this->logger instanceof Logger) {
            $channel = sprintf('db:%s', $config->getName());
            $this->logger->setChannel($channel);
        }

        $this->createDriver();

        $this->schema = new Schema($this);

        $this->connect();
    }

    /**
     * Create database driver
     * @return $this
     */
    public function createDriver(): self
    {
        /** @var class-string<Driver> $driverClass */
        $driverClass = $this->config->getDriverClassName();

        $this->driver = new $driverClass($this);

        return $this;
    }

    /**
     * Start the database transaction
     * @param string $name
     * @return bool
     */
    public function startTransaction(string $name = 'default'): bool
    {
        $this->logger->info('Start transaction [{name}]', ['name' => $name]);
        if ($this->pdo->inTransaction()) {
            $this->logger->warning(
                'Can not start transaction [{name}], there is an active transaction',
                ['name' => $name]
            );
            return false;
        }

        return $this->pdo->beginTransaction();
    }

    /**
     * Commit database transaction
     * @param string $name
     * @return bool
     */
    public function commit(string $name = 'default'): bool
    {
        $this->logger->info('Commit transaction [{name}]', ['name' => $name]);

        if ($this->pdo->inTransaction() === false) {
            $this->logger->warning(
                'Can not commit transaction [{name}], there is no active transaction',
                ['name' => $name]
            );
            return false;
        }

        return $this->pdo->commit();
    }

    /**
     * Rollback the database transaction
     * @param string $name
     * @return bool
     */
    public function rollback(string $name = 'default'): bool
    {
        $this->logger->info('Rollback transaction [{name}]', ['name' => $name]);
        if ($this->pdo->inTransaction() === false) {
            $this->logger->warning(
                'Can not rollback transaction [{name}], there is no active transaction',
                ['name' => $name]
            );
            return false;
        }

        return $this->pdo->rollBack();
    }

    /**
     * Connect to the database
     * @return void
     */
    public function connect(): void
    {
        $this->setConnectionParams();

        if ($this->config->isPersistent()) {
            $this->persistent(true);
        }

        $attr = $this->params;

        if (count($attr) === 0) {
            throw new InvalidArgumentException('Invalid database options supplied');
        }

        $driver = $attr['driver'];
        unset($attr['driver']);

        $params = [];
        foreach ($attr as $key => $value) {
            $params[] = is_int($key) ? $value : $key . '=' . $value;
        }

        $dsn = $driver . ':' . implode(';', $params);
        if (in_array($driver, ['mysql', 'pgsql', 'sqlsrv'])) {
            $charset = $this->config->getCharset();
            $this->config->addCommand('SET NAMES "' . $charset . '"' . (
                    $this->config->getDriverName() === 'mysql'
                            ? ' COLLATE "' . $this->config->getCollation() . '"'
                            : ''
                    ));
        }

        $this->dsn = $dsn;

        $this->createPDO();
    }

    /**
     *
     * @param LoggerInterface $logger
     * @return $this
     */
    public function setLogger(LoggerInterface $logger): self
    {
        $this->logger = $logger;

        return $this;
    }

    /**
     * Return the query execution logs
     * @return array<int, array<string, mixed>>
     */
    public function getLogs(): array
    {
        return $this->logs;
    }

    /**
     * Return the current connection parameters
     * @return array<int|string, mixed>
     */
    public function getParams(): array
    {
        return $this->params;
    }

    /**
     * Return the current connection configuration
     * @return Configuration
     */
    public function getConfig(): Configuration
    {
        return $this->config;
    }

    /**
     * Return the current driver instance
     * @return Driver
     */
    public function getDriver(): Driver
    {
        return $this->driver;
    }

    /**
     * Return the current Schema instance
     * @return Schema
     */
    public function getSchema(): Schema
    {
        return $this->schema;
    }

    /**
     * Set connection to be persistent
     * @param bool $value
     * @return $this
     */
    public function persistent(bool $value = true): self
    {
        $this->config->setOption(PDO::ATTR_PERSISTENT, $value);

        return $this;
    }

    /**
     * @return string
     */
    public function getDsn(): string
    {
        return $this->dsn;
    }

    /**
     * Return the instance of the PDO
     * @return PDO
     */
    public function getPDO(): PDO
    {
        return $this->pdo;
    }

    /**
     * Execute the SQL query and return the result
     * @param string $sql
     * @param array<int, mixed> $params the query parameters
     * @return ResultSet
     * @throws QueryException
     */
    public function query(string $sql, array $params = []): ResultSet
    {
        $prepared = $this->prepare($sql, $params);
        $this->execute($prepared);

        return new ResultSet($prepared['statement']);
    }

    /**
     * Direct execute the SQL query
     * @param string $sql
     * @param array<int, mixed> $params the query parameters
     * @return bool
     * @throws QueryException
     */
    public function exec(string $sql, array $params = []): bool
    {
        return $this->execute($this->prepare($sql, $params));
    }

    /**
     *  Execute the SQL query and return the number
     * of affected rows
     * @param string $sql
     * @param array<int, mixed> $params the query parameters
     * @return int
     * @throws QueryException
     */
    public function count(string $sql, array $params = []): int
    {
        $prepared = $this->prepare($sql, $params);
        $this->execute($prepared);

        $result = $prepared['statement']->rowCount();
        $prepared['statement']->closeCursor();

        return $result;
    }

    /**
     *  Execute the SQL query and return the first column result
     * @param string $sql
     * @param array<int, mixed> $params the query parameters
     * @return mixed
     * @throws QueryException
     */
    public function column(string $sql, array $params = []): mixed
    {
        $prepared = $this->prepare($sql, $params);
        $this->execute($prepared);

        $result = $prepared['statement']->fetchColumn();
        $prepared['statement']->closeCursor();

        return $result;
    }

    /**
     * @param callable $callback
     * @param mixed $that
     *
     * @return mixed
     *
     * @throws ConnectionException
     */
    public function transaction(
        callable $callback,
        mixed $that = null
    ): mixed {
        if ($that === null) {
            $that = $this;
        }

        if ($this->pdo->inTransaction()) {
            return $callback($that);
        }

        try {
            $this->pdo->beginTransaction();
            $result = $callback($that);
            $this->pdo->commit();
        } catch (PDOException $exception) {
            $this->pdo->rollBack();
            $this->logger->error('Database transaction error. Error message: {error}', [
                'error' => $exception->getMessage()
            ]);
            throw new TransactionException(
                $exception->getMessage(),
                (int) $exception->getCode(),
                $exception->getPrevious()
            );
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function __sleep(): array
    {
        return [
            'dsn',
            'driver',
            'schema',
            'config',
            'params',
            'logger',
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function __wakeup(): void
    {
        $this->createPDO();
    }

    /**
     * Return the last SQL queries
     * @return array<string>
     */
    public function getSql(): array
    {
        return $this->sql;
    }

    /**
     * Return the last query parameters values
     * @return array<int, array<mixed>>
     */
    public function getValues(): array
    {
        return $this->values;
    }

    /**
     * Reset the last query SQL and parameters
     * @return $this
     */
    public function resetSqlValues(): self
    {
        $this->sql    = [];
        $this->values = [];

        return $this;
    }

    /**
     * Return the emulation status
     * @return bool
     */
    public function isEmulate(): bool
    {
        return $this->emulate;
    }

    /**
     * Set the emulation status
     * @param bool $emulate
     * @return $this
     */
    public function setEmulate(bool $emulate): self
    {
        $this->emulate = $emulate;
        return $this;
    }


    /**
     * Create PDO connection
     * @return void
     * @throws ConnectionException
     */
    protected function createPDO(): void
    {
        try {
            $this->pdo = new PDO(
                $this->dsn,
                $this->config->getUsername(),
                $this->config->getPassword(),
                $this->config->getOptions()
            );

            foreach ($this->config->getCommands() as $command) {
                $this->pdo->exec($command);
            }
        } catch (PDOException $exception) {
            $this->logger->emergency('Can not connect to database. Error message: {error}', [
                'error' => $exception->getMessage()
            ]);

            throw new ConnectionException(
                'Can not connect to database',
                (int) $exception->getCode(),
                $exception->getPrevious()
            );
        }
    }

     /**
     * Change the query parameters placeholder with the value
     * @param string $query
     * @param array<int, mixed> $params
     * @return string
     */
    protected function replaceParameters(string $query, array $params): string
    {
        $driver = $this->driver;

        return (string) preg_replace_callback(
            '/\?/',
            function () use ($driver, &$params) {
                $param = array_shift($params);

                $value = is_object($param) ? get_class($param) : $param;
                if (is_int($value) || is_float($value)) {
                    return $value;
                }
                if ($value === null) {
                    return 'NULL';
                }
                if (is_bool($value)) {
                    return $value ? 'TRUE' : 'FALSE';
                }
                return $driver->quote($value);
            },
            $query
        );
    }

    /**
     * Prepare the query
     * @param string $query
     * @param array<mixed> $params
     * @return array<string, mixed>
     * @throws QueryException
     */
    protected function prepare(string $query, array $params): array
    {
        $this->sql[] = $query;
        $this->values[] = $params;
        if ($this->emulate) {
            return [
                'statement' => new ConnectionStatement(),
                'query' => $query,
                'params' => $params
            ];
        }

        try {
            $statement = $this->pdo->prepare($query);
        } catch (PDOException $exception) {
            $this->logger->error('Error when prepare query [{query}]. Error message: {error}', [
                'error' => $exception->getMessage(),
                'query' => $query
            ]);
            throw new QueryPrepareException(
                $exception->getMessage() . ' [' . $query . ']',
                (int) $exception->getCode(),
                $exception->getPrevious()
            );
        }

        return [
            'statement' => $statement,
            'query' => $query,
            'params' => $params
        ];
    }

    /**
     * Execute the prepared query
     * @param array<string, mixed> $prepared
     * @return bool the status of the execution
     * @throws QueryException
     */
    protected function execute(array $prepared): bool
    {
        if ($this->emulate) {
            return true;
        }

        $sql = $this->replaceParameters($prepared['query'], $prepared['params']);
        $sqlLog = [
            'query' => $prepared['query'],
            'parameters' => implode(', ', $prepared['params']),
        ];

        try {
            if ($prepared['params']) {
                $this->bindValues($prepared['statement'], $prepared['params']);
            }
            $start = microtime(true);
            $result = $prepared['statement']->execute();
            $executionTime = microtime(true) - $start;
            $sqlLog['time'] = number_format($executionTime, 6);

            $this->logs[] = $sqlLog;

            $this->logger->info(
                'Execute Query: [{query}], parameters: [{parameters}], time: [{time}]',
                $sqlLog
            );

            $slowQueryTime = $this->config->getSlowQueryTime();

            if ($executionTime >= $slowQueryTime) {
                $this->logger->warning(
                    'Query: [{query}], parameters: [{parameters}] cost too much time: [{time}]',
                    $sqlLog
                );
            }
        } catch (PDOException $exception) {
            $this->logger->error('Error when execute query [{sql}]. Error message: {error}', [
                'error' => $exception->getMessage(),
                'sql' => $sql
            ]);
            throw new QueryException(
                $exception->getMessage() . ' [' . $sql . ']',
                (int) $exception->getCode(),
                $exception->getPrevious()
            );
        }

        return $result;
    }

    /**
     * Bind the parameters values
     * @param PDOStatement $statement
     * @param array<int, mixed> $values
     *
     * @return void
     */
    protected function bindValues(PDOStatement $statement, array $values): void
    {
        foreach ($values as $key => $value) {
            $param = PDO::PARAM_STR;
            if (is_null($value)) {
                $param = PDO::PARAM_NULL;
            } elseif (is_int($value) || is_float($value)) {
                $param = PDO::PARAM_INT;
            } elseif (is_bool($value)) {
                $param = PDO::PARAM_BOOL;
            }

            $statement->bindValue($key + 1, $value, $param);
        }
    }

    /**
     * Set the PDO connection parameters to use
     * @return void
     */
    protected function setConnectionParams(): void
    {
        $port = $this->config->getPort();
        $database = $this->config->getDatabase();
        $hostname = $this->config->getHostname();
        $attr = [];

        $driverName = $this->config->getDriverName();
        switch ($driverName) {
            case 'mysql':
            case 'pgsql':
                $attr = [
                    'driver' => $driverName,
                    'dbname' => $database,
                    'host' => $hostname,
                ];

                if ($port > 0) {
                    $attr['port'] = $port;
                }

                if ($driverName === 'mysql') {
                    //Make MySQL using standard quoted identifier
                    $this->config->addCommand('SET SQL_MODE=ANSI_QUOTES');
                    $this->config->addCommand('SET CHARACTER SET "' . $this->config->getCharset() . '"');

                    $socket = $this->config->getSocket();
                    if (!empty($socket)) {
                        $attr['unix_socket'] = $socket;
                    }
                }
                break;
            case 'sqlsrv':
                //Keep MSSQL QUOTED_IDENTIFIER is ON for standard quoting
                $this->config->addCommand('SET QUOTED_IDENTIFIER ON');

                //Make ANSI_NULLS is ON for NULL value
                $this->config->addCommand('SET ANSI_NULLS ON');

                $attr = [
                    'driver' => 'sqlsrv',
                    'Server' => $hostname
                        . ($port > 0 ? ':' . $port : ''),
                    'Database' => $database
                ];

                $appName = $this->config->getAppname();
                if (!empty($appName)) {
                    $attr['APP'] = $appName;
                }

                $attributes = [
                    'ApplicationIntent',
                    'AttachDBFileName',
                    'Authentication',
                    'ColumnEncryption',
                    'ConnectionPooling',
                    'Encrypt',
                    'Failover_Partner',
                    'KeyStoreAuthentication',
                    'KeyStorePrincipalId',
                    'KeyStoreSecret',
                    'LoginTimeout',
                    'MultipleActiveResultSets',
                    'MultiSubnetFailover',
                    'Scrollable',
                    'TraceFile',
                    'TraceOn',
                    'TransactionIsolation',
                    'TransparentNetworkIPResolution',
                    'TrustServerCertificate',
                    'WSID',
                ];

                foreach ($attributes as $attribute) {
                    $str = preg_replace(
                        ['/([a-z\d])([A-Z])/', '/([^_])([A-Z][a-z])/'],
                        '$1_$2',
                        $attribute
                    );

                    if (is_string($str)) {
                        $keyname = strtolower($str);

                        if ($this->config->hasAttribute($keyname)) {
                            $attr[$attribute] = $this->config->getAttribute($keyname);
                        }
                    }
                }
                break;
            case 'oci':
            case 'oracle':
                $attr = [
                    'driver' => 'oci',
                    'dbname' => '//' . $hostname
                    . ($port > 0 ? ':' . $port : ':1521') . '/' . $database
                ];

                $attr['charset'] = $this->config->getCharset();
                break;
            case 'sqlite':
                $attr = [
                    'driver' => 'sqlite',
                    $database
                ];
                break;
        }

        $this->params = $attr;
    }
}