Ticket #3143: 3143_lobby_data_v2.5.patch

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

@@ -67 +67 @@
     return text.substr(0, 255).replace(/\\/g, "\\\\").replace(/\[/g, "\\[");
 }
 
+function unescapeText(text)
+{
+    if (!text)
+        return text;
+    return text.replace(/\\\\/g, "\\").replace(/\\\[/g, "\[");
+}
+
 function translateMapTitle(mapTitle)
 {
     return mapTitle == "random" ? translateWithContext("map selection", "Random") : translate(mapTitle);
@@ -262 +269 @@
         return '[font="sans-bold-14"]' + teamCaption + "[/font]:\n" + playerDescriptions[team].join("\n");
     }).join("\n\n");
 }
+/**
+ * Returns an object with formatted player and observer lists to send them to the lobby
+ *
+ * @returns {object}
+ */
+function formatClientsForLobbyReport(playerData, playerAssignments)
+{
+    let observerNames = [];
+    let playerNames = [];
+    for (let guid in playerAssignments)
+    {
+        let pData = playerData[playerAssignments[guid].player - 1];
+        if (pData)
+            playerNames.push({
+                "name": playerAssignments[guid].name,
+                "team": (pData.Team || pData.team) + 1
+            });
+        else
+            observerNames.push(playerAssignments[guid].name);
+    }
+    return {
+        "players": escapeText(JSON.stringify(playerNames)),
+        "playersLength": playerNames.length,
+        "observers": escapeText(JSON.stringify(observerNames))
+    };
+}
+ No newline at end of file

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

@@ -676 +676 @@
 {
     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 = formatClients();
+        Engine.SendChangeStateGame(clients.playersLength, clients.players, clients.observers);
     }
 
     Engine.SwitchGuiPage("page_loading.xml", {
@@ -1939 +1939 @@
 
     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 = formatClientsForLobbyReport(g_GameAttributes.settings.PlayerData, g_PlayerAssignments);
 
     let stanza = {
         "name": g_ServerName,
@@ -1949 +1949 @@
         "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.playersLength,
+        "maxnbp": g_GameAttributes.settings.PlayerData.length,
+        "players": clients.players,
+        "observers": clients.observers
     };
 
     // 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;
@@ -555 +555 @@
             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:
@@ -591 +591 @@
         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);
     }
@@ -625 +625 @@
 
     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;
+    let players = JSON.parse(unescapeText(game.players));
+    let observers = JSON.parse(unescapeText(game.observers));
+    let teams = [];
+    for (let player of players)
+    {
+        let teamIndex = player.team;
+        if (!teams[teamIndex])
+            teams[teamIndex] = [];
+        teams[teamIndex].push(player.name);
+    }
+
+    let playersCaption = "";
+    for (let team in teams)
+    {
+        teams[team].sort();
+        playersCaption += (team == 0 ? sprintf(translate("No Team: %(players)s\n"), { "players": teams[team].join(translate(", ")) }) :
+            sprintf(translate("Team %(teamnumber)s: %(players)s"), { "teamnumber": team, "players": teams[team].join(translate(", ")) })
+        );
+    }
+    if (observers.length)
+        playersCaption += sprintf(translatePlural("Observer: %(observers)s", "Observers: %(observers)s", observers.length), { "observers": observers.sort().join(translate(", ")) });
+
+    Engine.GetGUIObjectByName("sgPlayersNames").caption = playersCaption;
     Engine.GetGUIObjectByName("sgMapSize").caption = translateMapSize(game.mapSize);
 
     let mapTypeIdx = g_MapTypes.Name.indexOf(game.mapType);
@@ -662 +684 @@
 
     let username = g_UserRating ? g_Username + " (" + g_UserRating + ")" : g_Username;
 
-    if (game.state == "init" || game.players.split(", ").indexOf(username) > -1)
+    if (game.state == "init" || 
+        JSON.parse(unescapeText(game.players)).some(player => player.name == username) || 
+        JSON.parse(unescapeText(game.observers)).indexOf(username) > -1)
         joinSelectedGame();
     else
         messageBox(

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

@@ -536 +536 @@
     // 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(", "));
+        let formattedClients = formatClientsForLobbyReport(getPlayerData(), g_PlayerAssignments);
+        Engine.SendChangeStateGame(formattedClients.playersLength, formattedClients.players, formattedClients.observers);
     }
 }
 

source/lobby/IXmppClient.h

@@ -1 @@
-/* Copyright (C) 2015 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -38 +38 @@
     virtual void SendIqGameReport(ScriptInterface& scriptInterface, JS::HandleValue data) = 0;
     virtual void SendIqRegisterGame(ScriptInterface& scriptInterface, JS::HandleValue data) = 0;
     virtual void SendIqUnregisterGame() = 0;
-    virtual void SendIqChangeStateGame(const std::string& nbp, const std::string& players) = 0;
+    virtual void SendIqChangeStateGame(const std::string& nbp, const std::string& players, const std::string& observers) = 0;
     virtual void SetNick(const std::string& nick) = 0;
     virtual void GetNick(std::string& nick) = 0;
     virtual void kick(const std::string& nick, const std::string& reason) = 0;

source/lobby/scripting/JSInterface_Lobby.cpp

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -46 +46 @@
     scriptInterface.RegisterFunction<void, JS::HandleValue, &JSI_Lobby::SendRegisterGame>("SendRegisterGame");
     scriptInterface.RegisterFunction<void, JS::HandleValue, &JSI_Lobby::SendGameReport>("SendGameReport");
     scriptInterface.RegisterFunction<void, &JSI_Lobby::SendUnregisterGame>("SendUnregisterGame");
-    scriptInterface.RegisterFunction<void, std::wstring, std::wstring, &JSI_Lobby::SendChangeStateGame>("SendChangeStateGame");
+    scriptInterface.RegisterFunction<void, std::wstring, std::wstring, std::wstring, &JSI_Lobby::SendChangeStateGame>("SendChangeStateGame");
     scriptInterface.RegisterFunction<JS::Value, &JSI_Lobby::GetPlayerList>("GetPlayerList");
     scriptInterface.RegisterFunction<void, &JSI_Lobby::LobbyClearPresenceUpdates>("LobbyClearPresenceUpdates");
     scriptInterface.RegisterFunction<int, &JSI_Lobby::LobbyGetMucMessageCount>("LobbyGetMucMessageCount");
@@ -171 +171 @@
     g_XmppClient->SendIqUnregisterGame();
 }
 
-void JSI_Lobby::SendChangeStateGame(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::wstring& nbp, const std::wstring& players)
+void JSI_Lobby::SendChangeStateGame(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), const std::wstring& nbp, const std::wstring& players, const std::wstring& observers)
 {
     if (!g_XmppClient)
         return;
-    g_XmppClient->SendIqChangeStateGame(utf8_from_wstring(nbp), utf8_from_wstring(players));
+    g_XmppClient->SendIqChangeStateGame(utf8_from_wstring(nbp), utf8_from_wstring(players), utf8_from_wstring(observers));
 }
 
 JS::Value JSI_Lobby::GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate)

source/lobby/scripting/JSInterface_Lobby.h

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -43 +43 @@
     void SendGameReport(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue data);
     void SendRegisterGame(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue data);
     void SendUnregisterGame(ScriptInterface::CxPrivate* pCxPrivate);
-    void SendChangeStateGame(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nbp, const std::wstring& players);
+    void SendChangeStateGame(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nbp, const std::wstring& players, const std::wstring& observers);
     JS::Value GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate);
     void LobbyClearPresenceUpdates(ScriptInterface::CxPrivate* pCxPrivate);
     int LobbyGetMucMessageCount(ScriptInterface::CxPrivate* pCxPrivate);

source/lobby/XmppClient.cpp

@@ -408 +408 @@
  * decides which - but we need to update the current players that are
  * in-game so the server can make the calculation.
  */
-void XmppClient::SendIqChangeStateGame(const std::string& nbp, const std::string& players)
+void XmppClient::SendIqChangeStateGame(const std::string& nbp, const std::string& players, const std::string& observers)
 {
     glooxwrapper::JID xpartamuppJid(m_xpartamuppId);
 
@@ -418 +418 @@
     glooxwrapper::Tag* game = glooxwrapper::Tag::allocate("game");
     game->addAttribute("nbp", nbp);
     game->addAttribute("players", players);
+    game->addAttribute("observers", observers);
     g->m_GameList.emplace_back(game);
 
     glooxwrapper::IQ iq(gloox::IQ::Set, xpartamuppJid);
@@ -502 +503 @@
     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", "observers", "mapName", "niceMapName", "mapSize", "mapType", "victoryCondition" };
     for(const glooxwrapper::Tag* const& t : m_GameList)
     {
         JS::RootedValue game(cx);

source/lobby/XmppClient.h

@@ -68 +68 @@
     void SendIqGameReport(ScriptInterface& scriptInterface, JS::HandleValue data);
     void SendIqRegisterGame(ScriptInterface& scriptInterface, JS::HandleValue data);
     void SendIqUnregisterGame();
-    void SendIqChangeStateGame(const std::string& nbp, const std::string& players);
+    void SendIqChangeStateGame(const std::string& nbp, const std::string& players, const std::string& observers);
     void SetNick(const std::string& nick);
     void GetNick(std::string& nick);
     void kick(const std::string& nick, const std::string& reason);