diff options
author | Côme Chilliet <91878298+come-nc@users.noreply.github.com> | 2022-02-22 11:02:34 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-22 11:02:34 +0300 |
commit | 5b565a4726032628f2ca42d0e99f09709a04f910 (patch) | |
tree | 6c8ad3c293befeb1282af0262e53158d57cbc2b9 /lib | |
parent | 67f192e906685e923c3f537b8daa0e149364e0e8 (diff) | |
parent | 07940f9d052c7719ed4d95dea30f1c1ee44829d5 (diff) |
Merge pull request #31173 from nextcloud/enhancement/user_migration-version-handling
Add version handling to IMigrator
Diffstat (limited to 'lib')
-rw-r--r-- | lib/composer/composer/autoload_classmap.php | 1 | ||||
-rw-r--r-- | lib/composer/composer/autoload_static.php | 1 | ||||
-rw-r--r-- | lib/public/UserMigration/IExportDestination.php | 7 | ||||
-rw-r--r-- | lib/public/UserMigration/IImportSource.php | 16 | ||||
-rw-r--r-- | lib/public/UserMigration/IMigrator.php | 18 | ||||
-rw-r--r-- | lib/public/UserMigration/TMigratorBasicVersionHandling.php | 58 |
6 files changed, 101 insertions, 0 deletions
diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 81e02389e85..2c984e88918 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -547,6 +547,7 @@ return array( 'OCP\\UserMigration\\IExportDestination' => $baseDir . '/lib/public/UserMigration/IExportDestination.php', 'OCP\\UserMigration\\IImportSource' => $baseDir . '/lib/public/UserMigration/IImportSource.php', 'OCP\\UserMigration\\IMigrator' => $baseDir . '/lib/public/UserMigration/IMigrator.php', + 'OCP\\UserMigration\\TMigratorBasicVersionHandling' => $baseDir . '/lib/public/UserMigration/TMigratorBasicVersionHandling.php', 'OCP\\UserStatus\\IManager' => $baseDir . '/lib/public/UserStatus/IManager.php', 'OCP\\UserStatus\\IProvider' => $baseDir . '/lib/public/UserStatus/IProvider.php', 'OCP\\UserStatus\\IUserStatus' => $baseDir . '/lib/public/UserStatus/IUserStatus.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index abaa64aa3c0..5ccf3acd7d7 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -576,6 +576,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\UserMigration\\IExportDestination' => __DIR__ . '/../../..' . '/lib/public/UserMigration/IExportDestination.php', 'OCP\\UserMigration\\IImportSource' => __DIR__ . '/../../..' . '/lib/public/UserMigration/IImportSource.php', 'OCP\\UserMigration\\IMigrator' => __DIR__ . '/../../..' . '/lib/public/UserMigration/IMigrator.php', + 'OCP\\UserMigration\\TMigratorBasicVersionHandling' => __DIR__ . '/../../..' . '/lib/public/UserMigration/TMigratorBasicVersionHandling.php', 'OCP\\UserStatus\\IManager' => __DIR__ . '/../../..' . '/lib/public/UserStatus/IManager.php', 'OCP\\UserStatus\\IProvider' => __DIR__ . '/../../..' . '/lib/public/UserStatus/IProvider.php', 'OCP\\UserStatus\\IUserStatus' => __DIR__ . '/../../..' . '/lib/public/UserStatus/IUserStatus.php', diff --git a/lib/public/UserMigration/IExportDestination.php b/lib/public/UserMigration/IExportDestination.php index 5446e8d57f2..a721efcdf93 100644 --- a/lib/public/UserMigration/IExportDestination.php +++ b/lib/public/UserMigration/IExportDestination.php @@ -67,6 +67,13 @@ interface IExportDestination { public function copyFolder(Folder $folder, string $destinationPath): bool; /** + * @param array<string,int> $versions Migrators and their versions. + * + * @since 24.0.0 + */ + public function setMigratorVersions(array $versions): bool; + + /** * Called after export is complete * * @since 24.0.0 diff --git a/lib/public/UserMigration/IImportSource.php b/lib/public/UserMigration/IImportSource.php index 36f8686cb81..f3051b097e0 100644 --- a/lib/public/UserMigration/IImportSource.php +++ b/lib/public/UserMigration/IImportSource.php @@ -64,6 +64,22 @@ interface IImportSource { public function copyToFolder(Folder $destination, string $sourcePath): bool; /** + * @return array<string,int> Migrators and their versions from the export archive. + * + * @since 24.0.0 + */ + public function getMigratorVersions(): array; + + /** + * @return ?int Version for this migrator from the export archive. Null means migrator missing. + * + * @param class-string<IMigrator> $migrator + * + * @since 24.0.0 + */ + public function getMigratorVersion(string $migrator): ?int; + + /** * Called after import is complete * * @since 24.0.0 diff --git a/lib/public/UserMigration/IMigrator.php b/lib/public/UserMigration/IMigrator.php index 6ac057d605c..4ff09167f5e 100644 --- a/lib/public/UserMigration/IMigrator.php +++ b/lib/public/UserMigration/IMigrator.php @@ -6,6 +6,7 @@ declare(strict_types=1); * @copyright 2022 Christopher Ng <chrng8@gmail.com> * * @author Christopher Ng <chrng8@gmail.com> + * @author Côme Chilliet <come.chilliet@nextcloud.com> * * @license GNU AGPL version 3 or any later version * @@ -55,4 +56,21 @@ interface IMigrator { IImportSource $importSource, OutputInterface $output ): void; + + /** + * Returns the version of the export format for this migrator + * + * @since 24.0.0 + */ + public function getVersion(): int; + + /** + * Checks whether it is able to import a version of the export format for this migrator + * Use $importSource->getMigratorVersion(static::class) to get the version from the archive + * + * @since 24.0.0 + */ + public function canImport( + IImportSource $importSource + ): bool; } diff --git a/lib/public/UserMigration/TMigratorBasicVersionHandling.php b/lib/public/UserMigration/TMigratorBasicVersionHandling.php new file mode 100644 index 00000000000..5554bb90a91 --- /dev/null +++ b/lib/public/UserMigration/TMigratorBasicVersionHandling.php @@ -0,0 +1,58 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright Copyright (c) 2022 Côme Chilliet <come.chilliet@nextcloud.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 OCP\UserMigration; + +/** + * Basic version handling: we can import older versions but not newer ones + */ +trait TMigratorBasicVersionHandling { + protected int $version = 1; + + protected bool $mandatory = false; + + /** + * {@inheritDoc} + * @since 24.0.0 + */ + public function getVersion(): int { + return $this->version; + } + + /** + * {@inheritDoc} + * @since 24.0.0 + */ + public function canImport( + IImportSource $importSource + ): bool { + $version = $importSource->getMigratorVersion(static::class); + if ($version === null) { + return !$this->mandatory; + } + return ($this->version >= $version); + } +} |