Add Sieve support

* Expose managesieve port
* Add sieve client factory
* Add support for sieve to provisioning
* Refactor test connectivity logic and add sieve.
* Add support for sieve to provisioning
* Add sieve to account form
* Add debug logger for ManageSieve
* Add api to get and update active script
* Add error for managesieve exception
* Add text editor to update existing script

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>

2 files changed, 231 insertions, 2 deletions

diff --git a/lib/Controller/SettingsController.php b/lib/Controller/SettingsController.php
index 829068fc2..d65f04f03 100644
--- a/lib/Controller/SettingsController.php
+++ b/lib/Controller/SettingsController.php
@@ -50,7 +50,12 @@ class SettingsController extends Controller {
 								 string $smtpUser,
 								 string $smtpHost,
 								 int $smtpPort,
-								 string $smtpSslMode): JSONResponse {
+								 string $smtpSslMode,
+								 bool $sieveEnabled,
+								 string $sieveUser,
+								 string $sieveHost,
+								 int $sievePort,
+								 string $sieveSslMode): JSONResponse {
 		$this->provisioningManager->newProvisioning(
 			$emailTemplate,
 			$imapUser,
@@ -60,7 +65,12 @@ class SettingsController extends Controller {
 			$smtpUser,
 			$smtpHost,
 			$smtpPort,
-			$smtpSslMode
+			$smtpSslMode,
+			$sieveEnabled,
+			$sieveUser,
+			$sieveHost,
+			$sievePort,
+			$sieveSslMode
 		);
 
 		return new JSONResponse([]);
diff --git a/lib/Controller/SieveController.php b/lib/Controller/SieveController.php
new file mode 100644
index 000000000..11fc5b186
--- /dev/null
+++ b/lib/Controller/SieveController.php
@@ -0,0 +1,219 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @author Daniel Kesselberg <mail@danielkesselberg.de>
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\Mail\Controller;
+
+use Horde\ManageSieve\Exception as ManagesieveException;
+use OCA\Mail\AppInfo\Application;
+use OCA\Mail\Db\MailAccountMapper;
+use OCA\Mail\Exception\ClientException;
+use OCA\Mail\Exception\CouldNotConnectException;
+use OCA\Mail\Service\AccountService;
+use OCA\Mail\Sieve\SieveClientFactory;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\IRequest;
+use OCP\Security\ICrypto;
+
+class SieveController extends Controller {
+
+	/** @var AccountService */
+	private $accountService;
+
+	/** @var MailAccountMapper */
+	private $mailAccountMapper;
+
+	/** @var SieveClientFactory */
+	private $sieveClientFactory;
+
+	/** @var string */
+	private $currentUserId;
+
+	/** @var ICrypto */
+	private $crypto;
+
+	/**
+	 * AccountsController constructor.
+	 *
+	 * @param IRequest $request
+	 * @param string $UserId
+	 * @param AccountService $accountService
+	 * @param MailAccountMapper $mailAccountMapper
+	 * @param SieveClientFactory $sieveClientFactory
+	 * @param ICrypto $crypto
+	 */
+	public function __construct(IRequest $request,
+								string $UserId,
+								AccountService $accountService,
+								MailAccountMapper $mailAccountMapper,
+								SieveClientFactory $sieveClientFactory,
+								ICrypto $crypto
+	) {
+		parent::__construct(Application::APP_ID, $request);
+		$this->currentUserId = $UserId;
+		$this->accountService = $accountService;
+		$this->mailAccountMapper = $mailAccountMapper;
+		$this->sieveClientFactory = $sieveClientFactory;
+		$this->crypto = $crypto;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @TrapError
+	 *
+	 * @param int $id account id
+	 *
+	 * @return JSONResponse
+	 *
+	 * @throws CouldNotConnectException
+	 * @throws ClientException
+	 */
+	public function getActiveScript(int $id): JSONResponse {
+		$sieve = $this->getClient($id);
+
+		$scriptName = $sieve->getActive();
+		if ($scriptName === null) {
+			$script = '';
+		} else {
+			$script = $sieve->getScript($scriptName);
+		}
+
+		return new JSONResponse([
+			'scriptName' => $scriptName,
+			'script' => $script,
+		]);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @TrapError
+	 *
+	 * @param int $id account id
+	 * @param string $script
+	 *
+	 * @return JSONResponse
+	 *
+	 * @throws ClientException
+	 * @throws CouldNotConnectException
+	 * @throws ManagesieveException
+	 */
+	public function updateActiveScript(int $id, string $script): JSONResponse {
+		$sieve = $this->getClient($id);
+
+		$scriptName = $sieve->getActive() ?? 'nextcloud';
+		$sieve->installScript($scriptName, $script, true);
+
+		return new JSONResponse();
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @TrapError
+	 *
+	 * @param int $id account id
+	 * @param bool $sieveEnabled
+	 * @param string $sieveHost
+	 * @param int $sievePort
+	 * @param string $sieveUser
+	 * @param string $sievePassword
+	 * @param string $sieveSslMode
+	 *
+	 * @return JSONResponse
+	 *
+	 * @throws CouldNotConnectException
+	 * @throws DoesNotExistException
+	 */
+	public function updateAccount(int $id,
+								  bool $sieveEnabled,
+								  string $sieveHost,
+								  int $sievePort,
+								  string $sieveUser,
+								  string $sievePassword,
+								  string $sieveSslMode
+	): JSONResponse {
+		$mailAccount = $this->mailAccountMapper->find($this->currentUserId, $id);
+
+		if ($sieveEnabled === false) {
+			$mailAccount->setSieveEnabled(false);
+			$mailAccount->setSieveHost(null);
+			$mailAccount->setSievePort(null);
+			$mailAccount->setSieveUser(null);
+			$mailAccount->setSievePassword(null);
+			$mailAccount->setSieveSslMode(null);
+
+			$this->mailAccountMapper->save($mailAccount);
+			return new JSONResponse(['sieveEnabled' => $mailAccount->isSieveEnabled()]);
+		}
+
+		if (empty($sieveUser)) {
+			$sieveUser = $mailAccount->getInboundUser();
+		}
+
+		if (empty($sievePassword)) {
+			$sievePassword = $mailAccount->getInboundPassword();
+		} else {
+			$sievePassword = $this->crypto->encrypt($sievePassword);
+		}
+
+		try {
+			$this->sieveClientFactory->createClient($sieveHost, $sievePort, $sieveUser, $sievePassword, $sieveSslMode);
+		} catch (ManagesieveException $e) {
+			throw CouldNotConnectException::create($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);
+
+		$this->mailAccountMapper->save($mailAccount);
+		return new JSONResponse(['sieveEnabled' => $mailAccount->isSieveEnabled()]);
+	}
+
+	/**
+	 * @param int $id
+	 *
+	 * @return \Horde\ManageSieve
+	 *
+	 * @throws ClientException
+	 * @throws CouldNotConnectException
+	 */
+	protected function getClient(int $id): \Horde\ManageSieve {
+		$account = $this->accountService->find($this->currentUserId, $id);
+
+		if (!$account->getMailAccount()->isSieveEnabled()) {
+			throw new CouldNotConnectException('ManageSieve is disabled.');
+		}
+
+		try {
+			$sieve = $this->sieveClientFactory->getClient($account);
+		} catch (ManagesieveException $e) {
+			throw CouldNotConnectException::create($e, 'ManageSieve', $account->getMailAccount()->getSieveHost(), $account->getMailAccount()->getSievePort());
+		}
+
+		return $sieve;
+	}
+}