Ticket #3143: 3143_lobby_data_v3.patch

binaries/data/mods/public/gui/common/functions_utility.js

@@ -57 +57 @@
 
 /**
  * Escape tag start and escape characters, so users cannot use special formatting.
  * Also limit string length to 256 characters (not counting escape characters).
  */
-function escapeText(text)
+function escapeText(text, limitLength = true)
 {
     if (!text)
         return text;
 
-    return text.substr(0, 255).replace(/\\/g, "\\\\").replace(/\[/g, "\\[");
+    if (limitLength)
+        text = text.substr(0, 255);
+
+    return text.replace(/\\/g, "\\\\").replace(/\[/g, "\\[");
+}
+
+function unescapeText(text)
+{
+    if (!text)
+        return text;
+    return text.replace(/\\\\/g, "\\").replace(/\\\[/g, "\[");
+}
+
+/**
+ * Merge players by team to remove duplicate Team entries, thus reducing the packet size of the lobby report.
+ */
+function playerDataToStringifiedTeamList(playerData)
+{
+    let teamList = {};
+
+    for (let pData of playerData)
+    {
+        let team = pData.Team === undefined ? -1 : pData.Team;
+        if (!teamList[team])
+            teamList[team] = [];
+        teamList[team].push(pData);
+        delete teamList[team].Team;
+    }
+
+    return escapeText(JSON.stringify(teamList), false);
+}
+
+function stringifiedTeamListToPlayerData(stringifiedTeamList)
+{
+    let teamList = JSON.parse(unescapeText(stringifiedTeamList));
+    let playerData = [];
+
+    for (let team in teamList)
+        for (let pData of teamList[team])
+        {
+            pData.Team = +team;
+            playerData.push(pData);
+        }
+
+    return playerData;
 }
 
 function translateMapTitle(mapTitle)
 {
     return mapTitle == "random" ? translateWithContext("map selection", "Random") : translate(mapTitle);
@@ -224 +268 @@
     let playerDescriptions = {};
     let playerIdx = 0;
 
     for (let playerData of playerDataArray)
     {
-        if (playerData == null || playerData.Civ == "gaia")
+        if (playerData == null || playerData.Civ && playerData.Civ == "gaia")
             continue;
 
         ++playerIdx;
         let teamIdx = playerData.Team;
         let isAI = playerData.AI && playerData.AI != "";
-        let playerState = playerStates && playerStates[playerIdx];
+        let playerState = playerStates && playerStates[playerIdx] || playerData.State;
         let isActive = !playerState || playerState == "active";
+        let isOffline = playerData.Offline;
 
         let playerDescription;
         if (isAI)
         {
-            if (isActive)
-                // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
-                playerDescription = translate("%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s)");
+            if (playerData.Civ)
+            {
+                if (isActive)
+                    // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                    playerDescription = translate("%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s)");
+                else
+                    // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                    playerDescription = translate("%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s, %(state)s)");
+            }
             else
-                // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
-                playerDescription = translate("%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s, %(state)s)");
+            {
+                if (isActive)
+                    // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                    playerDescription = translate("%(playerName)s (%(AIdifficulty)s %(AIname)s)");
+                else
+                    // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                    playerDescription = translate("%(playerName)s (%(AIdifficulty)s %(AIname)s, %(state)s)");
+            }
         }
         else
         {
-            if (isActive)
-                // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
-                playerDescription = translate("%(playerName)s (%(civ)s)");
+            // Can only occur in the lobby for now, so no strings with civ needed
+            if (isOffline)
+            {
+                if (isActive)
+                    // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                    playerDescription = translate("%(playerName)s (OFFLINE)");
+                else
+                    // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                    playerDescription = translate("%(playerName)s (OFFLINE, %(state)s)");
+            }
             else
-                // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
-                playerDescription = translate("%(playerName)s (%(civ)s, %(state)s)");
+            {
+                if (playerData.Civ)
+                    if (isActive)
+                        // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                        playerDescription = translate("%(playerName)s (%(civ)s)");
+                    else
+                        // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                        playerDescription = translate("%(playerName)s (%(civ)s, %(state)s)");
+                else
+                    if (isActive)
+                        // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                        playerDescription = translate("%(playerName)s");
+                    else
+                        // Translation: Describe a player in a selected game, f.e. in the replay- or savegame menu
+                        playerDescription = translate("%(playerName)s (%(state)s)");
+            }
         }
 
         // Sort player descriptions by team
         if (!playerDescriptions[teamIdx])
             playerDescriptions[teamIdx] = [];
 
         playerDescriptions[teamIdx].push(sprintf(playerDescription, {
             "playerName":
                 '[color="' +
-                rgbToGuiColor(playerData.Color || g_Settings.PlayerDefaults[playerIdx].Color) +
+                (typeof getPlayerColor == 'function' ?
+                    (isAI ?
+                        "255 255 255" :
+                        getPlayerColor(playerData.Name)) :
+                    rgbToGuiColor(playerData.Color || g_Settings.PlayerDefaults[playerIdx].Color)) +
                 '"]' + escapeText(playerData.Name) + "[/color]",
 
             "civ":
                 !playerData.Civ ?
                     translate("Unknown Civilization") :
@@ -281 +363 @@
             "AIdifficulty": isAI ? translateAIDifficulty(playerData.AIDiff) : ""
         }));
     }
 
     let teams = Object.keys(playerDescriptions);
+    if (teams.indexOf("observer") > -1)
+        teams.splice(teams.indexOf("observer"), 1);
+
+    let teamDescription = [];
 
     // If there are no teams, merge all playersDescriptions
     if (teams.length == 1)
-        return playerDescriptions[teams[0]].join("\n") + "\n";
+        teamDescription.push(playerDescriptions[teams[0]].join("\n"));
 
     // If there are teams, merge "Team N:" + playerDescriptions
-    return teams.map(team => {
+    else
+        teamDescription = teamDescription.concat(teams.map(team => {
+
+            let teamCaption = team == -1 ?
+                translate("No Team") :
+                sprintf(translate("Team %(team)s"), { "team": +team + 1 });
+
+            // Translation: Describe players of one team in a selected game, f.e. in the replay- or savegame menu or lobby
+            return sprintf(translate("%(team)s:\n%(playerDescriptions)s"), {
+                "team": '[font="sans-bold-14"]' + teamCaption + "[/font]",
+                "playerDescriptions": playerDescriptions[team].join("\n")
+            });
+        }));
+
+    if (playerDescriptions.observer)
+        teamDescription.push(sprintf(translate("%(team)s:\n%(playerDescriptions)s"), {
+            "team": '[font="sans-bold-14"]' + translatePlural("Observer", "Observers", playerDescriptions.observer.length) + "[/font]",
+            "playerDescriptions": playerDescriptions.observer.join("\n")
+        }));
 
-        let teamCaption = team == -1 ?
-            translate("No Team") :
-            sprintf(translate("Team %(team)s"), { "team": +team + 1 });
-
-        // Translation: Describe players of one team in a selected game, f.e. in the replay- or savegame menu or lobby
-        return sprintf(translate("%(team)s:\n%(playerDescriptions)s"), {
-            "team": '[font="sans-bold-14"]' + teamCaption + "[/font]",
-            "playerDescriptions": playerDescriptions[team].join("\n")
-        });
-    }).join("\n\n");
+    return teamDescription.join("\n\n");
 }

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

@@ -676 +676 @@
  */
 function handleGamestartMessage(message)
 {
     if (g_IsController && Engine.HasXmppClient())
     {
-        let playerNames = Object.keys(g_PlayerAssignments).map(guid => g_PlayerAssignments[guid].name);
-        Engine.SendChangeStateGame(playerNames.length, playerNames.join(", "));
+        let clients = formatClientsForStanza();
+        Engine.SendChangeStateGame(clients.connectedPlayers, clients.list);
     }
 
     Engine.SwitchGuiPage("page_loading.xml", {
         "attribs": g_GameAttributes,
         "isNetworked" : g_IsNetworked,
@@ -1937 +1937 @@
     else
         setReady(false, false);
 }
 
 /**
+ * Don't send teams until the game was started.
+ * The playerData format from g_GameAttributes is kept to reuse the GUI function presenting the data.
+ */
+function formatClientsForStanza()
+{
+    let connectedPlayers = 0;
+    let list = [];
+
+    for (let guid in g_PlayerAssignments)
+    {
+        if (g_GameAttributes.settings.PlayerData[g_PlayerAssignments[guid].player - 1])
+        {
+            ++connectedPlayers;
+            list.push({
+                "Name": g_PlayerAssignments[guid].name
+            });
+        }
+        else
+            list.push({
+                "Name": g_PlayerAssignments[guid].name,
+                "Team": "observer"
+            });
+    }
+
+    return {
+        "list": playerDataToStringifiedTeamList(list),
+        "connectedPlayers": connectedPlayers
+    };
+}
+
+/**
  * Send the relevant gamesettings to the lobbybot.
  */
 function sendRegisterGameStanza()
 {
     if (!g_IsController || !Engine.HasXmppClient())
@@ -1949 +1980 @@
     let selectedMapSize = Engine.GetGUIObjectByName("mapSize").selected;
     let selectedVictoryCondition = Engine.GetGUIObjectByName("victoryCondition").selected;
 
     let mapSize = g_GameAttributes.mapType == "random" ? Engine.GetGUIObjectByName("mapSize").list_data[selectedMapSize] : "Default";
     let victoryCondition = Engine.GetGUIObjectByName("victoryCondition").list[selectedVictoryCondition];
-    let playerNames = Object.keys(g_PlayerAssignments).map(guid => g_PlayerAssignments[guid].name).sort();
+    let clients = formatClientsForStanza();
 
     let stanza = {
         "name": g_ServerName,
         "port": g_ServerPort,
         "mapName": g_GameAttributes.map,
         "niceMapName": getMapDisplayName(g_GameAttributes.map),
         "mapSize": mapSize,
         "mapType": g_GameAttributes.mapType,
         "victoryCondition": victoryCondition,
-        "nbp": Object.keys(g_PlayerAssignments).length || 1,
-        "tnbp": g_GameAttributes.settings.PlayerData.length,
-        "players": playerNames.join(", ")
+        "nbp": clients.connectedPlayers,
+        "maxnbp": g_GameAttributes.settings.PlayerData.length,
+        "players": clients.list,
     };
 
     // Only send the stanza if the relevant settings actually changed
     if (g_LastGameStanza && Object.keys(stanza).every(prop => g_LastGameStanza[prop] == stanza[prop]))
         return;

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

@@ -283 +283 @@
     if (mapSizeFilter.selected != 0 &&
         game.mapSize != mapSizeFilter.list_data[mapSizeFilter.selected])
         return true;
 
     if (playersNumberFilter.selected != 0 &&
-        game.tnbp != playersNumberFilter.list_data[playersNumberFilter.selected])
+        game.maxnbp != playersNumberFilter.list_data[playersNumberFilter.selected])
         return true;
 
     if (mapTypeFilter.selected != 0 &&
         game.mapType != mapTypeFilter.list_data[mapTypeFilter.selected])
         return true;
 
-    if (!showFullFilter.checked && game.tnbp <= game.nbp)
+    if (!showFullFilter.checked && game.maxnbp <= game.nbp)
         return true;
 
     return false;
 }
 
@@ -544 +544 @@
             sortA = translate(a.niceMapName);
             sortB = translate(b.niceMapName);
             break;
         case 'nPlayers':
             // Compare playercount ratio
-            sortA = a.nbp * b.tnbp;
-            sortB = b.nbp * a.tnbp;
+            sortA = a.nbp * b.maxnbp;
+            sortB = b.nbp * a.maxnbp;
             break;
         case 'status':
         default:
             sortA = g_GameStatusOrder.indexOf(a.state);
             sortB = g_GameStatusOrder.indexOf(b.state);
@@ -580 +580 @@
 
         list_name.push('[color="' + g_GameColors[game.state] + '"]' + gameName);
         list_mapName.push(translateMapTitle(game.niceMapName));
         list_mapSize.push(translateMapSize(game.mapSize));
         list_mapType.push(g_MapTypes.Title[mapTypeIdx] || "");
-        list_nPlayers.push(game.nbp + "/" + game.tnbp);
+        list_nPlayers.push(game.nbp + "/" + game.maxnbp);
         list.push(gameName);
         list_data.push(i);
     }
 
     gamesBox.list_name = list_name;
@@ -614 +614 @@
     if (!game)
         return;
 
     Engine.GetGUIObjectByName("sgMapName").caption = translateMapTitle(game.niceMapName);
     Engine.GetGUIObjectByName("sgNbPlayers").caption = sprintf(
-        translate("Players: %(current)s/%(total)s"), {
+        translate("Players: %(current)s/%(max)s"), {
             "current": game.nbp,
-            "total": game.tnbp
+            "max": game.maxnbp
         });
 
-    Engine.GetGUIObjectByName("sgPlayersNames").caption = game.players;
+    Engine.GetGUIObjectByName("sgPlayersNames").caption = formatPlayerInfo(stringifiedTeamListToPlayerData(game.players));
     Engine.GetGUIObjectByName("sgMapSize").caption = translateMapSize(game.mapSize);
 
     let mapTypeIdx = g_MapTypes.Name.indexOf(game.mapType);
     Engine.GetGUIObjectByName("sgMapType").caption = g_MapTypes.Title[mapTypeIdx] || "";
 
@@ -651 +651 @@
     if (!game)
         return;
 
     let username = g_UserRating ? g_Username + " (" + g_UserRating + ")" : g_Username;
 
-    if (game.state == "init" || game.players.split(", ").indexOf(username) > -1)
+    if (game.state == "init" || stringifiedTeamListToPlayerData(game.players).some(player => player.Name == username))
         joinSelectedGame();
     else
         messageBox(
             400, 200,
             translate("The game has already started.") + "\n" +

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

@@ -248 +248 @@
             "guid": findGuidForPlayerID(player),
             "player": player,
             "resign": !!notification.resign
         });
         playerFinished(player, false);
+        sendLobbyPlayerlistUpdate();
     },
     "won": function(notification, player)
     {
         addChatMessage({
             "type": "won",
             "guid": findGuidForPlayerID(player),
             "player": player
         });
         playerFinished(player, true);
+        sendLobbyPlayerlistUpdate();
     },
     "diplomacy": function(notification, player)
     {
         addChatMessage({
             "type": "diplomacy",
@@ -539 +541 @@
     joins.forEach(guid => {
         onClientJoin(guid);
     });
 
     updateChatAddressees();
-
-    // Update lobby gamestatus
-    if (g_IsController && Engine.HasXmppClient())
-    {
-        let players = Object.keys(g_PlayerAssignments).map(guid => g_PlayerAssignments[guid].name);
-        Engine.SendChangeStateGame(Object.keys(g_PlayerAssignments).length, players.join(", "));
-    }
+    sendLobbyPlayerlistUpdate();
 }
 
 function onClientJoin(guid)
 {
     let playerID = g_PlayerAssignments[guid].player;

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

@@ -13 +13 @@
 const g_Ambient = [ "audio/ambient/dayscape/day_temperate_gen_03.ogg" ];
 
 /**
  * Map, player and match settings set in gamesetup.
  */
-var g_GameAttributes;
+const g_GameAttributes = Object.freeze(Engine.GetInitAttributes());
 
 /**
  * Is this user in control of game settings (i.e. is a network server, or offline player).
  */
 var g_IsController;
@@ -223 +223 @@
         Engine.EndGame();
         Engine.SwitchGuiPage("page_pregame.xml");
         return;
     }
 
-    g_GameAttributes = Engine.GetInitAttributes();
-
     if (initData)
     {
         g_IsNetworked = initData.isNetworked;
         g_IsController = initData.isController;
         g_PlayerAssignments = initData.playerAssignments;
@@ -287 +285 @@
     initHotkeyTooltips();
 
     if (hotloadData)
         g_Selection.selected = hotloadData.selection;
 
+    sendLobbyPlayerlistUpdate();
     onSimulationUpdate();
-
     setTimeout(displayGamestateNotifications, 1000);
 
     // Report the performance after 5 seconds (when we're still near
     // the initial camera view) and a minute (when the profiler will
     // have settled down if framerates as very low), to give some

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

@@ -129 +129 @@
         totalCost += +neededResources[resource];
     var alpha = 50 + Math.round(+totalCost/10.0);
     alpha = alpha > 125 ? 125 : alpha;
     return "color:255 0 0 " + alpha;
 }
+
+/**
+ * The playerData format from g_GameAttributes is kept to reuse the GUI function presenting the data.
+ */
+function sendLobbyPlayerlistUpdate()
+{
+    if (!g_IsController || !Engine.HasXmppClient())
+        return;
+
+    // Extract the relevant player data and minimize packet load
+    let output = [];
+    for (let playerID in g_GameAttributes.settings.PlayerData)
+    {
+        let pData = g_GameAttributes.settings.PlayerData;
+
+        let outData = { "Name": pData.Name };
+
+        if (g_GameAttributes.settings.LockTeams)
+            outData.Team = pData.Team;
+
+        if (pData.AI)
+        {
+            outData.AI = pData.AI;
+            outData.AIDiff = pData.AIDiff;
+        }
+
+        if (g_Players[playerID + 1].Offline)
+            outData.Offline = true;
+
+        // Whether the player has won or was defeated
+        let state = g_Players[playerID + 1].State;
+        if (state != "active")
+            outData.State = state;
+
+        output.push(outData);
+    }
+
+    // Add observers
+    let connectedPlayers = 0;
+    for (let guid in g_PlayerAssignments)
+    {
+        let pData = g_GameAttributes.settings.PlayerData[g_PlayerAssignments[guid].player - 1];
+
+        if (pData)
+            ++connectedPlayers;
+        else
+            playerData.push({
+                "Name": g_PlayerAssignments[guid].name,
+                "Team": "observer"
+            });
+    }
+
+    Engine.SendChangeStateGame(connectedPlayers, playerDataToStringifiedTeamList(output));
+}

source/lobby/XmppClient.cpp

@@ -500 +500 @@
 {
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
 
     scriptInterface.Eval("([])", ret);
-    const char* stats[] = { "name", "ip", "port", "state", "nbp", "tnbp", "players", "mapName", "niceMapName", "mapSize", "mapType", "victoryCondition" };
+    const char* stats[] = { "name", "ip", "port", "state", "nbp", "maxnbp", "players", "mapName", "niceMapName", "mapSize", "mapType", "victoryCondition" };
     for(const glooxwrapper::Tag* const& t : m_GameList)
     {
         JS::RootedValue game(cx);
         scriptInterface.Eval("({})", &game);
 

source/tools/XpartaMuPP/XpartaMuPP.py

@@ -299 +299 @@
     """
     JID = str(JID)
     if JID in self.gameList:
       if self.gameList[JID]['nbp-init'] > data['nbp']:
         logging.debug("change game (%s) state from %s to %s", JID, self.gameList[JID]['state'], 'waiting')
-        self.gameList[JID]['nbp'] = data['nbp']
         self.gameList[JID]['state'] = 'waiting'
       else:
         logging.debug("change game (%s) state from %s to %s", JID, self.gameList[JID]['state'], 'running')
-        self.gameList[JID]['nbp'] = data['nbp']
         self.gameList[JID]['state'] = 'running'
+      self.gameList[JID]['nbp'] = data['nbp']
+      self.gameList[JID]['players'] = data['players']
 
 ## Class which manages different game reports from clients ##
 ##   and calls leaderboard functions as appropriate.       ##
 class ReportManager():
   def __init__(self, leaderboard):