Merge pull request #30667 from nextcloud/backport/30568/stable21

[stable21] Fix primary key change in user_ldap migration
2026-06-08 08:16:43 -04:00 · 2022-01-14 12:20:45 +01:00 · 2022-01-14 12:20:45 +01:00 · 0738110f01
commit 0738110f01
parent e966ddea8a 7ebbee52b7
7 changed files with 337 additions and 21 deletions
--- a/apps/user_ldap/composer/composer/autoload_classmap.php
+++ b/apps/user_ldap/composer/composer/autoload_classmap.php
@ -53,6 +53,7 @@ return array(
    'OCA\\User_LDAP\\Mapping\\AbstractMapping' => $baseDir . '/../lib/Mapping/AbstractMapping.php',
    'OCA\\User_LDAP\\Mapping\\GroupMapping' => $baseDir . '/../lib/Mapping/GroupMapping.php',
    'OCA\\User_LDAP\\Mapping\\UserMapping' => $baseDir . '/../lib/Mapping/UserMapping.php',
+    'OCA\\User_LDAP\\Migration\\GroupMappingMigration' => $baseDir . '/../lib/Migration/GroupMappingMigration.php',
    'OCA\\User_LDAP\\Migration\\RemoveRefreshTime' => $baseDir . '/../lib/Migration/RemoveRefreshTime.php',
    'OCA\\User_LDAP\\Migration\\SetDefaultProvider' => $baseDir . '/../lib/Migration/SetDefaultProvider.php',
    'OCA\\User_LDAP\\Migration\\UUIDFix' => $baseDir . '/../lib/Migration/UUIDFix.php',
@ -63,6 +64,9 @@ return array(
    'OCA\\User_LDAP\\Migration\\Version1010Date20200630192842' => $baseDir . '/../lib/Migration/Version1010Date20200630192842.php',
    'OCA\\User_LDAP\\Migration\\Version1120Date20210917155206' => $baseDir . '/../lib/Migration/Version1120Date20210917155206.php',
    'OCA\\User_LDAP\\Migration\\Version1130Date20211102154716' => $baseDir . '/../lib/Migration/Version1130Date20211102154716.php',
+    'OCA\\User_LDAP\\Migration\\Version1130Date20220110154717' => $baseDir . '/../lib/Migration/Version1130Date20220110154717.php',
+    'OCA\\User_LDAP\\Migration\\Version1130Date20220110154718' => $baseDir . '/../lib/Migration/Version1130Date20220110154718.php',
+    'OCA\\User_LDAP\\Migration\\Version1130Date20220110154719' => $baseDir . '/../lib/Migration/Version1130Date20220110154719.php',
    'OCA\\User_LDAP\\Notification\\Notifier' => $baseDir . '/../lib/Notification/Notifier.php',
    'OCA\\User_LDAP\\PagedResults\\IAdapter' => $baseDir . '/../lib/PagedResults/IAdapter.php',
    'OCA\\User_LDAP\\PagedResults\\Php54' => $baseDir . '/../lib/PagedResults/Php54.php',
--- a/apps/user_ldap/composer/composer/autoload_static.php
+++ b/apps/user_ldap/composer/composer/autoload_static.php
@ -68,6 +68,7 @@ class ComposerStaticInitUser_LDAP
        'OCA\\User_LDAP\\Mapping\\AbstractMapping' => __DIR__ . '/..' . '/../lib/Mapping/AbstractMapping.php',
        'OCA\\User_LDAP\\Mapping\\GroupMapping' => __DIR__ . '/..' . '/../lib/Mapping/GroupMapping.php',
        'OCA\\User_LDAP\\Mapping\\UserMapping' => __DIR__ . '/..' . '/../lib/Mapping/UserMapping.php',
+        'OCA\\User_LDAP\\Migration\\GroupMappingMigration' => __DIR__ . '/..' . '/../lib/Migration/GroupMappingMigration.php',
        'OCA\\User_LDAP\\Migration\\RemoveRefreshTime' => __DIR__ . '/..' . '/../lib/Migration/RemoveRefreshTime.php',
        'OCA\\User_LDAP\\Migration\\SetDefaultProvider' => __DIR__ . '/..' . '/../lib/Migration/SetDefaultProvider.php',
        'OCA\\User_LDAP\\Migration\\UUIDFix' => __DIR__ . '/..' . '/../lib/Migration/UUIDFix.php',
@ -78,6 +79,9 @@ class ComposerStaticInitUser_LDAP
        'OCA\\User_LDAP\\Migration\\Version1010Date20200630192842' => __DIR__ . '/..' . '/../lib/Migration/Version1010Date20200630192842.php',
        'OCA\\User_LDAP\\Migration\\Version1120Date20210917155206' => __DIR__ . '/..' . '/../lib/Migration/Version1120Date20210917155206.php',
        'OCA\\User_LDAP\\Migration\\Version1130Date20211102154716' => __DIR__ . '/..' . '/../lib/Migration/Version1130Date20211102154716.php',
+        'OCA\\User_LDAP\\Migration\\Version1130Date20220110154717' => __DIR__ . '/..' . '/../lib/Migration/Version1130Date20220110154717.php',
+        'OCA\\User_LDAP\\Migration\\Version1130Date20220110154718' => __DIR__ . '/..' . '/../lib/Migration/Version1130Date20220110154718.php',
+        'OCA\\User_LDAP\\Migration\\Version1130Date20220110154719' => __DIR__ . '/..' . '/../lib/Migration/Version1130Date20220110154719.php',
        'OCA\\User_LDAP\\Notification\\Notifier' => __DIR__ . '/..' . '/../lib/Notification/Notifier.php',
        'OCA\\User_LDAP\\PagedResults\\IAdapter' => __DIR__ . '/..' . '/../lib/PagedResults/IAdapter.php',
        'OCA\\User_LDAP\\PagedResults\\Php54' => __DIR__ . '/..' . '/../lib/PagedResults/Php54.php',
--- a/apps/user_ldap/lib/Migration/GroupMappingMigration.php
+++ b/apps/user_ldap/lib/Migration/GroupMappingMigration.php
@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\User_LDAP\Migration;
+
+use OCP\IDBConnection;
+use OCP\Migration\SimpleMigrationStep;
+
+abstract class GroupMappingMigration extends SimpleMigrationStep {
+
+	/** @var IDBConnection */
+	private $dbc;
+
+	public function __construct(IDBConnection $dbc) {
+		$this->dbc = $dbc;
+	}
+
+	protected function copyGroupMappingData(string $sourceTable, string $destinationTable): void {
+		$insert = $this->dbc->getQueryBuilder();
+		$insert->insert($destinationTable)
+			->values([
+				'ldap_dn' => $insert->createParameter('ldap_dn'),
+				'owncloud_name' => $insert->createParameter('owncloud_name'),
+				'directory_uuid' => $insert->createParameter('directory_uuid'),
+				'ldap_dn_hash' => $insert->createParameter('ldap_dn_hash'),
+			]);
+
+		$query = $this->dbc->getQueryBuilder();
+		$query->select('*')
+			->from($sourceTable);
+
+
+		$result = $query->executeQuery();
+		while ($row = $result->fetch()) {
+			$insert
+				->setParameter('ldap_dn', $row['ldap_dn'])
+				->setParameter('owncloud_name', $row['owncloud_name'])
+				->setParameter('directory_uuid', $row['directory_uuid'])
+				->setParameter('ldap_dn_hash', $row['ldap_dn_hash'])
+				;
+
+			$insert->executeStatement();
+		}
+		$result->closeCursor();
+	}
+}
--- a/apps/user_ldap/lib/Migration/Version1130Date20211102154716.php
+++ b/apps/user_ldap/lib/Migration/Version1130Date20211102154716.php
@ -73,11 +73,12 @@ class Version1130Date20211102154716 extends SimpleMigrationStep {
 				$changeSchema = true;
 			}
 			$column = $table->getColumn('ldap_dn');
-			if ($column->getLength() < 4096) {
-				$column->setLength(4096);
-				$changeSchema = true;
-			}
 			if ($tableName === 'ldap_user_mapping') {
+				if ($column->getLength() < 4096) {
+					$column->setLength(4096);
+					$changeSchema = true;
+				}
+
 				if ($table->hasIndex('ldap_dn_users')) {
 					$table->dropIndex('ldap_dn_users');
 					$changeSchema = true;
@ -91,23 +92,29 @@ class Version1130Date20211102154716 extends SimpleMigrationStep {
 					$changeSchema = true;
 				}
 			} else {
-				if ($table->hasIndex('owncloud_name_groups')) {
-					$table->dropIndex('owncloud_name_groups');
-					$changeSchema = true;
-				}
-				if (!$table->hasIndex('ldap_group_dn_hashes')) {
-					$table->addUniqueIndex(['ldap_dn_hash'], 'ldap_group_dn_hashes');
-					$changeSchema = true;
-				}
-				if (!$table->hasIndex('ldap_group_directory_uuid')) {
-					$table->addUniqueIndex(['directory_uuid'], 'ldap_group_directory_uuid');
-					$changeSchema = true;
-				}
-				if (!$table->hasPrimaryKey() || ($table->getPrimaryKeyColumns() !== ['owncloud_name'])) {
-					$table->dropPrimaryKey();
-					$table->setPrimaryKey(['owncloud_name']);
-					$changeSchema = true;
-				}
+				// We need to copy the table twice to be able to change primary key, prepare the backup table
+				$table2 = $schema->createTable('ldap_group_mapping_backup');
+				$table2->addColumn('ldap_dn', Types::STRING, [
+					'notnull' => true,
+					'length' => 4096,
+					'default' => '',
+				]);
+				$table2->addColumn('owncloud_name', Types::STRING, [
+					'notnull' => true,
+					'length' => 64,
+					'default' => '',
+				]);
+				$table2->addColumn('directory_uuid', Types::STRING, [
+					'notnull' => true,
+					'length' => 255,
+					'default' => '',
+				]);
+				$table2->addColumn('ldap_dn_hash', Types::STRING, [
+					'notnull' => false,
+					'length' => 64,
+				]);
+				$table2->setPrimaryKey(['owncloud_name'], 'lgm_backup_primary');
+				$changeSchema = true;
 			}
 		}

--- a/apps/user_ldap/lib/Migration/Version1130Date20220110154717.php
+++ b/apps/user_ldap/lib/Migration/Version1130Date20220110154717.php
@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\User_LDAP\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\IOutput;
+
+class Version1130Date20220110154717 extends GroupMappingMigration {
+	public function getName() {
+		return 'Copy ldap_group_mapping data to backup table if needed';
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @since 13.0.0
+	 */
+	public function preSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('ldap_group_mapping_backup')) {
+			// Backup table does not exist
+			return;
+		}
+
+		$output->startProgress();
+		$this->copyGroupMappingData('ldap_group_mapping', 'ldap_group_mapping_backup');
+		$output->finishProgress();
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('ldap_group_mapping_backup')) {
+			// Backup table does not exist
+			return null;
+		}
+
+		$schema->dropTable('ldap_group_mapping');
+
+		return $schema;
+	}
+}
--- a/apps/user_ldap/lib/Migration/Version1130Date20220110154718.php
+++ b/apps/user_ldap/lib/Migration/Version1130Date20220110154718.php
@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\User_LDAP\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+
+class Version1130Date20220110154718 extends GroupMappingMigration {
+	public function getName() {
+		return 'Copy ldap_group_mapping data from backup table and if needed';
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('ldap_group_mapping_backup')) {
+			// Backup table does not exist
+			return null;
+		}
+
+		$table = $schema->createTable('ldap_group_mapping');
+		$table->addColumn('ldap_dn', Types::STRING, [
+			'notnull' => true,
+			'length' => 4096,
+			'default' => '',
+		]);
+		$table->addColumn('owncloud_name', Types::STRING, [
+			'notnull' => true,
+			'length' => 64,
+			'default' => '',
+		]);
+		$table->addColumn('directory_uuid', Types::STRING, [
+			'notnull' => true,
+			'length' => 255,
+			'default' => '',
+		]);
+		$table->addColumn('ldap_dn_hash', Types::STRING, [
+			'notnull' => false,
+			'length' => 64,
+		]);
+		$table->setPrimaryKey(['owncloud_name']);
+		$table->addUniqueIndex(['ldap_dn_hash'], 'ldap_group_dn_hashes');
+		$table->addUniqueIndex(['directory_uuid'], 'ldap_group_directory_uuid');
+
+		return $schema;
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 */
+	public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options) {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('ldap_group_mapping_backup')) {
+			// Backup table does not exist
+			return;
+		}
+
+		$output->startProgress();
+		$this->copyGroupMappingData('ldap_group_mapping_backup', 'ldap_group_mapping');
+		$output->finishProgress();
+	}
+}
--- a/apps/user_ldap/lib/Migration/Version1130Date20220110154719.php
+++ b/apps/user_ldap/lib/Migration/Version1130Date20220110154719.php
@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\User_LDAP\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version1130Date20220110154719 extends SimpleMigrationStep {
+	public function getName() {
+		return 'Drop ldap_group_mapping_backup';
+	}
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if ($schema->hasTable('ldap_group_mapping_backup')) {
+			$schema->dropTable('ldap_group_mapping_backup');
+			return $schema;
+		}
+
+		return null;
+	}
+}