123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446 |
- <?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;
- /**
- * Compares two Schemas and return an instance of SchemaDiff.
- *
- * @link www.doctrine-project.org
- * @since 2.0
- * @author Benjamin Eberlei <kontakt@beberlei.de>
- */
- class Comparator
- {
- /**
- * @param \Doctrine\DBAL\Schema\Schema $fromSchema
- * @param \Doctrine\DBAL\Schema\Schema $toSchema
- *
- * @return \Doctrine\DBAL\Schema\SchemaDiff
- */
- static public function compareSchemas(Schema $fromSchema, Schema $toSchema)
- {
- $c = new self();
- return $c->compare($fromSchema, $toSchema);
- }
- /**
- * Returns a SchemaDiff object containing the differences between the schemas $fromSchema and $toSchema.
- *
- * The returned differences are returned in such a way that they contain the
- * operations to change the schema stored in $fromSchema to the schema that is
- * stored in $toSchema.
- *
- * @param \Doctrine\DBAL\Schema\Schema $fromSchema
- * @param \Doctrine\DBAL\Schema\Schema $toSchema
- *
- * @return \Doctrine\DBAL\Schema\SchemaDiff
- */
- public function compare(Schema $fromSchema, Schema $toSchema)
- {
- $diff = new SchemaDiff();
- $diff->fromSchema = $fromSchema;
- $foreignKeysToTable = array();
- foreach ( $toSchema->getTables() as $table ) {
- $tableName = $table->getShortestName($toSchema->getName());
- if ( ! $fromSchema->hasTable($tableName)) {
- $diff->newTables[$tableName] = $toSchema->getTable($tableName);
- } else {
- $tableDifferences = $this->diffTable($fromSchema->getTable($tableName), $toSchema->getTable($tableName));
- if ($tableDifferences !== false) {
- $diff->changedTables[$tableName] = $tableDifferences;
- }
- }
- }
- /* Check if there are tables removed */
- foreach ($fromSchema->getTables() as $table) {
- $tableName = $table->getShortestName($fromSchema->getName());
- $table = $fromSchema->getTable($tableName);
- if ( ! $toSchema->hasTable($tableName) ) {
- $diff->removedTables[$tableName] = $table;
- }
- // also remember all foreign keys that point to a specific table
- foreach ($table->getForeignKeys() as $foreignKey) {
- $foreignTable = strtolower($foreignKey->getForeignTableName());
- if (!isset($foreignKeysToTable[$foreignTable])) {
- $foreignKeysToTable[$foreignTable] = array();
- }
- $foreignKeysToTable[$foreignTable][] = $foreignKey;
- }
- }
- foreach ($diff->removedTables as $tableName => $table) {
- if (isset($foreignKeysToTable[$tableName])) {
- $diff->orphanedForeignKeys = array_merge($diff->orphanedForeignKeys, $foreignKeysToTable[$tableName]);
- // deleting duplicated foreign keys present on both on the orphanedForeignKey
- // and the removedForeignKeys from changedTables
- foreach ($foreignKeysToTable[$tableName] as $foreignKey) {
- // strtolower the table name to make if compatible with getShortestName
- $localTableName = strtolower($foreignKey->getLocalTableName());
- if (isset($diff->changedTables[$localTableName])) {
- foreach ($diff->changedTables[$localTableName]->removedForeignKeys as $key => $removedForeignKey) {
- unset($diff->changedTables[$localTableName]->removedForeignKeys[$key]);
- }
- }
- }
- }
- }
- foreach ($toSchema->getSequences() as $sequence) {
- $sequenceName = $sequence->getShortestName($toSchema->getName());
- if ( ! $fromSchema->hasSequence($sequenceName)) {
- $diff->newSequences[] = $sequence;
- } else {
- if ($this->diffSequence($sequence, $fromSchema->getSequence($sequenceName))) {
- $diff->changedSequences[] = $toSchema->getSequence($sequenceName);
- }
- }
- }
- foreach ($fromSchema->getSequences() as $sequence) {
- if ($this->isAutoIncrementSequenceInSchema($toSchema, $sequence)) {
- continue;
- }
- $sequenceName = $sequence->getShortestName($fromSchema->getName());
- if ( ! $toSchema->hasSequence($sequenceName)) {
- $diff->removedSequences[] = $sequence;
- }
- }
- return $diff;
- }
- /**
- * @param \Doctrine\DBAL\Schema\Schema $schema
- * @param \Doctrine\DBAL\Schema\Sequence $sequence
- *
- * @return boolean
- */
- private function isAutoIncrementSequenceInSchema($schema, $sequence)
- {
- foreach ($schema->getTables() as $table) {
- if ($sequence->isAutoIncrementsFor($table)) {
- return true;
- }
- }
- return false;
- }
- /**
- * @param \Doctrine\DBAL\Schema\Sequence $sequence1
- * @param \Doctrine\DBAL\Schema\Sequence $sequence2
- *
- * @return boolean
- */
- public function diffSequence(Sequence $sequence1, Sequence $sequence2)
- {
- if($sequence1->getAllocationSize() != $sequence2->getAllocationSize()) {
- return true;
- }
- if($sequence1->getInitialValue() != $sequence2->getInitialValue()) {
- return true;
- }
- return false;
- }
- /**
- * Returns the difference between the tables $table1 and $table2.
- *
- * If there are no differences this method returns the boolean false.
- *
- * @param \Doctrine\DBAL\Schema\Table $table1
- * @param \Doctrine\DBAL\Schema\Table $table2
- *
- * @return boolean|\Doctrine\DBAL\Schema\TableDiff
- */
- public function diffTable(Table $table1, Table $table2)
- {
- $changes = 0;
- $tableDifferences = new TableDiff($table1->getName());
- $tableDifferences->fromTable = $table1;
- $table1Columns = $table1->getColumns();
- $table2Columns = $table2->getColumns();
- /* See if all the fields in table 1 exist in table 2 */
- foreach ( $table2Columns as $columnName => $column ) {
- if ( !$table1->hasColumn($columnName) ) {
- $tableDifferences->addedColumns[$columnName] = $column;
- $changes++;
- }
- }
- /* See if there are any removed fields in table 2 */
- foreach ( $table1Columns as $columnName => $column ) {
- if ( !$table2->hasColumn($columnName) ) {
- $tableDifferences->removedColumns[$columnName] = $column;
- $changes++;
- }
- }
- foreach ( $table1Columns as $columnName => $column ) {
- if ( $table2->hasColumn($columnName) ) {
- $changedProperties = $this->diffColumn( $column, $table2->getColumn($columnName) );
- if (count($changedProperties) ) {
- $columnDiff = new ColumnDiff($column->getName(), $table2->getColumn($columnName), $changedProperties);
- $columnDiff->fromColumn = $column;
- $tableDifferences->changedColumns[$column->getName()] = $columnDiff;
- $changes++;
- }
- }
- }
- $this->detectColumnRenamings($tableDifferences);
- $table1Indexes = $table1->getIndexes();
- $table2Indexes = $table2->getIndexes();
- foreach ($table2Indexes as $index2Name => $index2Definition) {
- foreach ($table1Indexes as $index1Name => $index1Definition) {
- if ($this->diffIndex($index1Definition, $index2Definition) === false) {
- unset($table1Indexes[$index1Name]);
- unset($table2Indexes[$index2Name]);
- } else {
- if ($index1Name == $index2Name) {
- $tableDifferences->changedIndexes[$index2Name] = $table2Indexes[$index2Name];
- unset($table1Indexes[$index1Name]);
- unset($table2Indexes[$index2Name]);
- $changes++;
- }
- }
- }
- }
- foreach ($table1Indexes as $index1Name => $index1Definition) {
- $tableDifferences->removedIndexes[$index1Name] = $index1Definition;
- $changes++;
- }
- foreach ($table2Indexes as $index2Name => $index2Definition) {
- $tableDifferences->addedIndexes[$index2Name] = $index2Definition;
- $changes++;
- }
- $fromFkeys = $table1->getForeignKeys();
- $toFkeys = $table2->getForeignKeys();
- foreach ($fromFkeys as $key1 => $constraint1) {
- foreach ($toFkeys as $key2 => $constraint2) {
- if($this->diffForeignKey($constraint1, $constraint2) === false) {
- unset($fromFkeys[$key1]);
- unset($toFkeys[$key2]);
- } else {
- if (strtolower($constraint1->getName()) == strtolower($constraint2->getName())) {
- $tableDifferences->changedForeignKeys[] = $constraint2;
- $changes++;
- unset($fromFkeys[$key1]);
- unset($toFkeys[$key2]);
- }
- }
- }
- }
- foreach ($fromFkeys as $constraint1) {
- $tableDifferences->removedForeignKeys[] = $constraint1;
- $changes++;
- }
- foreach ($toFkeys as $constraint2) {
- $tableDifferences->addedForeignKeys[] = $constraint2;
- $changes++;
- }
- return $changes ? $tableDifferences : false;
- }
- /**
- * Try to find columns that only changed their name, rename operations maybe cheaper than add/drop
- * however ambiguities between different possibilities should not lead to renaming at all.
- *
- * @param \Doctrine\DBAL\Schema\TableDiff $tableDifferences
- *
- * @return void
- */
- private function detectColumnRenamings(TableDiff $tableDifferences)
- {
- $renameCandidates = array();
- foreach ($tableDifferences->addedColumns as $addedColumnName => $addedColumn) {
- foreach ($tableDifferences->removedColumns as $removedColumn) {
- if (count($this->diffColumn($addedColumn, $removedColumn)) == 0) {
- $renameCandidates[$addedColumn->getName()][] = array($removedColumn, $addedColumn, $addedColumnName);
- }
- }
- }
- foreach ($renameCandidates as $candidateColumns) {
- if (count($candidateColumns) == 1) {
- list($removedColumn, $addedColumn) = $candidateColumns[0];
- $removedColumnName = strtolower($removedColumn->getName());
- $addedColumnName = strtolower($addedColumn->getName());
- if ( ! isset($tableDifferences->renamedColumns[$removedColumnName])) {
- $tableDifferences->renamedColumns[$removedColumnName] = $addedColumn;
- unset($tableDifferences->addedColumns[$addedColumnName]);
- unset($tableDifferences->removedColumns[$removedColumnName]);
- }
- }
- }
- }
- /**
- * @param \Doctrine\DBAL\Schema\ForeignKeyConstraint $key1
- * @param \Doctrine\DBAL\Schema\ForeignKeyConstraint $key2
- *
- * @return boolean
- */
- public function diffForeignKey(ForeignKeyConstraint $key1, ForeignKeyConstraint $key2)
- {
- if (array_map('strtolower', $key1->getLocalColumns()) != array_map('strtolower', $key2->getLocalColumns())) {
- return true;
- }
- if (array_map('strtolower', $key1->getForeignColumns()) != array_map('strtolower', $key2->getForeignColumns())) {
- return true;
- }
- if ($key1->getUnqualifiedForeignTableName() !== $key2->getUnqualifiedForeignTableName()) {
- return true;
- }
- if ($key1->onUpdate() != $key2->onUpdate()) {
- return true;
- }
- if ($key1->onDelete() != $key2->onDelete()) {
- return true;
- }
- return false;
- }
- /**
- * Returns the difference between the fields $field1 and $field2.
- *
- * If there are differences this method returns $field2, otherwise the
- * boolean false.
- *
- * @param \Doctrine\DBAL\Schema\Column $column1
- * @param \Doctrine\DBAL\Schema\Column $column2
- *
- * @return array
- */
- public function diffColumn(Column $column1, Column $column2)
- {
- $changedProperties = array();
- if ( $column1->getType() != $column2->getType() ) {
- $changedProperties[] = 'type';
- }
- if ($column1->getNotnull() != $column2->getNotnull()) {
- $changedProperties[] = 'notnull';
- }
- if ($column1->getDefault() != $column2->getDefault()) {
- $changedProperties[] = 'default';
- }
- if ($column1->getUnsigned() != $column2->getUnsigned()) {
- $changedProperties[] = 'unsigned';
- }
- if ($column1->getType() instanceof \Doctrine\DBAL\Types\StringType) {
- // check if value of length is set at all, default value assumed otherwise.
- $length1 = $column1->getLength() ?: 255;
- $length2 = $column2->getLength() ?: 255;
- if ($length1 != $length2) {
- $changedProperties[] = 'length';
- }
- if ($column1->getFixed() != $column2->getFixed()) {
- $changedProperties[] = 'fixed';
- }
- }
- if ($column1->getType() instanceof \Doctrine\DBAL\Types\DecimalType) {
- if (($column1->getPrecision()?:10) != ($column2->getPrecision()?:10)) {
- $changedProperties[] = 'precision';
- }
- if ($column1->getScale() != $column2->getScale()) {
- $changedProperties[] = 'scale';
- }
- }
- if ($column1->getAutoincrement() != $column2->getAutoincrement()) {
- $changedProperties[] = 'autoincrement';
- }
- // only allow to delete comment if its set to '' not to null.
- if ($column1->getComment() !== null && $column1->getComment() != $column2->getComment()) {
- $changedProperties[] = 'comment';
- }
- $options1 = $column1->getCustomSchemaOptions();
- $options2 = $column2->getCustomSchemaOptions();
- $commonKeys = array_keys(array_intersect_key($options1, $options2));
- foreach ($commonKeys as $key) {
- if ($options1[$key] !== $options2[$key]) {
- $changedProperties[] = $key;
- }
- }
- $diffKeys = array_keys(array_diff_key($options1, $options2) + array_diff_key($options2, $options1));
- $changedProperties = array_merge($changedProperties, $diffKeys);
- return $changedProperties;
- }
- /**
- * Finds the difference between the indexes $index1 and $index2.
- *
- * Compares $index1 with $index2 and returns $index2 if there are any
- * differences or false in case there are no differences.
- *
- * @param \Doctrine\DBAL\Schema\Index $index1
- * @param \Doctrine\DBAL\Schema\Index $index2
- *
- * @return boolean
- */
- public function diffIndex(Index $index1, Index $index2)
- {
- if ($index1->isFullfilledBy($index2) && $index2->isFullfilledBy($index1)) {
- return false;
- }
- return true;
- }
- }
|