Ticket #3143: 3143_lobby_data_v2.6.6.patch

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

@@ -59 +59 @@
  * 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.
+ */
+function playerDataToStringifiedTeamList(originalplayerDataArray)
+{
+    let playerDataArray = clone(originalplayerDataArray);
+    let teamList = {};
+    for (let playerData of playerDataArray)
+    {
+        if (playerData.Team === undefined)
+            playerData.Team = -1;
+        if (!teamList[playerData.Team])
+            teamList[playerData.Team] = [];
+        teamList[playerData.Team].push(playerData);
+        delete teamList[playerData.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 player of teamList[team])
+        {
+            player.Team = team;
+            playerData.push(player);
+        }
+    }
+    return playerData;
+}
+
 function translateMapTitle(mapTitle)
 {
     return mapTitle == "random" ? translateWithContext("map selection", "Random") : translate(mapTitle);
@@ -226 +270 @@
 
     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
@@ -262 +340 @@
         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":
@@ -283 +365 @@
     }
 
     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 });
+            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");
+            // 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")
+        }));
+
+    return teamDescription.join("\n\n");
 }

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

@@ -678 +678 @@
 {
     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.nbp, clients.list);
     }
 
     Engine.SwitchGuiPage("page_loading.xml", {
@@ -1938 +1938 @@
         setReady(false, false);
 }
 
+function formatClientsForStanza()
+{
+    let numberOfPlayers = 0;
+    let list = [];
+    for (let guid in g_PlayerAssignments)
+    {
+        if (g_GameAttributes.settings.PlayerData[g_PlayerAssignments[guid].player - 1])
+        {
+            ++numberOfPlayers;
+            list.push({
+                "Name": g_PlayerAssignments[guid].name
+            });
+        }
+        else
+            list.push({
+                "Name": g_PlayerAssignments[guid].name,
+                "Team": "observer"
+            });
+    }
+    return {
+        "list": playerDataToStringifiedTeamList(list),
+        "nbp": numberOfPlayers
+    };
+}
+
 /**
  * Send the relevant gamesettings to the lobbybot.
  */
@@ -1951 +1976 @@
 
     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,
@@ -1961 +1986 @@
         "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.nbp,
+        "maxnbp": g_GameAttributes.settings.PlayerData.length,
+        "players": clients.list,
     };
 
     // Only send the stanza if the relevant settings actually changed

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

@@ -285 +285 @@
         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 &&
@@ -292 +292 @@
         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;
@@ -546 +546 @@
             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:
@@ -582 +582 @@
         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);
     }
@@ -616 +616 @@
 
     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);
@@ -653 +653 @@
 
     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(

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

@@ -544 +544 @@
 
     // 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(", "));
-    }
+        sendLobbyStanzaUpdate();
 }
 
 function onClientJoin(guid)
@@ -746 +743 @@
 
 function formatDefeatMessage(msg)
 {
+    if (g_IsController && Engine.HasXmppClient())
+        sendLobbyStanzaUpdate();
+
     return sprintf(
         msg.resign ?
             translate("%(player)s has resigned.") :

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

@@ -288 +288 @@
     if (hotloadData)
         g_Selection.selected = hotloadData.selection;
 
+    if (g_IsController && Engine.HasXmppClient())
+        sendLobbyStanzaUpdate();
+
     onSimulationUpdate();
 
     setTimeout(displayGamestateNotifications, 1000);

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

@@ -131 +131 @@
     alpha = alpha > 125 ? 125 : alpha;
     return "color:255 0 0 " + alpha;
 }
+ 
+function sendLobbyStanzaUpdate()
+{
+    let numberOfPlayers = 0;
+    let playerStates = {};
+    let playerDataArray = g_GameAttributes.settings.PlayerData.map(pData => ({
+        "Name": pData.Name,
+        "Team": pData.Team,
+        "AI": pData.AI,
+        "AIDiff": pData.AI
+    }));
+
+    for (let player of g_Players)
+        playerStates[player.name] = {
+            "State": player.state,
+            "Offline": player.offline
+        };
+
+    for (let playerData of playerDataArray)
+    {
+        if (!g_GameAttributes.settings.LockTeams)
+            delete playerData.Team;
+
+        let pState = playerStates[playerData.Name];
+        if (pState)
+        {
+            playerData.State = pState.State;
+            playerData.Offline = pState.Offline;
+        }
+    }
+
+    for (let guid in g_PlayerAssignments)
+    {
+        let pData = g_GameAttributes.settings.PlayerData[g_PlayerAssignments[guid].player - 1];
+
+        if (pData)
+            ++numberOfPlayers;
+        else
+            playerDataArray.push({
+                "Name": g_PlayerAssignments[guid].name,
+                "Team": "observer"
+            });
+    }
+    Engine.SendChangeStateGame(numberOfPlayers, playerDataToStringifiedTeamList(playerDataArray));
+}

source/lobby/XmppClient.cpp

@@ -502 +502 @@
     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);

source/tools/XpartaMuPP/XpartaMuPP.py

@@ -301 +301 @@
     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.       ##