feat: per account imap and smtp debugging

Signed-off-by: SebastianKrupinski <krupinskis05@gmail.com>
nextcloud · Oct 29, 2024 · 421a8dc · 421a8dc
1 parent 43cfb5a
commit 421a8dc
Show file tree

Hide file tree

Showing 10 changed files with 153 additions and 6 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -184,7 +184,7 @@ jobs:
             run: echo "SELECT * FROM mysql.slow_log WHERE sql_text LIKE '%oc_mail%' AND sql_text NOT LIKE '%information_schema%'" | mysql -h 127.0.0.1 -u root -pmy-secret-pw
           - name: Print debug logs
             if: ${{ always() }}
-            run: cat nextcloud/data/horde_*.log
+            run: cat nextcloud/data/mail-*-*-imap.log
           - name: Report coverage
             uses: codecov/codecov-action@b9fd7d16f6d7d1b5d2bec1a2887e65ceed900238 # v4.6.0
             if: ${{ always() && matrix.db == 'mysql' }}

diff --git a/appinfo/info.xml b/appinfo/info.xml
@@ -80,6 +80,7 @@ Learn more about the Nextcloud Ethical AI Rating [in our blog](https://nextcloud
 		<command>OCA\Mail\Command\CleanUp</command>
 		<command>OCA\Mail\Command\CreateAccount</command>
 		<command>OCA\Mail\Command\CreateTagMigrationJobEntry</command>
+		<command>OCA\Mail\Command\DebugAccount</command>
 		<command>OCA\Mail\Command\DeleteAccount</command>
 		<command>OCA\Mail\Command\DiagnoseAccount</command>
 		<command>OCA\Mail\Command\ExportAccount</command>

diff --git a/lib/Account.php b/lib/Account.php
@@ -61,6 +61,13 @@ public function getUserId() {
 		return $this->account->getUserId();
 	}
 
+	/**
+	 * @return int
+	 */
+	public function getDebug(): int {
+		return $this->account->getDebug();
+	}
+
 	/**
 	 * Set the quota percentage
 	 * @param Quota $quota

diff --git a/lib/Command/DebugAccount.php b/lib/Command/DebugAccount.php
@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Command;
+
+use OCA\Mail\Service\AccountService;
+use OCP\AppFramework\Db\DoesNotExistException;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DebugAccount extends Command {
+	protected const ARGUMENT_ACCOUNT_ID = 'account-id';
+	protected const OPTION_IMAP_DEFAULT = 'imap';
+	protected const OPTION_IMAP_FULL = 'imap-full';
+	protected const OPTION_SMTP_DEFAULT = 'smtp';
+
+	public function __construct(
+		private AccountService $accountService,
+		private LoggerInterface $logger,
+	) {
+		parent::__construct();
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function configure() {
+		$this->setName('mail:account:debug');
+		$this->setDescription('Enable or Disable IMAP/SMTP debugging on a account');
+		$this->addArgument(self::ARGUMENT_ACCOUNT_ID, InputArgument::REQUIRED);
+		$this->addOption(self::OPTION_IMAP_DEFAULT, null, InputOption::VALUE_NONE);
+		$this->addOption(self::OPTION_IMAP_FULL, null, InputOption::VALUE_NONE);
+		$this->addOption(self::OPTION_SMTP_DEFAULT, null, InputOption::VALUE_NONE);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$accountId = (int)$input->getArgument(self::ARGUMENT_ACCOUNT_ID);
+		$imapDefault = $input->getOption(self::OPTION_IMAP_DEFAULT);
+		$imapFull = $input->getOption(self::OPTION_IMAP_FULL);
+		$smtpDefault = $input->getOption(self::OPTION_SMTP_DEFAULT);
+		$debug = 0;
+		$debugImapDefault = 1 << 0;   // 1 (0000 0001)
+		$debugImapFull = 1 << 1;      // 2 (0000 0010)
+		$debugSmtpDefault = 1 << 4;   // 16 (0001 0000)
+
+		try {
+			$account = $this->accountService->findById($accountId)->getMailAccount();
+		} catch (DoesNotExistException $e) {
+			$output->writeln("<error>Account $accountId does not exist</error>");
+			return 1;
+		}
+
+		if ($imapDefault) {
+			$debug += $debugImapDefault;
+		} elseif ($imapFull) {
+			$debug += $debugImapFull;
+		}
+
+		if ($smtpDefault) {
+			$debug += $debugSmtpDefault;
+		}
+
+		$account->setDebug($debug);
+		$this->accountService->save($account);
+
+		return 0;
+	}
+}
diff --git a/lib/Db/MailAccount.php b/lib/Db/MailAccount.php
@@ -101,6 +101,8 @@
  * @method void setSearchBody(bool $searchBody)
  * @method bool|null getOooFollowsSystem()
  * @method void setOooFollowsSystem(bool $oooFollowsSystem)
+ * @method int getDebug()
+ * @method void setDebug(int $debug)
  */
 class MailAccount extends Entity {
 	public const SIGNATURE_MODE_PLAIN = 0;
@@ -183,6 +185,8 @@ class MailAccount extends Entity {
 	/** @var bool|null */
 	protected $oooFollowsSystem;
 
+	protected int $debug = 0;
+
 	/**
 	 * @param array $params
 	 */
@@ -240,6 +244,9 @@ public function __construct(array $params = []) {
 		if (isset($params['outOfOfficeFollowsSystem'])) {
 			$this->setOutOfOfficeFollowsSystem($params['outOfOfficeFollowsSystem']);
 		}
+		if (isset($params['debug'])) {
+			$this->setDebug($params['debug']);
+		}
 
 		$this->addType('inboundPort', 'integer');
 		$this->addType('outboundPort', 'integer');
@@ -263,6 +270,7 @@ public function __construct(array $params = []) {
 		$this->addType('junkMailboxId', 'integer');
 		$this->addType('searchBody', 'boolean');
 		$this->addType('oooFollowsSystem', 'boolean');
+		$this->addType('debug', 'integer');
 	}
 
 	public function getOutOfOfficeFollowsSystem(): bool {
@@ -310,6 +318,7 @@ public function toJson() {
 			'junkMailboxId' => $this->getJunkMailboxId(),
 			'searchBody' => $this->getSearchBody(),
 			'outOfOfficeFollowsSystem' => $this->getOutOfOfficeFollowsSystem(),
+			'debug' => $this->getDebug(),
 		];
 
 		if (!is_null($this->getOutboundHost())) {

diff --git a/lib/IMAP/IMAPClientFactory.php b/lib/IMAP/IMAPClientFactory.php
@@ -40,6 +40,9 @@ class IMAPClientFactory {
 	private ITimeFactory $timeFactory;
 	private HordeCacheFactory $hordeCacheFactory;
 
+	private int $debugDefault = 1 << 0;   // 1 (0000 0001)
+	private int $debugFull = 1 << 1;     // 2 (0000 0010)
+
 	public function __construct(ICrypto $crypto,
 		IConfig $config,
 		ICacheFactory $cacheFactory,
@@ -117,8 +120,13 @@ public function getClient(Account $account, bool $useCache = true): Horde_Imap_C
 				'backend' => $this->hordeCacheFactory->newCache($account),
 			];
 		}
-		if ($this->config->getSystemValue('debug', false)) {
-			$params['debug'] = $this->config->getSystemValue('datadirectory') . '/horde_imap.log';
+		$debug = $account->getDebug();
+		if ($debug & $this->debugDefault || $debug & $this->debugFull) {
+			$fn = 'mail-' . $account->getUserId() . '-' . $account->getId() . '-imap.log';
+			$params['debug'] = $this->config->getSystemValue('datadirectory') . '/' . $fn;
+			if ($debug & $this->debugFull) {
+				$params['debug_literal'] = true;
+			}
 		}
 
 		$client = new HordeImapClient($params);

diff --git a/lib/Migration/Version4100Date20241028000000.php b/lib/Migration/Version4100Date20241028000000.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version4100Date20241028000000 extends SimpleMigrationStep {
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		$schema = $schemaClosure();
+
+		$accountsTable = $schema->getTable('mail_accounts');
+		if (!$accountsTable->hasColumn('debug')) {
+			$accountsTable->addColumn('debug', Types::SMALLINT, [
+				'notnull' => false,
+				'default' => 0,
+			]);
+		}
+		return $schema;
+	}
+}
diff --git a/lib/SMTP/SmtpClientFactory.php b/lib/SMTP/SmtpClientFactory.php
@@ -28,6 +28,8 @@ class SmtpClientFactory {
 	/** @var HostNameFactory */
 	private $hostNameFactory;
 
+	private int $debugDefault = 1 << 4;   // 16 (0001 0000)
+
 	public function __construct(IConfig $config,
 		ICrypto $crypto,
 		HostNameFactory $hostNameFactory) {
@@ -77,8 +79,9 @@ public function create(Account $account): Horde_Mail_Transport {
 				$decryptedAccessToken,
 			);
 		}
-		if ($this->config->getSystemValue('debug', false)) {
-			$params['debug'] = $this->config->getSystemValue('datadirectory') . '/horde_smtp.log';
+		if ($account->getDebug() & $this->debugDefault) {
+			$fn = 'mail-' . $account->getUserId() . '-' . $account->getId() . '-smtp.log';
+			$params['debug'] = $this->config->getSystemValue('datadirectory') . '/' . $fn;
 		}
 		return new Horde_Mail_Transport_Smtphorde($params);
 	}

diff --git a/tests/Integration/Db/MailAccountTest.php b/tests/Integration/Db/MailAccountTest.php
@@ -54,7 +54,7 @@ public function testToAPI() {
 			'editorMode' => 'html',
 			'provisioningId' => null,
 			'order' => 13,
-			'showSubscribedOnly' => null,
+			'showSubscribedOnly' => false,
 			'personalNamespace' => null,
 			'draftsMailboxId' => null,
 			'sentMailboxId' => null,
@@ -70,6 +70,7 @@ public function testToAPI() {
 			'snoozeMailboxId' => null,
 			'searchBody' => false,
 			'outOfOfficeFollowsSystem' => true,
+			'debug' => 0,
 		], $a->toJson());
 	}
 
@@ -107,6 +108,7 @@ public function testMailAccountConstruct() {
 			'snoozeMailboxId' => null,
 			'searchBody' => false,
 			'outOfOfficeFollowsSystem' => false,
+			'debug' => 0,
 		];
 		$a = new MailAccount($expected);
 		// TODO: fix inconsistency

diff --git a/tests/Integration/Framework/ImapTestAccount.php b/tests/Integration/Framework/ImapTestAccount.php
@@ -47,6 +47,7 @@ public function createTestAccount(?string $userId = null) {
 		$mailAccount->setOutboundUser('user@domain.tld');
 		$mailAccount->setOutboundPassword(OC::$server->getCrypto()->encrypt('mypassword'));
 		$mailAccount->setOutboundSslMode('none');
+		$mailAccount->setDebug(1);
 		$acc = $accountService->save($mailAccount);
 
 		/** @var MailboxSync $mbSync */