Implement browser history API based navigation, preventing page reloads between routings

modules/advanced_search/js_modules/route_handlers.js

@@ -0,0 +1,30 @@
+function applyAdvancedSearchPageHandlers() {
+    globals.close_html = '<i class="bi bi-x-circle-fill cursor-pointer"></i>';
+
+    $('.settings_subtitle').on("click", function() { return Hm_Utils.toggle_page_section($(this).data('target')); });
+    $('.adv_folder_select').on("click", function() { adv_select_imap_folder(this); });
+    $('.new_time').on("click", function() { add_remove_times(this); });
+    $('.new_target').on("click", function() { add_remove_targets(this); });
+    $('.new_term').on("click", function() { add_remove_terms(this); });
+    $('.adv_expand_all').on("click", function() { adv_expand_sections(); });
+    $('.adv_collapse_all').on("click", function() { adv_collapse(); });
+    $('#adv_search').on("click", function() { process_advanced_search(); });
+    $('.toggle_link').on("click", function() { return Hm_Message_List.toggle_rows(); });
+    $('.adv_reset').on("click", function() { adv_reset_page(); });
+    $('.combined_sort').on("change", function() { Hm_Message_List.sort($(this).val()); });
+
+    apply_saved_search();
+    var data = Hm_Utils.get_from_local_storage('formatted_advanced_search_data');
+    if (data && data.length) {
+        adv_collapse();
+        Hm_Utils.tbody().html(data);
+        $('.adv_controls').show();
+        $('.core_msg_control').off('click');
+        $('.core_msg_control').on("click", function() { return Hm_Message_List.message_action($(this).data('action')); });
+        Hm_Message_List.set_checkbox_callback();
+        if (typeof check_select_for_imap !== 'undefined') {
+            check_select_for_imap();
+        }
+    }
+    Hm_Message_List.check_empty_list();
+}

modules/advanced_search/site.js

@@ -514,37 +514,3 @@ var adv_reset_page = function() {
     Hm_Utils.save_to_local_storage('adv_search_params', '');
     document.location.href = '?page=advanced_search';
 };
-
-$(function() {
-    if (hm_page_name() == 'advanced_search') {
-
-        globals.close_html = '<i class="bi bi-x-circle-fill cursor-pointer"></i>';
-
-        $('.settings_subtitle').on("click", function() { return Hm_Utils.toggle_page_section($(this).data('target')); });
-        $('.adv_folder_select').on("click", function() { adv_select_imap_folder(this); });
-        $('.new_time').on("click", function() { add_remove_times(this); });
-        $('.new_target').on("click", function() { add_remove_targets(this); });
-        $('.new_term').on("click", function() { add_remove_terms(this); });
-        $('.adv_expand_all').on("click", function() { adv_expand_sections(); });
-        $('.adv_collapse_all').on("click", function() { adv_collapse(); });
-        $('#adv_search').on("click", function() { process_advanced_search(); });
-        $('.toggle_link').on("click", function() { return Hm_Message_List.toggle_rows(); });
-        $('.adv_reset').on("click", function() { adv_reset_page(); });
-        $('.combined_sort').on("change", function() { Hm_Message_List.sort($(this).val()); });
-
-        apply_saved_search();
-        var data = Hm_Utils.get_from_local_storage('formatted_advanced_search_data');
-        if (data && data.length) {
-            adv_collapse();
-            Hm_Utils.tbody().html(data);
-            $('.adv_controls').show();
-            $('.core_msg_control').off('click');
-            $('.core_msg_control').on("click", function() { return Hm_Message_List.message_action($(this).data('action')); });
-            Hm_Message_List.set_checkbox_callback();
-            if (typeof check_select_for_imap !== 'undefined') {
-                check_select_for_imap();
-            }
-        }
-        Hm_Message_List.check_empty_list();
-    }
-});

modules/calendar/hm-calendar.php

@@ -69,7 +69,7 @@ private function output_event($day) {
                 $res .= '<div class="cal_event">'.
                     $this->output_event_details($event).
                     $this->output_mod->html_safe(date('H:i', $event['ts'])).
-                    ' <a class="cal_title cursor-pointer">'.$this->output_mod->html_safe($event['title']).
+                    ' <a class="cal_title cursor-pointer" href="#">'.$this->output_mod->html_safe($event['title']).
                     '</a></div>';
             }
             return $res;

modules/calendar/js_modules/route_handlers.js

@@ -0,0 +1,15 @@
+function applyCalendarPageHandlers() {
+    $('.event_delete').on("click", function() {
+        if (hm_delete_prompt()) {
+            $(this).parent().submit();
+        }
+    });
+    $('.cal_title').on("click", function(e) {
+        e.preventDefault();
+        $('.event_details').hide();
+        $('.event_details', $(this).parent()).show();
+        $('.event_details').on("click", function() {
+            $(this).hide();
+        });
+    });
+}

modules/calendar/site.js

@@ -1,18 +1 @@
 'use strict';
-
-$(function() {
-    if (hm_page_name() == 'calendar') {
-        $('.event_delete').on("click", function() {
-            if (hm_delete_prompt()) {
-                $(this).parent().submit();
-            }
-        });
-        $('.cal_title').on("click", function() {
-            $('.event_details').hide();
-            $('.event_details', $(this).parent()).show();
-            $('.event_details').on("click", function() {
-                $(this).hide();
-            });
-        });
-    }
-});

modules/contacts/js_modules/route_handlers.js

@@ -0,0 +1,33 @@
+function applyContactsPageHandlers() {
+    $('.delete_contact').on("click", function() {
+        delete_contact($(this).data('id'), $(this).data('source'), $(this).data('type'));
+        return false;
+    });
+    $('.show_contact').on("click", function() {
+        $('#'+$(this).data('id')).toggle();
+        return false;
+    });
+    $('.reset_contact').on("click", function() {
+        Hm_Utils.redirect('?page=contacts');
+    });
+    $('.server_title').on("click", function() {
+        $(this).next().toggle();
+    });
+    $('#contact_phone').on("keyup", function() {
+        let contact_phone = $('#contact_phone').val();
+        const regex_number = new RegExp('^\\d+$');
+        const allowed_characters = ['+','-','(',')'];
+        for (let chain_counter = 0; chain_counter < contact_phone.length; chain_counter++) {
+            if(!(regex_number.test(contact_phone[chain_counter])) && !(allowed_characters.indexOf(contact_phone[chain_counter]) > -1)){
+                Hm_Notices.show([hm_trans("This phone number appears to contain invalid character (s).\nIf you are sure ignore this warning and continue!")]);
+                $(this).off();
+            }
+        }
+
+    });
+    $('.source_link').on("click", function () {
+        $('.list_actions').toggle(); $('#list_controls_menu').hide();
+        return false;
+    });
+    contact_import_pagination();
+}

modules/contacts/site.js

@@ -58,8 +58,8 @@ var add_contact_from_popup = function(event) {
             {'name': 'contact_source', 'value': source}],
             function (res) {
                 $("#contact_popup_body").html(saveContactContent);
-                sessionStorage.removeItem(`${window.location.pathname}imap_4_${hm_list_path()}`);
-                sessionStorage.removeItem(`${window.location.pathname}${hm_msg_uid()}_${hm_list_path()}`);
+                sessionStorage.removeItem(`${window.location.pathname}imap_4_${getListPathParam()}`);
+                sessionStorage.removeItem(`${window.location.pathname}${getMessageUidParam()}_${getListPathParam()}`);
             }
         );
     }
@@ -263,43 +263,3 @@ var check_cc_exist_in_contacts_list = function() {
     }
     return "";
 };
-
-if (hm_page_name() == 'contacts') {
-    $('.delete_contact').on("click", function() {
-        delete_contact($(this).data('id'), $(this).data('source'), $(this).data('type'));
-        return false;
-    });
-    $('.show_contact').on("click", function() {
-        $('#'+$(this).data('id')).toggle();
-        return false;
-    });
-    $('.reset_contact').on("click", function() {
-        Hm_Utils.redirect('?page=contacts');
-    });
-    $('.server_title').on("click", function() {
-        $(this).next().toggle();
-    });
-    $('#contact_phone').on("keyup", function() {
-        let contact_phone = $('#contact_phone').val();
-        const regex_number = new RegExp('^\\d+$');
-        const allowed_characters = ['+','-','(',')'];
-        for (let chain_counter = 0; chain_counter < contact_phone.length; chain_counter++) {
-            if(!(regex_number.test(contact_phone[chain_counter])) && !(allowed_characters.indexOf(contact_phone[chain_counter]) > -1)){
-                Hm_Notices.show([hm_trans("This phone number appears to contain invalid character (s).\nIf you are sure ignore this warning and continue!")]);
-                $(this).off();
-            }
-        }
-
-    });
-    $('.source_link').on("click", function () {
-        $('.list_actions').toggle(); $('#list_controls_menu').hide();
-        return false;
-    });
-    contact_import_pagination();
-}
-else if (hm_page_name() == 'compose') {
-    $('.compose_to').on('keyup', function(e) { autocomplete_contact(e, '.compose_to', '#to_contacts'); });
-    $('.compose_cc').on('keyup', function(e) { autocomplete_contact(e, '.compose_cc', '#cc_contacts'); });
-    $('.compose_bcc').on('keyup', function(e) { autocomplete_contact(e, '.compose_bcc', '#bcc_contacts'); });
-    $('.compose_to').focus();
-}

modules/imap/js_modules/Hm_Message.js → modules/core/js_modules/Hm_MessagesStore.js

@@ -15,20 +15,29 @@ class Hm_MessagesStore {
      * @property {RowObject} 1 - An object containing the row message and the IMAP key
      */
 
-    constructor(path, page, rows = {}) {
+    constructor(path, page = 1, rows = {}, abortController = new AbortController()) {
         this.path = path;
         this.list = path + '_' + page;
         this.rows = rows;
         this.links = "";
         this.count = 0;
         this.flagAsReadOnOpen = true;
+        this.abortController = abortController;
+    }
+
+    /**
+     * Check if the store has data for the current instance
+     * @returns {Boolean}
+     */
+    hasLocalData() {
+        return this.#retrieveFromLocalStorage() !== false;
     }
 
     /**
      * 
-     * @returns {Promise<Array<String>>}
+     * @returns {Promise<this>}
      */
-    async load(reload = false, hideLoadingState = false) {
+    async load(reload = false, hideLoadingState = false, doNotFetch = false) {
         const storedMessages = this.#retrieveFromLocalStorage();
         if (storedMessages && !reload) {
             this.rows = storedMessages.rows;
@@ -38,9 +47,13 @@ class Hm_MessagesStore {
             return this;
         }
 
+        if (doNotFetch) {
+            return this;
+        }
+
         const { formatted_message_list: updatedMessages, page_links: pageLinks, folder_status, do_not_flag_as_read_on_open } = await this.#fetch(hideLoadingState);
 
-        this.count = Object.values(folder_status)[0].messages;
+        this.count = folder_status && Object.values(folder_status)[0]?.messages;
         this.links = pageLinks;
         this.rows = updatedMessages;
         this.flagAsReadOnOpen = !do_not_flag_as_read_on_open;
@@ -112,25 +125,61 @@ class Hm_MessagesStore {
     }
 
     #fetch(hideLoadingState = false) {
-        const detail = Hm_Utils.parse_folder_path(this.path, 'imap');
         return new Promise((resolve, reject) => {
             Hm_Ajax.request(
-              [
-                { name: "hm_ajax_hook", value: "ajax_imap_folder_display" },
-                { name: "imap_server_id", value: detail.server_id },
-                { name: "folder", value: detail.folder },
-              ],
+              this.#getRequestConfig(),
               (response) => {
                 resolve(response);
               },
               [],
               hideLoadingState,
               undefined,
-              reject
+              reject,
+              this.abortController?.signal
             );
         });
     }
 
+    #getRequestConfig() {
+        let hook;
+        let serverId;
+        let folder;
+        const config = [];
+        if (this.path.startsWith('imap')) {
+            hook = "ajax_imap_folder_display";
+            const detail = Hm_Utils.parse_folder_path(this.path, 'imap');
+            serverId = detail.server_id;
+            folder = detail.folder;
+        } else {
+            switch (this.path) {
+                case 'unread':
+                    hook = "ajax_imap_unread";
+                    break;
+                case 'flagged':
+                    hook = "ajax_imap_flagged";
+                    break;
+                case 'combined_inbox':
+                case 'email':
+                    hook = "ajax_imap_combined_inbox";
+                    break;
+                default:
+                    hook = "ajax_imap_folder_data";
+                    break;
+            }
+        }
+
+        if (hook) {
+            config.push({ name: "hm_ajax_hook", value: hook });
+        }
+        if (serverId) {
+            config.push({ name: "imap_server_id", value: serverId });
+        }
+        if (folder) {
+            config.push({ name: "folder", value: folder });
+        }
+        return config;
+    }
+
     #saveToLocalStorage() {
         Hm_Utils.save_to_local_storage(this.list, JSON.stringify({ rows: this.rows, links: this.links, count: this.count }));
         Hm_Utils.save_to_local_storage('flagAsReadOnOpen', this.flagAsReadOnOpen);

modules/core/js_modules/route_handlers.js

@@ -0,0 +1,58 @@
+function applyServersPageHandlers() {
+    $('.server_section').on("click", function() { return Hm_Utils.toggle_page_section($(this).data('target')); });
+    $('.edit_server_connection').on('click', imap_smtp_edit_action);
+    // NUX
+    expand_server_settings();
+    $('.nux_next_button').on("click", nux_service_select);
+    $('#service_select').on("change", function() {
+        if ($(this).val() == 'all-inkl') {
+            add_extra_fields(this, 'all_inkl_login', 'Login', hm_trans('Your All-inkl Login'));
+        } else {
+            $('.nux_extra_fields_container').remove();
+        }
+    });
+
+    // Optional modules
+    if (window.feedServersPageHandler) feedServersPageHandler();
+    if (window.githubServersPageHandler) githubServersPageHandler();
+    if (window.nasaServersPageHandler) nasaServersPageHandler();
+    if (window.smtpServersPageHandler) smtpServersPageHandler();
+    if (window.wpServersPageHandler) wpServersPageHandler();
+}
+
+function applySettingsPageHandlers() {
+    Hm_Utils.expand_core_settings();
+    $('.settings_subtitle').on("click", function() { return Hm_Utils.toggle_page_section($(this).data('target')); });
+    $('.reset_default_value_checkbox').on("click", reset_default_value_checkbox);
+    $('.reset_default_value_select').on("click", reset_default_value_select);
+    $('.reset_default_value_input').on("click", reset_default_value_input);
+    $('.reset_default_timezone').on("click", reset_default_timezone);
+
+    if (window.expand_feed_settings) expand_feed_settings();
+    if (window.smtpSettingsPageHandler) smtpSettingsPageHandler();
+}
+
+function applySearchPageHandlers(routeParams) {
+    Hm_Message_List.select_combined_view();
+    sortHandlerForMessageListAndSearchPage();
+    $('.search_reset').on("click", Hm_Utils.reset_search_form);
+
+    if (window.inlineMessageMessageListAndSearchPageHandler) inlineMessageMessageListAndSearchPageHandler(routeParams);
+    if (window.savedSearchesSearchPageHandler) savedSearchesSearchPageHandler();
+}
+
+function applyHomePageHandlers() {
+    $('.pw_update').on("click", function() { update_password($(this).data('id')); });
+}
+
+function applyInfoPageHandlers() {
+    const timer = setTimeout(() => {
+        imap_status_update();
+        if (window.feed_status_update) feed_status_update();
+        if (window.github_repo_update) github_repo_update();
+    }, 100);
+
+    return () => {
+        clearTimeout(timer);
+    }
+}