lib/internal/Magento/Framework/DB/Adapter/SqlVersionProvider.php - 2.4-develop - githubmirror/magento2

lib/internal/Magento/Framework/DB/Adapter/SqlVersionProvider.php
210 строк6 KB
sandesh.as
AC-16556: Add Compatibility with MariaDB 11.8 and 12.x
20 мар 2026, 09:52
20 мар 2026, 09:526db3556
<?php
/**
 * Copyright 2020 Adobe
 * All Rights Reserved.
 */
declare(strict_types=1);

namespace Magento\Framework\DB\Adapter;

use Magento\Framework\App\ResourceConnection;

/**
 * Class GetDbVersion provides sql engine version requesting version variable
 *
 * Rather then depending on this class, please implement this logic in your extension
 */
class SqlVersionProvider
{
    /**#@+
     * Database version specific templates
     */
    public const MYSQL_8_0_VERSION = '8.0.';

    public const MYSQL_5_7_VERSION = '5.7.';

    /**
     * @deprecated MARIA_DB_10_VERSION const
     * @see isMysqlGte8029(), isMariaDbEngine()
     */
    public const MARIA_DB_10_VERSION = '10.';

    public const MARIA_DB_10_4_VERSION = '10.4.';

    public const MARIA_DB_10_6_VERSION = '10.6.';

    public const MARIA_DB_10_11_VERSION = '10.11.';

    public const MYSQL_8_0_29_VERSION = '8.0.29';

    public const MARIA_DB_10_6_11_VERSION = '10.6.11';

    public const MARIA_DB_10_4_27_VERSION = '10.4.27';

    public const MYSQL_8_4_VERSION = '8.4.';

    public const MARIA_DB_11_4_VERSION = '11.4.';

    public const MARIA_DB_11_8_VERSION = '11.8.';

    public const MARIA_DB_12_2_VERSION = '12.2.';

    public const MARIA_DB_12_3_VERSION = '12.3.';
    public const MARIA_DB = "mariadb";

    /**#@-*/

    /**
     * Database version variable name
     */
    private const VERSION_VAR_NAME = 'version';

    /**
     * @var ResourceConnection
     */
    private $resourceConnection;

    /**
     * @var string
     */
    private $version;

    /**
     * @var array
     */
    private $supportedVersionPatterns;

    /**
     * @param ResourceConnection $resourceConnection
     * @param array $supportedVersionPatterns
     */
    public function __construct(
        ResourceConnection $resourceConnection,
        array $supportedVersionPatterns = []
    ) {
        $this->resourceConnection = $resourceConnection;
        $this->supportedVersionPatterns = $supportedVersionPatterns;
    }

    /**
     * Provides SQL engine version (MariaDB, MySQL-8, MySQL-5.7)
     *
     * @param string $resource
     *
     * @return string
     * @throws ConnectionException
     */
    public function getSqlVersion(string $resource = ResourceConnection::DEFAULT_CONNECTION): string
    {
        if (!$this->version) {
            $this->version = $this->getVersionString($resource);
        }

        return $this->version;
    }

    /**
     * Provides Sql Engine Version string
     *
     * @param string $resource
     *
     * @return string
     * @throws ConnectionException
     */
    private function getVersionString(string $resource): string
    {
        $pattern = sprintf('/(%s)/', implode('|', $this->supportedVersionPatterns));
        $sqlVersionOutput = $this->fetchSqlVersion($resource);
        preg_match($pattern, $sqlVersionOutput, $match);
        if (empty($match)) {
            throw new ConnectionException(
                sprintf(
                    "Current version of RDBMS is not supported. Used Version: %s. Supported versions: %s",
                    $sqlVersionOutput,
                    implode(', ', array_keys($this->supportedVersionPatterns))
                )
            );
        }

        return reset($match);
    }

    /**
     * Fetch version from sql engine
     *
     * @param string $resource
     *
     * @return string
     */
    private function fetchSqlVersion(string $resource): string
    {
        $versionOutput = $this->resourceConnection->getConnection($resource)
            ->fetchPairs(sprintf('SHOW variables LIKE "%s"', self::VERSION_VAR_NAME));

        return $versionOutput[self::VERSION_VAR_NAME];
    }

    /**
     * Check if MySQL version is greater than equal to 8.0.29
     *
     * @return bool
     * @throws ConnectionException
     */
    public function isMysqlGte8029(): bool
    {
        $isMariaDB = $this->isMariaDbEngine();
        $sqlExactVersion = $this->fetchSqlVersion(ResourceConnection::DEFAULT_CONNECTION);
        if (!$isMariaDB && version_compare($sqlExactVersion, '8.0.29', '>=')) {
            return true;
        }
        return false;
    }

    /**
     * Get MariaDB current version
     *
     * @return string
     * @throws ConnectionException
     */
    public function getMariaDbSuffixKey(): string
    {
        $sqlVersion = $this->getSqlVersion();
        $defaultSuffixKey = SqlVersionProvider::MARIA_DB_10_6_11_VERSION;
        $isMariaDB104 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_10_4_VERSION);
        $isMariaDB106 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_10_6_VERSION);
        $isMariaDB1011 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_10_11_VERSION);
        $isMariaDB114 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_11_4_VERSION);
        $isMariaDB118 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_11_8_VERSION);
        $isMariaDB122 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_12_2_VERSION);
        $isMariaDB123 = str_contains($sqlVersion, SqlVersionProvider::MARIA_DB_12_3_VERSION);
        $sqlExactVersion = $this->fetchSqlVersion(ResourceConnection::DEFAULT_CONNECTION);
        if (version_compare($sqlExactVersion, '10.4.27', '>=')) {
            if ($isMariaDB104) {
                return SqlVersionProvider::MARIA_DB_10_4_27_VERSION;
            } elseif ($isMariaDB106 || $isMariaDB114 || $isMariaDB118
                || $isMariaDB122 || $isMariaDB123) {
                return SqlVersionProvider::MARIA_DB_10_6_11_VERSION;
            } elseif ($isMariaDB1011) {
                return SqlVersionProvider::MARIA_DB_10_11_VERSION;
            }
        }
        return $defaultSuffixKey;
    }

    /**
     * Checks if MariaDB used as SQL engine
     *
     * @return bool
     * @throws ConnectionException
     */
    public function isMariaDbEngine(): bool
    {
        // check current version else send exception
        $this->getSqlVersion();

        // check current db is Maria DB
        $sqlExactVersion = $this->fetchSqlVersion(ResourceConnection::DEFAULT_CONNECTION);
        $isMariaDB = str_contains(strtolower($sqlExactVersion), SqlVersionProvider::MARIA_DB);
        return $isMariaDB ? true : false;
    }
}