Skip to content

feat(UserMigration): Overwork migration to include all settings (quick actions) #12852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DerDreschner wants to merge 1 commit into
base: feat/user-migration-accounts
Choose a base branch
from
Open

feat(UserMigration): Overwork migration to include all settings (quick actions) #12852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions lib/UserMigration/MailAccountMigrator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use OCA\Mail\UserMigration\Service\AccountMigrationService;
use OCA\Mail\UserMigration\Service\AppConfigMigrationService;
use OCA\Mail\UserMigration\Service\InternalAddressesMigrationService;
use OCA\Mail\UserMigration\Service\QuickActionsMigrationService;
use OCA\Mail\UserMigration\Service\SMIMEMigrationService;
use OCA\Mail\UserMigration\Service\TagsMigrationService;
use OCA\Mail\UserMigration\Service\TextBlocksMigrationService;
Expand All @@ -39,7 +40,8 @@ public function __construct(
private readonly TrustedSendersMigrationService $trustedSendersMigrationService,
private readonly TextBlocksMigrationService $textBlocksMigrationService,
private readonly TagsMigrationService $tagsMigrationService,
private readonly SMIMEMigrationService $smimeMigrationService,
private readonly SMIMEMigrationService $sMimeMigrationService,
private readonly QuickActionsMigrationService $quickActionsMigrationService,
) {
}

Expand All @@ -58,8 +60,9 @@ public function export(IUser $user,
$this->trustedSendersMigrationService->exportTrustedSenders($user, $exportDestination, $output);
$this->textBlocksMigrationService->exportTextBlocks($user, $exportDestination, $output);
$this->tagsMigrationService->exportTags($user, $exportDestination, $output);
$this->smimeMigrationService->exportCertificates($user, $exportDestination, $output);
$this->sMimeMigrationService->exportCertificates($user, $exportDestination, $output);
$this->accountMigrationService->exportAccounts($user, $exportDestination, $output);
$this->quickActionsMigrationService->exportQuickActions($user, $exportDestination, $output);
}

/**
Expand All @@ -81,9 +84,11 @@ public function import(IUser $user, IImportSource $importSource, OutputInterface
$this->trustedSendersMigrationService->importTrustedSenders($user, $importSource, $output);
$this->textBlocksMigrationService->importTextBlocks($user, $importSource, $output);
$migratedTags = $this->tagsMigrationService->importTags($user, $importSource, $output);
$migratedCertificates = $this->smimeMigrationService->importCertificates($user, $importSource, $output);
$migratedCertificates = $this->sMimeMigrationService->importCertificates($user, $importSource, $output);
$migratedAccountsAndMailboxes = $this->accountMigrationService->importAccounts($user, $importSource, $output,
$migratedCertificates);
$this->quickActionsMigrationService->importQuickActions($user, $importSource, $output,
$migratedAccountsAndMailboxes['accounts'], $migratedAccountsAndMailboxes['mailboxes'], $migratedTags);

$this->accountMigrationService->scheduleBackgroundJobs($user, $output);
}
Expand Down
201 changes: 201 additions & 0 deletions lib/UserMigration/Service/QuickActionsMigrationService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OCA\Mail\UserMigration\Service;

use JsonException;
use OCA\Mail\Service\QuickActionsService;
use OCA\Mail\UserMigration\MailAccountMigrator;
use OCP\IL10N;
use OCP\IUser;
use OCP\UserMigration\IExportDestination;
use OCP\UserMigration\IImportSource;
use OCP\UserMigration\UserMigrationException;
use Symfony\Component\Console\Output\OutputInterface;

class QuickActionsMigrationService {
public const QUICK_ACTIONS_FILE = MailAccountMigrator::EXPORT_ROOT . '/quick_actions.json';

public function __construct(
private readonly QuickActionsService $quickActionsService,
private readonly IL10N $l10n,
) {
}

/**
* Export all quick actions the user defined across
* their accounts.
*
* @param IUser $user
* @param IExportDestination $exportDestination
* @param OutputInterface $output
* @throws UserMigrationException
*/
public function exportQuickActions(IUser $user,
IExportDestination $exportDestination,
OutputInterface $output): void {
$output->writeln(
$this->l10n->t('Exporting quick actions for user %s', [$user->getUID()]),
OutputInterface::VERBOSITY_VERBOSE
);

$quickActions = $this->quickActionsService->findAll($user->getUID());

try {
$exportDestination->addFileContents(self::QUICK_ACTIONS_FILE,
json_encode($quickActions, JSON_THROW_ON_ERROR));
} catch (JsonException|UserMigrationException $exception) {
throw new UserMigrationException(
"Failed to export quick actions for user {$user->getUID()}",
previous: $exception
);
}
}

/**
* Import all quick actions the user defined across
* their accounts.
*
* @throws \OCA\Mail\Exception\ServiceException
*/
public function importQuickActions(IUser $user,
IImportSource $importSource,
OutputInterface $output,
array $accountMapping,
array $mailboxMapping,
array $tagMapping): void {
$output->writeln(
$this->l10n->t('Importing quick actions for user %s', [$user->getUID()]),
OutputInterface::VERBOSITY_VERBOSE
);

try {
$quickActionsFileContent = $importSource->getFileContents(self::QUICK_ACTIONS_FILE);
} catch (UserMigrationException) {
$output->writeln(
$this->l10n->t('Quick actions for user %s not found. Continue...', [$user->getUID()]),
OutputInterface::VERBOSITY_VERBOSE
);

return;
}

try {
$quickActions = json_decode($quickActionsFileContent, true, flags: JSON_THROW_ON_ERROR);
$this->validateQuickActions($quickActions);
} catch (JsonException|UserMigrationException) {
$output->writeln(
$this->l10n->t('Quick actions configuration for user %s is invalid and will be skipped. Continue...',
[$user->getUID()]),
OutputInterface::VERBOSITY_VERBOSE
);

return;
}


foreach ($quickActions as $quickAction) {
$createdQuickAction = $this->quickActionsService->create($quickAction['name'],
$accountMapping[$quickAction['accountId']]);

foreach ($quickAction['actionSteps'] as $actionStep) {
$this->quickActionsService->createActionStep($actionStep['name'], $actionStep['order'],
$createdQuickAction->getId(), $tagMapping[$actionStep['tagId']] ?? null,
$mailboxMapping[$actionStep['mailboxId']] ?? null);
}
}
}

/**
* Validate the parsed quick actions to ensure they
* have the expected structure and types.
*
* @throws UserMigrationException
*/
private function validateQuickActions(mixed $quickActions): void {
$quickActionsArrayIsValid = is_array($quickActions) && array_is_list($quickActions);
if (!$quickActionsArrayIsValid) {
throw new UserMigrationException('Invalid quick actions export structure');
}

foreach ($quickActions as $quickAction) {
$quickActionArrayIsValid = is_array($quickAction);

$idIsValid = $quickActionArrayIsValid
&& array_key_exists('id', $quickAction)
&& is_int($quickAction['id']);

$nameIsValid = $quickActionArrayIsValid
&& array_key_exists('name', $quickAction)
&& is_string($quickAction['name']);

$orderIsValid = $quickActionArrayIsValid
&& array_key_exists('accountId', $quickAction)
&& is_int($quickAction['accountId']);

$actionStepsArrayIsValid = $quickActionArrayIsValid
&& array_key_exists('actionSteps', $quickAction)
&& is_array($quickAction['actionSteps'])
&& array_is_list($quickAction['actionSteps'])
&& $this->validateQuickSteps($quickAction['actionSteps']);

if (
!$idIsValid
|| !$nameIsValid
|| !$orderIsValid
|| !$actionStepsArrayIsValid
) {
throw new UserMigrationException('Invalid quick action entry');
}
}
}

private function validateQuickSteps(mixed $quickSteps): bool {
$quickStepsArrayIsValid = true;

foreach ($quickSteps as $actionStep) {
$actionStepArrayIsValid = is_array($actionStep);

$idIsValid = $actionStepArrayIsValid
&& array_key_exists('id', $actionStep)
&& is_int($actionStep['id']);

$nameIsValid = $actionStepArrayIsValid
&& array_key_exists('name', $actionStep)
&& is_string($actionStep['name']);

$orderIsValid = $actionStepArrayIsValid
&& array_key_exists('order', $actionStep)
&& is_int($actionStep['order']);

$actionIdIsValid = $actionStepArrayIsValid
&& array_key_exists('actionId', $actionStep)
&& is_int($actionStep['actionId']);

$tagIdIsValid = $actionStepArrayIsValid
&& array_key_exists('tagId', $actionStep)
&& (is_int($actionStep['tagId']) || is_null($actionStep['tagId']));

$mailboxIdIsValid = $actionStepArrayIsValid
&& array_key_exists('mailboxId', $actionStep)
&& (is_int($actionStep['mailboxId']) || is_null($actionStep['mailboxId']));

$actionStepIsValid = $idIsValid
&& $nameIsValid
&& $orderIsValid
&& $actionIdIsValid
&& $tagIdIsValid
&& $mailboxIdIsValid;

$quickStepsArrayIsValid = $quickStepsArrayIsValid && $actionStepIsValid;
}

return $quickStepsArrayIsValid;
}
}
Loading
Loading