OracleMigrator::quoteForeignKeyConstraint() - Code Metrics - Inspection of "Add foreign key support to OC" - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#29151)

by Piotr

created 2017-10-05 15:25 UTC

OracleMigrator::quoteForeignKeyConstraint() A

↳ Parent: OracleMigrator

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	11
nc	1
nop	1
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Thomas Müller <[email protected]>
 *
 * @copyright Copyright (c) 2017, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\DB;

use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\ColumnDiff;
use Doctrine\DBAL\Schema\Index;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Schema\ForeignKeyConstraint;

class OracleMigrator extends NoCheckMigrator {

	/**
	 * Quote a column's name but changing the name requires recreating
	 * the column instance and copying over all properties.
	 *
	 * @param Column $column old column
	 * @return Column new column instance with new name
	 */
	protected function quoteColumn($column) {
		$newColumn = new Column(
			$this->connection->quoteIdentifier($column->getName()),
			$column->getType()
		);
		$newColumn->setAutoincrement($column->getAutoincrement());
		$newColumn->setColumnDefinition($column->getColumnDefinition());
		$newColumn->setComment($column->getComment());
		$newColumn->setDefault($column->getDefault());
		$newColumn->setFixed($column->getFixed());
		$newColumn->setLength($column->getLength());
		$newColumn->setNotnull($column->getNotnull());
		$newColumn->setPrecision($column->getPrecision());
		$newColumn->setScale($column->getScale());
		$newColumn->setUnsigned($column->getUnsigned());
		$newColumn->setPlatformOptions($column->getPlatformOptions());
		$newColumn->setCustomSchemaOptions($column->getPlatformOptions());
		return $newColumn;
	}

	/**
	 * Quote an index's name but changing the name requires recreating
	 * the index instance and copying over all properties.
	 *
	 * @param Index $index old index
	 * @return Index new index instance with new name
	 */
	protected function quoteIndex($index) {
		return new Index(
		//TODO migrate existing uppercase indexes, then $this->connection->quoteIdentifier($index->getName()),
			$index->getName(),
			array_map(function($columnName) {
				return $this->connection->quoteIdentifier($columnName);
			}, $index->getColumns()),
			$index->isUnique(),
			$index->isPrimary(),
			$index->getFlags(),
			$index->getOptions()
		);
	}

	/**
	 * Quote an ForeignKeyConstraint's name but changing the name requires recreating
	 * the ForeignKeyConstraint instance and copying over all properties.
	 *
	 * @param ForeignKeyConstraint $fkc old fkc
	 * @return ForeignKeyConstraint new fkc instance with new name
	 */
	protected function quoteForeignKeyConstraint($fkc) {
		return new ForeignKeyConstraint(
			array_map(function($columnName) {
				return $this->connection->quoteIdentifier($columnName);
			}, $fkc->getLocalColumns()),
			$this->connection->quoteIdentifier($fkc->getForeignTableName()),
			array_map(function($columnName) {
				return $this->connection->quoteIdentifier($columnName);
			}, $fkc->getForeignColumns()),
			$fkc->getName(),
			$fkc->getOptions()
		);
	}

	/**
	 * @param Schema $targetSchema
	 * @param \Doctrine\DBAL\Connection $connection
	 * @return \Doctrine\DBAL\Schema\SchemaDiff
	 */
	protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
		$schemaDiff = parent::getDiff($targetSchema, $connection);

		// oracle forces us to quote the identifiers
		$schemaDiff->newTables = array_map(function(Table $table) {
			return new Table(
				$this->connection->quoteIdentifier($table->getName()),
				array_map(function(Column $column) {
					return $this->quoteColumn($column);
				}, $table->getColumns()),
				array_map(function(Index $index) {
					return $this->quoteIndex($index);
				}, $table->getIndexes()),
				array_map(function(ForeignKeyConstraint $fck) {
					return $this->quoteForeignKeyConstraint($fck);
				}, $table->getForeignKeys()),
				0,
				$table->getOptions()
			);
		}, $schemaDiff->newTables);

		$schemaDiff->removedTables = array_map(function(Table $table) {
			return new Table(
				$this->connection->quoteIdentifier($table->getName()),
				$table->getColumns(),
				$table->getIndexes(),
				$table->getForeignKeys(),
				0,
				$table->getOptions()
			);
		}, $schemaDiff->removedTables);

		foreach ($schemaDiff->changedTables as $tableDiff) {
			$tableDiff->name = $this->connection->quoteIdentifier($tableDiff->name);

			$tableDiff->addedColumns = array_map(function(Column $column) {
				return $this->quoteColumn($column);
			}, $tableDiff->addedColumns);

			foreach ($tableDiff->changedColumns as $column) {
				$column->oldColumnName = $this->connection->quoteIdentifier($column->oldColumnName);
				// auto increment is not relevant for oracle and can anyhow not be applied on change
				$column->changedProperties = array_diff($column->changedProperties, ['autoincrement', 'unsigned']);
			}
			// remove columns that no longer have changed (because autoincrement and unsigned are not supported)
			$tableDiff->changedColumns = array_filter($tableDiff->changedColumns, function (ColumnDiff $column) {
				return count($column->changedProperties) > 0;
			});

			$tableDiff->removedColumns = array_map(function(Column $column) {
				return $this->quoteColumn($column);
			}, $tableDiff->removedColumns);

			$tableDiff->renamedColumns = array_map(function(Column $column) {
				return $this->quoteColumn($column);
			}, $tableDiff->renamedColumns);

			$tableDiff->addedIndexes = array_map(function(Index $index) {
				return $this->quoteIndex($index);
			}, $tableDiff->addedIndexes);

			$tableDiff->changedIndexes = array_map(function(Index $index) {
				return $this->quoteIndex($index);
			}, $tableDiff->changedIndexes);

			$tableDiff->removedIndexes = array_map(function(Index $index) {
				return $this->quoteIndex($index);
			}, $tableDiff->removedIndexes);

			$tableDiff->renamedIndexes = array_map(function(Index $index) {
				return $this->quoteIndex($index);
			}, $tableDiff->renamedIndexes);

			$tableDiff->addedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
				return $this->quoteForeignKeyConstraint($fkc);
			}, $tableDiff->addedForeignKeys);

			$tableDiff->changedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
				return $this->quoteForeignKeyConstraint($fkc);
			}, $tableDiff->changedForeignKeys);

			$tableDiff->removedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
				return $this->quoteForeignKeyConstraint($fkc);
			}, $tableDiff->removedForeignKeys);
		}

		return $schemaDiff;
	}

	/**
	 * @param string $name
	 * @return string
	 */
	protected function generateTemporaryTableName($name) {
		return 'oc_' . uniqid();
	}

	/**
	 * @param $statement
	 * @return string
	 */
	protected function convertStatementToScript($statement) {
		if (substr($statement, -1) === ';') {
			return $statement . PHP_EOL . '/' . PHP_EOL;
		}
		$script = $statement . ';';
		$script .= PHP_EOL;
		$script .= PHP_EOL;
		return $script;
	}

	protected function getFilterExpression() {
		return '/^"' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
	}

}


1			<?php
2			/**
3			* @author Morris Jobke <[email protected]>
4			* @author Robin Appelman <[email protected]>
5			* @author Thomas Müller <[email protected]>
6			*
7			* @copyright Copyright (c) 2017, ownCloud GmbH
8			* @license AGPL-3.0
9			*
10			* This code is free software: you can redistribute it and/or modify
11			* it under the terms of the GNU Affero General Public License, version 3,
12			* as published by the Free Software Foundation.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License, version 3,
20			* along with this program. If not, see <http://www.gnu.org/licenses/>
21			*
22			*/
23
24			namespace OC\DB;
25
26			use Doctrine\DBAL\Schema\Column;
27			use Doctrine\DBAL\Schema\ColumnDiff;
28			use Doctrine\DBAL\Schema\Index;
29			use Doctrine\DBAL\Schema\Schema;
30			use Doctrine\DBAL\Schema\Table;
31			use Doctrine\DBAL\Schema\ForeignKeyConstraint;
32
33			class OracleMigrator extends NoCheckMigrator {
34
35			/**
36			* Quote a column's name but changing the name requires recreating
37			* the column instance and copying over all properties.
38			*
39			* @param Column $column old column
40			* @return Column new column instance with new name
41			*/
42			protected function quoteColumn($column) {
43			$newColumn = new Column(
44			$this->connection->quoteIdentifier($column->getName()),
45			$column->getType()
46			);
47			$newColumn->setAutoincrement($column->getAutoincrement());
48			$newColumn->setColumnDefinition($column->getColumnDefinition());
49			$newColumn->setComment($column->getComment());
50			$newColumn->setDefault($column->getDefault());
51			$newColumn->setFixed($column->getFixed());
52			$newColumn->setLength($column->getLength());
53			$newColumn->setNotnull($column->getNotnull());
54			$newColumn->setPrecision($column->getPrecision());
55			$newColumn->setScale($column->getScale());
56			$newColumn->setUnsigned($column->getUnsigned());
57			$newColumn->setPlatformOptions($column->getPlatformOptions());
58			$newColumn->setCustomSchemaOptions($column->getPlatformOptions());
59			return $newColumn;
60			}
61
62			/**
63			* Quote an index's name but changing the name requires recreating
64			* the index instance and copying over all properties.
65			*
66			* @param Index $index old index
67			* @return Index new index instance with new name
68			*/
69			protected function quoteIndex($index) {
70			return new Index(
71			//TODO migrate existing uppercase indexes, then $this->connection->quoteIdentifier($index->getName()),
72			$index->getName(),
73			array_map(function($columnName) {
74			return $this->connection->quoteIdentifier($columnName);
75			}, $index->getColumns()),
76			$index->isUnique(),
77			$index->isPrimary(),
78			$index->getFlags(),
79			$index->getOptions()
80			);
81			}
82
83			/**
84			* Quote an ForeignKeyConstraint's name but changing the name requires recreating
85			* the ForeignKeyConstraint instance and copying over all properties.
86			*
87			* @param ForeignKeyConstraint $fkc old fkc
88			* @return ForeignKeyConstraint new fkc instance with new name
89			*/
90			protected function quoteForeignKeyConstraint($fkc) {
91			return new ForeignKeyConstraint(
92			array_map(function($columnName) {
93			return $this->connection->quoteIdentifier($columnName);
94			}, $fkc->getLocalColumns()),
95			$this->connection->quoteIdentifier($fkc->getForeignTableName()),
96			array_map(function($columnName) {
97			return $this->connection->quoteIdentifier($columnName);
98			}, $fkc->getForeignColumns()),
99			$fkc->getName(),
100			$fkc->getOptions()
101			);
102			}
103
104			/**
105			* @param Schema $targetSchema
106			* @param \Doctrine\DBAL\Connection $connection
107			* @return \Doctrine\DBAL\Schema\SchemaDiff
108			*/
109			protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $connection) {
110			$schemaDiff = parent::getDiff($targetSchema, $connection);
111
112			// oracle forces us to quote the identifiers
113			$schemaDiff->newTables = array_map(function(Table $table) {
114			return new Table(
115			$this->connection->quoteIdentifier($table->getName()),
116			array_map(function(Column $column) {
117			return $this->quoteColumn($column);
118			}, $table->getColumns()),
119			array_map(function(Index $index) {
120			return $this->quoteIndex($index);
121			}, $table->getIndexes()),
122			array_map(function(ForeignKeyConstraint $fck) {
123			return $this->quoteForeignKeyConstraint($fck);
124			}, $table->getForeignKeys()),
125			0,
126			$table->getOptions()
127			);
128			}, $schemaDiff->newTables);
129
130			$schemaDiff->removedTables = array_map(function(Table $table) {
131			return new Table(
132			$this->connection->quoteIdentifier($table->getName()),
133			$table->getColumns(),
134			$table->getIndexes(),
135			$table->getForeignKeys(),
136			0,
137			$table->getOptions()
138			);
139			}, $schemaDiff->removedTables);
140
141			foreach ($schemaDiff->changedTables as $tableDiff) {
142			$tableDiff->name = $this->connection->quoteIdentifier($tableDiff->name);
143
144			$tableDiff->addedColumns = array_map(function(Column $column) {
145			return $this->quoteColumn($column);
146			}, $tableDiff->addedColumns);
147
148			foreach ($tableDiff->changedColumns as $column) {
149			$column->oldColumnName = $this->connection->quoteIdentifier($column->oldColumnName);
150			// auto increment is not relevant for oracle and can anyhow not be applied on change
151			$column->changedProperties = array_diff($column->changedProperties, ['autoincrement', 'unsigned']);
152			}
153			// remove columns that no longer have changed (because autoincrement and unsigned are not supported)
154			$tableDiff->changedColumns = array_filter($tableDiff->changedColumns, function (ColumnDiff $column) {
155			return count($column->changedProperties) > 0;
156			});
157
158			$tableDiff->removedColumns = array_map(function(Column $column) {
159			return $this->quoteColumn($column);
160			}, $tableDiff->removedColumns);
161
162			$tableDiff->renamedColumns = array_map(function(Column $column) {
163			return $this->quoteColumn($column);
164			}, $tableDiff->renamedColumns);
165
166			$tableDiff->addedIndexes = array_map(function(Index $index) {
167			return $this->quoteIndex($index);
168			}, $tableDiff->addedIndexes);
169
170			$tableDiff->changedIndexes = array_map(function(Index $index) {
171			return $this->quoteIndex($index);
172			}, $tableDiff->changedIndexes);
173
174			$tableDiff->removedIndexes = array_map(function(Index $index) {
175			return $this->quoteIndex($index);
176			}, $tableDiff->removedIndexes);
177
178			$tableDiff->renamedIndexes = array_map(function(Index $index) {
179			return $this->quoteIndex($index);
180			}, $tableDiff->renamedIndexes);
181
182			$tableDiff->addedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
183			return $this->quoteForeignKeyConstraint($fkc);
184			}, $tableDiff->addedForeignKeys);
185
186			$tableDiff->changedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
187			return $this->quoteForeignKeyConstraint($fkc);
188			}, $tableDiff->changedForeignKeys);
189
190			$tableDiff->removedForeignKeys = array_map(function(ForeignKeyConstraint $fkc) {
191			return $this->quoteForeignKeyConstraint($fkc);
192			}, $tableDiff->removedForeignKeys);
193			}
194
195			return $schemaDiff;
196			}
197
198			/**
199			* @param string $name
200			* @return string
201			*/
202			protected function generateTemporaryTableName($name) {
203			return 'oc_' . uniqid();
204			}
205
206			/**
207			* @param $statement
208			* @return string
209			*/
210			protected function convertStatementToScript($statement) {
211			if (substr($statement, -1) === ';') {
212			return $statement . PHP_EOL . '/' . PHP_EOL;
213			}
214			$script = $statement . ';';
215			$script .= PHP_EOL;
216			$script .= PHP_EOL;
217			return $script;
218			}
219
220			protected function getFilterExpression() {
221			return '/^"' . preg_quote($this->config->getSystemValue('dbtableprefix', 'oc_')) . '/';
222			}
223
224			}
225

owncloud / core

Pull Request — master (#29151)

OracleMigrator::quoteForeignKeyConstraint() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like