fix: perform bulk message actions #10280
+362
−43
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\Mail\Service; | ||
|
|
||
| use OCA\Mail\Account; | ||
| use OCA\Mail\Db\MailAccountMapper; | ||
| use OCA\Mail\Db\MailboxMapper; | ||
| use OCA\Mail\Db\MessageMapper; | ||
| use OCA\Mail\IMAP\IMAPClientFactory; | ||
| use OCA\Mail\IMAP\MessageMapper as ImapMessageMapper; | ||
| use Throwable; | ||
|
|
||
| class MessageOperationService { | ||
|
|
||
| public function __construct( | ||
| protected IMAPClientFactory $clientFactory, | ||
| protected MailAccountMapper $accountMapper, | ||
| protected MailboxMapper $mailboxMapper, | ||
| protected MessageMapper $messageMapper, | ||
| protected MailManager $mailManager, | ||
| protected ImapMessageMapper $imapMessageMapper, | ||
| ) { | ||
| } | ||
|
|
||
| /** | ||
| * convert message collection to grouped collections by mailbox id | ||
| * | ||
| * [[mailbox_id, uid, id]] to [mailbox_id => [[id, uid]]] | ||
| * | ||
| * @param array<array{0:int,1:int,2:int}> $collection | ||
| * | ||
| * @return array<int,array<array{0:int,1:int}>> | ||
| */ | ||
| protected function groupByMailbox(array $collection): array { | ||
| return array_reduce($collection, function ($carry, $pair) { | ||
|
Check failure on line 42 in lib/Service/MessageOperationService.php
|
||
| if (!isset($carry[$pair['mailbox_id']])) { | ||
| $carry[$pair['mailbox_id']] = []; | ||
| } | ||
| $carry[$pair['mailbox_id']][] = ['id' => $pair['id'], 'uid' => $pair['uid']]; | ||
| return $carry; | ||
| }, []); | ||
| } | ||
|
|
||
| /** | ||
| * convert mailbox collection to grouped collections by account id | ||
| * | ||
| * [mailbox] to [account_id => [mailbox]] | ||
| * | ||
| * @param array<\OCA\Mail\Db\MailBox> $collection | ||
|
Check failure on line 56 in lib/Service/MessageOperationService.php
|
||
| * | ||
| * @return array<int,array<\OCA\Mail\Db\MailBox>> | ||
|
Check failure on line 58 in lib/Service/MessageOperationService.php
|
||
| */ | ||
| protected function groupByAccount(array $collection) { | ||
| return array_reduce($collection, function ($carry, $entry) { | ||
| if (!isset($carry[$entry->getAccountId()])) { | ||
| $carry[$entry->getAccountId()] = []; | ||
| } | ||
| $carry[$entry->getAccountId()][] = $entry; | ||
| return $carry; | ||
| }, []); | ||
| } | ||
|
|
||
| /** | ||
| * generates operation status responses for each message | ||
| * | ||
| * @param array<int,bool> &$results | ||
| * @param bool $value | ||
| * @param array<\OCA\Mail\Db\MailBox> $mailboxes | ||
|
Check failure on line 75 in lib/Service/MessageOperationService.php
|
||
| * @param array<int,array<array{0:int,1:int}>> $messages | ||
| */ | ||
| protected function generateResult(array &$results, bool $value, array $mailboxes, array $messages) { | ||
| foreach ($mailboxes as $mailbox) { | ||
| foreach ($messages[$mailbox->getId()] as $message) { | ||
| $results[$message['id']] = $value; | ||
|
Check warning on line 81 in lib/Service/MessageOperationService.php
|
||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Set/Unset system flags or keywords | ||
| * | ||
| * @param string $userId system user id | ||
| * @param array<int> $identifiers message ids | ||
| * @param array<string,bool> $flags message flags | ||
| * | ||
| * @return array<int,bool> operation results | ||
| */ | ||
| public function changeFlags(string $userId, array $identifiers, array $flags): array { | ||
|
|
||
| // retrieve message meta data [uid, mailbox_id] for all messages and group by mailbox id | ||
| $messages = $this->groupByMailbox($this->messageMapper->findMailboxAndUid($identifiers)); | ||
| // retrieve all mailboxes and group by account | ||
| $mailboxes = $this->groupByAccount($this->mailboxMapper->findByIds(array_keys($messages))); | ||
|
Check warning on line 100 in lib/Service/MessageOperationService.php
|
||
| // retrieve all accounts | ||
| $accounts = $this->accountMapper->findByIds(array_keys($mailboxes)); | ||
| // process every account | ||
| $results = []; | ||
| foreach ($accounts as $account) { | ||
| $account = new Account($account); | ||
| // determine if account belongs to the user and skip if not | ||
| if ($account->getUserId() != $userId) { | ||
| // add messages to results as failed | ||
| $this->generateResult($results, false, $mailboxes[$account->getId()], $messages); | ||
| continue; | ||
| } | ||
| $client = $this->clientFactory->getClient($account); | ||
| // process every mailbox | ||
| foreach ($mailboxes[$account->getId()] as $mailbox) { | ||
| try { | ||
| // check if specific flags are supported and group them by action | ||
| $addFlags = []; | ||
| $removeFlags = []; | ||
| foreach ($flags as $flag => $value) { | ||
| $value = filter_var($value, FILTER_VALIDATE_BOOLEAN); | ||
| $imapFlags = $this->mailManager->filterFlags($client, $account, $flag, $mailbox->getName()); | ||
| if (empty($imapFlags)) { | ||
| continue; | ||
| } | ||
| if ($value) { | ||
| $addFlags = array_merge($addFlags, $imapFlags); | ||
| } else { | ||
| $removeFlags = array_merge($removeFlags, $imapFlags); | ||
| } | ||
| } | ||
| // apply flags to messages on server | ||
| $this->imapMessageMapper->setFlags( | ||
| $client, | ||
| $mailbox, | ||
| array_column($messages[$mailbox->getId()], 'uid'), | ||
| $addFlags, | ||
| $removeFlags | ||
| ); | ||
| // add messages to results as successful | ||
| $this->generateResult($results, true, [$mailbox], $messages); | ||
| } catch (Throwable $e) { | ||
| // add messages to results as failed | ||
| $this->generateResult($results, false, [$mailbox], $messages); | ||
| } | ||
| } | ||
| $client->logout(); | ||
| } | ||
|
|
||
| return $results; | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to check, but please move this down into the db when looking up accounts. Make it a WHERE id IN (xxx) AND user_id = 'sebastian'. That avoids loaded any foreign accounts.