feat: enable account debugging for sieve

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>

Author: kesselb

lib/Controller/SieveController.php

@@ -141,36 +141,40 @@ public function updateAccount(int $id,
 			$mailAccount->setSieveEnabled(false);
 			$mailAccount->setSieveHost(null);
 			$mailAccount->setSievePort(null);
+			$mailAccount->setSieveSslMode(null);
 			$mailAccount->setSieveUser(null);
 			$mailAccount->setSievePassword(null);
-			$mailAccount->setSieveSslMode(null);
 
 			$this->mailAccountMapper->save($mailAccount);
 			return new JSONResponse(['sieveEnabled' => $mailAccount->isSieveEnabled()]);
 		}
 
-		if (empty($sieveUser)) {
+		if (empty($sieveUser) && empty($sievePassword)) {
+			$useImapCredentials = true;
 			$sieveUser = $mailAccount->getInboundUser();
-		}
-
-		if (empty($sievePassword)) {
-			$sievePassword = $mailAccount->getInboundPassword();
+			/** @psalm-suppress PossiblyNullArgument */
+			$sievePassword = $this->crypto->decrypt($mailAccount->getInboundPassword());
 		} else {
-			$sievePassword = $this->crypto->encrypt($sievePassword);
+			$useImapCredentials = false;
 		}
 
 		try {
-			$this->sieveClientFactory->createClient($sieveHost, $sievePort, $sieveUser, $sievePassword, $sieveSslMode);
+			$this->sieveClientFactory->createClient($sieveHost, $sievePort, $sieveUser, $sievePassword, $sieveSslMode, null);
 		} catch (ManagesieveException $e) {
 			throw new CouldNotConnectException($e, 'ManageSieve', $sieveHost, $sievePort);
 		}
 
 		$mailAccount->setSieveEnabled(true);
 		$mailAccount->setSieveHost($sieveHost);
 		$mailAccount->setSievePort($sievePort);
-		$mailAccount->setSieveUser($mailAccount->getInboundUser() === $sieveUser ? null : $sieveUser);
-		$mailAccount->setSievePassword($mailAccount->getInboundPassword() === $sievePassword ? null : $sievePassword);
 		$mailAccount->setSieveSslMode($sieveSslMode);
+		if ($useImapCredentials) {
+			$mailAccount->setSieveUser(null);
+			$mailAccount->setSievePassword(null);
+		} else {
+			$mailAccount->setSieveUser($sieveUser);
+			$mailAccount->setSievePassword($this->crypto->encrypt($sievePassword));
+		}
 
 		$this->mailAccountMapper->save($mailAccount);
 		return new JSONResponse(['sieveEnabled' => $mailAccount->isSieveEnabled()]);

lib/Sieve/SieveClientFactory.php

@@ -15,26 +15,16 @@
 use OCP\Security\ICrypto;
 
 class SieveClientFactory {
-	/** @var ICrypto */
-	private $crypto;
+	private ICrypto $crypto;
+	private IConfig $config;
+	private array $cache = [];
 
-	/** @var IConfig */
-	private $config;
-
-	private $cache = [];
-
-	/**
-	 * @param ICrypto $crypto
-	 * @param IConfig $config
-	 */
 	public function __construct(ICrypto $crypto, IConfig $config) {
 		$this->crypto = $crypto;
 		$this->config = $config;
 	}
 
 	/**
-	 * @param Account $account
-	 * @return ManageSieve
 	 * @throws ManageSieve\Exception
 	 */
 	public function getClient(Account $account): ManageSieve {
@@ -48,28 +38,31 @@ public function getClient(Account $account): ManageSieve {
 				$password = $account->getMailAccount()->getInboundPassword();
 			}
 
+			if ($account->getDebug() || $this->config->getSystemValueBool('app.mail.debug')) {
+				$logFile = $this->config->getSystemValue('datadirectory') . '/mail-' . $account->getUserId() . '-' . $account->getId() . '-sieve.log';
+			} else {
+				$logFile = null;
+			}
+
 			$this->cache[$account->getId()] = $this->createClient(
 				$account->getMailAccount()->getSieveHost(),
 				$account->getMailAccount()->getSievePort(),
 				$user,
-				$password,
-				$account->getMailAccount()->getSieveSslMode()
+				$this->crypto->decrypt($password),
+				$account->getMailAccount()->getSieveSslMode(),
+				$logFile,
 			);
 		}
 
 		return $this->cache[$account->getId()];
 	}
 
 	/**
-	 * @param string $host
-	 * @param int $port
-	 * @param string $user
-	 * @param string $password
-	 * @param string $sslMode
-	 * @return ManageSieve
+	 * @param string $sslMode possible values: '', 'none', 'ssl' or 'tls'
+	 * @param ?string $logFile absolute path for logFile or null to disable logging
 	 * @throws ManageSieve\Exception
 	 */
-	public function createClient(string $host, int $port, string $user, string $password, string $sslMode): ManageSieve {
+	public function createClient(string $host, int $port, string $user, string $password, string $sslMode, ?string $logFile): ManageSieve {
 		if (empty($sslMode)) {
 			$sslMode = true;
 		} elseif ($sslMode === 'none') {
@@ -80,9 +73,9 @@ public function createClient(string $host, int $port, string $user, string $pass
 			'host' => $host,
 			'port' => $port,
 			'user' => $user,
-			'password' => $this->crypto->decrypt($password),
+			'password' => $password,
 			'secure' => $sslMode,
-			'timeout' => (int)$this->config->getSystemValue('app.mail.sieve.timeout', 5),
+			'timeout' => $this->config->getSystemValueInt('app.mail.sieve.timeout', 5),
 			'context' => [
 				'ssl' => [
 					'verify_peer' => $this->config->getSystemValueBool('app.mail.verify-tls-peer', true),
@@ -92,8 +85,8 @@ public function createClient(string $host, int $port, string $user, string $pass
 			],
 		];
 
-		if ($this->config->getSystemValue('debug', false)) {
-			$params['logger'] = new SieveLogger($this->config->getSystemValue('datadirectory') . '/horde_sieve.log');
+		if ($logFile !== null) {
+			$params['logger'] = new SieveLogger($logFile);
 		}
 
 		return new ManageSieve($params);

tests/Integration/Sieve/SieveClientFactoryTest.php

@@ -35,20 +35,16 @@ protected function setUp(): void {
 		$this->crypto = $this->createMock(ICrypto::class);
 		$this->config = $this->createMock(IConfig::class);
 
-		$this->config->method('getSystemValue')
-			->willReturnCallback(static function ($key, $default) {
-				if ($key === 'app.mail.sieve.timeout') {
-					return 5;
-				}
-				if ($key === 'debug') {
-					return false;
-				}
-				return null;
-			});
+		$this->config->method('getSystemValueInt')
+			->willReturnMap([
+				['app.mail.sieve.timeout', 5, 5],
+			]);
 
 		$this->config->method('getSystemValueBool')
-			->with('app.mail.verify-tls-peer', true)
-			->willReturn(false);
+			->willReturnMap([
+				['app.mail.verify-tls-peer', true, false],
+				['app.mail.debug', false, false],
+			]);
 
 		$this->factory = new SieveClientFactory($this->crypto, $this->config);
 	}