feat: mail provider backend

Signed-off-by: SebastianKrupinski <[email protected]>
nextcloud · Sep 8, 2024 · 7f85f0d · 7f85f0d
1 parent 9d2deda
commit 7f85f0d
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 79 deletions.
diff --git a/lib/Provider/Command/MessageSend.php b/lib/Provider/Command/MessageSend.php
@@ -9,19 +9,19 @@
 namespace OCA\Mail\Provider\Command;
 
 use OCA\Mail\Db\LocalMessage;
+use OCA\Mail\Exception\ClientException;
+use OCA\Mail\Exception\UploadException;
 use OCA\Mail\Service\AccountService;
 use OCA\Mail\Service\Attachment\AttachmentService;
 use OCA\Mail\Service\OutboxService;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\IConfig;
 use OCP\Mail\Provider\Exception\SendException;
 use OCP\Mail\Provider\IAddress;
 use OCP\Mail\Provider\IMessage;
 
 class MessageSend {
 
 	public function __construct(
-		protected IConfig $config,
 		protected ITimeFactory $time,
 		protected AccountService $accountService,
 		protected OutboxService $outboxService,
@@ -66,7 +66,7 @@ public function perform(string $userId, string $serviceId, IMessage $message, ar
 		// retrieve user mail account details
 		try {
 			$account = $this->accountService->find($userId, (int)$serviceId);
-		} catch (\Throwable $e) {
+		} catch (ClientException $e) {
 			throw new SendException('Error: occurred while retrieving mail account details', 0, $e);
 		}
 		// convert mail provider message to mail app message
@@ -79,29 +79,26 @@ public function perform(string $userId, string $serviceId, IMessage $message, ar
 		//$localMessage->setEditorBody($message->getBody());
 		$localMessage->setHtml(true);
 		$localMessage->setSendAt($this->time->getTime());
-		// convert all mail provider attachments to local attachments
+		// convert mail provider addresses to recipient addresses
+		$to = $this->convertAddressArray($message->getTo());
+		$cc = $this->convertAddressArray($message->getCc());
+		$bcc = $this->convertAddressArray($message->getBcc());
+		// save attachments
 		$attachments = [];
-		if (count($message->getAttachments()) > 0) {
-			// iterate attachments and save them
+		try {
 			foreach ($message->getAttachments() as $entry) {
-				// convert mail provider attachment to mail app attachment
-				try {
-					$attachments[] = $this->attachmentService->addFileFromString(
-						$userId,
-						(string)$entry->getName(),
-						(string)$entry->getType(),
-						(string)$entry->getContents()
-					)->jsonSerialize();
-				} catch (\Throwable $e) {
-					throw new SendException('Error: occurred while saving mail message attachment', 0, $e);
-				}
+				$attachments[] = $this->attachmentService->addFileFromString(
+					$userId,
+					(string)$entry->getName(),
+					(string)$entry->getType(),
+					(string)$entry->getContents()
+				)->jsonSerialize();
 			}
+		} catch (UploadException $e) {
+			$this->purgeSavedAttachments($attachments);
+			throw new SendException('Error: occurred while saving mail message attachment', 0, $e);
 		}
-		// convert recipient addresses
-		$to = $this->convertAddressArray($message->getTo());
-		$cc = $this->convertAddressArray($message->getCc());
-		$bcc = $this->convertAddressArray($message->getBcc());
-		// save message for sending
+		// save message
 		try {
 			$localMessage = $this->outboxService->saveMessage(
 				$account,
@@ -112,6 +109,7 @@ public function perform(string $userId, string $serviceId, IMessage $message, ar
 				$attachments
 			);
 		} catch (\Throwable $e) {
+			$this->purgeSavedAttachments($attachments);
 			throw new SendException('Error: occurred while saving mail message', 0, $e);
 		}
 		// send message
@@ -131,7 +129,7 @@ public function perform(string $userId, string $serviceId, IMessage $message, ar
 	 *
 	 * @param array<int,IAddress> $addresses collection of IAddress objects
 	 *
-	 * @return array collection of addresses and labels e.g. [[email => '[email protected]', 'User One']]
+	 * @return array<int, array{email: string, label?: string}> collection of addresses and labels
 	 */
 	protected function convertAddressArray(array $addresses): array {
 		return array_map(static function (IAddress $address) {
@@ -141,4 +139,19 @@ protected function convertAddressArray(array $addresses): array {
 		}, $addresses);
 	}
 
+	/**
+	 *
+	 *
+	 * @since 4.0.0
+	 *
+	 * @param array
+	 *
+	 * @return array
+	 */
+	protected function purgeSavedAttachments(array $attachments): void {
+		foreach ($attachments as $attachment) {
+			$this->attachmentService->deleteAttachment($attachment->getUserId(), $attachment->getId());
+		}
+	}
+
 }
diff --git a/lib/Provider/MailProvider.php b/lib/Provider/MailProvider.php
@@ -9,6 +9,7 @@
 namespace OCA\Mail\Provider;
 
 use OCA\Mail\Account;
+use OCA\Mail\Exception\ClientException;
 use OCA\Mail\Service\AccountService;
 use OCP\IL10N;
 use OCP\Mail\Provider\Address as MailAddress;
@@ -73,12 +74,7 @@ public function hasServices(string $userId): bool {
 	 */
 	public function listServices(string $userId): array {
 		// retrieve service(s) details from data store
-		try {
-			$accounts = $this->accountService->findByUserId($userId);
-		} catch (\Throwable $e) {
-			$this->logger->error('Error occurred while retrieving mail account details', [ 'exception' => $e ]);
-			return [];
-		}
+		$accounts = $this->accountService->findByUserId($userId);
 		// construct temporary collection
 		$services = [];
 		// add services to collection
@@ -108,7 +104,7 @@ public function findServiceById(string $userId, string $serviceId): IService|nul
 		// retrieve service details from data store
 		try {
 			$account = $this->accountService->find($userId, (int)$serviceId);
-		} catch(\Throwable $e) {
+		} catch(ClientException $e) {
 			$this->logger->error('Error occurred while retrieving mail account details', [ 'exception' => $e ]);
 			return null;
 		}
@@ -128,12 +124,7 @@ public function findServiceById(string $userId, string $serviceId): IService|nul
 	 */
 	public function findServiceByAddress(string $userId, string $address): IService|null {
 		// retrieve service details from data store
-		try {
-			$accounts = $this->accountService->findByUserIdAndAddress($userId, $address);
-		} catch(\Throwable $e) {
-			$this->logger->error('Error occurred while retrieving mail account details', [ 'exception' => $e ]);
-			return null;
-		}
+		$accounts = $this->accountService->findByUserIdAndAddress($userId, $address);
 		// evaluate if service details where found
 		if (count($accounts) > 0) {
 			// return mail service object

diff --git a/tests/Unit/Provider/Command/MessageSendTest.php b/tests/Unit/Provider/Command/MessageSendTest.php
@@ -13,12 +13,13 @@
 use OCA\Mail\Db\LocalAttachment;
 use OCA\Mail\Db\LocalMessage;
 use OCA\Mail\Db\MailAccount;
+use OCA\Mail\Exception\ClientException;
+use OCA\Mail\Exception\UploadException;
 use OCA\Mail\Provider\Command\MessageSend;
 use OCA\Mail\Service\AccountService;
 use OCA\Mail\Service\Attachment\AttachmentService;
 use OCA\Mail\Service\OutboxService;
 use OCP\AppFramework\Utility\ITimeFactory;
-use OCP\IConfig;
 use OCP\Mail\Provider\Address;
 use OCP\Mail\Provider\Attachment;
 use OCP\Mail\Provider\Exception\SendException;
@@ -32,18 +33,18 @@ class MessageSendTest extends TestCase {
 	private AccountService&MockObject $accountService;
 	private OutboxService&MockObject $outboxService;
 	private AttachmentService&MockObject $attachmentService;
-	private $commandSend;
+	private MessageSend $commandSend;
+	private Message $mailMessage;
 
 	protected function setUp(): void {
 		parent::setUp();
 		// construct mock constructor parameters
-		$this->config = $this->createMock(IConfig::class);
 		$this->time = $this->createMock(ITimeFactory::class);
 		$this->accountService = $this->createMock(AccountService::class);
 		$this->outboxService = $this->createMock(OutboxService::class);
 		$this->attachmentService = $this->createMock(AttachmentService::class);
 		// construct test object
-		$this->commandSend = new MessageSend($this->config, $this->time, $this->accountService, $this->outboxService, $this->attachmentService);
+		$this->commandSend = new MessageSend($this->time, $this->accountService, $this->outboxService, $this->attachmentService);
 		// construct mail provider attachment
 		$this->mailAttachment = new Attachment(
 			'This is the contents of our plan',
@@ -229,7 +230,7 @@ public function testPerformWithAccountServiceFailure(): void {
 		$this->time->method('getTime')->willReturn(1719792000);
 		// define account service returns
 		$this->accountService->method('find')->will(
-			$this->throwException(new \Exception('Something went wrong'))
+			$this->throwException(new ClientException('Something went wrong'))
 		);
 
 		// construct mail provider message
@@ -258,7 +259,7 @@ public function testPerformWithAttachmentServiceFailure(): void {
 				$this->mailAttachment->getType(),
 				$this->mailAttachment->getContents()
 			)->will(
-				$this->throwException(new \Exception('Something went wrong'))
+				$this->throwException(new UploadException('Something went wrong'))
 			);
 		// construct mail provider message with attachment
 		$mailMessage = $this->mailMessage;

diff --git a/tests/Unit/Provider/MailProviderTest.php b/tests/Unit/Provider/MailProviderTest.php
@@ -76,16 +76,12 @@ public function testHasServices(): void {
 			'smtpUser' => '',
 		]));
 		// define account services find
-		$this->accountService
-			->expects($this->any())
-			->method('findByUserId')
+		$this->accountService->expects($this->any())->method('findByUserId')
 			->will(
-				$this->returnValueMap(
-					[
-						['user0', []],
-						['user1', [100 => $mailAccount]]
-					]
-				)
+				$this->returnValueMap([
+					['user0', []],
+					['user1', [100 => $mailAccount]]
+				])
 			);
 		// construct mail provider
 		$mailProvider = new MailProvider($this->containerInterface, $this->accountService, $this->logger, $this->l10n);
@@ -121,16 +117,12 @@ public function testListServices(): void {
 			new MailAddress('[email protected]', 'User One')
 		);
 		// define account services find
-		$this->accountService
-			->expects($this->any())
-			->method('findByUserId')
+		$this->accountService->expects($this->any())->method('findByUserId')
 			->will(
-				$this->returnValueMap(
-					[
-						['user0', []],
-						['user1', [$mailAccount]]
-					]
-				)
+				$this->returnValueMap([
+					['user0', []],
+					['user1', [$mailAccount]]
+				])
 			);
 		// construct mail provider
 		$mailProvider = new MailProvider($this->containerInterface, $this->accountService, $this->logger, $this->l10n);
@@ -166,16 +158,12 @@ public function testFindServiceById(): void {
 			new MailAddress('[email protected]', 'User One')
 		);
 		// define account services find
-		$this->accountService
-			->expects($this->any())
-			->method('find')
-			->will(
-				$this->returnValueMap(
-					[
-						['user0', 100, $this->throwException(new ClientException())],
-						['user1', 100, $mailAccount]
-					]
-				)
+		$this->accountService->expects($this->any())->method('find')
+			->willReturnCallback(
+				fn (string $userId, int $serviceId) => match (true) {
+					$userId === 'user1' && $serviceId === 100 => $mailAccount,
+					default => throw new ClientException()
+				}
 			);
 		// construct mail provider
 		$mailProvider = new MailProvider($this->containerInterface, $this->accountService, $this->logger, $this->l10n);
@@ -211,16 +199,12 @@ public function testFindServiceByAddress(): void {
 			new MailAddress('[email protected]', 'User One')
 		);
 		// define account services find
-		$this->accountService
-			->expects($this->any())
-			->method('findByUserIdAndAddress')
+		$this->accountService->expects($this->any())->method('findByUserIdAndAddress')
 			->will(
-				$this->returnValueMap(
-					[
-						['user0', '[email protected]', $this->throwException(new ClientException())],
-						['user1', '[email protected]', [$mailAccount]]
-					]
-				)
+				$this->returnValueMap([
+					['user0', '[email protected]', []],
+					['user1', '[email protected]', [$mailAccount]]
+				])
 			);
 		// construct mail provider
 		$mailProvider = new MailProvider($this->containerInterface, $this->accountService, $this->logger, $this->l10n);