File ext-model-db-mysql/src/MvcCore/Ext/Models/Db/Providers/Connections/MySql.php

  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:

<?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\Models\Db\Providers\Connections;

class       MySql 
extends     \MvcCore\Ext\Models\Db\Connection
implements  \MvcCore\Ext\Models\Db\Model\IConstants,
            \MvcCore\Ext\Models\Db\Models\MySqls\IConstants {

    /**
     * MySQL autocommit for current session.
     * @var bool
     */
    protected $autocommit = TRUE;
    
    /**
     * `TRUE` for MariaDB server connection, FALSE for MySQL or Percona Server connections.
     * @var bool|NULL
     */
    protected $mariadb = NULL;

    /**
     * `TRUE` for SQL `READ WRITE` or `READ ONLY` start transaction property support.
     * @var bool|NULL
     */
    protected $transReadWriteSupport = NULL;


    /**
     * Return `TRUE` if server is MariaDB.
     * @return bool|null
     */
    public function IsMariaDb () {
        return $this->mariadb;
    }

    /**
     * Return `TRUE` if server is MySQL or Percona Server.
     * @return bool
     */
    public function IsMySqlOrPercona () {
        return !$this->mariadb;
    }

    
    /**
     * @inheritDocs
     * @param string $identifierName
     * @return string
     */
    public function QuoteName ($identifierName) {
        return "`{$identifierName}`";
    }

    
    /**
     * @inheritDocs
     * @param int $flags Transaction isolation, read/write mode and consistent snapshot option.
     * @param string $name String without spaces to identify transaction in logs.
     * @throws \PDOException|\RuntimeException
     * @return bool
     */
    public function BeginTransaction ($flags = 0, $name = NULL) {
        if ($flags === 0) $flags = self::TRANS_READ_WRITE;

        $transRepeatableRead = ($flags & self::TRANS_ISOLATION_REPEATABLE_READ) > 0;
        $consistentSnapshot = (
            $transRepeatableRead &&
            ($flags & self::TRANS_CONSISTENT_SHAPSHOT) > 0
        );

        $readWrite = NULL;
        if (($flags & self::TRANS_READ_WRITE) > 0) {
            $readWrite = TRUE;
        } else if (($flags & self::TRANS_READ_ONLY) > 0) {
            $readWrite = FALSE;
        }

        if ($this->inTransaction) {
            $cfg = $this->GetConfig();
            unset($cfg['password']);
            $toolClass = \MvcCore\Application::GetInstance()->GetToolClass();
            throw new \RuntimeException(
                'Connection has opened transaction already ('.($toolClass::EncodeJson($cfg)).').'
            );
        }

        $sqlItems = [];

        $startTransPropsSeparator = '';
        $snapshotStr = '';
        $writeStr = '';
        
        if ($consistentSnapshot) 
            $snapshotStr = ' WITH CONSISTENT SNAPSHOT';
        
        if ($this->autocommit) {
            $this->autocommit = FALSE;
            $sqlItems[] = 'SET SESSION autocommit = 0;';
        }

        if ($this->transReadWriteSupport) {
            if ($readWrite === TRUE) {
                $writeStr = ' READ WRITE';
                if ($consistentSnapshot)
                    $startTransPropsSeparator = ',';
            } else if ($readWrite === FALSE) {
                $writeStr = ' READ ONLY';
                if ($consistentSnapshot)
                    $startTransPropsSeparator = ',';
            }
        }

        $transStartProperties = implode($startTransPropsSeparator, [$snapshotStr, $writeStr]);

        if ($transRepeatableRead) {
            $sqlItems[] = 'SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;';
        } else if (($flags & self::TRANS_ISOLATION_READ_COMMITTED) > 0) {
            $sqlItems[] = 'SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED;';
        } else if (($flags & self::TRANS_ISOLATION_READ_UNCOMMITTED) > 0) {
            $sqlItems[] = 'SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;';
        } else if (($flags & self::TRANS_ISOLATION_SERIALIZABLE) > 0) {
            $sqlItems[] = 'SET SESSION TRANSACTION ISOLATION LEVEL SERIALIZABLE;';
        }

        if ($name !== NULL) {
            $toolClass = \MvcCore\Application::GetInstance()->GetToolClass();
            $this->transactionName = $toolClass::GetUnderscoredFromPascalCase($name);
            $sqlItems[] = "/* trans_start:{$this->transactionName} */";
        }
        // examples:"START TRANSACTION WITH CONSISTENT SNAPSHOT, READ WRITE;" or
        //          "START TRANSACTION READ WRITE;" or
        //          "START TRANSACTION READ ONLY;" or ...
        $sqlItems[] = "START TRANSACTION{$transStartProperties};";
        
        if ($this->multiStatements) {
            $this->provider->exec(implode(" \n", $sqlItems));
        } else {
            foreach ($sqlItems as $sqlItem)
                $this->provider->exec($sqlItem);
        }

        $this->inTransaction = TRUE;

        return TRUE;
    }

    /**
     * @inheritDocs
     * @param int $flags Transaction chaininig.
     * @throws \PDOException
     * @return bool
     */
    public function Commit ($flags = 0) {
        if (!$this->inTransaction) return FALSE;
        $sqlItems = [];
        $chain = NULL;
        $chainSql = '';

        if (($flags & self::TRANS_CHAIN) > 0) {
            $chain = TRUE;
            $chainSql = ' AND CHAIN';
        } else if (($flags & self::TRANS_NO_CHAIN) > 0) {
            $chain = FALSE;
            $chainSql = ' AND NO CHAIN';
        }

        if ($this->transactionName !== NULL) 
            $sqlItems[] = "/* trans_commit:{$this->transactionName} */";

        $sqlItems[] = "COMMIT{$chainSql};";

        if (!$chain && !$this->autocommit) {
            $this->autocommit = TRUE;
            $sqlItems[] = 'SET SESSION autocommit = 1;';
        }

        if ($this->multiStatements) {
            $this->provider->exec(implode(" \n", $sqlItems));
        } else {
            foreach ($sqlItems as $sqlItem)
                $this->provider->exec($sqlItem);
        }
        
        if ($chain) {
            $this->inTransaction  = TRUE;
        } else {
            $this->inTransaction  = FALSE;
            $this->transactionName = NULL;
        }

        return TRUE;
    }

    /**
     * Rolls back a transaction.
     * @param int $flags Transaction chaininig.
     * @throws \PDOException
     * @return bool
     */
    public function RollBack ($flags = NULL) {
        if (!$this->inTransaction) return FALSE;
        $sqlItems = [];
        $chain = NULL;
        $chainSql = '';

        if (($flags & self::TRANS_CHAIN) > 0) {
            $chain = TRUE;
            $chainSql = ' AND CHAIN';
        } else if (($flags & self::TRANS_NO_CHAIN) > 0) {
            $chain = FALSE;
            $chainSql = ' AND NO CHAIN';
        }

        if ($this->transactionName !== NULL) 
            $sqlItems[] = "/* trans_rollback:{$this->transactionName} */";

        $sqlItems[] = "ROLLBACK{$chainSql};";

        if (!$chain && !$this->autocommit) {
            $this->autocommit = TRUE;
            $sqlItems[] = 'SET SESSION autocommit = 1;';
        }

        if ($this->multiStatements) {
            $this->provider->exec(implode(" \n", $sqlItems));
        } else {
            foreach ($sqlItems as $sqlItem)
                $this->provider->exec($sqlItem);
        }

        if ($chain) {
            $this->inTransaction  = TRUE;
        } else {
            $this->inTransaction  = FALSE;
            $this->transactionName = NULL;
        }

        return TRUE;
    }



    /**
     * @inheritDocs
     * @see https://stackoverflow.com/questions/7942154/mysql-error-2006-mysql-server-has-gone-away
     * @param \Throwable $e 
     * @return bool
     */
    protected function isConnectionLost (\Throwable $e) {
        $prevError = $e->getPrevious();
        $error = $prevError instanceof \PDOException
            ? $prevError
            : $e;
        return (
            $error instanceof \PDOException &&
            mb_strpos(mb_strtolower($e->getMessage()), 'server has gone away') !== FALSE
        );
    }

    /**
     * Set up connection specific properties depends on this driver.
     * @return void
     */
    protected function setUpConnectionSpecifics () {
        parent::setUpConnectionSpecifics();
        $mariaDbPos = mb_strpos($this->version, 'mariadb');
        if ($mariaDbPos !== FALSE) {
            $this->mariadb = TRUE;
            $this->version = trim(mb_substr($this->version, 0, $mariaDbPos), '-');
            $dashPos = mb_strrpos($this->version, '-');
            if ($dashPos !== FALSE) 
                $this->version = mb_substr($this->version, $dashPos + 1);
        } else {
            $this->mariadb = FALSE;
            $dashPos = mb_strrpos($this->version, '-');
            if ($dashPos !== FALSE) 
                $this->version = mb_substr($this->version, $dashPos + 1);
        }

        $this->transReadWriteSupport = (
            $this->mariadb || (
                !$this->mariadb &&
                version_compare($this->version, '5.6.0', '>')
            )
        );

        $multiStatementsConst = '\PDO::MYSQL_ATTR_MULTI_STATEMENTS';
        $multiStatementsConstVal = defined($multiStatementsConst) 
            ? constant($multiStatementsConst) 
            : 0;
        $this->multiStatements = isset($this->options[$multiStatementsConstVal]);
    }
}

Classes

Interfaces

Traits

Exceptions

Functions