Ticket #4069: 4069_chat_history_v1.patch

binaries/data/mods/public/gui/session/chat_window.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
-<object name="chatDialogPanel" size="50%-180 50%-66 50%+180 50%+54" type="image" hidden="true" sprite="genericPanel">
+<object name="chatDialogPanel" size="50%-200 50%-410 50%+200 50%+60" type="image" hidden="true" sprite="genericPanel">
 
+    <object type="image" name="chatHistoryPage" size="0 0 100% 300" hidden="false">
+        <object name="chatHistory" type="text" size="10 10 100%-10 100%-36" sprite="ModernDarkBoxGold"  style="chatHistory"/>
+
+        <!-- Chat History Filter -->
+        <object size="16 100%-22 60 100%-2" type="text" style="chatPanel">
+            <translatableAttribute id="caption" context="chat input">Filter:</translatableAttribute>
+        </object>
+        <object size="75 100%-24 100%-16 100%" name="chatHistoryFilter" type="dropdown" style="ModernDropDown" tooltip_style="sessionToolTipBold">
+            <translatableAttribute id="tooltip" context="chat input">Filter the chat history.</translatableAttribute>
+            <action on="SelectionChange">updateChatHistory();</action>
+        </object>
+    </object>
+
     <!-- Message addressee -->
-    <object size="16 14 50 38" type="text" style="chatPanel">
+    <object size="16 100%-106 50 100%-82" type="text" style="chatPanel">
         <translatableAttribute id="caption" context="chat input">To:</translatableAttribute>
     </object>
-    <object size="75 12 100%-16 36" name="chatAddressee" type="dropdown" style="ModernDropDown" tooltip_style="sessionToolTipBold">
-        <translatableAttribute id="tooltip" context="chat input">Select chatmessage addressee</translatableAttribute>
+    <object size="75 100%-108 100%-16 100%-84" name="chatAddressee" type="dropdown" style="ModernDropDown" tooltip_style="sessionToolTipBold">
+        <translatableAttribute id="tooltip" context="chat input">Select chatmessage addressee.</translatableAttribute>
     </object>
 
     <!-- Message text -->
-    <object size="16 46 50 70" type="text" style="chatPanel">
+    <object size="16 100%-74 50 100%-50" type="text" style="chatPanel">
         <translatableAttribute id="caption" context="chat input">Text:</translatableAttribute>
     </object>
-    <object name="chatInput" size="75 44 100%-16 68" type="input" style="ModernInput" max_length="80">
+    <object name="chatInput" size="75 100%-76 100%-16 100%-52" type="input" style="ModernInput" max_length="80">
         <translatableAttribute id="tooltip" context="chat input">Type the message to send.</translatableAttribute>
         <action on="Press">submitChatInput();</action>
         <action on="Tab">
@@ -30 +43 @@
         <translatableAttribute id="caption">Cancel</translatableAttribute>
         <action on="Press">closeChat();</action>
     </object>
+    
+    <!-- Extended Chat Checkbox -->
+    <object name="extendedChat" type="checkbox" checked="false" style="ModernTickBox" size="50%-50 100%-38 50%-24 100%-12">
+        <action on="Press">resizeChatWindow();</action>
+    </object>
 
+    <!-- Extended Chat Label -->
+    <object type="text" size="50%-24 100%-38 50%+40 100%-12" text_align="left" textcolor="white">
+        <translatableAttribute id="caption" context="extended chat">Extended</translatableAttribute>
+    </object>
+
     <!-- Send Button -->
     <object size="60%+16 100%-40 100%-16 100%-12" type="button" style="StoneButton">
         <translatableAttribute id="caption">Send</translatableAttribute>

binaries/data/mods/public/gui/session/menu.js

@@ -217 +217 @@
     let command = teamChat ? (g_IsObserver ? "/observers" : "/allies") : "";
     chatAddressee.selected = chatAddressee.list_data.indexOf(command);
 
-    Engine.GetGUIObjectByName("chatInput").focus();
     Engine.GetGUIObjectByName("chatDialogPanel").hidden = false;
+
+    resizeChatWindow();
 }
 
 function closeChat()
@@ -228 +229 @@
     Engine.GetGUIObjectByName("chatDialogPanel").hidden = true;
 }
 
+function resizeChatWindow()
+{
+    let extended = Engine.GetGUIObjectByName("extendedChat").checked;
+    let chatDialogPanel = Engine.GetGUIObjectByName("chatDialogPanel");
+    let chatHistoryPage = Engine.GetGUIObjectByName("chatHistoryPage");
+    let panelSize = chatDialogPanel.size;
+    panelSize.top = (extended ? -chatHistoryPage.size.bottom : 0) - 60;
+    chatDialogPanel.size = panelSize;
+
+    if (extended)
+        updateChatHistory();
+    Engine.GetGUIObjectByName("chatHistoryPage").hidden = !extended;
+    Engine.GetGUIObjectByName("chatInput").focus();
+}
+
+function initChatHistoryFilter()
+{
+    let chatHistoryFilter = Engine.GetGUIObjectByName("chatHistoryFilter");
+    chatHistoryFilter.list = [translate("All"), translate("Chat"), translate("Players chat"), translate("Ally chat")];
+    chatHistoryFilter.list_data = ["all", "isChat", "noObserver", "isAlly"];
+    chatHistoryFilter.selected = 0;
+}
+
+function updateChatHistory()
+{
+    let chatHistoryFilter = Engine.GetGUIObjectByName("chatHistoryFilter");
+    let selected = chatHistoryFilter.list_data[chatHistoryFilter.selected];
+    Engine.GetGUIObjectByName("chatHistory").caption = g_ChatHistory.filter(msg => selected == "all" || msg[selected]).map(
+        msg => Engine.ConfigDB_GetValue("user", "lobby.chattimestamp") == "true" ?
+            sprintf(translate("%(time)s %(message)s"), {
+                "time": msg.timePrefix,
+                "message": msg.txt
+            }) :
+            msg.txt).join("\n");
+}
+
 function openDiplomacy()
 {
     closeOpenDialogs();

binaries/data/mods/public/gui/session/messages.js

@@ -15 +15 @@
 const g_ChatLines = 20;
 
 /**
- * The strings to be displayed including sender and formating.
+ * The currently displayed strings, limited by the given timeframe and limit above.
  */
 var g_ChatMessages = [];
 
 /**
+ * All unparsed chat messages received since connect, including timestamp.
+ */
+var g_ChatHistory = [];
+
+/**
  * Holds the timer-IDs used for hiding the chat after g_ChatTimeout seconds.
  */
 var g_ChatTimers = [];
@@ -703 +708 @@
     if (!formatted)
         return;
 
+    // Remember the original text as it depends on g_PlayerAssignments
+    let time = new Date(Date.now());
+    let senderID = g_PlayerAssignments[msg.guid].player
+    g_ChatHistory.push({
+        "txt": formatted,
+        "timePrefix": sprintf(translate("\\[%(time)s]"), {
+            "time": Engine.FormatMillisecondsIntoDateString(time.getTime(), translate("HH:mm"))
+        }),
+        "isChat": msg.type == "message",
+        "noObserver": msg.type == "message" && senderID > 0 && !isPlayerObserver(senderID),
+        "isAlly": msg.type == "message" && g_Players[Engine.GetPlayerID()] && g_Players[Engine.GetPlayerID()].isAlly[senderID]
+    });
+    if (!Engine.GetGUIObjectByName("chatDialogPanel").hidden)
+        updateChatHistory();
+
     g_ChatMessages.push(formatted);
     g_ChatTimers.push(setTimeout(removeOldChatMessage, g_ChatTimeout * 1000));
 

binaries/data/mods/public/gui/session/session.js

@@ -294 +294 @@
         Engine.GetGUIObjectByName("menuExitButton").enabled = false;
 
     initHotkeyTooltips();
+    initChatHistoryFilter();
 
     if (hotloadData)
         g_Selection.selected = hotloadData.selection;

binaries/data/mods/public/gui/session/styles.xml

@@ -247 +247 @@
         textcolor_selected="darkgray"
     />
 
+    <style name="chatHistory"
+        buffer_zone="5"
+        font="sans-13"
+        scrollbar="true"
+        scrollbar_style="ModernScrollBar"
+        scroll_bottom="true"
+        textcolor="white"
+        textcolor_selected="gold"
+        text_align="left"
+        text_valign="center"
+    />
+
     <style name="notificationPanel"
         buffer_zone="5"
         font="sans-bold-stroke-14"