refactor: Consolidate account classes

Signed-off-by: Christoph Wurst <[email protected]>
nextcloud · Sep 17, 2024 · 880e2f8 · 880e2f8
1 parent b1c5609
commit 880e2f8
Show file tree

Hide file tree

Showing 101 changed files with 1,621 additions and 1,235 deletions.
diff --git a/lib/Account.php b/lib/Account.php
@@ -9,71 +9,14 @@
  */
 namespace OCA\Mail;
 
-use JsonSerializable;
 use OCA\Mail\Db\MailAccount;
-use OCA\Mail\Service\Quota;
-use ReturnTypeWillChange;
 
-class Account implements JsonSerializable {
+class Account {
 	public function __construct(private MailAccount $account) {
 	}
 
 	public function getMailAccount(): MailAccount {
 		return $this->account;
 	}
 
-	/**
-	 * @return int
-	 */
-	public function getId() {
-		return $this->account->getId();
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getName() {
-		return $this->account->getName();
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getEMailAddress() {
-		return $this->account->getEmail();
-	}
-
-	#[ReturnTypeWillChange]
-	public function jsonSerialize() {
-		return $this->account->toJson();
-	}
-
-	public function getEmail(): string {
-		return $this->account->getEmail();
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getUserId() {
-		return $this->account->getUserId();
-	}
-
-	/**
-	 * Set the quota percentage
-	 * @param Quota $quota
-	 * @return void
-	 */
-	public function calculateAndSetQuotaPercentage(Quota $quota): void {
-		if ($quota->getLimit() === 0) {
-			$this->account->setQuotaPercentage(0);
-			return;
-		}
-		$percentage = (int)round($quota->getUsage() / $quota->getLimit() * 100);
-		$this->account->setQuotaPercentage($percentage);
-	}
-
-	public function getQuotaPercentage(): ?int {
-		return $this->account->getQuotaPercentage();
-	}
 }
diff --git a/lib/BackgroundJob/MigrateImportantJob.php b/lib/BackgroundJob/MigrateImportantJob.php
@@ -9,7 +9,6 @@
 
 namespace OCA\Mail\BackgroundJob;
 
-use OCA\Mail\Account;
 use OCA\Mail\Db\MailAccountMapper;
 use OCA\Mail\Db\MailboxMapper;
 
@@ -65,27 +64,25 @@ public function run($argument) {
 		try {
 			$mailAccount = $this->mailAccountMapper->findById($accountId);
 		} catch (DoesNotExistException $e) {
-			$this->logger->debug('Could not find account <' . $accountId . '>');
+			$this->logger->debug('Could not find mailAccount <' . $accountId . '>');
 			return;
 		}
 
-		$account = new Account($mailAccount);
-		$client = $this->imapClientFactory->getClient($account);
-
+		$client = $this->imapClientFactory->getClient($mailAccount);
 		try {
-			if ($this->mailManager->isPermflagsEnabled($client, $account, $mailbox->getName()) === false) {
+			if ($this->mailManager->isPermflagsEnabled($client, $mailAccount, $mailbox->getName()) === false) {
 				$this->logger->debug('Permflags not enabled for <' . $accountId . '>');
 				return;
 			}
 
 			try {
-				$this->migration->migrateImportantOnImap($client, $account, $mailbox);
+				$this->migration->migrateImportantOnImap($client, $mailbox);
 			} catch (ServiceException $e) {
 				$this->logger->debug('Could not flag messages on IMAP for mailbox <' . $mailboxId . '>.');
 			}
 
 			try {
-				$this->migration->migrateImportantFromDb($client, $account, $mailbox);
+				$this->migration->migrateImportantFromDb($client, $mailbox);
 			} catch (ServiceException $e) {
 				$this->logger->debug('Could not flag messages from DB on IMAP for mailbox <' . $mailboxId . '>.');
 			}

diff --git a/lib/BackgroundJob/PreviewEnhancementProcessingJob.php b/lib/BackgroundJob/PreviewEnhancementProcessingJob.php
@@ -57,7 +57,7 @@ public function run($argument) {
 			return;
 		}
 
-		if (!$account->getMailAccount()->canAuthenticateImap()) {
+		if (!$account->canAuthenticateImap()) {
 			$this->logger->info('Ignoring preprocessing job for provisioned account as athentication on IMAP not possible');
 			return;
 		}

diff --git a/lib/BackgroundJob/QuotaJob.php b/lib/BackgroundJob/QuotaJob.php
@@ -8,7 +8,6 @@
 
 namespace OCA\Mail\BackgroundJob;
 
-use OCA\Mail\Account;
 use OCA\Mail\Contracts\IMailManager;
 use OCA\Mail\Service\AccountService;
 use OCP\AppFramework\Db\DoesNotExistException;
@@ -18,6 +17,7 @@
 use OCP\IUserManager;
 use OCP\Notification\IManager;
 use Psr\Log\LoggerInterface;
+use function round;
 use function sprintf;
 
 class QuotaJob extends TimedJob {
@@ -54,15 +54,14 @@ public function __construct(ITimeFactory $time,
 	protected function run($argument): void {
 		$accountId = (int)$argument['accountId'];
 		try {
-			/** @var Account $account */
 			$account = $this->accountService->findById($accountId);
 		} catch (DoesNotExistException $e) {
 			$this->logger->debug('Could not find account <' . $accountId . '> removing from jobs');
 			$this->jobList->remove(self::class, $argument);
 			return;
 		}
 
-		if(!$account->getMailAccount()->canAuthenticateImap()) {
+		if(!$account->canAuthenticateImap()) {
 			$this->logger->debug('No authentication on IMAP possible, skipping quota job');
 			return;
 		}
@@ -82,9 +81,14 @@ protected function run($argument): void {
 			$this->logger->debug('Could not get quota information for account <' . $account->getEmail() . '>', ['app' => 'mail']);
 			return;
 		}
-		$previous = $account->getMailAccount()->getQuotaPercentage();
-		$account->calculateAndSetQuotaPercentage($quota);
-		$this->accountService->update($account->getMailAccount());
+		$previous = $account->getQuotaPercentage();
+		if ($quota->getLimit() === 0) {
+			$account->setQuotaPercentage(0);
+			return;
+		}
+		$percentage = (int)round($quota->getUsage() / $quota->getLimit() * 100);
+		$account->setQuotaPercentage($percentage);
+		$this->accountService->update($account);
 		$current = $account->getQuotaPercentage();
 
 		// Only notify if we've reached the rising edge

diff --git a/lib/BackgroundJob/SyncJob.php b/lib/BackgroundJob/SyncJob.php
@@ -73,7 +73,7 @@ protected function run($argument) {
 			return;
 		}
 
-		if(!$account->getMailAccount()->canAuthenticateImap()) {
+		if(!$account->canAuthenticateImap()) {
 			$this->logger->debug('No authentication on IMAP possible, skipping background sync job');
 			return;
 		}

diff --git a/lib/BackgroundJob/TrainImportanceClassifierJob.php b/lib/BackgroundJob/TrainImportanceClassifierJob.php
@@ -58,7 +58,7 @@ protected function run($argument) {
 			return;
 		}
 
-		if(!$account->getMailAccount()->canAuthenticateImap()) {
+		if(!$account->canAuthenticateImap()) {
 			$this->logger->debug('Cron importance classifier training not possible: no authentication on IMAP possible');
 			return;
 		}

diff --git a/lib/BackgroundJob/TrashRetentionJob.php b/lib/BackgroundJob/TrashRetentionJob.php
@@ -9,8 +9,8 @@
 
 namespace OCA\Mail\BackgroundJob;
 
-use OCA\Mail\Account;
 use OCA\Mail\Contracts\IMailManager;
+use OCA\Mail\Db\MailAccount;
 use OCA\Mail\Db\MailAccountMapper;
 use OCA\Mail\Db\MailboxMapper;
 use OCA\Mail\Db\MessageMapper;
@@ -46,9 +46,7 @@ public function __construct(
 	public function run($argument) {
 		$accounts = $this->accountMapper->getAllAccounts();
 		foreach ($accounts as $account) {
-			$account = new Account($account);
-
-			$retentionDays = $account->getMailAccount()->getTrashRetentionDays();
+			$retentionDays = $account->getTrashRetentionDays();
 			if ($retentionDays === null || $retentionDays <= 0) {
 				continue;
 			}
@@ -62,7 +60,7 @@ public function run($argument) {
 					'exception' => $e,
 					'userId' => $account->getUserId(),
 					'accountId' => $account->getId(),
-					'trashMailboxId' => $account->getMailAccount()->getTrashMailboxId(),
+					'trashMailboxId' => $account->getTrashMailboxId(),
 				]);
 			}
 		}
@@ -73,8 +71,8 @@ public function run($argument) {
 	 * @throws ClientException
 	 * @throws ServiceException
 	 */
-	private function cleanTrash(Account $account, int $retentionSeconds): void {
-		$trashMailboxId = $account->getMailAccount()->getTrashMailboxId();
+	private function cleanTrash(MailAccount $account, int $retentionSeconds): void {
+		$trashMailboxId = $account->getTrashMailboxId();
 		if ($trashMailboxId === null) {
 			return;
 		}

diff --git a/lib/Command/DeleteAccount.php b/lib/Command/DeleteAccount.php
@@ -9,7 +9,7 @@
 
 namespace OCA\Mail\Command;
 
-use OCA\Mail\Account;
+use OCA\Mail\Db\MailAccount;
 use OCA\Mail\Exception\ClientException;
 use OCA\Mail\Service\AccountService;
 use OCP\AppFramework\Db\DoesNotExistException;
@@ -53,7 +53,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		}
 		$output->writeLn('<info>Found account with email: ' . $account->getEmail() . '</info>');
 
-		if (!is_null($account->getMailAccount()->getProvisioningId())) {
+		if (!is_null($account->getProvisioningId())) {
 			$output->writeLn('<error>This is a provisioned account which can not be deleted from CLI. Use the Provisioning UI instead.</error>');
 			return 2;
 		}
@@ -63,7 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		return 0;
 	}
 
-	private function delete(Account $account, OutputInterface $output): void {
+	private function delete(MailAccount $account, OutputInterface $output): void {
 		$id = $account->getId();
 		try {
 			$this->accountService->deleteByAccountId($account->getId());

diff --git a/lib/Command/DiagnoseAccount.php b/lib/Command/DiagnoseAccount.php
@@ -61,7 +61,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			return 1;
 		}
 
-		if ($account->getMailAccount()->getInboundPassword() === null) {
+		if ($account->getInboundPassword() === null) {
 			$output->writeln('<error>No IMAP passwort set. The user might have to log into their account to set it.</error>');
 		}
 		$imapClient = $this->clientFactory->getClient($account);