Merge pull request #1622 from Shadow243/fix-orphaned-profiles

fix(backend): delete profile after imap or smtp server removed to avoid orphaned profiles

Author: kroky

lib/framework.php

@@ -10,6 +10,7 @@
 
 /* load the framework */
 require APP_PATH.'lib/repository.php';
+require APP_PATH.'lib/searchable.php';
 require APP_PATH.'lib/module.php';
 require APP_PATH.'lib/modules.php';
 require APP_PATH.'lib/modules_exec.php';

lib/searchable.php

@@ -0,0 +1,27 @@
+<?php
+
+trait Searchable {
+    /**
+     * Return items matching $match in column $column.
+     *
+     * @param mixed  $match
+     * @param string $column
+     * @param bool   $returnFirst
+     * @return array|null
+     */
+    public static function getBy($match, $column = 'id', $returnFirst = false) {
+        $results = [];
+        foreach (static::getDataset() as $item) {
+            if (isset($item[$column]) && $item[$column] === $match) {
+                if ($returnFirst) {
+                    return $item;
+                }
+                $results[] = $item;
+            }
+        }
+        return $returnFirst ? null : $results;
+    }
+
+    // Each class must implement this
+    abstract protected static function getDataset();
+}

lib/servers.php

@@ -174,6 +174,7 @@ public static function toggle_hidden($id, $hide) {
 trait Hm_Server_List {
 
     use Hm_Server_Modify;
+    use Searchable;
     use Hm_Repository {
         Hm_Repository::add as repo_add;
         Hm_Repository::get as repo_get;
@@ -216,24 +217,11 @@ public static function dump($id = false, $full = false) {
     }
 
     /**
-     * Return server details matching $match in column $column.
-     *
-     * @param mixed  $match        Value to match.
-     * @param string $column       Column name to match against.
-     * @param bool   $returnFirst  If true, return only the first matching server.
-     * @return array|null          Array of matches, or a single server array, or null if no match.
+     * Get the dataset for the server list
+     * @return array
      */
-    public static function getBy($match, $column = 'id', $returnFirst = false) {
-        $results = [];
-        foreach (self::$server_list as $server) {
-            if (isset($server[$column]) && $server[$column] === $match) {
-                if ($returnFirst) {
-                    return $server;
-                }
-                $results[] = $server;
-            }
-        }
-        return $returnFirst ? null : $results;
+    protected static function getDataset() {
+        return self::$server_list;
     }
 
     /**

modules/profiles/functions.php

@@ -9,6 +9,7 @@ function add_profile($name, $signature, $reply_to, $is_default, $email, $server,
             'sig' => $signature,
             'rmk' => $remark,
             'smtp_id' => $smtp_server_id,
+            'imap_id' => $imap_server_id,
             'replyto' => $reply_to,
             'default' => $is_default,
             'address' => $email,

modules/profiles/hm-profiles.php

@@ -13,7 +13,7 @@
  */
 class Hm_Profiles {
 
-    use Hm_Repository;
+    use Hm_Repository, Searchable;
 
     private static $data = array();
 
@@ -65,6 +65,15 @@ public static function getDefault() {
         return null;
     }
 
+
+    /**
+     * Get the dataset for the server list
+     * @return array
+     */
+    protected static function getDataset() {
+        return self::$data;
+    }
+
     public static function createDefault($hmod) {
         if (! $hmod->module_is_supported('imap') || ! $hmod->module_is_supported('smtp')) {
             return;
@@ -84,6 +93,7 @@ public static function createDefault($hmod) {
                 'address' => $address,
                 'replyto' => $reply_to,
                 'smtp_id' => $smtp_server['id'],
+                'imap_id' => $imap_server['id'],
                 'sig' => '',
                 'rmk' => '',
                 'type' => 'imap',
@@ -109,6 +119,7 @@ public static function loadLegacy($hmod) {
                     'address' => array_key_exists('profile_address', $profile) ? $profile['profile_address'] : '',
                     'replyto' => $profile['profile_replyto'],
                     'smtp_id' => $profile['profile_smtp'],
+                    'imap_id' => $server['id'],
                     'sig' => $profile['profile_sig'],
                     'rmk' => $profile['profile_rmk'],
                     'type' => 'imap',
@@ -120,10 +131,10 @@ public static function loadLegacy($hmod) {
     }
 
     /**
- * @param string $field The name of the field to search within.
- * @param mixed $value The value to search for within the specified field.
- * @return array An array containing profiles that match the search criteria.
- */
+     * @param string $field The name of the field to search within.
+     * @param mixed $value The value to search for within the specified field.
+     * @return array An array containing profiles that match the search criteria.
+     */
     public static function search($field, $value) {
         $res = array();
         foreach (self::getAll() as $profile) {

modules/profiles/modules.php

@@ -56,6 +56,44 @@ public function process() {
     }
 }
 
+/**
+ * @subpackage profile/handler
+ */
+class Hm_Handler_process_smtp_server_data_delete extends Hm_Handler_Module {
+    public function process() {
+        if (isset($this->request->post['smtp_delete'])) {
+            $deleted_server_id = $this->get('deleted_server_id', '');
+            Hm_Profiles::init($this);
+            $servers = Hm_Profiles::getBy($deleted_server_id,'smtp_id');
+            if ($servers) {
+                foreach ($servers as $server) {
+                    Hm_Profiles::del($server['id']);
+                    Hm_Msgs::add("Profile {$server['name']} has been deleted since its server was removed.");
+                }
+            }
+        }
+    }
+}
+
+/**
+ * @subpackage profile/handler
+ */
+class Hm_Handler_process_imap_server_data_delete extends Hm_Handler_Module {
+    public function process() {
+        if (isset($this->request->post['imap_delete'])) {
+            $deleted_server_id = $this->get('deleted_server_id', '');
+            Hm_Profiles::init($this);
+            $servers = Hm_Profiles::getBy($deleted_server_id,'imap_id');
+            if ($servers) {
+                foreach ($servers as $server) {
+                    Hm_Profiles::del($server['id']);
+                    Hm_Msgs::add("Profile {$server['name']} has been deleted since its server was removed.");
+                }
+            }
+        }
+    }
+}
+
 /**
  * @subpackage profile/handler
  */

modules/profiles/setup.php

@@ -24,6 +24,8 @@
 add_handler('ajax_smtp_save_draft', 'compose_profile_data', true, 'profiles', 'load_smtp_servers_from_config', 'after');
 add_handler('ajax_smtp_attach_file', 'compose_profile_data', true, 'profiles', 'load_smtp_servers_from_config', 'after');
 add_handler('servers', 'compose_profile_data', true, 'profiles', 'load_smtp_servers_from_config', 'after');
+add_handler('ajax_smtp_debug', 'process_smtp_server_data_delete', true, 'profiles','smtp_delete', 'after');
+add_handler('ajax_imap_debug', 'process_imap_server_data_delete', true, 'profiles','imap_delete', 'after');
 
 return array(
     'allowed_pages' => array(