-
Notifications
You must be signed in to change notification settings - Fork 263
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.
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
fix: perform bulk message actions #10280
base: main
Are you sure you want to change the base?
Changes from 2 commits
7d4f62f
442750b
ccfe0da
47361c7
def7d68
8a4525e
bdfe6f2
fa0f79a
ae9a9a8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 GitHub Actions / static-psalm-analysis dev-masterInvalidReturnStatement
|
||
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 GitHub Actions / static-psalm-analysis dev-masterInvalidClass
|
||
* | ||
* @return array<int,array<\OCA\Mail\Db\MailBox>> | ||
Check failure on line 58 in lib/Service/MessageOperationService.php GitHub Actions / static-psalm-analysis dev-masterInvalidClass
|
||
*/ | ||
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 GitHub Actions / static-psalm-analysis dev-masterInvalidClass
|
||
* @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 failure on line 81 in lib/Service/MessageOperationService.php GitHub Actions / static-psalm-analysis dev-masterInvalidArrayOffset
|
||
} | ||
} | ||
} | ||
|
||
/** | ||
* 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 failure on line 100 in lib/Service/MessageOperationService.php GitHub Actions / static-psalm-analysis dev-masterInvalidArgument
|
||
// 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; | ||
} | ||
|
||
} |
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.