Merge pull request #31382 from nextcloud/feat/account-migrator
User account migrationpull/30950/head
Côme Chilliet
GitHub
commit
58582dfd33
@ -0,0 +1,140 @@
|
||||
<?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 OCA\Settings\UserMigration;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use OC\Accounts\TAccountsHelper;
|
||||
use OC\NotSquareException;
|
||||
use OCA\Settings\AppInfo\Application;
|
||||
use OCP\Accounts\IAccountManager;
|
||||
use OCP\IAvatarManager;
|
||||
use OCP\IUser;
|
||||
use OCP\UserMigration\IExportDestination;
|
||||
use OCP\UserMigration\IImportSource;
|
||||
use OCP\UserMigration\IMigrator;
|
||||
use OCP\UserMigration\TMigratorBasicVersionHandling;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Throwable;
|
||||
|
||||
class AccountMigrator implements IMigrator {
|
||||
use TMigratorBasicVersionHandling;
|
||||
|
||||
use TAccountsHelper;
|
||||
|
||||
private IAccountManager $accountManager;
|
||||
|
||||
private IAvatarManager $avatarManager;
|
||||
|
||||
private const PATH_ROOT = Application::APP_ID . '/';
|
||||
|
||||
private const PATH_ACCOUNT_FILE = AccountMigrator::PATH_ROOT . 'account.json';
|
||||
|
||||
private const AVATAR_BASENAME = 'avatar';
|
||||
|
||||
public function __construct(
|
||||
IAccountManager $accountManager,
|
||||
IAvatarManager $avatarManager
|
||||
) {
|
||||
$this->accountManager = $accountManager;
|
||||
$this->avatarManager = $avatarManager;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function export(IUser $user, IExportDestination $exportDestination, OutputInterface $output): void {
|
||||
$output->writeln('Exporting account information in ' . AccountMigrator::PATH_ACCOUNT_FILE . '…');
|
||||
|
||||
$account = $this->accountManager->getAccount($user);
|
||||
if ($exportDestination->addFileContents(AccountMigrator::PATH_ACCOUNT_FILE, json_encode($account)) === false) {
|
||||
throw new AccountMigratorException('Could not export account information');
|
||||
}
|
||||
|
||||
$avatar = $this->avatarManager->getAvatar($user->getUID());
|
||||
if ($avatar->isCustomAvatar()) {
|
||||
$avatarFile = $avatar->getFile(-1);
|
||||
$exportPath = AccountMigrator::PATH_ROOT . AccountMigrator::AVATAR_BASENAME . '.' . $avatarFile->getExtension();
|
||||
|
||||
$output->writeln('Exporting avatar to ' . $exportPath . '…');
|
||||
if ($exportDestination->addFileAsStream($exportPath, $avatarFile->read()) === false) {
|
||||
throw new AccountMigratorException('Could not export avatar');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function import(IUser $user, IImportSource $importSource, OutputInterface $output): void {
|
||||
if ($importSource->getMigratorVersion(static::class) === null) {
|
||||
$output->writeln('No version for ' . static::class . ', skipping import…');
|
||||
return;
|
||||
}
|
||||
|
||||
$output->writeln('Importing account information from ' . AccountMigrator::PATH_ACCOUNT_FILE . '…');
|
||||
|
||||
$account = $this->accountManager->getAccount($user);
|
||||
|
||||
/** @var array<string, array<string, string>>|array<string, array<int, array<string, string>>> $data */
|
||||
$data = json_decode($importSource->getFileContents(AccountMigrator::PATH_ACCOUNT_FILE), true, 512, JSON_THROW_ON_ERROR);
|
||||
$account->setAllPropertiesFromJson($data);
|
||||
|
||||
try {
|
||||
$this->accountManager->updateAccount($account);
|
||||
} catch (InvalidArgumentException $e) {
|
||||
throw new AccountMigratorException('Failed to import account information');
|
||||
}
|
||||
|
||||
/** @var array<int, string> $avatarFiles */
|
||||
$avatarFiles = array_filter(
|
||||
$importSource->getFolderListing(AccountMigrator::PATH_ROOT),
|
||||
fn (string $filename) => pathinfo($filename, PATHINFO_FILENAME) === AccountMigrator::AVATAR_BASENAME,
|
||||
);
|
||||
|
||||
if (!empty($avatarFiles)) {
|
||||
if (count($avatarFiles) > 1) {
|
||||
$output->writeln('Expected single avatar image file, using first file found');
|
||||
}
|
||||
|
||||
$importPath = AccountMigrator::PATH_ROOT . reset($avatarFiles);
|
||||
|
||||
$output->writeln('Importing avatar from ' . $importPath . '…');
|
||||
$stream = $importSource->getFileAsStream($importPath);
|
||||
$image = new \OC_Image();
|
||||
$image->loadFromFileHandle($stream);
|
||||
|
||||
try {
|
||||
$avatar = $this->avatarManager->getAvatar($user->getUID());
|
||||
$avatar->set($image);
|
||||
} catch (NotSquareException $e) {
|
||||
throw new AccountMigratorException('Avatar image must be square');
|
||||
} catch (Throwable $e) {
|
||||
throw new AccountMigratorException('Failed to import avatar', 0, $e);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
<?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 OCA\Settings\UserMigration;
|
||||
|
||||
use OCP\UserMigration\UserMigrationException;
|
||||
|
||||
class AccountMigratorException extends UserMigrationException {
|
||||
}
|
||||
Loading…
Reference in New Issue