Ticket #4069: chathistory_wip1.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" type="image" size="50%-180 50%-60 50%+180 50%+60" hidden="true" sprite="genericPanel">
 
-    <!-- Message addressee -->
-    <object size="16 14 50 38" 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>
-
-    <!-- Message text -->
-    <object size="16 46 50 70" 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">
-        <translatableAttribute id="tooltip" context="chat input">Type the message to send.</translatableAttribute>
-        <action on="Press">submitChatInput();</action>
-        <action on="Tab">
-            let playernames = [];
-            for (let player in g_PlayerAssignments)
-                playernames.push(g_PlayerAssignments[player].name);
-            autoCompleteNick(this, playernames);
-        </action>
-    </object>
+    <object name="chatExtended" size="0 0 100% 350" hidden="true">
 
-    <!-- Cancel Button -->
-    <object size="16 100%-40 30%+16 100%-12" type="button" style="StoneButton">
-        <translatableAttribute id="caption">Cancel</translatableAttribute>
-        <action on="Press">closeChat();</action>
-    </object>
+        <!-- Tab buttons: Chat, Filter, possibly a page for preformatted, translated messages -->
+        <object type="image" name="chatPageButtons" size="10 10 100%-10 55">
+            <object name="chatPageButtonHistory" type="button" size="0 5 140 100%-10" style="StoneButton" textcolor_disabled="245 208 96">
+                <translatableAttribute id="caption">Chat</translatableAttribute>
+                <action on="Press">showChatPage("History");</action>
+            </object>
+            <object  name="chatPageButtonFilter" type="button" size="150 5 270 100%-10" style="StoneButton" textcolor_disabled="245 208 96">
+                <translatableAttribute id="caption" context="chatWindow">Filter</translatableAttribute>
+                <action on="Press">showChatPage("Filter");</action>
+            </object>
+        </object>
+
+        <object type="image" name="chatPages" size="10 60 100%-10 100%" sprite="ModernDarkBoxGold">
+
+            <!-- History page -->
+            <object name="pageChatHistory" size="0 0 100% 100%">
+                <object name="chatHistory" type="text" size="0 0 100% 100%" style="chatHistory"/>
+            </object>
+
+            <!-- Filter page -->
+            <object name="pageChatFilter" size="0 0 100% 100%">
+                <object name="chatFilterInfo" type="text" size="0 0 100% 25" textcolor="white">
+                    <translatableAttribute id="caption">Specify which messages should be shown:</translatableAttribute>
+                </object>
+                <repeat count="7" var="i">
+                    <object name="chatFilter[i]" type="checkbox" style="ModernTickBox"/>
+                    <object name="chatFilterLabel[i]" type="text" textcolor="white"/>
+                </repeat>
+            </object>
+
+        </object>
+    </object>
+
+    <object name="chatSimple" size="0 0 100% 120">
+
+        <!-- Message addressee -->
+        <object type="text" size="16 14 50 38" style="chatPanel">
+            <translatableAttribute id="caption" context="chat input">To:</translatableAttribute>
+        </object>
+        <object type="dropdown" size="75 12 100%-16 36" name="chatAddressee" style="ModernDropDown" tooltip_style="sessionToolTipBold">
+            <translatableAttribute id="tooltip" context="chat input">Select chatmessage addressee</translatableAttribute>
+        </object>
+
+        <!-- Message text -->
+        <object type="text" size="16 46 50 70" style="chatPanel">
+            <translatableAttribute id="caption" context="chat input">Text:</translatableAttribute>
+        </object>
+        <object name="chatInput" type="input" size="75 44 100%-16 68" 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">
+                let playernames = [];
+                for (let player in g_PlayerAssignments)
+                    playernames.push(g_PlayerAssignments[player].name);
+
+                autoCompleteNick(this, playernames);
+            </action>
+        </object>
+
+        <!-- Close Button -->
+        <object size="16 100%-40 30%+16 100%-12" type="button" style="StoneButton">
+            <translatableAttribute id="caption">Close</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">toggleExtendedChat();</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>
+            <action on="Press">submitChatInput();</action>
+        </object>
 
-    <!-- Send Button -->
-    <object size="60%+16 100%-40 100%-16 100%-12" type="button" style="StoneButton">
-        <translatableAttribute id="caption">Send</translatableAttribute>
-        <action on="Press">submitChatInput();</action>
     </object>
 
 </object>

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

@@ -214 +214 @@
 
     let chatAddressee = Engine.GetGUIObjectByName("chatAddressee");
     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()
 {
     Engine.GetGUIObjectByName("chatInput").caption = "";
     Engine.GetGUIObjectByName("chatInput").blur(); // Remove focus
     Engine.GetGUIObjectByName("chatDialogPanel").hidden = true;
 }
 
+/**
+ * The extended part is shown above the simple one.
+ * So move the simple to the top if extended part is hidden.
+ */
+function resizeChatWindow()
+{
+    let chatSimple = Engine.GetGUIObjectByName("chatSimple");
+    let chatSimpleHeight = chatSimple.size.bottom - chatSimple.size.top;
+
+    let chatExtended = Engine.GetGUIObjectByName("chatExtended");
+    let chatExtendedHeight = chatExtended.size.bottom - chatExtended.size.top;
+
+    // Move simple part to the top if extended is hidden
+    let size = chatSimple.size;
+    size.top = chatExtended.hidden ? 0 : chatExtendedHeight;
+    size.bottom = size.top + chatSimpleHeight;
+    chatSimple.size = size;
+
+    // Resize window to show the extended part
+    let width = chatExtended.hidden ? 360 : 480;
+    let height = chatSimpleHeight + (chatExtended.hidden ? 0 : chatExtendedHeight);
+
+    // Don't center the window vertically
+    let topOffset = 60;
+
+    let chatDialogPanel = Engine.GetGUIObjectByName("chatDialogPanel");
+    let size = chatDialogPanel.size;
+    size.top = -height / 2 - topOffset;
+    size.bottom = height / 2 - topOffset;
+    size.left = -width / 2;
+    size.right = width / 2;
+    chatDialogPanel.size = size;
+
+    Engine.GetGUIObjectByName("chatInput").focus();
+}
+
+function initChatFilters()
+{
+    const checkboxSize = 20;
+    const spacing = 5;
+    const offset = Engine.GetGUIObjectByName("chatFilterInfo").size.bottom;
+
+    for (let i=0; i < g_ChatFilter.length; ++i)
+    {
+        let top = offset + i * (checkboxSize + spacing);
+        let bottom = offset + (i+1) * checkboxSize + i * spacing;
+
+        let chatFilter = Engine.GetGUIObjectByName("chatFilter[" + i + "]");
+        chatFilter.size = [0, top, checkboxSize, bottom].join(" ");
+        chatFilter.hidden = false;
+        chatFilter.checked = true;
+        chatFilter.onPress = function() {
+            updateChatHistory();
+        };
+
+        let chatFilterLabel = Engine.GetGUIObjectByName("chatFilterLabel[" + i + "]");
+        chatFilterLabel.caption = g_ChatFilter[i].caption;
+        chatFilterLabel.size = [checkboxSize, top, "100%", bottom].join(" ");
+        chatFilterLabel.hidden = false;
+    }
+}
+
+function showChatPage(pageName)
+{
+    for (let button of Engine.GetGUIObjectByName("chatPageButtons").children)
+        button.enabled = button.name != "chatPageButton" + pageName
+
+    for (let page of Engine.GetGUIObjectByName("chatPages").children)
+        page.hidden = page.name != "pageChat" + pageName;
+}
+
+function toggleExtendedChat()
+{
+    let chatExtended = Engine.GetGUIObjectByName("chatExtended");
+    chatExtended.hidden = !chatExtended.hidden;
+
+    if (!chatExtended.hidden)
+        updateChatHistory();
+
+    resizeChatWindow();
+}
+
+function updateChatHistory()
+{
+    let filteredTypes = [];
+
+    for (let i=0; i < g_ChatFilter.length; ++i)
+    {
+        //if (Engine.GetGUIObjectByName("chatFilter[" + i + "]").checked)
+        // TODO: filters
+    }
+
+    Engine.GetGUIObjectByName("chatHistory").caption =
+        g_ChatHistory.filter(msg => {
+            return msg.txt; // && filteredTypes.indexOf(msg.type) != -1;
+        }).map(msg => msg.txt).join("\n");
+}
+
 function openDiplomacy()
 {
     closeOpenDialogs();
 
     if (g_ViewedPlayer < 1)

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

@@ -13 +13 @@
  * Maximum number of lines to display simultaneously.
  */
 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 = [];
 
 /**
@@ -191 +196 @@
         "neutral": translate("%(player)s is now neutral with %(player2)s.")
     }
 };
 
 /**
+ * TODO: Should include an entry for every client once scrolling is implemented.
+ */
+var g_ChatFilter = [
+    {
+        "caption": translate("Public"),
+        "key": "public"
+    },
+    {
+        "caption": translate("Allies"),
+        "key": "allies"
+    },
+    {
+        "caption": translate("Enemies"),
+        "key": "enemies"
+    },
+    {
+        "caption": translate("Private"),
+        "key": "private"
+    },
+    {
+        "caption": translate("Observer"),
+        "key": "observer"
+    },
+    {
+        "caption": translate("Connection Status"),
+        "key": "connection"
+    },
+    {
+        "caption": translate("Game Notifications"),
+        "key": "game"
+    }
+];
+
+/**
  * Defines how the GUI reacts to notifications that are sent by the simulation.
  */
 var g_NotificationsTypes =
 {
     "chat": function(notification, player)
@@ -655 +694 @@
 
 /**
  * Loads the text from the GUI window, checks if it is a local command
  * or cheat and executes it. Otherwise sends it as chat.
  */
-function submitChatInput()
+function submitChatInput(window)
 {
     let text = Engine.GetGUIObjectByName("chatInput").caption;
 
     closeChat();
+    Engine.GetGUIObjectByName("chatInput").caption = "";
 
     if (!text.length)
         return;
 
     if (executeNetworkCommand(text))
@@ -691 +731 @@
 
     let formatted = g_FormatChatMessage[msg.type](msg);
     if (!formatted)
         return;
 
+    // Remember the original text as it depends on g_PlayerAssignments
+    g_ChatHistory.push({
+        "type": msg.type,
+        "txt": formatted
+    });
+    updateChatHistory();
+
     g_ChatMessages.push(formatted);
     g_ChatTimers.push(setTimeout(removeOldChatMessage, g_ChatTimeout * 1000));
 
     if (g_ChatMessages.length > g_ChatLines)
         removeOldChatMessage();

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

@@ -288 +288 @@
 
     // If in Atlas editor, disable the exit button
     if (Engine.IsAtlasRunning())
         Engine.GetGUIObjectByName("menuExitButton").enabled = false;
 
+    showChatPage("History");
+    initChatFilters();
+
     initHotkeyTooltips();
 
     if (hotloadData)
         g_Selection.selected = hotloadData.selection;
 

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

@@ -239 +239 @@
         sprite_selectarea="chatInputHighlight"
         textcolor="white"
         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"
        textcolor="white"
        text_align="center"