MySqlSchemaManager::getMariaDb1027ColumnDefault() - 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

MySqlSchemaManager::getMariaDb1027ColumnDefault() B

↳ Parent: MySqlSchemaManager

Complexity

Conditions	7
Paths	6

Size

Total Lines	20
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	20
ccs	0
cts	15
cp	0
rs	8.2222
cc	7
eloc	16
nc	6
nop	2
crap	56

<?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\Schema;

use Doctrine\DBAL\Platforms\MariaDb1027Platform;
use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Types\Type;

/**
 * Schema manager for the MySql RDBMS.
 *
 * @author Konsta Vesterinen <[email protected]>
 * @author Lukas Smith <[email protected]> (PEAR MDB2 library)
 * @author Roman Borschel <[email protected]>
 * @author Benjamin Eberlei <[email protected]>
 * @since  2.0
 */
class MySqlSchemaManager extends AbstractSchemaManager
{
    /**
     * {@inheritdoc}
     */
    protected function _getPortableViewDefinition($view)
    {
        return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableDefinition($table)
    {
        return array_shift($table);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableUserDefinition($user)
    {
        return [
            'user' => $user['User'],
            'password' => $user['Password'],
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableIndexesList($tableIndexes, $tableName=null)
    {
        foreach ($tableIndexes as $k => $v) {
            $v = array_change_key_case($v, CASE_LOWER);
            if ($v['key_name'] === 'PRIMARY') {
                $v['primary'] = true;
            } else {
                $v['primary'] = false;
            }
            if (strpos($v['index_type'], 'FULLTEXT') !== false) {
                $v['flags'] = ['FULLTEXT'];
            } elseif (strpos($v['index_type'], 'SPATIAL') !== false) {
                $v['flags'] = ['SPATIAL'];
            }
            $tableIndexes[$k] = $v;
        }

        return parent::_getPortableTableIndexesList($tableIndexes, $tableName);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableSequenceDefinition($sequence)
    {
        return end($sequence);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableDatabaseDefinition($database)
    {
        return $database['Database'];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableColumnDefinition($tableColumn)
    {
        $tableColumn = array_change_key_case($tableColumn, CASE_LOWER);

        $dbType = strtolower($tableColumn['type']);
        $dbType = strtok($dbType, '(), ');
        if (isset($tableColumn['length'])) {
            $length = $tableColumn['length'];
        } else {
            $length = strtok('(), ');
        }

        $fixed = null;

        if ( ! isset($tableColumn['name'])) {
            $tableColumn['name'] = '';
        }

        $scale = null;
        $precision = null;

        $type = $this->_platform->getDoctrineTypeMapping($dbType);

        // In cases where not connected to a database DESCRIBE $table does not return 'Comment'
        if (isset($tableColumn['comment'])) {
            $type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
            $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
        }

        switch ($dbType) {
            case 'char':
            case 'binary':
                $fixed = true;
                break;
            case 'float':
            case 'double':
            case 'real':
            case 'numeric':
            case 'decimal':
                if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) {
                    $precision = $match[1];
                    $scale = $match[2];
                    $length = null;
                }
                break;
            case 'tinytext':
                $length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT;
                break;
            case 'text':
                $length = MySqlPlatform::LENGTH_LIMIT_TEXT;
                break;
            case 'mediumtext':
                $length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT;
                break;
            case 'tinyblob':
                $length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB;
                break;
            case 'blob':
                $length = MySqlPlatform::LENGTH_LIMIT_BLOB;
                break;
            case 'mediumblob':
                $length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB;
                break;
            case 'tinyint':
            case 'smallint':
            case 'mediumint':
            case 'int':
            case 'integer':
            case 'bigint':
            case 'year':
                $length = null;
                break;
        }

        $length = $length !== null ? (int) $length : null;

        $isNotNull = $tableColumn['null'] !== 'YES';

        if ($this->_platform instanceof MariaDb1027Platform) {
            $columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default'] ?? null);
        } else {
            $columnDefault = (isset($tableColumn['default'])) ? $tableColumn['default'] : null;
        }

        $options = [
            'length'        => $length,
            'unsigned'      => strpos($tableColumn['type'], 'unsigned') !== false,
            'fixed'         => (bool) $fixed,
            'default'       => $columnDefault,
            'notnull'       => $isNotNull,
            'scale'         => null,
            'precision'     => null,
            'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false,
            'comment'       => isset($tableColumn['comment']) && $tableColumn['comment'] !== ''
                ? $tableColumn['comment']
                : null,
        ];

        if ($scale !== null && $precision !== null) {
            $options['scale'] = $scale;
            $options['precision'] = $precision;
        }

        $column = new Column($tableColumn['field'], Type::getType($type), $options);

        if (isset($tableColumn['collation'])) {
            $column->setPlatformOption('collation', $tableColumn['collation']);
        }

        return $column;
    }


    /**
     * Return column default value for MariaDB >= 10.2.7 servers that is
     * compatible with existing doctrine mysql implementation (unquoted literals)
     *
     * Since 10.2.7:
     *
     * 1. Column defaults stored in information_schema are now quoted
     *    to distinguish them from expressions (see MDEV-10134 for a what is an expression).
     *
     * @link https://mariadb.com/kb/en/library/information-schema-columns-table/
     * @link https://jira.mariadb.org/browse/MDEV-13132
     *
     * 2. Quoted string defaults use double single quotes as escaping character in information_schema.
     *
     * @links https://mariadb.com/kb/en/library/string-literals/
     *
     * @param null|string $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7
     */
    private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault): ?string {
        if ($columnDefault === 'NULL' || $columnDefault === null) {
            $defaultValue = null;
        } elseif (strpos($columnDefault, "'") === 0) {
            $defaultValue = stripslashes(
                str_replace("''", "'",
                    preg_replace('/^\'(.*)\'$/', '$1', $columnDefault)
                )
            );
        } elseif ($columnDefault === 'current_timestamp()') {
            $defaultValue = $platform->getCurrentTimestampSQL();
        } elseif ($columnDefault === 'curdate()') {
            $defaultValue = $platform->getCurrentDateSQL();
        } elseif ($columnDefault === 'curtime()') {
            $defaultValue = $platform->getCurrentTimeSQL();
        } else {
            $defaultValue = $columnDefault;
        }
        return $defaultValue;
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeysList($tableForeignKeys)
    {
        $list = [];
        foreach ($tableForeignKeys as $value) {
            $value = array_change_key_case($value, CASE_LOWER);
            if (!isset($list[$value['constraint_name']])) {
                if (!isset($value['delete_rule']) || $value['delete_rule'] === "RESTRICT") {
                    $value['delete_rule'] = null;
                }
                if (!isset($value['update_rule']) || $value['update_rule'] === "RESTRICT") {
                    $value['update_rule'] = null;
                }

                $list[$value['constraint_name']] = [
                    'name' => $value['constraint_name'],
                    'local' => [],
                    'foreign' => [],
                    'foreignTable' => $value['referenced_table_name'],
                    'onDelete' => $value['delete_rule'],
                    'onUpdate' => $value['update_rule'],
                ];
            }
            $list[$value['constraint_name']]['local'][] = $value['column_name'];
            $list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name'];
        }

        $result = [];
        foreach ($list as $constraint) {
            $result[] = new ForeignKeyConstraint(
                array_values($constraint['local']), $constraint['foreignTable'],
                array_values($constraint['foreign']), $constraint['name'],
                [
                    'onDelete' => $constraint['onDelete'],
                    'onUpdate' => $constraint['onUpdate'],
                ]
            );
        }

        return $result;
    }
}


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\Schema;
21
22		use Doctrine\DBAL\Platforms\MariaDb1027Platform;
23		use Doctrine\DBAL\Platforms\MySqlPlatform;
24		use Doctrine\DBAL\Types\Type;
25
26		/**
27		* Schema manager for the MySql RDBMS.
28		*
29		* @author Konsta Vesterinen <[email protected]>
30		* @author Lukas Smith <[email protected]> (PEAR MDB2 library)
31		* @author Roman Borschel <[email protected]>
32		* @author Benjamin Eberlei <[email protected]>
33		* @since 2.0
34		*/
35		class MySqlSchemaManager extends AbstractSchemaManager
36		{
37		/**
38		* {@inheritdoc}
39		*/
40		protected function _getPortableViewDefinition($view)
41		{
42		return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
		0 ignored issues – show Bug Best Practice introduced 2017-06-29 19:45 UTC by Report Bug Copy Issue Report The return type of `return new \Doctrine\DBA...ew['VIEW_DEFINITION']);` (`Doctrine\DBAL\Schema\View`) is incompatible with the return type of the parent method `Doctrine\DBAL\Schema\Abs...tPortableViewDefinition` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
43		}
44
45		/**
46		* {@inheritdoc}
47		*/
48		protected function _getPortableTableDefinition($table)
49		{
50		return array_shift($table);
51		}
52
53		/**
54		* {@inheritdoc}
55		*/
56		protected function _getPortableUserDefinition($user)
57		{
58		return [
59		'user' => $user['User'],
60		'password' => $user['Password'],
61		];
62		}
63
64		/**
65		* {@inheritdoc}
66		*/
67		protected function _getPortableTableIndexesList($tableIndexes, $tableName=null)
68		{
69		foreach ($tableIndexes as $k => $v) {
70		$v = array_change_key_case($v, CASE_LOWER);
71		if ($v['key_name'] === 'PRIMARY') {
72		$v['primary'] = true;
73		} else {
74		$v['primary'] = false;
75		}
76		if (strpos($v['index_type'], 'FULLTEXT') !== false) {
77		$v['flags'] = ['FULLTEXT'];
78		} elseif (strpos($v['index_type'], 'SPATIAL') !== false) {
79		$v['flags'] = ['SPATIAL'];
80		}
81		$tableIndexes[$k] = $v;
82		}
83
84		return parent::_getPortableTableIndexesList($tableIndexes, $tableName);
85		}
86
87		/**
88		* {@inheritdoc}
89		*/
90		protected function _getPortableSequenceDefinition($sequence)
91		{
92		return end($sequence);
93		}
94
95		/**
96		* {@inheritdoc}
97		*/
98		protected function _getPortableDatabaseDefinition($database)
99		{
100		return $database['Database'];
101		}
102
103		/**
104		* {@inheritdoc}
105		*/
106		protected function _getPortableTableColumnDefinition($tableColumn)
107		{
108		$tableColumn = array_change_key_case($tableColumn, CASE_LOWER);
109
110		$dbType = strtolower($tableColumn['type']);
111		$dbType = strtok($dbType, '(), ');
112		if (isset($tableColumn['length'])) {
113		$length = $tableColumn['length'];
114		} else {
115		$length = strtok('(), ');
116		}
117
118		$fixed = null;
119
120		if ( ! isset($tableColumn['name'])) {
121		$tableColumn['name'] = '';
122		}
123
124		$scale = null;
125		$precision = null;
126
127		$type = $this->_platform->getDoctrineTypeMapping($dbType);
128
129		// In cases where not connected to a database DESCRIBE $table does not return 'Comment'
130		if (isset($tableColumn['comment'])) {
131		$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
132		$tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
133		}
134
135		switch ($dbType) {
136		case 'char':
137		case 'binary':
138		$fixed = true;
139		break;
140		case 'float':
141		case 'double':
142		case 'real':
143		case 'numeric':
144		case 'decimal':
145		if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) {
146		$precision = $match[1];
147		$scale = $match[2];
148		$length = null;
149		}
150		break;
151		case 'tinytext':
152		$length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT;
153		break;
154		case 'text':
155		$length = MySqlPlatform::LENGTH_LIMIT_TEXT;
156		break;
157		case 'mediumtext':
158		$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT;
159		break;
160		case 'tinyblob':
161		$length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB;
162		break;
163		case 'blob':
164		$length = MySqlPlatform::LENGTH_LIMIT_BLOB;
165		break;
166		case 'mediumblob':
167		$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB;
168		break;
169		case 'tinyint':
170		case 'smallint':
171		case 'mediumint':
172		case 'int':
173		case 'integer':
174		case 'bigint':
175		case 'year':
176		$length = null;
177		break;
178		}
179
180		$length = $length !== null ? (int) $length : null;
181
182		$isNotNull = $tableColumn['null'] !== 'YES';
183
184		if ($this->_platform instanceof MariaDb1027Platform) {
185		$columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default'] ?? null);
186		} else {
187		$columnDefault = (isset($tableColumn['default'])) ? $tableColumn['default'] : null;
188		}
189
190		$options = [
191		'length' => $length,
192		'unsigned' => strpos($tableColumn['type'], 'unsigned') !== false,
193		'fixed' => (bool) $fixed,
194		'default' => $columnDefault,
195		'notnull' => $isNotNull,
196		'scale' => null,
197		'precision' => null,
198		'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false,
199		'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== ''
200		? $tableColumn['comment']
201		: null,
202		];
203
204		if ($scale !== null && $precision !== null) {
205		$options['scale'] = $scale;
206		$options['precision'] = $precision;
207		}
208
209		$column = new Column($tableColumn['field'], Type::getType($type), $options);
210
211		if (isset($tableColumn['collation'])) {
212		$column->setPlatformOption('collation', $tableColumn['collation']);
213		}
214
215		return $column;
216		}
217
218
219		/**
220		* Return column default value for MariaDB >= 10.2.7 servers that is
221		* compatible with existing doctrine mysql implementation (unquoted literals)
222		*
223		* Since 10.2.7:
224		*
225		* 1. Column defaults stored in information_schema are now quoted
226		* to distinguish them from expressions (see MDEV-10134 for a what is an expression).
227		*
228		* @link https://mariadb.com/kb/en/library/information-schema-columns-table/
229		* @link https://jira.mariadb.org/browse/MDEV-13132
230		*
231		* 2. Quoted string defaults use double single quotes as escaping character in information_schema.
232		*
233		* @links https://mariadb.com/kb/en/library/string-literals/
234		*
235		* @param null\|string $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7
236		*/
237		private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault): ?string {
238		if ($columnDefault === 'NULL' \|\| $columnDefault === null) {
239		$defaultValue = null;
240		} elseif (strpos($columnDefault, "'") === 0) {
241		$defaultValue = stripslashes(
242		str_replace("''", "'",
243		preg_replace('/^\'(.*)\'$/', '$1', $columnDefault)
244		)
245		);
246		} elseif ($columnDefault === 'current_timestamp()') {
247		$defaultValue = $platform->getCurrentTimestampSQL();
248		} elseif ($columnDefault === 'curdate()') {
249		$defaultValue = $platform->getCurrentDateSQL();
250		} elseif ($columnDefault === 'curtime()') {
251		$defaultValue = $platform->getCurrentTimeSQL();
252		} else {
253		$defaultValue = $columnDefault;
254		}
255		return $defaultValue;
256		}
257
258		/**
259		* {@inheritdoc}
260		*/
261	1	protected function _getPortableTableForeignKeysList($tableForeignKeys)
262		{
263	1	$list = [];
264	1	foreach ($tableForeignKeys as $value) {
265	1	$value = array_change_key_case($value, CASE_LOWER);
266	1	if (!isset($list[$value['constraint_name']])) {
267	1	if (!isset($value['delete_rule']) \|\| $value['delete_rule'] === "RESTRICT") {
268	1	$value['delete_rule'] = null;
269		}
270	1	if (!isset($value['update_rule']) \|\| $value['update_rule'] === "RESTRICT") {
271	1	$value['update_rule'] = null;
272		}
273
274	1	$list[$value['constraint_name']] = [
275	1	'name' => $value['constraint_name'],
276		'local' => [],
277		'foreign' => [],
278	1	'foreignTable' => $value['referenced_table_name'],
279	1	'onDelete' => $value['delete_rule'],
280	1	'onUpdate' => $value['update_rule'],
281		];
282		}
283	1	$list[$value['constraint_name']]['local'][] = $value['column_name'];
284	1	$list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name'];
285		}
286
287	1	$result = [];
288	1	foreach ($list as $constraint) {
289	1	$result[] = new ForeignKeyConstraint(
290	1	array_values($constraint['local']), $constraint['foreignTable'],
291	1	array_values($constraint['foreign']), $constraint['name'],
292		[
293	1	'onDelete' => $constraint['onDelete'],
294	1	'onUpdate' => $constraint['onUpdate'],
295		]
296		);
297		}
298
299	1	return $result;
300		}
301		}
302

doctrine / dbal

Pull Request — master (#2825)

MySqlSchemaManager::getMariaDb1027ColumnDefault() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like