AbstractMySQLDriver::getOracleMysqlVersionNumber() - Code Metrics - Inspection of "Fix mariadb 10.2.7 default column values (nulls to..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#2825)

by Sébastien

created 2017-09-26 15:59 UTC

AbstractMySQLDriver::getOracleMysqlVersionNumber() B

↳ Parent: AbstractMySQLDriver

Complexity

Conditions	5
Paths	3

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	5

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	18
ccs	11
cts	11
cp	1
rs	8.8571
cc	5
eloc	11
nc	3
nop	1
crap	5

<?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\AbstractPlatform;
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}
     *
     * @return AbstractPlatform|MariaDb1027Platform|MySQL57Platform|MySqlPlatform
     * @throws DBALException
     */
    public function createDatabasePlatformForVersion($version): AbstractPlatform
    {
        if (false !== stripos($version, 'mariadb')) {
            $versionNumber = $this->getMariaDbMysqlVersionNumber($version);
            if (version_compare($versionNumber, '10.2.7', '>=')) {
                return new MariaDb1027Platform();
            }
        } else {
            $versionNumber = $this->getOracleMysqlVersionNumber($version);
            if (version_compare($versionNumber, '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
    {
        $version = str_replace('5.5.5-', '', $versionString);

        if (!preg_match('/^(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/', strtolower($version), $versionParts)) {
            throw DBALException::invalidPlatformVersionSpecified(
                $version,
                '(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}
     */
    public function getDatabasePlatform()
    {
        return new MySqlPlatform();
    }

    /**
     * {@inheritdoc}
     */
    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\AbstractPlatform;
26			use Doctrine\DBAL\Platforms\MariaDb1027Platform;
27			use Doctrine\DBAL\Platforms\MySQL57Platform;
28			use Doctrine\DBAL\Platforms\MySqlPlatform;
29			use Doctrine\DBAL\Schema\MySqlSchemaManager;
30			use Doctrine\DBAL\VersionAwarePlatformDriver;
31
32			/**
33			* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for MySQL based drivers.
34			*
35			* @author Steve Müller <[email protected]>
36			* @link www.doctrine-project.org
37			* @since 2.5
38			*/
39			abstract class AbstractMySQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
40			{
41			/**
42			* {@inheritdoc}
43			*
44			* @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
45			* @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
46			*/
47	4		public function convertException($message, DriverException $exception)
48			{
49	4		switch ($exception->getErrorCode()) {
50	4		case '1213':
51	4		return new Exception\DeadlockException($message, $exception);
52	4		case '1205':
53	4		return new Exception\LockWaitTimeoutException($message, $exception);
54	4		case '1050':
55	4		return new Exception\TableExistsException($message, $exception);
56
57	4		case '1051':
58	4		case '1146':
59	4		return new Exception\TableNotFoundException($message, $exception);
60
61	4		case '1216':
62	4		case '1217':
63	4		case '1451':
64	4		case '1452':
65	4		case '1701':
66	4		return new Exception\ForeignKeyConstraintViolationException($message, $exception);
67
68	4		case '1062':
69	4		case '1557':
70	4		case '1569':
71	4		case '1586':
72	4		return new Exception\UniqueConstraintViolationException($message, $exception);
73
74	4		case '1054':
75	4		case '1166':
76	4		case '1611':
77	4		return new Exception\InvalidFieldNameException($message, $exception);
78
79	4		case '1052':
80	4		case '1060':
81	4		case '1110':
82	4		return new Exception\NonUniqueFieldNameException($message, $exception);
83
84	4		case '1064':
85	4		case '1149':
86	4		case '1287':
87	4		case '1341':
88	4		case '1342':
89	4		case '1343':
90	4		case '1344':
91	4		case '1382':
92	4		case '1479':
93	4		case '1541':
94	4		case '1554':
95	4		case '1626':
96	4		return new Exception\SyntaxErrorException($message, $exception);
97
98	4		case '1044':
99	4		case '1045':
100	4		case '1046':
101	4		case '1049':
102	4		case '1095':
103	4		case '1142':
104	4		case '1143':
105	4		case '1227':
106	4		case '1370':
107	4		case '1429':
108	4		case '2002':
109	4		case '2005':
110	4		return new Exception\ConnectionException($message, $exception);
111
112	4		case '1048':
113	4		case '1121':
114	4		case '1138':
115	4		case '1171':
116	4		case '1252':
117	4		case '1263':
118	4		case '1364':
119	4		case '1566':
120	4		return new Exception\NotNullConstraintViolationException($message, $exception);
121			}
122
123	4		return new Exception\DriverException($message, $exception);
124			}
125
126			/**
127			* {@inheritdoc}
128			*
129			* @return AbstractPlatform\|MariaDb1027Platform\|MySQL57Platform\|MySqlPlatform
130			* @throws DBALException
131			*/
132	6		public function createDatabasePlatformForVersion($version): AbstractPlatform
133			{
134	6		if (false !== stripos($version, 'mariadb')) {
135	3		$versionNumber = $this->getMariaDbMysqlVersionNumber($version);
136	3		if (version_compare($versionNumber, '10.2.7', '>=')) {
137	3		return new MariaDb1027Platform();
138			}
139			} else {
140	6		$versionNumber = $this->getOracleMysqlVersionNumber($version);
141	3		if (version_compare($versionNumber, '5.7.9', '>=')) {
142	3		return new MySQL57Platform();
143			}
144			}
145
146	3		return $this->getDatabasePlatform();
147			}
148
149			/**
150			* Get a normalized 'version number' from the server string
151			* returned by Oracle MySQL servers.
152			*
153			* @param string $versionString Version string returned by the driver, i.e. '5.7.10'
154			* @throws DBALException
155			*/
156	6		private function getOracleMysqlVersionNumber(string $versionString): string
157			{
158	6		if (!preg_match('/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/', $versionString, $versionParts)) {
159	3		throw DBALException::invalidPlatformVersionSpecified(
160	3		$versionString,
161	3		'<major_version>.<minor_version>.<patch_version>'
162			);
163			}
164	3		$majorVersion = $versionParts['major'];
165	3		$minorVersion = $versionParts['minor'] ?? 0;
166	3		$patchVersion = $versionParts['patch'] ?? null;
167
168	3		if ('5' === $majorVersion && '7' === $minorVersion && null === $patchVersion) {
169	3		$patchVersion = '9';
170			}
171
172	3		return $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
173			}
174
175			/**
176			* Detect MariaDB server version, including hack for some mariadb distributions
177			* that starts with the prefix '5.5.5-'
178			*
179			* @param string $versionString Version string as returned by mariadb server, i.e. '5.5.5-Mariadb-10.0.8-xenial'
180			* @throws DBALException
181			*/
182	3		private function getMariaDbMysqlVersionNumber(string $versionString): string
183			{
184	3		$version = str_replace('5.5.5-', '', $versionString);
185
186	3		if (!preg_match('/^(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/', strtolower($version), $versionParts)) {
187			throw DBALException::invalidPlatformVersionSpecified(
188			$version,
189			'(mariadb-)?<major_version>.<minor_version>.<patch_version>'
190			);
191			}
192
193	3		return $versionParts['major'] . '.' . $versionParts['minor'] . '.' . $versionParts['patch'];
194			}
195
196			/**
197			* {@inheritdoc}
198			*/
199	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...
200			{
201	4		$params = $conn->getParams();
202
203	4		if (isset($params['dbname'])) {
204	4		return $params['dbname'];
205			}
206
207	4		return $conn->query('SELECT DATABASE()')->fetchColumn();
			0 ignored issues – show Bug Compatibility introduced 2017-06-29 19:45 UTC by Report Bug Copy Issue Report The expression `$conn->query('SELECT DATABASE()')->fetchColumn();` of type `string\|boolean` adds the type `boolean` to the return on line 207 which is incompatible with the return type declared by the interface `Doctrine\DBAL\Driver::getDatabase` of type `string`. Loading history...
208			}
209
210			/**
211			* {@inheritdoc}
212			*/
213	6		public function getDatabasePlatform()
214			{
215	6		return new MySqlPlatform();
216			}
217
218			/**
219			* {@inheritdoc}
220			*/
221	3		public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
222			{
223	3		return new MySqlSchemaManager($conn);
224			}
225			}
226

doctrine / dbal

Pull Request — master (#2825)

AbstractMySQLDriver::getOracleMysqlVersionNumber() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like