migrate therinaldos.com data

wedding-pics/lib/public/UserMigration/IExportDestination.php

@@ -0,0 +1,85 @@
+<?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.
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function addFileContents(string $path, string $content): void;
+
+	/**
+	 * Adds a file to the export as a stream
+	 *
+	 * @param string $path Full path to the file in the export archive. Parent directories will be created if needed.
+	 * @param resource $stream A stream resource to read from to get the file content.
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function addFileAsStream(string $path, $stream): void;
+
+	/**
+	 * 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.
+	 * @param ?callable(\OCP\Files\Node):bool $nodeFilter Callback to filter nodes to copy
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function copyFolder(Folder $folder, string $destinationPath, ?callable $nodeFilter = null): void;
+
+	/**
+	 * @param array<string,int> $versions Migrators and their versions.
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function setMigratorVersions(array $versions): void;
+
+	/**
+	 * Called after export is complete
+	 *
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function close(): void;
+}

wedding-pics/lib/public/UserMigration/IImportSource.php

@@ -0,0 +1,125 @@
+<?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 {
+	public const PATH_USER = 'user.json';
+
+	/**
+	 * 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.
+	 * @throws UserMigrationException
+	 *
+	 * @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.
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function getFileAsStream(string $path);
+
+	/**
+	 * List the files of a folder
+	 *
+	 * @param string $path Full path to the folder in the export archive.
+	 * @return array The list of files.
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function getFolderListing(string $path): array;
+
+	/**
+	 * Test if a path exists, which may be a file or a folder
+	 *
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function pathExists(string $path): bool;
+
+	/**
+	 * Copy files from the export to a Folder
+	 *
+	 * Folder $destination folder to copy into
+	 * string $sourcePath path in the export archive
+	 *
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function copyToFolder(Folder $destination, string $sourcePath): void;
+
+	/**
+	 * @return array<string,int> Migrators and their versions from the export archive.
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function getMigratorVersions(): array;
+
+	/**
+	 * @return ?int Version for this migrator from the export archive. Null means migrator missing.
+	 * @throws UserMigrationException
+	 * @param string $migrator Migrator id (as returned by IMigrator::getId)
+	 *
+	 * @since 24.0.0
+	 */
+	public function getMigratorVersion(string $migrator): ?int;
+
+	/**
+	 * Get original uid of the imported account
+	 *
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function getOriginalUid(): string;
+
+	/**
+	 * Called after import is complete
+	 *
+	 * @throws UserMigrationException
+	 *
+	 * @since 24.0.0
+	 */
+	public function close(): void;
+}

wedding-pics/lib/public/UserMigration/IMigrator.php

@@ -0,0 +1,98 @@
+<?php
+
+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
+ *
+ * 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
+	 *
+	 * @throws UserMigrationException
+	 * @since 24.0.0
+	 */
+	public function export(
+		IUser $user,
+		IExportDestination $exportDestination,
+		OutputInterface $output
+	): void;
+
+	/**
+	 * Import user data
+	 *
+	 * @throws UserMigrationException
+	 * @since 24.0.0
+	 */
+	public function import(
+		IUser $user,
+		IImportSource $importSource,
+		OutputInterface $output
+	): void;
+
+	/**
+	 * Returns the unique ID
+	 *
+	 * @since 24.0.0
+	 */
+	public function getId(): string;
+
+	/**
+	 * Returns the display name
+	 *
+	 * @since 24.0.0
+	 */
+	public function getDisplayName(): string;
+
+	/**
+	 * Returns the description
+	 *
+	 * @since 24.0.0
+	 */
+	public function getDescription(): string;
+
+	/**
+	 * 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($this->getId()) to get the version from the archive
+	 *
+	 * @since 24.0.0
+	 */
+	public function canImport(
+		IImportSource $importSource
+	): bool;
+}

wedding-pics/lib/public/UserMigration/ISizeEstimationMigrator.php

@@ -0,0 +1,44 @@
+<?php
+
+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
+ *
+ * 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;
+
+/**
+ * @since 25.0.0
+ */
+interface ISizeEstimationMigrator {
+	/**
+	 * Returns an estimate of the exported data size in KiB.
+	 * Should be fast, favor performance over accuracy.
+	 *
+	 * @since 25.0.0
+	 * @since 27.0.0 return value may overflow from int to float
+	 */
+	public function getEstimatedExportSize(IUser $user): int|float;
+}

wedding-pics/lib/public/UserMigration/TMigratorBasicVersionHandling.php

@@ -0,0 +1,59 @@
+<?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
+ * @since 24.0.0
+ */
+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($this->getId());
+		if ($version === null) {
+			return !$this->mandatory;
+		}
+		return ($this->version >= $version);
+	}
+}

wedding-pics/lib/public/UserMigration/UserMigrationException.php

@@ -0,0 +1,33 @@
+<?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;
+
+/**
+ * @since 24.0.0
+ */
+class UserMigrationException extends \Exception {
+}