AbstractMySQLDriver::getMariaDbMysqlVersionNumber() - Code Metrics - Inspection of "Merge pull request #2825 from belgattitude/fix/mar..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( edfbda...298c91 )

by Luís

created 2017-11-19 11:51 UTC

getMariaDbMysqlVersionNumber() A

↳ Parent: AbstractMySQLDriver

Complexity

Conditions	2
Paths	1

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2.1481

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
ccs	6
cts	9
cp	0.6667
cc	2
eloc	8
nc	1
nop	1
crap	2.1481

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Driver;

use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Driver;
use Doctrine\DBAL\Exception;
use Doctrine\DBAL\Platforms\MariaDb1027Platform;
use Doctrine\DBAL\Platforms\MySQL57Platform;
use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Schema\MySqlSchemaManager;
use Doctrine\DBAL\VersionAwarePlatformDriver;

/**
 * Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for MySQL based drivers.
 *
 * @author Steve Müller <[email protected]>
 * @link   www.doctrine-project.org
 * @since  2.5
 */
abstract class AbstractMySQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
{
    /**
     * {@inheritdoc}
     *
     * @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
     * @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
     */
    public function convertException($message, DriverException $exception)
    {
        switch ($exception->getErrorCode()) {
            case '1213':
                return new Exception\DeadlockException($message, $exception);
            case '1205':
                return new Exception\LockWaitTimeoutException($message, $exception);
            case '1050':
                return new Exception\TableExistsException($message, $exception);

            case '1051':
            case '1146':
                return new Exception\TableNotFoundException($message, $exception);

            case '1216':
            case '1217':
            case '1451':
            case '1452':
            case '1701':
                return new Exception\ForeignKeyConstraintViolationException($message, $exception);

            case '1062':
            case '1557':
            case '1569':
            case '1586':
                return new Exception\UniqueConstraintViolationException($message, $exception);

            case '1054':
            case '1166':
            case '1611':
                return new Exception\InvalidFieldNameException($message, $exception);

            case '1052':
            case '1060':
            case '1110':
                return new Exception\NonUniqueFieldNameException($message, $exception);

            case '1064':
            case '1149':
            case '1287':
            case '1341':
            case '1342':
            case '1343':
            case '1344':
            case '1382':
            case '1479':
            case '1541':
            case '1554':
            case '1626':
                return new Exception\SyntaxErrorException($message, $exception);

            case '1044':
            case '1045':
            case '1046':
            case '1049':
            case '1095':
            case '1142':
            case '1143':
            case '1227':
            case '1370':
            case '1429':
            case '2002':
            case '2005':
                return new Exception\ConnectionException($message, $exception);

            case '1048':
            case '1121':
            case '1138':
            case '1171':
            case '1252':
            case '1263':
            case '1364':
            case '1566':
                return new Exception\NotNullConstraintViolationException($message, $exception);
        }

        return new Exception\DriverException($message, $exception);
    }

    /**
     * {@inheritdoc}
     *
     * @throws DBALException
     */
    public function createDatabasePlatformForVersion($version)
    {
        $mariadb = false !== stripos($version, 'mariadb');
        if ($mariadb && version_compare($this->getMariaDbMysqlVersionNumber($version), '10.2.7', '>=')) {
            return new MariaDb1027Platform();
        }

        if ( ! $mariadb && version_compare($this->getOracleMysqlVersionNumber($version), '5.7.9', '>=')) {
            return new MySQL57Platform();
        }

        return $this->getDatabasePlatform();
    }

    /**
     * Get a normalized 'version number' from the server string
     * returned by Oracle MySQL servers.
     *
     * @param string $versionString Version string returned by the driver, i.e. '5.7.10'
     * @throws DBALException
     */
    private function getOracleMysqlVersionNumber(string $versionString) : string
    {
        if ( ! preg_match(
            '/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/',
            $versionString,
            $versionParts
        )) {
            throw DBALException::invalidPlatformVersionSpecified(
                $versionString,
                '<major_version>.<minor_version>.<patch_version>'
            );
        }
        $majorVersion = $versionParts['major'];
        $minorVersion = $versionParts['minor'] ?? 0;
        $patchVersion = $versionParts['patch'] ?? null;

        if ('5' === $majorVersion && '7' === $minorVersion && null === $patchVersion) {
            $patchVersion = '9';
        }

        return $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
    }

    /**
     * Detect MariaDB server version, including hack for some mariadb distributions
     * that starts with the prefix '5.5.5-'
     *
     * @param string $versionString Version string as returned by mariadb server, i.e. '5.5.5-Mariadb-10.0.8-xenial'
     * @throws DBALException
     */
    private function getMariaDbMysqlVersionNumber(string $versionString) : string
    {
        if ( ! preg_match(
            '/^(?:5\.5\.5-)?(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/i',
            $versionString,
            $versionParts
        )) {
            throw DBALException::invalidPlatformVersionSpecified(
                $versionString,
                '^(?:5\.5\.5-)?(mariadb-)?<major_version>.<minor_version>.<patch_version>'
            );
        }

        return $versionParts['major'] . '.' . $versionParts['minor'] . '.' . $versionParts['patch'];
    }

    /**
     * {@inheritdoc}
     */
    public function getDatabase(\Doctrine\DBAL\Connection $conn)

    {
        $params = $conn->getParams();

        if (isset($params['dbname'])) {
            return $params['dbname'];
        }

        return $conn->query('SELECT DATABASE()')->fetchColumn();

    }

    /**
     * {@inheritdoc}
     * @return MySqlPlatform
     */
    public function getDatabasePlatform()
    {
        return new MySqlPlatform();
    }

    /**
     * {@inheritdoc}
     * @return MySqlSchemaManager
     */
    public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
    {
        return new MySqlSchemaManager($conn);
    }
}


1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the MIT license. For more information, see
17			* <http://www.doctrine-project.org>.
18			*/
19
20			namespace Doctrine\DBAL\Driver;
21
22			use Doctrine\DBAL\DBALException;
23			use Doctrine\DBAL\Driver;
24			use Doctrine\DBAL\Exception;
25			use Doctrine\DBAL\Platforms\MariaDb1027Platform;
26			use Doctrine\DBAL\Platforms\MySQL57Platform;
27			use Doctrine\DBAL\Platforms\MySqlPlatform;
28			use Doctrine\DBAL\Schema\MySqlSchemaManager;
29			use Doctrine\DBAL\VersionAwarePlatformDriver;
30
31			/**
32			* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for MySQL based drivers.
33			*
34			* @author Steve Müller <[email protected]>
35			* @link www.doctrine-project.org
36			* @since 2.5
37			*/
38			abstract class AbstractMySQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
39			{
40			/**
41			* {@inheritdoc}
42			*
43			* @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
44			* @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
45			*/
46	4		public function convertException($message, DriverException $exception)
47			{
48	4		switch ($exception->getErrorCode()) {
49	4		case '1213':
50	4		return new Exception\DeadlockException($message, $exception);
51	4		case '1205':
52	4		return new Exception\LockWaitTimeoutException($message, $exception);
53	4		case '1050':
54	4		return new Exception\TableExistsException($message, $exception);
55
56	4		case '1051':
57	4		case '1146':
58	4		return new Exception\TableNotFoundException($message, $exception);
59
60	4		case '1216':
61	4		case '1217':
62	4		case '1451':
63	4		case '1452':
64	4		case '1701':
65	4		return new Exception\ForeignKeyConstraintViolationException($message, $exception);
66
67	4		case '1062':
68	4		case '1557':
69	4		case '1569':
70	4		case '1586':
71	4		return new Exception\UniqueConstraintViolationException($message, $exception);
72
73	4		case '1054':
74	4		case '1166':
75	4		case '1611':
76	4		return new Exception\InvalidFieldNameException($message, $exception);
77
78	4		case '1052':
79	4		case '1060':
80	4		case '1110':
81	4		return new Exception\NonUniqueFieldNameException($message, $exception);
82
83	4		case '1064':
84	4		case '1149':
85	4		case '1287':
86	4		case '1341':
87	4		case '1342':
88	4		case '1343':
89	4		case '1344':
90	4		case '1382':
91	4		case '1479':
92	4		case '1541':
93	4		case '1554':
94	4		case '1626':
95	4		return new Exception\SyntaxErrorException($message, $exception);
96
97	4		case '1044':
98	4		case '1045':
99	4		case '1046':
100	4		case '1049':
101	4		case '1095':
102	4		case '1142':
103	4		case '1143':
104	4		case '1227':
105	4		case '1370':
106	4		case '1429':
107	4		case '2002':
108	4		case '2005':
109	4		return new Exception\ConnectionException($message, $exception);
110
111	4		case '1048':
112	4		case '1121':
113	4		case '1138':
114	4		case '1171':
115	4		case '1252':
116	4		case '1263':
117	4		case '1364':
118	4		case '1566':
119	4		return new Exception\NotNullConstraintViolationException($message, $exception);
120			}
121
122	4		return new Exception\DriverException($message, $exception);
123			}
124
125			/**
126			* {@inheritdoc}
127			*
128			* @throws DBALException
129			*/
130	6		public function createDatabasePlatformForVersion($version)
131			{
132	6		$mariadb = false !== stripos($version, 'mariadb');
133	6		if ($mariadb && version_compare($this->getMariaDbMysqlVersionNumber($version), '10.2.7', '>=')) {
134	3		return new MariaDb1027Platform();
135			}
136
137	6		if ( ! $mariadb && version_compare($this->getOracleMysqlVersionNumber($version), '5.7.9', '>=')) {
138	3		return new MySQL57Platform();
139			}
140
141	3		return $this->getDatabasePlatform();
142			}
143
144			/**
145			* Get a normalized 'version number' from the server string
146			* returned by Oracle MySQL servers.
147			*
148			* @param string $versionString Version string returned by the driver, i.e. '5.7.10'
149			* @throws DBALException
150			*/
151	6		private function getOracleMysqlVersionNumber(string $versionString) : string
152			{
153	6		if ( ! preg_match(
154	6		'/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/',
155	6		$versionString,
156	6		$versionParts
157			)) {
158	3		throw DBALException::invalidPlatformVersionSpecified(
159	3		$versionString,
160	3		'<major_version>.<minor_version>.<patch_version>'
161			);
162			}
163	3		$majorVersion = $versionParts['major'];
164	3		$minorVersion = $versionParts['minor'] ?? 0;
165	3		$patchVersion = $versionParts['patch'] ?? null;
166
167	3		if ('5' === $majorVersion && '7' === $minorVersion && null === $patchVersion) {
168	3		$patchVersion = '9';
169			}
170
171	3		return $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
172			}
173
174			/**
175			* Detect MariaDB server version, including hack for some mariadb distributions
176			* that starts with the prefix '5.5.5-'
177			*
178			* @param string $versionString Version string as returned by mariadb server, i.e. '5.5.5-Mariadb-10.0.8-xenial'
179			* @throws DBALException
180			*/
181	3		private function getMariaDbMysqlVersionNumber(string $versionString) : string
182			{
183	3		if ( ! preg_match(
184	3		'/^(?:5\.5\.5-)?(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/i',
185	3		$versionString,
186	3		$versionParts
187			)) {
188			throw DBALException::invalidPlatformVersionSpecified(
189			$versionString,
190			'^(?:5\.5\.5-)?(mariadb-)?<major_version>.<minor_version>.<patch_version>'
191			);
192			}
193
194	3		return $versionParts['major'] . '.' . $versionParts['minor'] . '.' . $versionParts['patch'];
195			}
196
197			/**
198			* {@inheritdoc}
199			*/
200	4	View Code Duplication	public function getDatabase(\Doctrine\DBAL\Connection $conn)
			0 ignored issues – show Duplication introduced 2017-07-31 14:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
201			{
202	4		$params = $conn->getParams();
203
204	4		if (isset($params['dbname'])) {
205	4		return $params['dbname'];
206			}
207
208	4		return $conn->query('SELECT DATABASE()')->fetchColumn();
			0 ignored issues – show Bug Best Practice introduced 2017-11-18 19:58 UTC by Report Bug Copy Issue Report The expression `return $conn->query('SEL...BASE()')->fetchColumn()` also could return the type `boolean` which is incompatible with the return type mandated by `Doctrine\DBAL\Driver::getDatabase()` of `string`. Loading history...
209			}
210
211			/**
212			* {@inheritdoc}
213			* @return MySqlPlatform
214			*/
215	6		public function getDatabasePlatform()
216			{
217	6		return new MySqlPlatform();
218			}
219
220			/**
221			* {@inheritdoc}
222			* @return MySqlSchemaManager
223			*/
224	3		public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
225			{
226	3		return new MySqlSchemaManager($conn);
227			}
228			}
229

doctrine / dbal

Push — master ( edfbda...298c91 )

getMariaDbMysqlVersionNumber() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like