fix(frontend/backend): show active tags checked when displaying a message and ensure that unchecking the input, the tag is removed

Author: mercihabam

modules/imap/functions.php

@@ -1512,16 +1512,18 @@ function snooze_dropdown($output, $unsnooze = false) {
 }}
 
 if (!hm_exists('tags_dropdown')) {
-function tags_dropdown($context, $headers) {
+function tags_dropdown($context) {
+    $msgUid = $context->get('msg_text_uid');
+    $msgTags = Hm_Tags::getTagIdsWithMessage($msgUid);
+
     $folders = $context->get('tags', array());
     $txt = '<div class="dropdown d-inline-block">
-                <a class="hlink text-decoration-none btn btn-sm btn-outline-secondary dropdown-toggle" id="dropdownMenuTag" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="true">'.$context->trans('Tags').'</a>
+                <a class="hlink text-decoration-none btn btn-sm btn-outline-secondary dropdown-toggle" id="dropdownMenuTag" data-bs-toggle="dropdown" aria-haspopup="true" href="#" aria-expanded="true">'.$context->trans('Tags').'</a>
                 <ul class="dropdown-menu" aria-labelledby="dropdownMenuTag">';
 
-    $tags =  !empty($headers['X-Cypht-Tags']) ? explode(',', $headers['X-Cypht-Tags']) : array();
     foreach ($folders as $folder) {
         $tag = $folder['name'];
-        $is_checked = in_array($folder['id'], array_map('trim', $tags));
+        $is_checked = in_array($folder['id'], $msgTags);
         $txt .= '<li class="d-flex dropdown-item gap-2">';
         $txt .= '<input class="form-check-input me-1 label-checkbox" type="checkbox" value="" aria-label="..." data-id="'.$folder['id'].'" '.($is_checked ? 'checked' : '').'>';
         $txt .= '<span>'.$context->trans($tag).'</span>';

modules/imap/output_modules.php

@@ -390,7 +390,7 @@ protected function output() {
             }
 
             if($this->get('tags')){
-                $txt .= tags_dropdown($this, $headers);
+                $txt .= tags_dropdown($this);
             }
             if (isset($lc_headers['x-schedule'])) {
                 $txt .= schedule_dropdown($this, true);

modules/imap/site.js

@@ -1153,7 +1153,20 @@ function imap_setup_tags() {
         Hm_Ajax.request(
             [{'name': 'hm_ajax_hook', 'value': 'ajax_imap_tag'},
             {'name': 'tag_id', 'value': folder_id},
-            {'name': 'list_path', 'value': ids}]
+            {'name': 'list_path', 'value': ids},
+            {'name': 'untag', 'value': !$(this).is(':checked')},
+            {'name': 'tag', 'value': $(this).is(':checked')}],
+            function() {
+                if (getPageNameParam() == 'message_list') {
+                    // remove cached message content so that tag changes are reflected
+                    ids.forEach((id) => {
+                        const uid = id.split('_')[1];
+                        Hm_Utils.remove_from_local_storage(getMessageStorageKey(uid));
+                    });
+                } else if (getPageNameParam() == 'message') {
+                    set_message_content();
+                }
+            }
         );
     });
 }

modules/tags/handler_modules.php

@@ -23,8 +23,8 @@ class Hm_Handler_add_tag_to_message extends Hm_Handler_Module {
      * Use IMAP to tag the selected message uid
      */
     public function process() {
-        list($success, $form) = $this->process_form(array('tag_id', 'list_path'));
-        if (!$success) {
+        list($success, $form) = $this->process_form(array('tag_id', 'list_path', 'tag'));
+        if (!$success || !isset($form['tag']) || $form['tag'] != true) {
             return;
         }
 
@@ -53,6 +53,45 @@ public function process() {
     }
 }
 
+/**
+ * Remove tag/label from message
+ * @subpackage imap/handler
+ */
+class Hm_Handler_remove_tag_from_message extends Hm_Handler_Module {
+    /**
+     * Use IMAP to remove tag from the selected message uid
+     */
+    public function process() {
+        list($success, $form) = $this->process_form(array('tag_id', 'list_path', 'untag'));
+        if (!$success || !isset($form['untag']) || $form['untag'] != true) {
+            return;
+        }
+
+        $untaged_messages = 0;
+        $ids = explode(',', $form['list_path']);
+        foreach ($ids as $msg_part) {
+            list($imap_server_id, $msg_id, $folder) = explode('_', $msg_part);
+            $folder = hex2bin($folder);
+            $untagged = Hm_Tags::removeMessage($msg_id, $form['tag_id']);
+            if ($untagged) {
+                $untaged_messages++;
+            }
+        }
+        $this->out('untaged_messages', $untaged_messages);
+        $type = 'success';
+        if ($untaged_messages == count($ids)) {
+            $msg = 'Tag removed';
+        } elseif ($untaged_messages > 0) {
+            $msg = 'Messages have been untaged';
+            $type = 'warning';
+        } else {
+            $msg = 'ERRFailed to remove tag from selected messages';
+            $type = 'danger';
+        }
+        Hm_Msgs::add($msg, $type);
+    }
+}
+
 /**
  * @subpackage tags/handler
  */

modules/tags/hm-tags.php

@@ -37,6 +37,22 @@ public static function addMessage($tagId, $serverId, $folder, $messageId) {
         return self::edit($tagId, $tag);
     }
 
+    public static function removeMessage($messageId, $tagId) {
+        $tag = self::get($tagId);
+        if (!$tag) {
+            return false;
+        }
+        foreach ($tag['server'] as $serverId => $folders) {
+            foreach ($folders as $folder => $messages) {
+                $newMessages = array_filter($messages, function($msgId) use ($messageId) {
+                    return $msgId != $messageId;
+                });
+                $tag['server'][$serverId][$folder] = $newMessages;
+            }
+        }
+        return self::edit($tagId, $tag);
+    }
+
     public static function registerFolder($tag_id, $serverId, $folder) {
         $tag = self::get($tag_id);
         if (! isset($tag['server'][$serverId][$folder])) {
@@ -53,7 +69,7 @@ public static function getFolders($tag_id, $serverId) {
         return [];
     }
 
-    private static function getTagIdsWithMessage($messageId) {
+    public static function getTagIdsWithMessage($messageId) {
         $tags = self::getAll();
         $tagIds = [];
         foreach ($tags as $tagId => $tag) {

modules/tags/setup.php

@@ -47,6 +47,7 @@
 add_handler('ajax_imap_tag', 'close_session_early',  true, 'core');
 add_handler('ajax_imap_tag', 'tag_data', true, 'tags', 'load_user_data', 'after');
 add_handler('ajax_imap_tag', 'add_tag_to_message',  true, 'tags', 'save_imap_cache', 'after');
+add_handler('ajax_imap_tag', 'remove_tag_from_message',  true, 'tags', 'save_imap_cache', 'after');
 
 /* Sync the Tags Repository when moving messages */
 add_handler('ajax_imap_move_copy_action', 'tag_data', true, 'tags', 'load_user_data', 'after');
@@ -68,6 +69,8 @@
         'tag_delete' => FILTER_UNSAFE_RAW,
         'tag_per_source' => FILTER_VALIDATE_INT,
         'tag_since' => FILTER_UNSAFE_RAW,
+        'untag' => FILTER_VALIDATE_BOOLEAN,
+        'tag' => FILTER_VALIDATE_BOOLEAN,
     ),
     'allowed_get' => array(
         'tag_id' => FILTER_SANITIZE_FULL_SPECIAL_CHARS,