fix: perform bulk message actions

lib/Controller/MessagesController.php

@@ -30,11 +30,14 @@
 use OCA\Mail\Service\AccountService;
 use OCA\Mail\Service\AiIntegrations\AiIntegrationsService;
 use OCA\Mail\Service\ItineraryService;
+use OCA\Mail\Service\MessageOperationService;
 use OCA\Mail\Service\SmimeService;
 use OCA\Mail\Service\SnoozeService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\FrontpageRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\Attribute\OpenAPI;
 use OCP\AppFramework\Http\ContentSecurityPolicy;
 use OCP\AppFramework\Http\JSONResponse;
@@ -74,7 +77,8 @@
 	private SnoozeService $snoozeService;
 	private AiIntegrationsService $aiIntegrationService;
 
-	public function __construct(string $appName,
+	public function __construct(
+		string $appName,
 		IRequest $request,
 		AccountService $accountService,
 		IMailManager $mailManager,
@@ -94,7 +98,9 @@
 		IDkimService $dkimService,
 		IUserPreferences $preferences,
 		SnoozeService $snoozeService,
-		AiIntegrationsService $aiIntegrationService) {
+		AiIntegrationsService $aiIntegrationService,
+		private MessageOperationService $messageOperationService,
+	) {
 		parent::__construct($appName, $request);
 		$this->accountService = $accountService;
 		$this->mailManager = $mailManager;
@@ -782,6 +788,24 @@
 		return new JSONResponse();
 	}
 
+	/**
+	 *
+	 * @NoAdminRequired
+	 *
+	 * @param array<int,int> $identifiers
+	 * @param array<string,bool> $flags
+	 *
+	 * @return JSONResponse
+	 */
+	#[FrontpageRoute(verb: 'PUT', url: '/api/messages/flags')]
+	#[NoAdminRequired]
+	#[TrapError]
+	public function changeFlags(array $identifiers, array $flags): JSONResponse {
+		return new JSONResponse(
+			$this->messageOperationService->changeFlags($this->currentUserId, $identifiers, $flags)
+		);
+	}
+
 	/**
 	 * @NoAdminRequired
 	 *
@@ -882,7 +906,7 @@
 	#[TrapError]
 	public function smartReply(int $messageId):JSONResponse {
 		try {
 			$message = $this->mailManager->getMessage($this->currentUserId, $messageId);
 			$mailbox = $this->mailManager->getMailbox($this->currentUserId, $message->getMailboxId());
 			$account = $this->accountService->find($this->currentUserId, $mailbox->getAccountId());
 		} catch (DoesNotExistException $e) {

lib/Db/MailAccountMapper.php

@@ -66,6 +66,29 @@
 		return $this->findEntity($query);
 	}
 
+	/**
+	 * Finds all mail accounts by account ids
+	 *
+	 * @param string $userId
+	 * @param array<int,int> $identifiers
+	 *
+	 * @return array<int,MailAccount>
+	 */
+	public function findByIds(string $userId, array $identifiers): array {
+
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where(
+				$qb->expr()->eq('user_id', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR), IQueryBuilder::PARAM_STR)
+			)
+			->andWhere(
+				$qb->expr()->in('id', $qb->createNamedParameter($identifiers, IQueryBuilder::PARAM_STR_ARRAY), IQueryBuilder::PARAM_STR_ARRAY)
+			);
+
+		return $this->findEntities($qb);
+	}
+
 	/**
 	 * Finds all Mail Accounts by user id existing for this user
 	 *

lib/Db/MailboxMapper.php

@@ -113,7 +113,9 @@ public function findById(int $id): Mailbox {
 	}
 
 	/**
-	 * @return Mailbox[]
+	 * @param array<int> $ids
+	 *
+	 * @return array<Mailbox>
 	 *
 	 * @throws Exception
 	 */

lib/Db/MessageMapper.php

@@ -178,6 +178,28 @@
 		}, array_chunk($ids, 1000));
 	}
 
+	/**
+	 * @param array<int,int> $identifiers
+	 *
+	 * @return array
+	 */
+	public function findMailboxAndUid(array $identifiers): array {
+
+		if ($identifiers === []) {
+			return [];
+		}
+
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('id', 'mailbox_id', 'uid')
+			->from($this->getTableName())
+			->where(
+				$qb->expr()->in('id', $qb->createNamedParameter($identifiers, IQueryBuilder::PARAM_STR_ARRAY), IQueryBuilder::PARAM_STR_ARRAY)
+			);
+
+		return $qb->executeQuery()->fetchAll();
+
+	}
+
 	/**
 	 * @param Account $account
 	 *

lib/IMAP/MessageMapper.php

@@ -439,6 +439,44 @@
 		);
 	}
 
+	/**
+	 * @throws Horde_Imap_Client_Exception
+	 */
+	public function setFlags(
+		Horde_Imap_Client_Socket $client,
+		Mailbox $mailbox,
+		array $uids,
+		array $addFlags = [],
+		array $removeFlags = [],
+		array $replaceFlags = [],
+	): array {
+
+		if (count($uids) === 0) {
+			return [];
+		}
+
+		$cmd = [];
+
+		if (count($replaceFlags) > 0) {
+			$cmd['replace'] = $replaceFlags;
+		} else {
+			if (count($addFlags) > 0) {
+				$cmd['add'] = $addFlags;
+			}
+			if (count($removeFlags) > 0) {
+				$cmd['remove'] = $removeFlags;
+			}
+		}
+
+		if (count($cmd) > 0) {
+			$cmd['ids'] = new Horde_Imap_Client_Ids($uids);
+			$result = $client->store($mailbox->getName(), $cmd);
+			return $result->ids;
+		}
+
+		return [];
+	}
+
 	/**
 	 * @param Horde_Imap_Client_Socket $client
 	 * @param Mailbox $mailbox

lib/Service/MessageOperationService.php

@@ -0,0 +1,147 @@
+<?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<int,array{0:int,1:int,2:int}>>
+	 */
+	protected function groupByMailbox(array $collection): array {
+		return array_reduce($collection, function ($carry, $pair) {
+			if (!isset($carry[$pair['mailbox_id']])) {
+				$carry[$pair['mailbox_id']] = [];
+			}
+			$carry[(int)$pair['mailbox_id']][] = ['id' => (int)$pair['id'], 'uid' => (int)$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
+	 *
+	 * @return array<int,array<\OCA\Mail\Db\Mailbox>>
+	 */
+	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
+	 * @param array<int,array<array{id:int,uid: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;
+			}
+		}
+	}
+
+	/**
+	 * 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)));
+		// retrieve all accounts
+		$accounts = $this->accountMapper->findByIds($userId, array_keys($mailboxes));
+		// process every account
+		$results = [];
+		foreach ($accounts as $account) {
+			$account = new Account($account);
+			$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;
+	}
+
+}