fix sieve initialization - move parsing of sieve config to sievefilters module and re-use client factory for every initialization except nux connection test

Author: kroky

modules/imap/functions.php

@@ -1526,20 +1526,6 @@ function forward_dropdown($output,$reply_args) {
     }
 }
 
-/**
- * @subpackage imap/functions
- */
-if (!hm_exists('parse_sieve_config_host')) {
-function parse_sieve_config_host($host) {
-    $url = parse_url($host);
-    if ($url === false) {
-        return $host;
-    }
-    $host = $url['host'] ?? $url['path'];
-    $port = $url['port'] ?? '4190';
-    return [$host, $port];
-}}
-
 if (!hm_exists('connect_to_imap_server')) {
     function connect_to_imap_server($address, $name, $port, $user, $pass, $tls, $imap_sieve_host, $enableSieve, $type, $context, $hidden = false, $server_id = false, $sieve_tls = false, $show_errors = true) {
         $imap_list = array(

modules/imap/handler_modules.php

@@ -1905,10 +1905,9 @@ public function process() {
             $imap_details = Hm_IMAP_List::dump($form['imap_server_id'], true);
             if ($success && $imap_details) {
                 if ($this->module_is_supported('sievefilters') && $this->user_config->get('enable_sieve_filter_setting', DEFAULT_ENABLE_SIEVE_FILTER)) {
+                    $factory = get_sieve_client_factory($this->site_config);
                     try {
-                        list($sieve_host, $sieve_port) = parse_sieve_config_host($imap_details['sieve_config_host']);
-                        $client = new \PhpSieveManager\ManageSieve\Client($sieve_host, $sieve_port);
-                        $client->connect($imap_details['user'], $imap_details['pass'], $imap_details['sieve_tls'], "", "PLAIN");
+                        $client = $factory->init($this->user_config, $imap_details, $this->module_is_supported('nux'));
                     } catch (Exception $e) {
                         Hm_Msgs::add("Failed to authenticate to the Sieve host", "danger");
                         return;

modules/imap_folders/modules.php

@@ -211,10 +211,9 @@ public function process() {
                         $imap_account = $imap_servers[$form['imap_server_id']];
                         $linked_mailboxes = get_sieve_linked_mailbox($imap_account, $this);
                         if ($linked_mailboxes && in_array($old_folder, $linked_mailboxes)) {
-                            list($sieve_host, $sieve_port) = parse_sieve_config_host($imap_account['sieve_config_host']);
+                            $factory = get_sieve_client_factory($this->site_config);
                             try {
-                                $client = new \PhpSieveManager\ManageSieve\Client($sieve_host, $sieve_port);
-                                $client->connect($imap_account['user'], $imap_account['pass'], $imap_account['sieve_tls'], "", "PLAIN");
+                                $client = $factory->init($this->user_config, $imap_account, $this->module_is_supported('nux'));
                                 $script_names = array_filter(
                                     $linked_mailboxes,
                                     function ($value) use($old_folder) {
@@ -835,14 +834,12 @@ protected function output() {
 
 if (!hm_exists('get_sieve_linked_mailbox')) {
     function get_sieve_linked_mailbox ($imap_account, $module) {
-        if (!$module->module_is_supported('sievefilters') && $module->user_config->get('enable_sieve_filter_setting', DEFAULT_ENABLE_SIEVE_FILTER)) {
+        if (! ($module->module_is_supported('sievefilters') && $module->user_config->get('enable_sieve_filter_setting', DEFAULT_ENABLE_SIEVE_FILTER))) {
             return;
         }
-        list($sieve_host, $sieve_port) = parse_sieve_config_host($imap_account['sieve_config_host']);
-        $client = new \PhpSieveManager\ManageSieve\Client($sieve_host, $sieve_port);
+        $factory = get_sieve_client_factory($site_config);
         try {
-            $tls = isset($imap_account['sieve_tls']) ? $imap_account['sieve_tls'] : false;
-            $client->connect($imap_account['user'], $imap_account['pass'], $tls, "", "PLAIN");
+            $client = $factory->init($module->user_config, $imap_account, $module->module_is_supported('nux'));
             $scripts = $client->listScripts();
             $folders = [];
             foreach ($scripts as $s) {

modules/sievefilters/functions.php

@@ -284,6 +284,23 @@ function get_sieve_client_factory($site_config)
     }
 }
 
+if (!hm_exists('parse_sieve_config_host')) {
+function parse_sieve_config_host($imap_account) {
+    $host = $imap_account['sieve_config_host'];
+    $url = parse_url($host);
+    if ($url === false) {
+        return $host;
+    }
+    $host = $url['host'] ?? $url['path'];
+    $port = $url['port'] ?? '4190';
+    if (isset($url['scheme'])) {
+        $tls = $url['scheme'] == 'tls';
+    } else {
+        $tls = $imap_account['tls'] ?? true;
+    }
+    return [$host, $port, $tls];
+}}
+
 if (!hm_exists('prepare_sieve_script ')) {
     function prepare_sieve_script ($script, $index = 1, $action = "decode")
     {
@@ -554,6 +571,7 @@ function get_sieve_host_from_services($imap_host) {
                 return [
                     'host' => $service['sieve']['host'],
                     'port' => $service['sieve']['port'] ?? 4190,
+                    'tls' => $service['sieve']['tls'] ?? true,
                 ];
             }
         }

modules/sievefilters/hm-sieve.php

@@ -11,11 +11,12 @@ public function init($user_config = null, $imap_account = null, $is_nux_supporte
             if($is_nux_supported && $sieve_config = get_sieve_host_from_services($imap_account['server'])) {
                 $sieve_host = $sieve_config['host'];
                 $sieve_port = $sieve_config['port'];
+                $sieve_tls = $sieve_config['tls'];
             } else {
-                list($sieve_host, $sieve_port) = parse_sieve_config_host($imap_account['sieve_config_host']);
+                list($sieve_host, $sieve_port, $sieve_tls) = parse_sieve_config_host($imap_account);
             }
             $client = new PhpSieveManager\ManageSieve\Client($sieve_host, $sieve_port);
-            $client->connect($imap_account['user'], $imap_account['pass'], $imap_account['sieve_tls'], "", "PLAIN");
+            $client->connect($imap_account['user'], $imap_account['pass'], $sieve_tls, "", "PLAIN");
             return $client;
         } else {
             $errorMsg = 'Invalid config host';