refactor: ensure that special folders data include folder id so hex2bin conversion stays unconditional

Author: mercihabam

modules/advanced_search/js_modules/route_handlers.js

@@ -75,9 +75,10 @@ function applyAdvancedSearchPageHandlers() {
         const serverId = $(this).closest('li').data('serverId');
         const specialFolders = [];
         ['archive', 'draft', 'junk', 'sent', 'trash'].forEach(folderType => {
-            const folderName = hm_special_folders()[serverId][folderType];
-            if (folderName) {
-                specialFolders.push(folderName);
+            const folders = hm_special_folders()?.[serverId];
+            const folder = folders?.find(f => f.type === folderType);
+            if (folder) {
+                specialFolders.push(folder);
             }
         });
 
@@ -92,13 +93,13 @@ function applyAdvancedSearchPageHandlers() {
         modal.setContent(`
         <div class="d-flex gap-3 flex-wrap">
             <div class="form-check form-switch">
-                <input class="form-check-input" type="checkbox" id="all">
-                <label class="form-check-label" for="all">All Folders</label>
+                <input class="form-check-input" type="checkbox" id="all-special-folders">
+                <label class="form-check-label" for="all-special-folders">All Folders</label>
             </div>
             ${specialFolders.map(folder => `
             <div class="form-check form-switch">
-                <input class="form-check-input special_folder_checkbox" type="checkbox" data-folder-id="${folder}" ${isFolderSelected(folder) ? 'checked' : ''}>
-                <label class="form-check-label" for="${folder}">${folder}</label>
+                <input class="form-check-input special_folder_checkbox" type="checkbox" id="${folder.id}" ${isFolderSelected(folder.label) ? 'checked' : ''}>
+                <label class="form-check-label" for="${folder.id}">${folder.label}</label>
             </div>
             `).join('')}
         </div>    
@@ -107,28 +108,28 @@ function applyAdvancedSearchPageHandlers() {
         modal.addFooterBtn('Pick', 'btn-primary', function() {
             const selectedFolders = [];
             $('.special_folder_checkbox:checked').each(function() {
-                selectedFolders.push($(this).data('folder-id'));
+                selectedFolders.push(specialFolders.find(folder => folder.id === $(this).attr('id')));
             });
             selectedFolders.forEach(folder => {
-                add_source_to_list(accountId + folder, getFolderLabel(folder), true);
+                add_source_to_list(accountId + folder.id, getFolderLabel(folder.label), true);
             });
             modal.hide();
         });
 
         modal.open();
 
-        $('#all').on('change', function() {
+        $('#all-special-folders').on('change', function() {
             const checked = $(this).is(':checked');
             $('.special_folder_checkbox').prop('checked', checked);
         });
 
         $('.special_folder_checkbox').on('change', function() {
             const allChecked = $('.special_folder_checkbox').length === $('.special_folder_checkbox:checked').length;
-            $('#all').prop('checked', allChecked);
+            $('#all-special-folders').prop('checked', allChecked);
         });
 
-        if (specialFolders.every(folder => isFolderSelected(folder))) {
-            $('#all').prop('checked', true);
+        if (specialFolders.every(folder => isFolderSelected(folder.label))) {
+            $('#all-special-folders').prop('checked', true);
         }
     });
 

modules/advanced_search/modules.php

@@ -108,7 +108,8 @@ public function process() {
 
     private function all_folders_search($mailbox, $flags, $params, $limit, $parent = '') {
         if ($parent) {
-            $folders = $mailbox->get_subfolders($parent);
+            $folders = [['name' => $parent]];
+            $folders = array_merge($folders, $mailbox->get_subfolders($parent));
         } else {
             $folders = $mailbox->get_folders();
         }
@@ -160,12 +161,7 @@ private function validate_source($val) {
         $source_parts = explode('_', $val);
         $this->imap_id = $source_parts[1];
 
-        $folder = $source_parts[2];
-        if (ctype_xdigit($folder)) {
-            $this->folder = hex2bin($folder);
-        } else {
-            $this->folder = $folder;
-        }
+        $this->folder = hex2bin($source_parts[2]);
         return true;
     }
 

modules/core/output_modules.php

@@ -616,6 +616,14 @@ protected function output() {
         $settings = $this->get('user_settings', array());
         $enable_snooze = $settings['enable_snooze'] ?? DEFAULT_ENABLE_SNOOZE;
         $enable_collect_address_on_send = $settings['enable_collect_address_on_send_setting'] ?? DEFAULT_ENABLE_COLLECT_ADDRESS_ON_SEND;
+        $specialFolders = $settings['special_imap_folders'];
+        $formattedSpecialFolders = [];
+        foreach ($specialFolders as $serverId => $folders) {
+            $formattedSpecialFolders[$serverId] = [];
+            foreach ($folders as $type => $folder) {
+                $formattedSpecialFolders[$serverId][] = ['type' => $type, 'label' => $folder, 'id' => bin2hex($folder)];
+            }
+        }
         $res = '<script type="text/javascript" id="data-store">'.
             'var globals = {};'.
             'var hm_is_logged = function () { return '.($this->get('is_logged') ? '1' : '0').'; };'.
@@ -633,7 +641,7 @@ protected function output() {
             'var hm_web_root_path = function() { return "'.WEB_ROOT.'"; };'.
             'var hm_flag_image_src = function() { return "<i class=\"bi bi-star-half\"></i>"; };'.
             'var hm_check_dirty_flag = function() { return '.($this->get('warn_for_unsaved_changes', '') ? '1' : '0').'; };'.
-            'var hm_special_folders = function() { return '.json_encode($settings['special_imap_folders']).'; };'.
+            'var hm_special_folders = function() { return '.json_encode($formattedSpecialFolders).'; };'.
             format_data_sources($this->get('data_sources', array()), $this);
 
         if (!$this->get('disable_delete_prompt', DEFAULT_DISABLE_DELETE_PROMPT)) {