From 344c4c7927dc319a588ddd8a31d21350e2e799b7 Mon Sep 17 00:00:00 2001
From: Alessandro Castellani <alessandro@thunderbird.net>
Date: Thu, 29 Jun 2023 17:19:15 +0000
Subject: [PATCH] Bug 1828499 - Add a sort menu to the threadPaneDisplayButton
 menu. r=Paenglab

Differential Revision: https://phabricator.services.mozilla.com/D180040

--HG--
extra : moz-landing-system : lando
---
 mail/base/content/about3Pane.js    |  55 +++++++++++-
 mail/base/content/about3Pane.xhtml | 133 ++++++++++++++++++++++++++++-
 2 files changed, 186 insertions(+), 2 deletions(-)

diff --git a/mail/base/content/about3Pane.js b/mail/base/content/about3Pane.js
index 0322ef1fde..5815901bea 100644
--- a/mail/base/content/about3Pane.js
+++ b/mail/base/content/about3Pane.js
@@ -3887,8 +3887,13 @@ var threadPaneHeader = {
 
   /**
    * Update the context menu to reflect the currently selected display options.
+   *
+   * @param {Event} event - The popupshowing DOMEvent.
    */
-  updateDisplayContextMenu() {
+  updateDisplayContextMenu(event) {
+    if (event.target.id != "threadPaneDisplayContext") {
+      return;
+    }
     const isTableLayout = document.body.classList.contains("layout-table");
     document
       .getElementById(
@@ -3897,6 +3902,54 @@ var threadPaneHeader = {
       .setAttribute("checked", "true");
   },
 
+  /**
+   * Update the menuitems inside the thread pane sort menupopup.
+   *
+   * @param {Event} event - The popupshowing DOMEvent.
+   */
+  updateThreadPaneSortMenu(event) {
+    if (event.target.id != "menu_threadPaneSortPopup") {
+      return;
+    }
+
+    const hiddenColumns = threadPane.columns
+      .filter(c => c.hidden)
+      .map(c => c.sortKey);
+
+    // Update menuitem to reflect sort key.
+    for (const menuitem of event.target.querySelectorAll(`[name="sortby"]`)) {
+      const sortKey = menuitem.getAttribute("value");
+      menuitem.setAttribute(
+        "checked",
+        gViewWrapper.primarySortType == Ci.nsMsgViewSortType[sortKey]
+      );
+      if (hiddenColumns.includes(sortKey)) {
+        menuitem.setAttribute("disabled", "true");
+      } else {
+        menuitem.removeAttribute("disabled");
+      }
+    }
+
+    // Update sort direction menu items.
+    event.target
+      .querySelector(`[value="ascending"]`)
+      .setAttribute("checked", gViewWrapper.isSortedAscending);
+    event.target
+      .querySelector(`[value="descending"]`)
+      .setAttribute("checked", !gViewWrapper.isSortedAscending);
+
+    // Update the threaded and groupedBy menu items.
+    event.target
+      .querySelector(`[value="threaded"]`)
+      .setAttribute("checked", gViewWrapper.showThreaded);
+    event.target
+      .querySelector(`[value="unthreaded"]`)
+      .setAttribute("checked", gViewWrapper.showUnthreaded);
+    event.target
+      .querySelector(`[value="group"]`)
+      .setAttribute("checked", gViewWrapper.showGroupedBySort);
+  },
+
   /**
    * Change the display view of the message list pane.
    *
diff --git a/mail/base/content/about3Pane.xhtml b/mail/base/content/about3Pane.xhtml
index c0676bc19b..1c85628163 100644
--- a/mail/base/content/about3Pane.xhtml
+++ b/mail/base/content/about3Pane.xhtml
@@ -590,7 +590,7 @@
   <menupopup id="threadPaneDisplayContext"
              class="no-accel-menupopup"
              position="bottomleft topleft"
-             onpopupshowing="threadPaneHeader.updateDisplayContextMenu();">
+             onpopupshowing="threadPaneHeader.updateDisplayContextMenu(event);">
     <menuitem id="threadPaneTableView"
               class="thread-view-option"
               type="radio"
@@ -608,6 +608,137 @@
               data-l10n-id="thread-pane-header-context-cards-view"
               oncommand="threadPaneHeader.changePaneView(event);"/>
     <menuseparator id="separatorBeforeHideThreadHeaderOption"/>
+    <menu id="threadPaneSortMenu"
+          accesskey="&sortMenu.accesskey;"
+          label="&sortMenu.label;">
+      <menupopup id="menu_threadPaneSortPopup"
+                 oncommand="goDoCommand('cmd_sort', event);"
+                 onpopupshowing="threadPaneHeader.updateThreadPaneSortMenu(event);">
+        <menuitem id="threadPaneSortByDateMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byDate"
+                  label="&sortByDateCmd.label;"
+                  accesskey="&sortByDateCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByReceivedMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byReceived"
+                  label="&sortByReceivedCmd.label;"
+                  accesskey="&sortByReceivedCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByFlagMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byFlagged"
+                  label="&sortByStarCmd.label;"
+                  accesskey="&sortByStarCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByOrderReceivedMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byId"
+                  label="&sortByOrderReceivedCmd.label;"
+                  accesskey="&sortByOrderReceivedCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByPriorityMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byPriority"
+                  label="&sortByPriorityCmd.label;"
+                  accesskey="&sortByPriorityCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByFromMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byAuthor"
+                  label="&sortByFromCmd.label;"
+                  accesskey="&sortByFromCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByRecipientMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byRecipient"
+                  label="&sortByRecipientCmd.label;"
+                  accesskey="&sortByRecipientCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByCorrespondentMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byCorrespondent"
+                  label="&sortByCorrespondentCmd.label;"
+                  accesskey="&sortByCorrespondentCmd.accesskey;"/>
+        <menuitem id="threadPaneSortBySizeMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="bySize"
+                  label="&sortBySizeCmd.label;"
+                  accesskey="&sortBySizeCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByStatusMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byStatus"
+                  label="&sortByStatusCmd.label;"
+                  accesskey="&sortByStatusCmd.accesskey;"/>
+        <menuitem id="threadPaneSortBySubjectMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="bySubject"
+                  label="&sortBySubjectCmd.label;"
+                  accesskey="&sortBySubjectCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByUnreadMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byUnread"
+                  label="&sortByUnreadCmd.label;"
+                  accesskey="&sortByUnreadCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByTagsMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byTags"
+                  label="&sortByTagsCmd.label;"
+                  accesskey="&sortByTagsCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByJunkStatusMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byJunkStatus"
+                  label="&sortByJunkStatusCmd.label;"
+                  accesskey="&sortByJunkStatusCmd.accesskey;"/>
+        <menuitem id="threadPaneSortByAttachmentsMenuitem"
+                  type="radio"
+                  name="sortby"
+                  value="byAttachments"
+                  label="&sortByAttachmentsCmd.label;"
+                  accesskey="&sortByAttachmentsCmd.accesskey;"/>
+        <menuseparator id="threadPaneSortAfterAttachmentSeparator"/>
+        <menuitem id="threadPaneSortAscending"
+                  type="radio"
+                  name="sortdirection"
+                  value="ascending"
+                  label="&sortAscending.label;"
+                  accesskey="&sortAscending.accesskey;"/>
+        <menuitem id="threadPaneSortDescending"
+                  type="radio"
+                  name="sortdirection"
+                  value="descending"
+                  label="&sortDescending.label;"
+                  accesskey="&sortDescending.accesskey;"/>
+        <menuseparator id="threadPaneSortAfterDescendingSeparator"/>
+        <menuitem id="threadPaneSortThreaded"
+                  type="radio"
+                  name="threaded"
+                  value="threaded"
+                  label="&sortThreaded.label;"
+                  accesskey="&sortThreaded.accesskey;"/>
+        <menuitem id="threadPaneSortUnthreaded"
+                  type="radio"
+                  name="threaded"
+                  value="unthreaded"
+                  label="&sortUnthreaded.label;"
+                  accesskey="&sortUnthreaded.accesskey;"/>
+        <menuitem id="threadPaneGroupBySort"
+                  type="checkbox"
+                  name="group"
+                  value="group"
+                  label="&groupBySort.label;"
+                  accesskey="&groupBySort.accesskey;"/>
+      </menupopup>
+    </menu>
+    <menuseparator id="separatorAfterSortOptions"/>
     <menuitem data-l10n-id="thread-pane-header-context-hide"
               oncommand="threadPaneHeader.toggleThreadPaneHeader();"/>
   </menupopup>