MySqlSchemaManager::parseCreateOptions() - Code Metrics - Inspection of "Merge pull request #3393 from morozov/issues/3384" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( af38e2...b8729e )

by Sergei

created 2018-12-07 02:50 UTC

MySqlSchemaManager::parseCreateOptions() A

↳ Parent: MySqlSchemaManager

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	15
rs	10
c	0
b	0
f	0
ccs	8
cts	8
cp	1
cc	3
nc	3
nop	1
crap	3

<?php

namespace Doctrine\DBAL\Schema;

use Doctrine\DBAL\Platforms\MariaDb1027Platform;
use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Types\Type;
use const CASE_LOWER;
use function array_change_key_case;
use function array_shift;
use function array_values;
use function end;
use function explode;
use function preg_match;
use function preg_replace;
use function str_replace;
use function stripslashes;
use function strpos;
use function strtok;
use function strtolower;

/**
 * Schema manager for the MySql RDBMS.
 */
class MySqlSchemaManager extends AbstractSchemaManager
{
    /**
     * {@inheritdoc}
     */
    protected function _getPortableViewDefinition($view)
    {
        return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
    }

    /**
     * {@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'];
            }
            $v['length'] = $v['sub_part'] ?? null;

            $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, '(), ');
        $length = $tableColumn['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;
        }

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

        $options = [
            'length'        => $length !== null ? (int) $length : null,
            'unsigned'      => strpos($tableColumn['type'], 'unsigned') !== false,
            'fixed'         => (bool) $fixed,
            'default'       => $columnDefault,
            'notnull'       => $tableColumn['null'] !== 'YES',
            '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']     = (int) $scale;
            $options['precision'] = (int) $precision;
        }

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

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

        return $column;
    }

    /**
     * Return Doctrine/Mysql-compatible column default values for MariaDB 10.2.7+ servers.
     *
     * - Since MariaDb 10.2.7 column defaults stored in information_schema are now quoted
     *   to distinguish them from expressions (see MDEV-10134).
     * - CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE are stored in information_schema
     *   as current_timestamp(), currdate(), currtime()
     * - Quoted 'NULL' is not enforced by Maria, it is technically possible to have
     *   null in some circumstances (see https://jira.mariadb.org/browse/MDEV-14053)
     * - \' is always stored as '' in information_schema (normalized)
     *
     * @link https://mariadb.com/kb/en/library/information-schema-columns-table/
     * @link https://jira.mariadb.org/browse/MDEV-13132
     *
     * @param string|null $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) {
            return null;
        }
        if ($columnDefault[0] === "'") {
            return stripslashes(
                str_replace(
                    "''",
                    "'",
                    preg_replace('/^\'(.*)\'$/', '$1', $columnDefault)
                )
            );
        }
        switch ($columnDefault) {
            case 'current_timestamp()':
                return $platform->getCurrentTimestampSQL();
            case 'curdate()':
                return $platform->getCurrentDateSQL();
            case 'curtime()':
                return $platform->getCurrentTimeSQL();
        }
        return $columnDefault;
    }

    /**
     * {@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;
    }

    public function listTableDetails($tableName)
    {
        $table = parent::listTableDetails($tableName);

        /** @var MySqlPlatform $platform */
        $platform = $this->_platform;
        $sql      = $platform->getListTableMetadataSQL($tableName);

        $tableOptions = $this->_conn->fetchAssoc($sql);

        $table->addOption('engine', $tableOptions['ENGINE']);
        if ($tableOptions['TABLE_COLLATION'] !== null) {
            $table->addOption('collation', $tableOptions['TABLE_COLLATION']);
        }
        if ($tableOptions['AUTO_INCREMENT'] !== null) {
            $table->addOption('autoincrement', $tableOptions['AUTO_INCREMENT']);
        }
        $table->addOption('comment', $tableOptions['TABLE_COMMENT']);
        $table->addOption('create_options', $this->parseCreateOptions($tableOptions['CREATE_OPTIONS']));

        return $table;
    }

    /**
     * @return string[]|true[]
     */
    private function parseCreateOptions(string $string) : array
    {
        $options = [];

        if ($string === '') {
            return $options;
        }

        foreach (explode(' ', $string) as $pair) {
            $parts = explode('=', $pair, 2);

            $options[$parts[0]] = $parts[1] ?? true;
        }

        return $options;
    }
}


1		<?php
2
3		namespace Doctrine\DBAL\Schema;
4
5		use Doctrine\DBAL\Platforms\MariaDb1027Platform;
6		use Doctrine\DBAL\Platforms\MySqlPlatform;
7		use Doctrine\DBAL\Types\Type;
8		use const CASE_LOWER;
9		use function array_change_key_case;
10		use function array_shift;
11		use function array_values;
12		use function end;
13		use function explode;
14		use function preg_match;
15		use function preg_replace;
16		use function str_replace;
17		use function stripslashes;
18		use function strpos;
19		use function strtok;
20		use function strtolower;
21
22		/**
23		* Schema manager for the MySql RDBMS.
24		*/
25		class MySqlSchemaManager extends AbstractSchemaManager
26		{
27		/**
28		* {@inheritdoc}
29		*/
30	14	protected function _getPortableViewDefinition($view)
31		{
32	14	return new View($view['TABLE_NAME'], $view['VIEW_DEFINITION']);
33		}
34
35		/**
36		* {@inheritdoc}
37		*/
38	1076	protected function _getPortableTableDefinition($table)
39		{
40	1076	return array_shift($table);
41		}
42
43		/**
44		* {@inheritdoc}
45		*/
46		protected function _getPortableUserDefinition($user)
47		{
48		return [
49		'user' => $user['User'],
50		'password' => $user['Password'],
51		];
52		}
53
54		/**
55		* {@inheritdoc}
56		*/
57	600	protected function _getPortableTableIndexesList($tableIndexes, $tableName = null)
58		{
59	600	foreach ($tableIndexes as $k => $v) {
60	322	$v = array_change_key_case($v, CASE_LOWER);
61	322	if ($v['key_name'] === 'PRIMARY') {
62	252	$v['primary'] = true;
63		} else {
64	210	$v['primary'] = false;
65		}
66	322	if (strpos($v['index_type'], 'FULLTEXT') !== false) {
67	42	$v['flags'] = ['FULLTEXT'];
68	308	} elseif (strpos($v['index_type'], 'SPATIAL') !== false) {
69	42	$v['flags'] = ['SPATIAL'];
70		}
71	322	$v['length'] = $v['sub_part'] ?? null;
72
73	322	$tableIndexes[$k] = $v;
74		}
75
76	600	return parent::_getPortableTableIndexesList($tableIndexes, $tableName);
77		}
78
79		/**
80		* {@inheritdoc}
81		*/
82		protected function _getPortableSequenceDefinition($sequence)
83		{
84		return end($sequence);
85		}
86
87		/**
88		* {@inheritdoc}
89		*/
90	28	protected function _getPortableDatabaseDefinition($database)
91		{
92	28	return $database['Database'];
93		}
94
95		/**
96		* {@inheritdoc}
97		*/
98	712	protected function _getPortableTableColumnDefinition($tableColumn)
99		{
100	712	$tableColumn = array_change_key_case($tableColumn, CASE_LOWER);
101
102	712	$dbType = strtolower($tableColumn['type']);
103	712	$dbType = strtok($dbType, '(), ');
104	712	$length = $tableColumn['length'] ?? strtok('(), ');
105
106	712	$fixed = null;
107
108	712	if (! isset($tableColumn['name'])) {
109	712	$tableColumn['name'] = '';
110		}
111
112	712	$scale = null;
113	712	$precision = null;
114
115	712	$type = $this->_platform->getDoctrineTypeMapping($dbType);
116
117		// In cases where not connected to a database DESCRIBE $table does not return 'Comment'
118	712	if (isset($tableColumn['comment'])) {
119	712	$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
120	712	$tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);
121		}
122
123	712	switch ($dbType) {
124	712	case 'char':
125	684	case 'binary':
126	84	$fixed = true;
127	84	break;
128	684	case 'float':
129	684	case 'double':
130	670	case 'real':
131	670	case 'numeric':
132	670	case 'decimal':
133	98	if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['type'], $match)) {
134	84	$precision = $match[1];
135	84	$scale = $match[2];
136	84	$length = null;
137		}
138	98	break;
139	656	case 'tinytext':
140	42	$length = MySqlPlatform::LENGTH_LIMIT_TINYTEXT;
141	42	break;
142	656	case 'text':
143	42	$length = MySqlPlatform::LENGTH_LIMIT_TEXT;
144	42	break;
145	656	case 'mediumtext':
146	42	$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMTEXT;
147	42	break;
148	656	case 'tinyblob':
149		$length = MySqlPlatform::LENGTH_LIMIT_TINYBLOB;
150		break;
151	656	case 'blob':
152	42	$length = MySqlPlatform::LENGTH_LIMIT_BLOB;
153	42	break;
154	656	case 'mediumblob':
155	42	$length = MySqlPlatform::LENGTH_LIMIT_MEDIUMBLOB;
156	42	break;
157	656	case 'tinyint':
158	642	case 'smallint':
159	642	case 'mediumint':
160	642	case 'int':
161	334	case 'integer':
162	334	case 'bigint':
163	334	case 'year':
164	546	$length = null;
165	546	break;
166		}
167
168	712	if ($this->_platform instanceof MariaDb1027Platform) {
169	200	$columnDefault = $this->getMariaDb1027ColumnDefault($this->_platform, $tableColumn['default']);
170		} else {
171	512	$columnDefault = $tableColumn['default'];
172		}
173
174		$options = [
175	712	'length' => $length !== null ? (int) $length : null,
176	712	'unsigned' => strpos($tableColumn['type'], 'unsigned') !== false,
177	712	'fixed' => (bool) $fixed,
178	712	'default' => $columnDefault,
179	712	'notnull' => $tableColumn['null'] !== 'YES',
180		'scale' => null,
181		'precision' => null,
182	712	'autoincrement' => strpos($tableColumn['extra'], 'auto_increment') !== false,
183	712	'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== ''
184	196	? $tableColumn['comment']
185		: null,
186		];
187
188	712	if ($scale !== null && $precision !== null) {
189	84	$options['scale'] = (int) $scale;
190	84	$options['precision'] = (int) $precision;
191		}
192
193	712	$column = new Column($tableColumn['field'], Type::getType($type), $options);
194
195	712	if (isset($tableColumn['collation'])) {
196	306	$column->setPlatformOption('collation', $tableColumn['collation']);
197		}
198
199	712	return $column;
200		}
201
202		/**
203		* Return Doctrine/Mysql-compatible column default values for MariaDB 10.2.7+ servers.
204		*
205		* - Since MariaDb 10.2.7 column defaults stored in information_schema are now quoted
206		* to distinguish them from expressions (see MDEV-10134).
207		* - CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE are stored in information_schema
208		* as current_timestamp(), currdate(), currtime()
209		* - Quoted 'NULL' is not enforced by Maria, it is technically possible to have
210		* null in some circumstances (see https://jira.mariadb.org/browse/MDEV-14053)
211		* - \' is always stored as '' in information_schema (normalized)
212		*
213		* @link https://mariadb.com/kb/en/library/information-schema-columns-table/
214		* @link https://jira.mariadb.org/browse/MDEV-13132
215		*
216		* @param string\|null $columnDefault default value as stored in information_schema for MariaDB >= 10.2.7
217		*/
218	200	private function getMariaDb1027ColumnDefault(MariaDb1027Platform $platform, ?string $columnDefault) : ?string
219		{
220	200	if ($columnDefault === 'NULL' \|\| $columnDefault === null) {
221	176	return null;
222		}
223	48	if ($columnDefault[0] === "'") {
224	32	return stripslashes(
225	32	str_replace(
226	32	"''",
227	32	"'",
228	32	preg_replace('/^\'(.*)\'$/', '$1', $columnDefault)
229		)
230		);
231		}
232	32	switch ($columnDefault) {
233	32	case 'current_timestamp()':
234	16	return $platform->getCurrentTimestampSQL();
235	28	case 'curdate()':
236	12	return $platform->getCurrentDateSQL();
237	28	case 'curtime()':
238	12	return $platform->getCurrentTimeSQL();
239		}
240	24	return $columnDefault;
241		}
242
243		/**
244		* {@inheritdoc}
245		*/
246	571	protected function _getPortableTableForeignKeysList($tableForeignKeys)
247		{
248	571	$list = [];
249	571	foreach ($tableForeignKeys as $value) {
250	125	$value = array_change_key_case($value, CASE_LOWER);
251	125	if (! isset($list[$value['constraint_name']])) {
252	125	if (! isset($value['delete_rule']) \|\| $value['delete_rule'] === 'RESTRICT') {
253	99	$value['delete_rule'] = null;
254		}
255	125	if (! isset($value['update_rule']) \|\| $value['update_rule'] === 'RESTRICT') {
256	111	$value['update_rule'] = null;
257		}
258
259	125	$list[$value['constraint_name']] = [
260	125	'name' => $value['constraint_name'],
261		'local' => [],
262		'foreign' => [],
263	125	'foreignTable' => $value['referenced_table_name'],
264	125	'onDelete' => $value['delete_rule'],
265	125	'onUpdate' => $value['update_rule'],
266		];
267		}
268	125	$list[$value['constraint_name']]['local'][] = $value['column_name'];
269	125	$list[$value['constraint_name']]['foreign'][] = $value['referenced_column_name'];
270		}
271
272	571	$result = [];
273	571	foreach ($list as $constraint) {
274	125	$result[] = new ForeignKeyConstraint(
275	125	array_values($constraint['local']),
276	125	$constraint['foreignTable'],
277	125	array_values($constraint['foreign']),
278	125	$constraint['name'],
279		[
280	125	'onDelete' => $constraint['onDelete'],
281	125	'onUpdate' => $constraint['onUpdate'],
282		]
283		);
284		}
285
286	571	return $result;
287		}
288
289	516	public function listTableDetails($tableName)
290		{
291	516	$table = parent::listTableDetails($tableName);
292
293		/** @var MySqlPlatform $platform */
294	516	$platform = $this->_platform;
295	516	$sql = $platform->getListTableMetadataSQL($tableName);
296
297	516	$tableOptions = $this->_conn->fetchAssoc($sql);
298
299	516	$table->addOption('engine', $tableOptions['ENGINE']);
300	516	if ($tableOptions['TABLE_COLLATION'] !== null) {
301	516	$table->addOption('collation', $tableOptions['TABLE_COLLATION']);
302		}
303	516	if ($tableOptions['AUTO_INCREMENT'] !== null) {
304	68	$table->addOption('autoincrement', $tableOptions['AUTO_INCREMENT']);
305		}
306	516	$table->addOption('comment', $tableOptions['TABLE_COMMENT']);
307	516	$table->addOption('create_options', $this->parseCreateOptions($tableOptions['CREATE_OPTIONS']));
308
309	516	return $table;
310		}
311
312		/**
313		* @return string[]\|true[]
314		*/
315	516	private function parseCreateOptions(string $string) : array
316		{
317	516	$options = [];
318
319	516	if ($string === '') {
320	502	return $options;
321		}
322
323	42	foreach (explode(' ', $string) as $pair) {
324	42	$parts = explode('=', $pair, 2);
325
326	42	$options[$parts[0]] = $parts[1] ?? true;
327		}
328
329	42	return $options;
330		}
331		}
332

doctrine / dbal

Push — master ( af38e2...b8729e )

MySqlSchemaManager::parseCreateOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like