SQLServerSchemaManager::_getPortableTableDefinition() - Code Metrics - Inspection of "Enforce parameter and return value types in the co..." - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — develop (#3348)

by Sergei

created 2019-05-24 22:29 UTC

_getPortableTableDefinition() A

↳ Parent: SQLServerSchemaManager

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Doctrine\DBAL\Schema;

use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Driver\DriverException;
use Doctrine\DBAL\Types\Type;
use PDOException;
use Throwable;
use function assert;
use function count;
use function in_array;
use function is_string;
use function preg_match;
use function sprintf;
use function str_replace;
use function strpos;
use function strtok;

/**
 * SQL Server Schema Manager.
 */
class SQLServerSchemaManager extends AbstractSchemaManager
{
    /**
     * {@inheritdoc}
     */
    public function dropDatabase(string $database) : void
    {
        try {
            parent::dropDatabase($database);
        } catch (DBALException $exception) {
            $exception = $exception->getPrevious();
            assert($exception instanceof Throwable);

            if (! $exception instanceof DriverException) {
                throw $exception;
            }

            // If we have a error code 3702, the drop database operation failed
            // because of active connections on the database.
            // To force dropping the database, we first have to close all active connections
            // on that database and issue the drop database operation again.
            if ($exception->getCode() !== 3702) {
                throw $exception;
            }

            $this->closeActiveDatabaseConnections($database);

            parent::dropDatabase($database);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableSequenceDefinition(array $sequence) : Sequence
    {
        return new Sequence($sequence['name'], (int) $sequence['increment'], (int) $sequence['start_value']);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableColumnDefinition(array $tableColumn) : Column
    {
        $dbType = strtok($tableColumn['type'], '(), ');
        assert(is_string($dbType));

        $length = (int) $tableColumn['length'];

        $precision = $default = null;

        $scale = 0;
        $fixed = false;

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

        if ($tableColumn['scale'] !== null) {
            $scale = (int) $tableColumn['scale'];
        }

        if ($tableColumn['precision'] !== null) {
            $precision = (int) $tableColumn['precision'];
        }

        if ($tableColumn['default'] !== null) {
            $default = $this->parseDefaultExpression($tableColumn['default']);
        }

        switch ($dbType) {
            case 'nchar':
            case 'nvarchar':
            case 'ntext':
                // Unicode data requires 2 bytes per character
                $length /= 2;
                break;
            case 'varchar':
                // TEXT type is returned as VARCHAR(MAX) with a length of -1
                if ($length === -1) {
                    $dbType = 'text';
                }
                break;
        }

        if ($dbType === 'char' || $dbType === 'nchar' || $dbType === 'binary') {
            $fixed = true;
        }

        $type = $this->extractDoctrineTypeFromComment($tableColumn['comment'])
            ?? $this->_platform->getDoctrineTypeMapping($dbType);

        $options = [
            'length'        => $length === 0 || ! in_array($type, ['text', 'string']) ? null : $length,
            'fixed'         => $fixed,
            'default'       => $default,
            'notnull'       => (bool) $tableColumn['notnull'],
            'scale'         => $scale,
            'precision'     => $precision,
            'autoincrement' => (bool) $tableColumn['autoincrement'],
            'comment'       => $tableColumn['comment'] !== '' ? $tableColumn['comment'] : null,
        ];

        if ($fixed !== null) {

            $options['fixed'] = $fixed;
        }

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

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

        return $column;
    }

    private function parseDefaultExpression(string $value) : ?string
    {
        while (preg_match('/^\((.*)\)$/s', $value, $matches)) {
            $value = $matches[1];
        }

        if ($value === 'NULL') {
            return null;
        }

        if (preg_match('/^\'(.*)\'$/s', $value, $matches)) {
            $value = str_replace("''", "'", $matches[1]);
        }

        if ($value === 'getdate()') {
            return $this->_platform->getCurrentTimestampSQL();
        }

        return $value;
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeysList(array $tableForeignKeys) : array
    {
        $foreignKeys = [];

        foreach ($tableForeignKeys as $tableForeignKey) {
            if (! isset($foreignKeys[$tableForeignKey['ForeignKey']])) {
                $foreignKeys[$tableForeignKey['ForeignKey']] = [
                    'local_columns' => [$tableForeignKey['ColumnName']],
                    'foreign_table' => $tableForeignKey['ReferenceTableName'],
                    'foreign_columns' => [$tableForeignKey['ReferenceColumnName']],
                    'name' => $tableForeignKey['ForeignKey'],
                    'options' => [
                        'onUpdate' => str_replace('_', ' ', $tableForeignKey['update_referential_action_desc']),
                        'onDelete' => str_replace('_', ' ', $tableForeignKey['delete_referential_action_desc']),
                    ],
                ];
            } else {
                $foreignKeys[$tableForeignKey['ForeignKey']]['local_columns'][]   = $tableForeignKey['ColumnName'];
                $foreignKeys[$tableForeignKey['ForeignKey']]['foreign_columns'][] = $tableForeignKey['ReferenceColumnName'];
            }
        }

        return parent::_getPortableTableForeignKeysList($foreignKeys);
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableIndexesList(array $tableIndexRows, string $tableName) : array
    {
        foreach ($tableIndexRows as &$tableIndex) {
            $tableIndex['non_unique'] = (bool) $tableIndex['non_unique'];
            $tableIndex['primary']    = (bool) $tableIndex['primary'];
            $tableIndex['flags']      = $tableIndex['flags'] ? [$tableIndex['flags']] : null;
        }

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

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeyDefinition($tableForeignKey) : ForeignKeyConstraint
    {
        return new ForeignKeyConstraint(
            $tableForeignKey['local_columns'],
            $tableForeignKey['foreign_table'],
            $tableForeignKey['foreign_columns'],
            $tableForeignKey['name'],
            $tableForeignKey['options']
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableDefinition($table) : string
    {
        if (isset($table['schema_name']) && $table['schema_name'] !== 'dbo') {
            return $table['schema_name'] . '.' . $table['name'];
        }

        return $table['name'];
    }

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

    /**
     * {@inheritdoc}
     */
    protected function getPortableNamespaceDefinition(array $namespace)
    {
        return $namespace['name'];
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableViewDefinition(array $view) : View
    {
        // @todo
        return new View($view['name'], '');
    }

    /**
     * {@inheritdoc}
     */
    public function listTableIndexes(string $table) : array
    {
        $sql = $this->_platform->getListTableIndexesSQL($table, $this->_conn->getDatabase());

        try {
            $tableIndexes = $this->_conn->fetchAll($sql);
        } catch (PDOException $e) {
            if ($e->getCode() === 'IMSSP') {
                return [];
            }

            throw $e;
        } catch (DBALException $e) {
            if (strpos($e->getMessage(), 'SQLSTATE [01000, 15472]') === 0) {
                return [];
            }

            throw $e;
        }

        return $this->_getPortableTableIndexesList($tableIndexes, $table);
    }

    /**
     * {@inheritdoc}
     */
    public function alterTable(TableDiff $tableDiff) : void
    {
        if (count($tableDiff->removedColumns) > 0) {
            foreach ($tableDiff->removedColumns as $col) {
                $columnConstraintSql = $this->getColumnConstraintSQL($tableDiff->name, $col->getName());
                foreach ($this->_conn->fetchAll($columnConstraintSql) as $constraint) {
                    $this->_conn->exec(
                        sprintf(
                            'ALTER TABLE %s DROP CONSTRAINT %s',
                            $tableDiff->name,
                            $constraint['Name']
                        )
                    );
                }
            }
        }

        parent::alterTable($tableDiff);
    }

    /**
     * Returns the SQL to retrieve the constraints for a given column.
     */
    private function getColumnConstraintSQL(string $table, string $column) : string
    {
        return "SELECT SysObjects.[Name]
            FROM SysObjects INNER JOIN (SELECT [Name],[ID] FROM SysObjects WHERE XType = 'U') AS Tab
            ON Tab.[ID] = Sysobjects.[Parent_Obj]
            INNER JOIN sys.default_constraints DefCons ON DefCons.[object_id] = Sysobjects.[ID]
            INNER JOIN SysColumns Col ON Col.[ColID] = DefCons.[parent_column_id] AND Col.[ID] = Tab.[ID]
            WHERE Col.[Name] = " . $this->_conn->quote($column) . ' AND Tab.[Name] = ' . $this->_conn->quote($table) . '
            ORDER BY Col.[Name]';
    }

    /**
     * Closes currently active connections on the given database.
     *
     * This is useful to force DROP DATABASE operations which could fail because of active connections.
     *
     * @param string $database The name of the database to close currently active connections for.
     */
    private function closeActiveDatabaseConnections(string $database) : void
    {
        $database = new Identifier($database);

        $this->_execSql(
            sprintf(
                'ALTER DATABASE %s SET SINGLE_USER WITH ROLLBACK IMMEDIATE',
                $database->getQuotedName($this->_platform)
            )
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\DBAL\Schema;
6
7		use Doctrine\DBAL\DBALException;
8		use Doctrine\DBAL\Driver\DriverException;
9		use Doctrine\DBAL\Types\Type;
10		use PDOException;
11		use Throwable;
12		use function assert;
13		use function count;
14		use function in_array;
15		use function is_string;
16		use function preg_match;
17		use function sprintf;
18		use function str_replace;
19		use function strpos;
20		use function strtok;
21
22		/**
23		* SQL Server Schema Manager.
24		*/
25		class SQLServerSchemaManager extends AbstractSchemaManager
26		{
27		/**
28		* {@inheritdoc}
29		*/
30		public function dropDatabase(string $database) : void
31		{
32		try {
33		parent::dropDatabase($database);
34		} catch (DBALException $exception) {
35		$exception = $exception->getPrevious();
36		assert($exception instanceof Throwable);
37
38		if (! $exception instanceof DriverException) {
39		throw $exception;
40		}
41
42		// If we have a error code 3702, the drop database operation failed
43		// because of active connections on the database.
44		// To force dropping the database, we first have to close all active connections
45		// on that database and issue the drop database operation again.
46		if ($exception->getCode() !== 3702) {
47		throw $exception;
48		}
49
50		$this->closeActiveDatabaseConnections($database);
51
52		parent::dropDatabase($database);
53		}
54		}
55
56		/**
57		* {@inheritdoc}
58		*/
59		protected function _getPortableSequenceDefinition(array $sequence) : Sequence
60		{
61		return new Sequence($sequence['name'], (int) $sequence['increment'], (int) $sequence['start_value']);
62		}
63
64		/**
65		* {@inheritdoc}
66		*/
67		protected function _getPortableTableColumnDefinition(array $tableColumn) : Column
68	27	{
69		$dbType = strtok($tableColumn['type'], '(), ');
70	27	assert(is_string($dbType));
71	27
72		$length = (int) $tableColumn['length'];
73	27
74		$precision = $default = null;
75	27
76		$scale = 0;
77	27	$fixed = false;
78	27
79		if (! isset($tableColumn['name'])) {
80	27	$tableColumn['name'] = '';
81	27	}
82
83		if ($tableColumn['scale'] !== null) {
84	27	$scale = (int) $tableColumn['scale'];
85	27	}
86
87		if ($tableColumn['precision'] !== null) {
88	27	$precision = (int) $tableColumn['precision'];
89	27	}
90
91		if ($tableColumn['default'] !== null) {
92	27	$default = $this->parseDefaultExpression($tableColumn['default']);
93		}
94
95		switch ($dbType) {
96	27	case 'nchar':
97	2	case 'nvarchar':
98	2	case 'ntext':
99	2	// Unicode data requires 2 bytes per character
100		$length /= 2;
101		break;
102		case 'varchar':
103	2	// TEXT type is returned as VARCHAR(MAX) with a length of -1
104		if ($length === -1) {
105		$dbType = 'text';
106		}
107		break;
108		}
109
110		if ($dbType === 'char' \|\| $dbType === 'nchar' \|\| $dbType === 'binary') {
111	27	$fixed = true;
112		}
113
114		$type = $this->extractDoctrineTypeFromComment($tableColumn['comment'])
115	27	?? $this->_platform->getDoctrineTypeMapping($dbType);
116	27
117		$options = [
118		'length' => $length === 0 \|\| ! in_array($type, ['text', 'string']) ? null : $length,
119	27	'fixed' => $fixed,
120	27	'default' => $default,
121	27	'notnull' => (bool) $tableColumn['notnull'],
122	27	'scale' => $scale,
123	27	'precision' => $precision,
124	27	'autoincrement' => (bool) $tableColumn['autoincrement'],
125	27	'comment' => $tableColumn['comment'] !== '' ? $tableColumn['comment'] : null,
126	27	];
127
128		if ($fixed !== null) {
		0 ignored issues – show introduced 2019-04-19 00:33 UTC by Report Bug Copy Issue Report The condition `$fixed !== null` is always `true`. Loading history...
129	27	$options['fixed'] = $fixed;
130		}
131	27
132	27	$column = new Column($tableColumn['name'], Type::getType($type), $options);
133
134		if (isset($tableColumn['collation']) && $tableColumn['collation'] !== 'NULL') {
135	27	$column->setPlatformOption('collation', $tableColumn['collation']);
136		}
137
138		return $column;
139		}
140
141		private function parseDefaultExpression(string $value) : ?string
142		{
143		while (preg_match('/^\((.*)\)$/s', $value, $matches)) {
144		$value = $matches[1];
145		}
146
147		if ($value === 'NULL') {
148		return null;
149		}
150
151		if (preg_match('/^\'(.*)\'$/s', $value, $matches)) {
152		$value = str_replace("''", "'", $matches[1]);
153		}
154
155		if ($value === 'getdate()') {
156		return $this->_platform->getCurrentTimestampSQL();
157		}
158
159		return $value;
160		}
161
162		/**
163		* {@inheritdoc}
164		*/
165		protected function _getPortableTableForeignKeysList(array $tableForeignKeys) : array
166		{
167		$foreignKeys = [];
168
169		foreach ($tableForeignKeys as $tableForeignKey) {
170		if (! isset($foreignKeys[$tableForeignKey['ForeignKey']])) {
171		$foreignKeys[$tableForeignKey['ForeignKey']] = [
172		'local_columns' => [$tableForeignKey['ColumnName']],
173		'foreign_table' => $tableForeignKey['ReferenceTableName'],
174		'foreign_columns' => [$tableForeignKey['ReferenceColumnName']],
175		'name' => $tableForeignKey['ForeignKey'],
176		'options' => [
177		'onUpdate' => str_replace('_', ' ', $tableForeignKey['update_referential_action_desc']),
178		'onDelete' => str_replace('_', ' ', $tableForeignKey['delete_referential_action_desc']),
179		],
180		];
181		} else {
182		$foreignKeys[$tableForeignKey['ForeignKey']]['local_columns'][] = $tableForeignKey['ColumnName'];
183		$foreignKeys[$tableForeignKey['ForeignKey']]['foreign_columns'][] = $tableForeignKey['ReferenceColumnName'];
184		}
185		}
186
187		return parent::_getPortableTableForeignKeysList($foreignKeys);
188		}
189
190		/**
191		* {@inheritdoc}
192		*/
193		protected function _getPortableTableIndexesList(array $tableIndexRows, string $tableName) : array
194		{
195		foreach ($tableIndexRows as &$tableIndex) {
196		$tableIndex['non_unique'] = (bool) $tableIndex['non_unique'];
197		$tableIndex['primary'] = (bool) $tableIndex['primary'];
198		$tableIndex['flags'] = $tableIndex['flags'] ? [$tableIndex['flags']] : null;
199		}
200
201		return parent::_getPortableTableIndexesList($tableIndexRows, $tableName);
202		}
203
204		/**
205		* {@inheritdoc}
206		*/
207		protected function _getPortableTableForeignKeyDefinition($tableForeignKey) : ForeignKeyConstraint
208		{
209		return new ForeignKeyConstraint(
210		$tableForeignKey['local_columns'],
211		$tableForeignKey['foreign_table'],
212		$tableForeignKey['foreign_columns'],
213		$tableForeignKey['name'],
214		$tableForeignKey['options']
215		);
216		}
217
218		/**
219		* {@inheritdoc}
220		*/
221		protected function _getPortableTableDefinition($table) : string
222		{
223		if (isset($table['schema_name']) && $table['schema_name'] !== 'dbo') {
224		return $table['schema_name'] . '.' . $table['name'];
225		}
226
227		return $table['name'];
228		}
229
230		/**
231		* {@inheritdoc}
232		*/
233		protected function _getPortableDatabaseDefinition($database)
234		{
235		return $database['name'];
236		}
237
238		/**
239		* {@inheritdoc}
240		*/
241		protected function getPortableNamespaceDefinition(array $namespace)
242		{
243		return $namespace['name'];
244		}
245
246		/**
247		* {@inheritdoc}
248		*/
249		protected function _getPortableViewDefinition(array $view) : View
250		{
251		// @todo
252		return new View($view['name'], '');
253		}
254
255		/**
256		* {@inheritdoc}
257		*/
258		public function listTableIndexes(string $table) : array
259		{
260		$sql = $this->_platform->getListTableIndexesSQL($table, $this->_conn->getDatabase());
261
262		try {
263		$tableIndexes = $this->_conn->fetchAll($sql);
264		} catch (PDOException $e) {
265		if ($e->getCode() === 'IMSSP') {
266		return [];
267		}
268
269		throw $e;
270		} catch (DBALException $e) {
271		if (strpos($e->getMessage(), 'SQLSTATE [01000, 15472]') === 0) {
272		return [];
273		}
274
275		throw $e;
276		}
277
278		return $this->_getPortableTableIndexesList($tableIndexes, $table);
279		}
280
281		/**
282		* {@inheritdoc}
283		*/
284		public function alterTable(TableDiff $tableDiff) : void
285		{
286		if (count($tableDiff->removedColumns) > 0) {
287		foreach ($tableDiff->removedColumns as $col) {
288		$columnConstraintSql = $this->getColumnConstraintSQL($tableDiff->name, $col->getName());
289		foreach ($this->_conn->fetchAll($columnConstraintSql) as $constraint) {
290		$this->_conn->exec(
291		sprintf(
292		'ALTER TABLE %s DROP CONSTRAINT %s',
293		$tableDiff->name,
294		$constraint['Name']
295		)
296		);
297		}
298		}
299		}
300
301		parent::alterTable($tableDiff);
302		}
303
304		/**
305		* Returns the SQL to retrieve the constraints for a given column.
306		*/
307		private function getColumnConstraintSQL(string $table, string $column) : string
308		{
309		return "SELECT SysObjects.[Name]
310		FROM SysObjects INNER JOIN (SELECT [Name],[ID] FROM SysObjects WHERE XType = 'U') AS Tab
311		ON Tab.[ID] = Sysobjects.[Parent_Obj]
312		INNER JOIN sys.default_constraints DefCons ON DefCons.[object_id] = Sysobjects.[ID]
313		INNER JOIN SysColumns Col ON Col.[ColID] = DefCons.[parent_column_id] AND Col.[ID] = Tab.[ID]
314		WHERE Col.[Name] = " . $this->_conn->quote($column) . ' AND Tab.[Name] = ' . $this->_conn->quote($table) . '
315		ORDER BY Col.[Name]';
316		}
317
318		/**
319		* Closes currently active connections on the given database.
320		*
321		* This is useful to force DROP DATABASE operations which could fail because of active connections.
322		*
323		* @param string $database The name of the database to close currently active connections for.
324		*/
325		private function closeActiveDatabaseConnections(string $database) : void
326		{
327		$database = new Identifier($database);
328
329		$this->_execSql(
330		sprintf(
331		'ALTER DATABASE %s SET SINGLE_USER WITH ROLLBACK IMMEDIATE',
332		$database->getQuotedName($this->_platform)
333		)
334		);
335		}
336		}
337

doctrine / dbal

Pull Request — develop (#3348)

_getPortableTableDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like