Allow registration of migrators

Signed-off-by: Christopher Ng <chrng8@gmail.com>

3 files changed, 194 insertions, 0 deletions

diff --git a/lib/public/UserMigration/IExportDestination.php b/lib/public/UserMigration/IExportDestination.php
new file mode 100644
index 00000000000..0e4b121628e
--- /dev/null
+++ b/lib/public/UserMigration/IExportDestination.php
@@ -0,0 +1,64 @@
+<?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;
+
+use OCP\Files\Folder;
+
+/**
+ * @since 24.0.0
+ */
+interface IExportDestination {
+
+	/**
+	 * Adds a file to the export
+	 *
+	 * @param string $path Full path to the file in the export archive. Parent directories will be created if needed.
+	 * @param string $content The full content of the file.
+	 * @return bool whether the file was successfully added.
+	 *
+	 * @since 24.0.0
+	 */
+	public function addFile(string $path, string $content): bool;
+
+	/**
+	 * Copy a folder to the export
+	 *
+	 * @param Folder $folder folder to copy to the export archive.
+	 * @param string $destinationPath Full path to the folder in the export archive. Parent directories will be created if needed.
+	 * @return bool whether the folder was successfully added.
+	 *
+	 * @since 24.0.0
+	 */
+	public function copyFolder(Folder $folder, string $destinationPath): bool;
+
+	/**
+	 * Called after export is complete
+	 *
+	 * @since 24.0.0
+	 */
+	public function close(): void;
+}
diff --git a/lib/public/UserMigration/IImportSource.php b/lib/public/UserMigration/IImportSource.php
new file mode 100644
index 00000000000..36f8686cb81
--- /dev/null
+++ b/lib/public/UserMigration/IImportSource.php
@@ -0,0 +1,72 @@
+<?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;
+
+use OCP\Files\Folder;
+
+/**
+ * @since 24.0.0
+ */
+interface IImportSource {
+
+	/**
+	 * Reads a file from the export
+	 *
+	 * @param string $path Full path to the file in the export archive.
+	 * @return string The full content of the file.
+	 *
+	 * @since 24.0.0
+	 */
+	public function getFileContents(string $path): string;
+
+	/**
+	 * Reads a file from the export as a stream
+	 *
+	 * @param string $path Full path to the file in the export archive.
+	 * @return resource A stream resource to read from to get the file content.
+	 *
+	 * @since 24.0.0
+	 */
+	public function getFileAsStream(string $path);
+
+	/**
+	 * Copy files from the export to a Folder
+	 *
+	 * Folder $destination folder to copy into
+	 * string $sourcePath path in the export archive
+	 *
+	 * @since 24.0.0
+	 */
+	public function copyToFolder(Folder $destination, string $sourcePath): bool;
+
+	/**
+	 * Called after import is complete
+	 *
+	 * @since 24.0.0
+	 */
+	public function close(): void;
+}
diff --git a/lib/public/UserMigration/IMigrator.php b/lib/public/UserMigration/IMigrator.php
new file mode 100644
index 00000000000..6ac057d605c
--- /dev/null
+++ b/lib/public/UserMigration/IMigrator.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright 2022 Christopher Ng <chrng8@gmail.com>
+ *
+ * @author Christopher Ng <chrng8@gmail.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;
+
+use OCP\IUser;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @since 24.0.0
+ */
+interface IMigrator {
+
+	/**
+	 * Export user data
+	 *
+	 * @since 24.0.0
+	 */
+	public function export(
+		IUser $user,
+		IExportDestination $exportDestination,
+		OutputInterface $output
+	): void;
+
+	/**
+	 * Import user data
+	 *
+	 * @since 24.0.0
+	 */
+	public function import(
+		IUser $user,
+		IImportSource $importSource,
+		OutputInterface $output
+	): void;
+}