AbstractMySQLDriver::createDatabasePlatformForVersion() - Code Metrics - Inspection of "Fix for Mariadb 10.2.7 default column value and nu..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#2825)

by Sébastien

created 2017-08-28 10:46 UTC

createDatabasePlatformForVersion() C

↳ Parent: AbstractMySQLDriver

Complexity

Conditions	12
Paths	20

Size

Total Lines	64
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	26
CRAP Score	12.1591

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	64
ccs	26
cts	29
cp	0.8966
rs	6.0561
cc	12
eloc	31
nc	20
nop	1
crap	12.1591

How to fix Long Method Complexity

<?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\MariaDb102Platform;
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}
     */
    public function createDatabasePlatformForVersion($version)
    {

        // Detect vendor and version
        $lowerCaseVersion = strtolower($version);

        if (false !== strpos($lowerCaseVersion, 'mariadb')) {
            // MariaDB does not follow one rule for versions ;)

            // Will catch things like '10.2.8-MariaDB-1~lenny-log'
            preg_match('/(?P<major>\d{1,2})\.(?P<minor>\d{1,2})\.(?P<patch>\d+)/', $lowerCaseVersion, $firstMatch);
            // Will catch things like '5.5.5-10.2.8-MariaDB-10.2.8+maria~xenial-log'
            preg_match('/\-(?P<major>10)\.(?P<minor>\d{1,2})\.(?P<patch>\d+)/', $lowerCaseVersion, $secondMatch);

            if (empty($firstMatch) && empty($secondMatch)
            ) {
                throw DBALException::invalidPlatformVersionSpecified(
                    $version,
                    'MariaDB-<major_version>.<minor_version>.<patch_version>' .
                                 'or <major_version>.<minor_version>.<patch_version>-MariaDB'
                );
            }

            $versionParts = array_merge($firstMatch, $secondMatch);

            $majorVersion = $versionParts['major'];
            $minorVersion = $versionParts['minor'];
            $patchVersion = $versionParts['patch'];

            $version = $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
            if (version_compare($version, '10.2.7', '>=')) {
                return new MariaDb102Platform();
            }

        } else {
            // Oracle MySQL

            if (!preg_match('/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/', $version, $versionParts)) {
                throw DBALException::invalidPlatformVersionSpecified(
                    $version,
                    '<major_version>.<minor_version>.<patch_version>'
                );
            }
            $majorVersion = $versionParts['major'];
            $minorVersion = isset($versionParts['minor']) ? $versionParts['minor'] : 0;
            $patchVersion = isset($versionParts['patch']) ? $versionParts['patch'] : null;

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

            $version = $majorVersion . '.' . $minorVersion . '.' . $patchVersion;

            if (version_compare($version, '5.7.9', '>=')) {
                return new MySQL57Platform();
            }
        }




        return $this->getDatabasePlatform();

    }


    /**
     * {@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\MariaDb102Platform;
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			/**
127			* {@inheritdoc}
128			*/
129	6		public function createDatabasePlatformForVersion($version)
130			{
131
132			// Detect vendor and version
133	6		$lowerCaseVersion = strtolower($version);
134
135	6		if (false !== strpos($lowerCaseVersion, 'mariadb')) {
136			// MariaDB does not follow one rule for versions ;)
137
138			// Will catch things like '10.2.8-MariaDB-1~lenny-log'
139	3		preg_match('/(?P<major>\d{1,2})\.(?P<minor>\d{1,2})\.(?P<patch>\d+)/', $lowerCaseVersion, $firstMatch);
140			// Will catch things like '5.5.5-10.2.8-MariaDB-10.2.8+maria~xenial-log'
141	3		preg_match('/\-(?P<major>10)\.(?P<minor>\d{1,2})\.(?P<patch>\d+)/', $lowerCaseVersion, $secondMatch);
142
143	3		if (empty($firstMatch) && empty($secondMatch)
144			) {
145			throw DBALException::invalidPlatformVersionSpecified(
146			$version,
147			'MariaDB-<major_version>.<minor_version>.<patch_version>' .
148			'or <major_version>.<minor_version>.<patch_version>-MariaDB'
149			);
150			}
151
152	3		$versionParts = array_merge($firstMatch, $secondMatch);
153
154	3		$majorVersion = $versionParts['major'];
155	3		$minorVersion = $versionParts['minor'];
156	3		$patchVersion = $versionParts['patch'];
157
158	3		$version = $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
159	3		if (version_compare($version, '10.2.7', '>=')) {
160	3		return new MariaDb102Platform();
161			}
162
163			} else {
164			// Oracle MySQL
165
166	6		if (!preg_match('/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/', $version, $versionParts)) {
167	3		throw DBALException::invalidPlatformVersionSpecified(
168	3		$version,
169	3		'<major_version>.<minor_version>.<patch_version>'
170			);
171			}
172	3		$majorVersion = $versionParts['major'];
173	3		$minorVersion = isset($versionParts['minor']) ? $versionParts['minor'] : 0;
174	3		$patchVersion = isset($versionParts['patch']) ? $versionParts['patch'] : null;
175
176	3		if ('5' === $majorVersion && '7' === $minorVersion && null === $patchVersion) {
177	3		$patchVersion = '9';
178			}
179
180	3		$version = $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
181
182	3		if (version_compare($version, '5.7.9', '>=')) {
183	3		return new MySQL57Platform();
184			}
185			}
186
187
188
189
190	3		return $this->getDatabasePlatform();
191
192			}
193
194
195			/**
196			* {@inheritdoc}
197			*/
198	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...
199			{
200	4		$params = $conn->getParams();
201
202	4		if (isset($params['dbname'])) {
203	4		return $params['dbname'];
204			}
205
206	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 206 which is incompatible with the return type declared by the interface `Doctrine\DBAL\Driver::getDatabase` of type `string`. Loading history...
207			}
208
209			/**
210			* {@inheritdoc}
211			*/
212	6		public function getDatabasePlatform()
213			{
214	6		return new MySqlPlatform();
215			}
216
217			/**
218			* {@inheritdoc}
219			*/
220	3		public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
221			{
222	3		return new MySqlSchemaManager($conn);
223			}
224			}
225

doctrine / dbal

Pull Request — master (#2825)

createDatabasePlatformForVersion() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like