Ticket #2640: 2640_3.patch

new file inaries/data/mods/public/gui/common/functions_chat.js

@@ +1 @@
+function addChatMessageGameSetup(msg)
+{
+    var username = "";
+    if (msg.username)
+        username = escapeText(msg.username);
+    else if (msg.guid && g_PlayerAssignments[msg.guid])
+        username = escapeText(g_PlayerAssignments[msg.guid].name);
+
+    var message = "";
+    if ("text" in msg && msg.text)
+        message = escapeText(msg.text);
+
+    // TODO: Maybe host should have distinct font/color?
+    var color = "white";
+
+    if (msg.guid && g_PlayerAssignments[msg.guid] && g_PlayerAssignments[msg.guid].player != -1)
+    {
+        // Valid player who has been assigned - get player color
+        var player = g_PlayerAssignments[msg.guid].player - 1;
+        var mapName = g_GameAttributes.map;
+        var mapData = loadMapData(mapName);
+        var mapSettings = (mapData && mapData.settings ? mapData.settings : {});
+        var pData = mapSettings.PlayerData ? mapSettings.PlayerData[player] : {};
+        var pDefs = g_DefaultPlayerData ? g_DefaultPlayerData[player] : {};
+
+        color = rgbToGuiColor(getSetting(pData, pDefs, "Color"));
+    }
+
+    var formatted;
+    switch (msg.type)
+    {
+    case "connect":
+        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has joined"), { username: formattedUsername }) }) + '[/font]';
+        break;
+
+    case "disconnect":
+        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has left"), { username: formattedUsername }) }) + '[/font]';
+        break;
+
+    case "message":
+        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
+        var formattedUsernamePrefix = '[font="sans-bold-13"]' + sprintf(translate("<%(username)s>"), { username: formattedUsername }) + '[/font]'
+        formatted = sprintf(translate("%(username)s %(message)s"), { username: formattedUsernamePrefix, message: message });
+        break;
+
+    case "ready":
+        var formattedUsername = '[font="sans-bold-13"][color="'+ color +'"]' + username + '[/color][/font]'
+        if (msg.ready)
+            formatted = ' ' + sprintf(translate("* %(username)s is ready!"), { username: formattedUsername });
+        else
+            formatted = ' ' + sprintf(translate("* %(username)s is not ready."), { username: formattedUsername });
+        break;
+
+    case "settings":
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: translate('Game settings have been changed') }) + '[/font]';
+        break;
+
+    default:
+        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
+        return;
+    }
+
+    g_ChatMessages.push(formatted);
+
+    Engine.GetGUIObjectByName("chatText").caption = g_ChatMessages.join("\n");
+}
+
+function addChatMessageSession(msg, playerAssignments)
+{
+    // Default to global assignments, but allow overriding for when reporting
+    // new players joining
+    if (!playerAssignments)
+        playerAssignments = g_PlayerAssignments;
+
+    var playerColor, username;
+
+    // No context by default. May be set by parseChatCommands().
+    msg.context = "";
+
+    if ("guid" in msg && playerAssignments[msg.guid])
+    {
+        var n = playerAssignments[msg.guid].player;
+        // Observers have an ID of -1 which is not a valid index.
+        if (n < 0)
+            n = 0;
+        playerColor = g_Players[n].color.r + " " + g_Players[n].color.g + " " + g_Players[n].color.b;
+        username = escapeText(playerAssignments[msg.guid].name);
+
+        // Parse in-line commands in regular messages.
+        if (msg.type == "message")
+            parseChatCommands(msg, playerAssignments);
+    }
+    else if (msg.type == "defeat" && msg.player)
+    {
+        [username, playerColor] = getUsernameAndColor(msg.player);
+    }
+    else if (msg.type == "message")
+    {
+        [username, playerColor] = getUsernameAndColor(msg.player);
+        parseChatCommands(msg, playerAssignments);
+    }
+    else
+    {
+        playerColor = "255 255 255";
+        username = translate("Unknown player");
+    }
+
+    var formatted;
+
+    switch (msg.type)
+    {
+    case "connect":
+        formatted = sprintf(translate("%(player)s is starting to rejoin the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
+    case "disconnect":
+        formatted = sprintf(translate("%(player)s has left the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
+    case "rejoined":
+        formatted = sprintf(translate("%(player)s has rejoined the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
+    case "defeat":
+        // In singleplayer, the local player is "You". "You has" is incorrect.
+        if (!g_IsNetworked && msg.player == Engine.GetPlayerID())
+            formatted = translate("You have been defeated.");
+        else
+            formatted = sprintf(translate("%(player)s has been defeated."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
+    case "diplomacy":
+        var message;
+        if (msg.player == Engine.GetPlayerID())
+        {
+            [username, playerColor] = getUsernameAndColor(msg.player1);
+            if (msg.status == "ally")
+                message = translate("You are now allied with %(player)s.");
+            else if (msg.status == "enemy")
+                message = translate("You are now at war with %(player)s.");
+            else // (msg.status == "neutral")
+                message = translate("You are now neutral with %(player)s.");
+        }
+        else if (msg.player1 == Engine.GetPlayerID())
+        {
+            [username, playerColor] = getUsernameAndColor(msg.player);
+            if (msg.status == "ally")
+                message = translate("%(player)s is now allied with you.");
+            else if (msg.status == "enemy")
+                message = translate("%(player)s is now at war with you.");
+            else // (msg.status == "neutral")
+                message = translate("%(player)s is now neutral with you.");
+        }
+        else // No need for other players to know of this.
+            return;
+
+        formatted = sprintf(message, { "player": '[color="'+ playerColor + '"]' + username + '[/color]' });
+        break;
+    case "tribute":
+        if (msg.player != Engine.GetPlayerID()) 
+            return;
+
+        [username, playerColor] = getUsernameAndColor(msg.player1);
+
+        // Format the amounts to proper English: 200 food, 100 wood, and 300 metal; 100 food; 400 wood and 200 stone
+        let amounts = Object.keys(msg.amounts)
+            .filter(function (type) { return msg.amounts[type] > 0; })
+            .map(function (type) { return sprintf(translate("%(amount)s %(resourceType)s"), {
+                "amount": msg.amounts[type],
+                "resourceType": getLocalizedResourceName(type, "withinSentence")});
+            });
+
+        if (amounts.length > 1)
+        {
+            let lastAmount = amounts.pop();
+            amounts = sprintf(translate("%(previousAmounts)s and %(lastAmount)s"), {
+                previousAmounts: amounts.join(translate(", ")),
+                lastAmount: lastAmount
+            });
+        }
+
+        formatted = sprintf(translate("%(player)s has sent you %(amounts)s."), {
+            player: "[color=\"" + playerColor + "\"]" + username + "[/color]",
+            amounts: amounts
+        });
+        break;
+    case "attack":
+        if (msg.player != Engine.GetPlayerID()) 
+            return;
+
+        [username, playerColor] = getUsernameAndColor(msg.attacker);
+        // Since livestock can be attacked/gathered by other players,
+        // we display a more specific notification in this case to not confuse the player
+        if (msg.targetIsDomesticAnimal)
+            var message = translate("Your livestock have been attacked by %(attacker)s!");
+        else
+            var message = translate("You have been attacked by %(attacker)s!");
+        formatted = sprintf(message, { attacker: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
+    case "message":
+        // May have been hidden by the 'team' command.
+        if (msg.hide)
+            return;
+
+        var message;
+        if ("translate" in msg && msg.translate)
+        {
+            message = translate(msg.text); // No need to escape, not a user message.
+            if ("translateParameters" in msg && msg.translateParameters)
+            {
+                var parameters = msg.parameters || {};
+                translateObjectKeys(parameters, msg.translateParameters);
+                message = sprintf(message, parameters);
+            }
+        }
+        else
+            message = escapeText(msg.text);
+
+        if (msg.action)
+        {
+            if (msg.context !== "")
+            {
+                formatted = sprintf(translate("(%(context)s) * %(user)s %(message)s"), {
+                    context: msg.context,
+                    user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
+                    message: message
+                });
+            }
+            else
+            {
+                formatted = sprintf(translate("* %(user)s %(message)s"), {
+                    user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
+                    message: message
+                });
+            }
+        }
+        else
+        {
+            var userTag = sprintf(translate("<%(user)s>"), { user: username })
+            var formattedUserTag = sprintf(translate("<%(user)s>"), { user: "[color=\"" + playerColor + "\"]" + username + "[/color]" })
+            if (msg.context !== "")
+            {
+                formatted = sprintf(translate("(%(context)s) %(userTag)s %(message)s"), {
+                    context: msg.context,
+                    userTag: formattedUserTag,
+                    message: message
+                });
+            }
+            else
+            {
+                formatted = sprintf(translate("%(userTag)s %(message)s"), { userTag: formattedUserTag, message: message});
+            }
+        }
+        break;
+    default:
+        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
+        return;
+    }
+
+    chatMessages.push(formatted);
+    chatTimers.push(setTimeout(removeOldChatMessages, CHAT_TIMEOUT));
+
+    if (chatMessages.length > MAX_NUM_CHAT_LINES)
+        removeOldChatMessages();
+    else
+        Engine.GetGUIObjectByName("chatText").caption = chatMessages.join("\n");
+}
+
+function addChatMessageLobby(msg)
+{
+    // Some calls of this function will leave some msg parameters empty. Text is required though.
+    if (msg.from)
+    {
+        // Display the moderator symbol in the chatbox.
+        var playerRole = Engine.LobbyGetPlayerRole(msg.from);
+        if (playerRole == "moderator")
+            msg.from = g_modPrefix + msg.from;
+    }
+    else
+        msg.from = null;
+    if (!msg.color)
+        msg.color = null;
+    if (!msg.key)
+        msg.key = null;
+    if (!msg.datetime)
+        msg.datetime = null;
+
+    // Highlight local user's nick
+    if (msg.text.indexOf(g_Name) != -1 && g_Name != msg.from)
+        msg.text = msg.text.replace(new RegExp('\\b' + '\\' + g_Name + '\\b', "g"), colorPlayerName(g_Name));
+
+    // Run spam test if it's not a historical message
+    if (!msg.datetime)
+        updateSpamMonitor(msg.from);
+    if (isSpam(msg.text, msg.from))
+        return;
+
+    // Format Text
+    var formatted = ircFormat(msg.text, msg.from, msg.color, msg.key, msg.datetime);
+
+    // If there is text, add it to the chat box.
+    if (formatted)
+    {
+        g_ChatMessages.push(formatted);
+        Engine.GetGUIObjectByName("chatText").caption = g_ChatMessages.join("\n");
+    }
+}
+

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

@@ -451 +451 @@
                 // If we have extra player slots and we are the controller, give the player an ID.
                 if (g_IsController && message.hosts[host].player === -1 && g_AssignedCount < g_GameAttributes.settings.PlayerData.length)
                     Engine.AssignNetworkPlayer(g_AssignedCount + 1, host);
-                addChatMessage({ "type": "connect", "username": message.hosts[host].name });
+                addChatMessageGameSetup({ "type": "connect", "username": message.hosts[host].name });
                 newPlayer = host;
             }
         }
@@ -460 +460 @@
         {
             if (!message.hosts[host])
             {
-                addChatMessage({ "type": "disconnect", "guid": host });
+                addChatMessageGameSetup({ "type": "disconnect", "guid": host });
                 if (g_PlayerAssignments[host].player != -1)
                     resetReady = true; // Observers shouldn't reset ready.
             }
@@ -494 +494 @@
         break;
 
     case "chat":
-        addChatMessage({ "type": "message", "guid": message.guid, "text": message.text });
+        addChatMessageGameSetup({ "type": "message", "guid": message.guid, "text": message.text });
         break;
 
     // Singular client to host message
     case "ready":
         g_ReadyChanged -= 1;
         if (g_ReadyChanged < 1 && g_PlayerAssignments[message.guid].player != -1)
-            addChatMessage({ "type": "ready", "guid": message.guid, "ready": +message.status == 1 });
+            addChatMessageGameSetup({ "type": "ready", "guid": message.guid, "ready": +message.status == 1 });
         if (!g_IsController)
             break;
         g_PlayerAssignments[message.guid].status = +message.status == 1;
@@ -1688 +1688 @@
     }
 }
 
-function addChatMessage(msg)
-{
-    var username = "";
-    if (msg.username)
-        username = escapeText(msg.username);
-    else if (msg.guid && g_PlayerAssignments[msg.guid])
-        username = escapeText(g_PlayerAssignments[msg.guid].name);
-
-    var message = "";
-    if ("text" in msg && msg.text)
-        message = escapeText(msg.text);
-
-    // TODO: Maybe host should have distinct font/color?
-    var color = "white";
-
-    if (msg.guid && g_PlayerAssignments[msg.guid] && g_PlayerAssignments[msg.guid].player != -1)
-    {
-        // Valid player who has been assigned - get player color
-        var player = g_PlayerAssignments[msg.guid].player - 1;
-        var mapName = g_GameAttributes.map;
-        var mapData = loadMapData(mapName);
-        var mapSettings = (mapData && mapData.settings ? mapData.settings : {});
-        var pData = mapSettings.PlayerData ? mapSettings.PlayerData[player] : {};
-        var pDefs = g_DefaultPlayerData ? g_DefaultPlayerData[player] : {};
-
-        color = rgbToGuiColor(getSetting(pData, pDefs, "Color"));
-    }
-
-    var formatted;
-    switch (msg.type)
-    {
-    case "connect":
-        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has joined"), { username: formattedUsername }) }) + '[/font]';
-        break;
-
-    case "disconnect":
-        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has left"), { username: formattedUsername }) }) + '[/font]';
-        break;
-
-    case "message":
-        var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        var formattedUsernamePrefix = '[font="sans-bold-13"]' + sprintf(translate("<%(username)s>"), { username: formattedUsername }) + '[/font]'
-        formatted = sprintf(translate("%(username)s %(message)s"), { username: formattedUsernamePrefix, message: message });
-        break;
-
-    case "ready":
-        var formattedUsername = '[font="sans-bold-13"][color="'+ color +'"]' + username + '[/color][/font]'
-        if (msg.ready)
-            formatted = ' ' + sprintf(translate("* %(username)s is ready!"), { username: formattedUsername });
-        else
-            formatted = ' ' + sprintf(translate("* %(username)s is not ready."), { username: formattedUsername });
-        break;
-
-    case "settings":
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: translate('Game settings have been changed') }) + '[/font]';
-        break;
-
-    default:
-        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
-        return;
-    }
-
-    g_ChatMessages.push(formatted);
-
-    Engine.GetGUIObjectByName("chatText").caption = g_ChatMessages.join("\n");
-}
-
 function toggleMoreOptions()
 {
     Engine.GetGUIObjectByName("moreOptionsFade").hidden = !Engine.GetGUIObjectByName("moreOptionsFade").hidden;
@@ -1835 +1766 @@
         return;
 
     if (g_ReadyChanged < 1)
-        addChatMessage({ "type": "settings"});
+        addChatMessageGameSetup({ "type": "settings"});
     else if (g_ReadyChanged == 2 && !g_ReadyInit)
         return; // duplicate calls on init
     else

binaries/data/mods/public/gui/gamesetup/gamesetup.xml

@@ -3 +3 @@
 <objects>
 
     <script file="gui/common/network.js"/>
+    <script file="gui/common/functions_chat.js"/>
     <script file="gui/common/functions_civinfo.js"/>
     <script file="gui/common/functions_global_object.js"/>
     <script file="gui/common/functions_utility.js"/>

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

@@ -75 +75 @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
-// Update functions
-////////////////////////////////////////////////////////////////////////////////////////////////
-
-function updateGameListOrderSelection()
-{
-    g_GameListSortBy = Engine.GetGUIObjectByName("gamesBox").selected_column;
-    g_GameListOrder = Engine.GetGUIObjectByName("gamesBox").selected_column_order;
-
-    applyFilters();
-}
-
-function updatePlayerListOrderSelection()
-{
-    g_PlayerListSortBy = Engine.GetGUIObjectByName("playersBox").selected_column;
-    g_PlayerListOrder = Engine.GetGUIObjectByName("playersBox").selected_column_order;
-
-    updatePlayerList();
-}
-
-function resetFilters()
-{
-    // Reset states of gui objects
+// Update functions
+////////////////////////////////////////////////////////////////////////////////////////////////
+
+function updateGameListOrderSelection()
+{
+    g_GameListSortBy = Engine.GetGUIObjectByName("gamesBox").selected_column;
+    g_GameListOrder = Engine.GetGUIObjectByName("gamesBox").selected_column_order;
+
+    applyFilters();
+}
+
+function updatePlayerListOrderSelection()
+{
+    g_PlayerListSortBy = Engine.GetGUIObjectByName("playersBox").selected_column;
+    g_PlayerListOrder = Engine.GetGUIObjectByName("playersBox").selected_column_order;
+
+    updatePlayerList();
+}
+
+function resetFilters()
+{
+    // Reset states of gui objects
     Engine.GetGUIObjectByName("mapSizeFilter").selected = 0
     Engine.GetGUIObjectByName("playersNumberFilter").selected = 0;
-    Engine.GetGUIObjectByName("mapTypeFilter").selected = 0;
-    Engine.GetGUIObjectByName("showFullFilter").checked = false;
-
-    applyFilters();
-}
-
-function applyFilters()
+    Engine.GetGUIObjectByName("mapTypeFilter").selected = 0;
+    Engine.GetGUIObjectByName("showFullFilter").checked = false;
+
+    applyFilters();
+}
+
+function applyFilters()
 {
     // Update the list of games
     updateGameList();
@@ -162 +162 @@
         subjectBox.hidden = false;
         logo.size = "50%-110 40 50%+110 140";
     }
-}
-
-/**
- * Do a full update of the player listing, including ratings from cached C++ information.
- *
- * @return Array containing the player, presence, nickname, and rating listings.
- */
+}
+
+/**
+ * Do a full update of the player listing, including ratings from cached C++ information.
+ *
+ * @return Array containing the player, presence, nickname, and rating listings.
+ */
 function updatePlayerList()
 {
     var playersBox = Engine.GetGUIObjectByName("playersBox");
@@ -402 +402 @@
     // to update the game info panel.
     g_GameList = gameList;
 
-    // Sort the list of games to that games 'waiting' are displayed at the top, followed by 'init', followed by 'running'.
+    // Sort the list of games to that games 'waiting' are displayed at the top, followed by 'init', followed by 'running'.
     var gameStatuses = ['waiting', 'init', 'running'];
     g_GameList.sort(function (a,b) {
         switch (g_GameListSortBy)
@@ -633 +633 @@
         // Check if it looks like an ip address
         if (sip.split('.').length != 4)
         {
-            addChatMessage({ "from": "system", "text": sprintf(translate("This game's address '%(ip)s' does not appear to be valid."), { ip: sip }) });
+            addChatMessageLobby({ "from": "system", "text": sprintf(translate("This game's address '%(ip)s' does not appear to be valid."), { ip: sip }) });
             return;
         }
 
@@ -681 +681 @@
         {
         case "mucmessage": // For room messages
             var from = escapeText(message.from);
-            addChatMessage({ "from": from, "text": text, "datetime": message.datetime});
+            addChatMessageLobby({ "from": from, "text": text, "datetime": message.datetime});
             break;
         case "message": // For private messages
             var from = escapeText(message.from);
-            addChatMessage({ "from": from, "text": text, "datetime": message.datetime});
+            addChatMessageLobby({ "from": from, "text": text, "datetime": message.datetime});
             break;
         case "muc":
             var nick = message.text;
@@ -716 +716 @@
                     nickList.push(nick);
                     ratingList.push(String(rating));
                     Engine.SendGetRatingList();
-                    addChatMessage({ "text": "/special " + sprintf(translate("%(nick)s has joined."), { nick: nick }), "key": g_specialKey });
+                    addChatMessageLobby({ "text": "/special " + sprintf(translate("%(nick)s has joined."), { nick: nick }), "key": g_specialKey });
                 }
                 break;
             case "leave":
@@ -726 +726 @@
                 presenceList.splice(nickIndex, 1);
                 nickList.splice(nickIndex, 1);
                 ratingList.splice(nickIndex, 1);
-                addChatMessage({ "text": "/special " + sprintf(translate("%(nick)s has left."), { nick: nick }), "key": g_specialKey });
+                addChatMessageLobby({ "text": "/special " + sprintf(translate("%(nick)s has left."), { nick: nick }), "key": g_specialKey });
                 break;
             case "nick":
                 if (nickIndex == -1) // This shouldn't ever happen
                     break;
                 if (!isValidNick(message.data))
                 {
-                    addChatMessage({ "from": "system", "text": sprintf(translate("Invalid nickname: %(nick)s"), { nick: message.data })});
+                    addChatMessageLobby({ "from": "system", "text": sprintf(translate("Invalid nickname: %(nick)s"), { nick: message.data })});
                     break;
                 }
                 var [name, status, rating] = formatPlayerListEntry(message.data, presence, stripColorCodes(ratingList[nickIndex])); // TODO: actually we don't want to change the presence here, so use what was used before
                 playerList[nickIndex] = name;
                 // presence stays the same
                 nickList[nickIndex] = message.data;
-                addChatMessage({ "text": "/special " + sprintf(translate("%(oldnick)s is now known as %(newnick)s."), { oldnick: nick, newnick: message.data }), "key": g_specialKey });
+                addChatMessageLobby({ "text": "/special " + sprintf(translate("%(oldnick)s is now known as %(newnick)s."), { oldnick: nick, newnick: message.data }), "key": g_specialKey });
                 Engine.SendGetRatingList();
                 break;
             case "presence":
@@ -770 +770 @@
             switch (message.level)
             {
             case "standard":
-                addChatMessage({ "from": "system", "text": text, "color": "150 0 0" });
+                addChatMessageLobby({ "from": "system", "text": text, "color": "150 0 0" });
                 if (message.text == "disconnected")
                 {
                     // Clear the list of games and the list of players
@@ -786 +786 @@
                 }
                 break;
             case "error":
-                addChatMessage({ "from": "system", "text": text, "color": "150 0 0" });
+                addChatMessageLobby({ "from": "system", "text": text, "color": "150 0 0" });
                 break;
             case "internal":
                 switch (message.text)
@@ -868 +868 @@
     case "me":
         return false;
     default:
-        addChatMessage({ "from":"system", "text": sprintf(translate("We're sorry, the '%(cmd)s' command is not supported."), { cmd: cmd})});
+        addChatMessageLobby({ "from":"system", "text": sprintf(translate("We're sorry, the '%(cmd)s' command is not supported."), { cmd: cmd})});
     }
     return true;
 }
 
-/**
- * Process and, if appropriate, display a formatted message.
- *
- * @param msg The message to be processed.
- */
-function addChatMessage(msg)
-{
-    // Some calls of this function will leave some msg parameters empty. Text is required though.
-    if (msg.from)
-    {
-        // Display the moderator symbol in the chatbox.
-        var playerRole = Engine.LobbyGetPlayerRole(msg.from);
-        if (playerRole == "moderator")
-            msg.from = g_modPrefix + msg.from;
-    }
-    else
-        msg.from = null;
-    if (!msg.color)
-        msg.color = null;
-    if (!msg.key)
-        msg.key = null;
-    if (!msg.datetime)
-        msg.datetime = null;
-
-    // Highlight local user's nick
-    if (msg.text.indexOf(g_Name) != -1 && g_Name != msg.from)
-        msg.text = msg.text.replace(new RegExp('\\b' + '\\' + g_Name + '\\b', "g"), colorPlayerName(g_Name));
-
-    // Run spam test if it's not a historical message
-    if (!msg.datetime)
-        updateSpamMonitor(msg.from);
-    if (isSpam(msg.text, msg.from))
-        return;
-
-    // Format Text
-    var formatted = ircFormat(msg.text, msg.from, msg.color, msg.key, msg.datetime);
-
-    // If there is text, add it to the chat box.
-    if (formatted)
-    {
-        g_ChatMessages.push(formatted);
-        Engine.GetGUIObjectByName("chatText").caption = g_ChatMessages.join("\n");
-    }
-}
-
 function ircSplit(string)
 {
     var idx = string.indexOf(' ');
@@ -1062 +1017 @@
     {
         g_spamMonitor[from][2] = time;
         if (from == g_Name)
-            addChatMessage({ "from": "system", "text": translate("Please do not spam. You have been blocked for thirty seconds.") });
+            addChatMessageLobby({ "from": "system", "text": translate("Please do not spam. You have been blocked for thirty seconds.") });
         return true;
     }
     // Return false if everything is clear.

binaries/data/mods/public/gui/lobby/lobby.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
+    <script file="gui/common/functions_chat.js"/>
     <script file="gui/common/functions_global_object.js"/>
     <script file="gui/common/functions_utility.js"/>
     <script file="gui/common/timer.js"/>

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

@@ -44 +44 @@
         } else {
             message["guid"] = guid;
         }
-        addChatMessage(message);
+        addChatMessageSession(message);
     },
     "aichat": function(notification, player)
     {
@@ -74 +74 @@
         } else {
             message["guid"] = guid;
         }
-        addChatMessage(message);
+        addChatMessageSession(message);
     },
     "defeat": function(notification, player)
     {
-        addChatMessage({
+        addChatMessageSession({
             "type": "defeat",
             "guid": findGuidForPlayerID(g_PlayerAssignments, player),
             "player": player
@@ -88 +88 @@
     },
     "diplomacy": function(notification, player)
     {
-        addChatMessage({
+        addChatMessageSession({
             "type": "diplomacy",
             "player": player,
             "player1": notification.player1,
@@ -103 +103 @@
     },
     "tribute": function(notification, player)
     {
-        addChatMessage({
+        addChatMessageSession({
             "type": "tribute",
             "player": player,
             "player1": notification.donator,
@@ -116 +116 @@
             return;
         if (Engine.ConfigDB_GetValue("user", "gui.session.attacknotificationmessage") !== "true")
             return;
-        addChatMessage({
+        addChatMessageSession({
             "type": "attack",
             "player": player,
             "attacker": notification.attacker,
@@ -259 +259 @@
             if (!message.hosts[host])
             {
                 // Tell the user about the disconnection
-                addChatMessage({ "type": "disconnect", "guid": host });
+                addChatMessageSession({ "type": "disconnect", "guid": host });
 
                 // Update the cached player data, so we can display the disconnection status
                 updatePlayerDataRemove(g_Players, host);
@@ -275 +275 @@
                 updatePlayerDataAdd(g_Players, host, message.hosts[host]);
 
                 // Tell the user about the connection
-                addChatMessage({ "type": "connect", "guid": host }, message.hosts);
+                addChatMessageSession({ "type": "connect", "guid": host }, message.hosts);
             }
         }
 
@@ -290 +290 @@
         break;
 
     case "chat":
-        addChatMessage({ "type": "message", "guid": message.guid, "text": message.text });
+        addChatMessageSession({ "type": "message", "guid": message.guid, "text": message.text });
         break;
 
     case "aichat":
-        addChatMessage({ "type": "message", "guid": message.guid, "text": message.text, "translate": true });
+        addChatMessageSession({ "type": "message", "guid": message.guid, "text": message.text, "translate": true });
         break;
 
     case "rejoined":
-        addChatMessage({ "type": "rejoined", "guid": message.guid});
+        addChatMessageSession({ "type": "rejoined", "guid": message.guid});
         break;
         
     // To prevent errors, ignore these message types that occur during autostart
@@ -318 +318 @@
         if (g_IsNetworked)
             Engine.SendNetworkChat(text);
         else
-            addChatMessage({ "type": "message", "guid": "local", "text": text });
+            addChatMessageSession({ "type": "message", "guid": "local", "text": text });
     }
 }
 
@@ -385 +385 @@
             if (g_IsNetworked)
                 Engine.SendNetworkChat(text);
             else
-                addChatMessage({ "type": "message", "guid": "local", "text": text });
+                addChatMessageSession({ "type": "message", "guid": "local", "text": text });
         }
         input.caption = ""; // Clear chat input
     }
@@ -395 +395 @@
     toggleChatWindow();
 }
 
-function addChatMessage(msg, playerAssignments)
-{
-    // Default to global assignments, but allow overriding for when reporting
-    // new players joining
-    if (!playerAssignments)
-        playerAssignments = g_PlayerAssignments;
-
-    var playerColor, username;
-
-    // No context by default. May be set by parseChatCommands().
-    msg.context = "";
-
-    if ("guid" in msg && playerAssignments[msg.guid])
-    {
-        var n = playerAssignments[msg.guid].player;
-        // Observers have an ID of -1 which is not a valid index.
-        if (n < 0)
-            n = 0;
-        playerColor = g_Players[n].color.r + " " + g_Players[n].color.g + " " + g_Players[n].color.b;
-        username = escapeText(playerAssignments[msg.guid].name);
-
-        // Parse in-line commands in regular messages.
-        if (msg.type == "message")
-            parseChatCommands(msg, playerAssignments);
-    }
-    else if (msg.type == "defeat" && msg.player)
-    {
-        [username, playerColor] = getUsernameAndColor(msg.player);
-    }
-    else if (msg.type == "message")
-    {
-        [username, playerColor] = getUsernameAndColor(msg.player);
-        parseChatCommands(msg, playerAssignments);
-    }
-    else
-    {
-        playerColor = "255 255 255";
-        username = translate("Unknown player");
-    }
-
-    var formatted;
-
-    switch (msg.type)
-    {
-    case "connect":
-        formatted = sprintf(translate("%(player)s is starting to rejoin the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-        break;
-    case "disconnect":
-        formatted = sprintf(translate("%(player)s has left the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-        break;
-    case "rejoined":
-        formatted = sprintf(translate("%(player)s has rejoined the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-        break;
-    case "defeat":
-        // In singleplayer, the local player is "You". "You has" is incorrect.
-        if (!g_IsNetworked && msg.player == Engine.GetPlayerID())
-            formatted = translate("You have been defeated.");
-        else
-            formatted = sprintf(translate("%(player)s has been defeated."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-        break;
-    case "diplomacy":
-        var message;
-        if (msg.player == Engine.GetPlayerID())
-        {
-            [username, playerColor] = getUsernameAndColor(msg.player1);
-            if (msg.status == "ally")
-                message = translate("You are now allied with %(player)s.");
-            else if (msg.status == "enemy")
-                message = translate("You are now at war with %(player)s.");
-            else // (msg.status == "neutral")
-                message = translate("You are now neutral with %(player)s.");
-        }
-        else if (msg.player1 == Engine.GetPlayerID())
-        {
-            [username, playerColor] = getUsernameAndColor(msg.player);
-            if (msg.status == "ally")
-                message = translate("%(player)s is now allied with you.");
-            else if (msg.status == "enemy")
-                message = translate("%(player)s is now at war with you.");
-            else // (msg.status == "neutral")
-                message = translate("%(player)s is now neutral with you.");
-        }
-        else // No need for other players to know of this.
-            return;
-
-        formatted = sprintf(message, { "player": '[color="'+ playerColor + '"]' + username + '[/color]' });
-        break;
-    case "tribute":
-        if (msg.player != Engine.GetPlayerID()) 
-            return;
-
-        [username, playerColor] = getUsernameAndColor(msg.player1);
-
-        // Format the amounts to proper English: 200 food, 100 wood, and 300 metal; 100 food; 400 wood and 200 stone
-        let amounts = Object.keys(msg.amounts)
-            .filter(function (type) { return msg.amounts[type] > 0; })
-            .map(function (type) { return sprintf(translate("%(amount)s %(resourceType)s"), {
-                "amount": msg.amounts[type],
-                "resourceType": getLocalizedResourceName(type, "withinSentence")});
-            });
-
-        if (amounts.length > 1)
-        {
-            let lastAmount = amounts.pop();
-            amounts = sprintf(translate("%(previousAmounts)s and %(lastAmount)s"), {
-                previousAmounts: amounts.join(translate(", ")),
-                lastAmount: lastAmount
-            });
-        }
-
-        formatted = sprintf(translate("%(player)s has sent you %(amounts)s."), {
-            player: "[color=\"" + playerColor + "\"]" + username + "[/color]",
-            amounts: amounts
-        });
-        break;
-    case "attack":
-        if (msg.player != Engine.GetPlayerID()) 
-            return;
-
-        [username, playerColor] = getUsernameAndColor(msg.attacker);
-        // Since livestock can be attacked/gathered by other players,
-        // we display a more specific notification in this case to not confuse the player
-        if (msg.targetIsDomesticAnimal)
-            var message = translate("Your livestock have been attacked by %(attacker)s!");
-        else
-            var message = translate("You have been attacked by %(attacker)s!");
-        formatted = sprintf(message, { attacker: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
-        break;
-    case "message":
-        // May have been hidden by the 'team' command.
-        if (msg.hide)
-            return;
-
-        var message;
-        if ("translate" in msg && msg.translate)
-        {
-            message = translate(msg.text); // No need to escape, not a user message.
-            if ("translateParameters" in msg && msg.translateParameters)
-            {
-                var parameters = msg.parameters || {};
-                translateObjectKeys(parameters, msg.translateParameters);
-                message = sprintf(message, parameters);
-            }
-        }
-        else
-            message = escapeText(msg.text);
-
-        if (msg.action)
-        {
-            if (msg.context !== "")
-            {
-                formatted = sprintf(translate("(%(context)s) * %(user)s %(message)s"), {
-                    context: msg.context,
-                    user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
-                    message: message
-                });
-            }
-            else
-            {
-                formatted = sprintf(translate("* %(user)s %(message)s"), {
-                    user: "[color=\"" + playerColor + "\"]" + username + "[/color]",
-                    message: message
-                });
-            }
-        }
-        else
-        {
-            var userTag = sprintf(translate("<%(user)s>"), { user: username })
-            var formattedUserTag = sprintf(translate("<%(user)s>"), { user: "[color=\"" + playerColor + "\"]" + username + "[/color]" })
-            if (msg.context !== "")
-            {
-                formatted = sprintf(translate("(%(context)s) %(userTag)s %(message)s"), {
-                    context: msg.context,
-                    userTag: formattedUserTag,
-                    message: message
-                });
-            }
-            else
-            {
-                formatted = sprintf(translate("%(userTag)s %(message)s"), { userTag: formattedUserTag, message: message});
-            }
-        }
-        break;
-    default:
-        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
-        return;
-    }
-
-    chatMessages.push(formatted);
-    chatTimers.push(setTimeout(removeOldChatMessages, CHAT_TIMEOUT));
-
-    if (chatMessages.length > MAX_NUM_CHAT_LINES)
-        removeOldChatMessages();
-    else
-        Engine.GetGUIObjectByName("chatText").caption = chatMessages.join("\n");
-}
-
 function removeOldChatMessages()
 {
     clearTimeout(chatTimers[0]); // The timer only needs to be cleared when new messages bump old messages off

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

@@ -3 +3 @@
 <objects>
 
 <script file="gui/common/colorFades.js"/>
+<script file="gui/common/functions_chat.js"/>
 <script file="gui/common/functions_civinfo.js"/>
 <script file="gui/common/functions_global_object.js"/>
 <script file="gui/common/functions_utility.js"/>