MailProvider.php

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
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;
use OCP\Mail\Provider\IProvider;
use OCP\Mail\Provider\IService;
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerInterface;

class MailProvider implements IProvider {

	public function __construct(
		protected ContainerInterface $container,
		protected AccountService $accountService,
		protected LoggerInterface $logger,
		protected IL10N $l10n,
	) {
	}

	/**
	 * Arbitrary unique text string identifying this provider
	 *
	 * @since 4.0.0
	 *
	 * @return string id of this provider (e.g. UUID or 'IMAP/SMTP' or anything else)
	 */
	#[\Override]
	public function id(): string {
		return 'mail-application';
	}

	/**
	 * Localized human friendly name of this provider
	 *
	 * @since 4.0.0
	 *
	 * @return string label/name of this provider (e.g. Plain Old IMAP/SMTP)
	 */
	#[\Override]
	public function label(): string {
		return $this->l10n->t('Mail Application');
	}

	/**
	 * Determine if any services are configured for a specific user
	 *
	 * @since 4.0.0
	 *
	 * @param string $userId system user id
	 *
	 * @return bool true if any services are configure for the user
	 */
	#[\Override]
	public function hasServices(string $userId): bool {
		return ($this->listServices($userId) !== []);
	}

	/**
	 * Retrieve collection of services for a specific user
	 *
	 * @since 4.0.0
	 *
	 * @param string $userId system user id
	 *
	 * @return array<string,IService> collection of service id and object ['1' => IServiceObject]
	 */
	#[\Override]
	public function listServices(string $userId): array {
		// retrieve service(s) details from data store
		$accounts = $this->accountService->findByUserId($userId);
		// construct temporary collection
		$services = [];
		// add services to collection
		foreach ($accounts as $entry) {
			$services[(string)$entry->getId()] = $this->serviceFromAccount($userId, $entry);
		}
		// return list of services for user
		return $services;
	}

	/**
	 * Retrieve a service with a specific id
	 *
	 * @since 4.0.0
	 *
	 * @param string $userId system user id
	 * @param string $serviceId mail account id
	 *
	 * @return IService|null returns service object or null if none found
	 *
	 */
	#[\Override]
	public function findServiceById(string $userId, string $serviceId): ?IService {
		// determine if a valid user and service id was submitted
		if (empty($userId) && !ctype_digit($serviceId)) {
			return null;
		}
		// retrieve service details from data store
		try {
			$account = $this->accountService->find($userId, (int)$serviceId);
		} catch (ClientException $e) {
			$this->logger->error('Error occurred while retrieving mail account details', [ 'exception' => $e ]);
			return null;
		}
		// return mail service object
		return $this->serviceFromAccount($userId, $account);
	}

	/**
	 * Retrieve a service for a specific mail address
	 *
	 * @since 4.0.0
	 *
	 * @param string $userId system user id
	 * @param string $address mail address (e.g. test@example.com)
	 *
	 * @return IService|null returns service object or null if none found
	 */
	#[\Override]
	public function findServiceByAddress(string $userId, string $address): ?IService {
		// retrieve service details from data store
		$accounts = $this->accountService->findByUserIdAndAddress($userId, $address);
		// evaluate if service details where found
		if ($accounts !== []) {
			// return mail service object
			return $this->serviceFromAccount($userId, $accounts[0]);
		}

		return null;
	}

	/**
	 * Construct a new fresh service object
	 *
	 * @since 4.0.0
	 *
	 * @return IService fresh service object
	 */
	#[\Override]
	public function initiateService(): IService {
		return new MailService($this->container);
	}

	/**
	 * Construct a service object from a mail account
	 *
	 * @since 4.0.0
	 *
	 * @param string $userId system user id
	 * @param Account $account mail account
	 *
	 * @return IService service object
	 */
	protected function serviceFromAccount(string $userId, Account $account): IService {
		// extract values
		$serviceId = (string)$account->getId();
		$serviceLabel = $account->getName();
		$serviceAddress = new MailAddress($account->getEmail(), $account->getName());
		// return mail service object
		return new MailService($this->container, $userId, $serviceId, $serviceLabel, $serviceAddress);
	}

}