SQLServerSchemaManager::_getPortableTableDefinition() - Code Metrics - Inspection of "Use Ubuntu 16.04" - doctrine/dbal - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#3429)

by Gabriel

created 2019-02-14 07:30 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	5
cp	0
rs	10
c	0
b	0
f	0
cc	3
nc	2
nop	1
crap	12

<?php

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;
use function trim;

/**
 * SQL Server Schema Manager.
 */
class SQLServerSchemaManager extends AbstractSchemaManager
{
    /**
     * {@inheritdoc}
     */
    public function dropDatabase($database)
    {
        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->getErrorCode() !== 3702) {
                throw $exception;
            }

            $this->closeActiveDatabaseConnections($database);

            parent::dropDatabase($database);
        }
    }

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

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

        $fixed   = null;
        $length  = (int) $tableColumn['length'];
        $default = $tableColumn['default'];

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

        if ($default !== null) {
            $default = $this->parseDefaultExpression($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->_platform->getDoctrineTypeMapping($dbType);
        $type                   = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type);
        $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type);

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

        $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('/^\((.*)\)$/', $value, $matches)) {
            $value = trim($matches[1], "'");
        }

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

        return $value;
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableForeignKeysList($tableForeignKeys)
    {
        $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($tableIndexRows, $tableName = null)
    {
        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)
    {
        return new ForeignKeyConstraint(
            $tableForeignKey['local_columns'],
            $tableForeignKey['foreign_table'],
            $tableForeignKey['foreign_columns'],
            $tableForeignKey['name'],
            $tableForeignKey['options']
        );
    }

    /**
     * {@inheritdoc}
     */
    protected function _getPortableTableDefinition($table)
    {
        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($view)
    {
        // @todo
        return new View($view['name'], '');
    }

    /**
     * {@inheritdoc}
     */
    public function listTableIndexes($table)
    {
        $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)
    {
        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.
     *
     * @param string $table
     * @param string $column
     *
     * @return string
     */
    private function getColumnConstraintSQL($table, $column)
    {
        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.
     *
     * @return void
     */
    private function closeActiveDatabaseConnections($database)
    {
        $database = new Identifier($database);

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


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

doctrine / dbal

Pull Request — master (#3429)

_getPortableTableDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like