Ticket #3386: t3386_fix_lobby_rejoin_v3.patch

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

@@ -46 +46 @@
     mapTypeFilter.list_data = [""].concat(g_mapTypes);
 
     Engine.LobbySetPlayerPresence("available");
     Engine.SendGetGameList();
     Engine.SendGetBoardList();
+
+    // When rejoining the lobby after a game, we don't need to process presence changes
+    Engine.LobbyClearPresenceUpdates();
     updatePlayerList();
+
     updateSubject(Engine.LobbyGetRoomSubject());
 
     resetFilters();
 }
 
@@ -231 +235 @@
     playersBox.list_status = presenceList;
     playersBox.list_rating = ratingList;
     playersBox.list = nickList;
     if (playersBox.selected >= playersBox.list.length)
         playersBox.selected = -1;
-    return [playerList, presenceList, nickList, ratingList];
 }
 
 /**
  * Display the profile of the selected player.
  * Displays N/A for all stats until updateProfile is called when the stats
@@ -687 +690 @@
             var from = escapeText(message.from);
             addChatMessage({ "from": from, "text": text, "datetime": message.datetime});
             break;
         case "muc":
             var nick = message.text;
-            var presence = Engine.LobbyGetPlayerPresence(nick);
-            var playersBox = Engine.GetGUIObjectByName("playersBox");
-            var playerList = playersBox.list_name;
-            var presenceList = playersBox.list_status;
-            var nickList = playersBox.list;
-            var ratingList = playersBox.list_rating;
-            var nickIndex = nickList.indexOf(nick);
             switch(message.level)
             {
             case "join":
-                var [name, status, rating] = formatPlayerListEntry(nick, presence, "-");
-                playerList.push(name);
-                presenceList.push(status);
-                nickList.push(nick);
-                ratingList.push(String(rating));
                 addChatMessage({ "text": "/special " + sprintf(translate("%(nick)s has joined."), { nick: nick }), "key": g_specialKey });
                 break;
             case "leave":
-                if (nickIndex == -1) // Left, but not present (TODO: warn about this?)
-                    break;
-                playerList.splice(nickIndex, 1);
-                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 });
                 break;
             case "nick":
-                if (nickIndex == -1) // Changed nick, but not present (shouldn't ever happen)
-                    break;
-                if (!isValidNick(message.data))
-                {
-                    addChatMessage({ "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 });
                 break;
             case "presence":
-                if (nickIndex == -1) // Changed presence, but not online (shouldn't ever happen)
-                    break;
-                var [name, status, rating] = formatPlayerListEntry(nick, presence, stripColorCodes(ratingList[nickIndex]));
-                presenceList[nickIndex] = status;
-                playerList[nickIndex] = name;
-                ratingList[nickIndex] = rating;
                 break;
             case "subject":
                 updateSubject(message.text);
                 break;
             default:
                 warn(sprintf("Unknown message.level '%(msglvl)s'", { msglvl: message.level }));
                 break;
             }
-            // Push new data to GUI
-            playersBox.list_name = playerList;
-            playersBox.list_status = presenceList;
-            playersBox.list_rating = ratingList;
-            playersBox.list = nickList;     
-            if (playersBox.selected >= playersBox.list.length)
-                playersBox.selected = -1;
+            // We might receive many join/leaves when returning to the lobby from a long game.
+            // To improve performance, only update the playerlist GUI when the last update in the current stack is processed
+            if (Engine.LobbyGetMucMessageCount() == 0)
+                updatePlayerList();
             break;
         case "system":
             switch (message.level)
             {
             case "standard":

source/lobby/IXmppClient.h

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -45 +45 @@
     virtual void ban(const std::string& nick, const std::string& reason) = 0;
     virtual void SetPresence(const std::string& presence) = 0;
     virtual void GetPresence(const std::string& nickname, std::string& presence) = 0;
     virtual void GetRole(const std::string& nickname, std::string& role) = 0;
     virtual void GetSubject(std::string& subject) = 0;
-
     virtual void GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
+    virtual void ClearPresenceUpdates() = 0;
+    virtual int GetMucMessageCount() = 0;
     virtual void GUIGetGameList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
     virtual void GUIGetBoardList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
     virtual void GUIGetProfile(ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
 
     virtual void GuiPollMessage(ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;

source/lobby/XmppClient.cpp

@@ -640 +640 @@
 {
     m_GuiMessageQueue.push_back(std::move(message));
 }
 
 /**
+ * Clears all presence updates from the message queue.
+ * Used when rejoining the lobby, since we don't need to handle past presence changes.
+ */
+void XmppClient::ClearPresenceUpdates()
+{
+    m_GuiMessageQueue.erase(
+        std::remove_if(m_GuiMessageQueue.begin(), m_GuiMessageQueue.end(),
+            [](XmppClient::GUIMessage& message)
+            {
+                return message.type == L"muc" && message.level == L"presence";
+            }
+    ), m_GuiMessageQueue.end());
+}
+
+/**
+ * Used in order to update the GUI only once when multiple updates are queued.
+ *
+ * @return number of join/leave events currently queued.
+ */
+int XmppClient::GetMucMessageCount()
+{
+    return std::count_if(m_GuiMessageQueue.begin(), m_GuiMessageQueue.end(),
+        [](XmppClient::GUIMessage& message)
+        {
+            return message.type == L"muc";
+        });
+}
+
+/**
  * Handle a standard MUC textual message.
  */
 void XmppClient::handleMUCMessage(glooxwrapper::MUCRoom*, const glooxwrapper::Message& msg, bool)
 {
     DbgXMPP(msg.from().resource() << " said " << msg.body());

source/lobby/XmppClient.h

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -18 +18 @@
 #ifndef XXXMPPCLIENT_H
 #define XXXMPPCLIENT_H
 
 #include "IXmppClient.h"
 
-#include "glooxwrapper/glooxwrapper.h"
-
-//game - script
 #include <deque>
+
+#include "glooxwrapper/glooxwrapper.h"
 #include "scriptinterface/ScriptVal.h"
 
-//Game - script
 class ScriptInterface;
 
 namespace glooxwrapper
 {
     class Client;
@@ -36 +34 @@
 }
 
 class XmppClient : public IXmppClient, public glooxwrapper::ConnectionListener, public glooxwrapper::MUCRoomHandler, public glooxwrapper::IqHandler, public glooxwrapper::RegistrationHandler, public glooxwrapper::MessageHandler
 {
     NONCOPYABLE(XmppClient);
+
 private:
     //Components
     glooxwrapper::Client* m_client;
     glooxwrapper::MUCRoom* m_mucRoom;
     glooxwrapper::Registration* m_registration;
+
     //Account infos
     std::string m_username;
     std::string m_password;
     std::string m_nick;
     std::string m_xpartamuppId;
+
     // State
     bool m_initialLoadComplete = false;
+
 public:
     //Basic
     XmppClient(const std::string& sUsername, const std::string& sPassword, const std::string& sRoom, const std::string& sNick, const int historyRequestSize = 0, const bool regOpt = false);
     virtual ~XmppClient();
 
@@ -78 +80 @@
 
     void GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
     void GUIGetGameList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
     void GUIGetBoardList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
     void GUIGetProfile(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
+
     //Script
     ScriptInterface& GetScriptInterface();
 
 protected:
     /* Xmpp handlers */
@@ -120 +123 @@
 
     // Helpers
     void GetPresenceString(const gloox::Presence::PresenceType p, std::string& presence) const;
     void GetRoleString(const gloox::MUCRoomRole r, std::string& role) const;
     std::string StanzaErrorToString(gloox::StanzaError err);
+
 public:
     /* Messages */
     struct GUIMessage
     {
         std::wstring type;
@@ -134 +138 @@
         std::wstring message;
         std::string datetime;
     };
     void GuiPollMessage(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
     void SendMUCMessage(const std::string& message);
+    void ClearPresenceUpdates();
+    int GetMucMessageCount();
     protected:
     void PushGuiMessage(XmppClient::GUIMessage message);
     void CreateSimpleMessage(const std::string& type, const std::string& text, const std::string& level = "standard", const std::string& data = "");
 
 private:

source/lobby/scripting/JSInterface_Lobby.cpp

@@ -45 +45 @@
     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<JS::Value, &JSI_Lobby::GetPlayerList>("GetPlayerList");
+    scriptInterface.RegisterFunction<void, &JSI_Lobby::LobbyClearPresenceUpdates>("LobbyClearPresenceUpdates");
+    scriptInterface.RegisterFunction<int, &JSI_Lobby::LobbyGetMucMessageCount>("LobbyGetMucMessageCount");
     scriptInterface.RegisterFunction<JS::Value, &JSI_Lobby::GetGameList>("GetGameList");
     scriptInterface.RegisterFunction<JS::Value, &JSI_Lobby::GetBoardList>("GetBoardList");
     scriptInterface.RegisterFunction<JS::Value, &JSI_Lobby::GetProfile>("GetProfile");
     scriptInterface.RegisterFunction<JS::Value, &JSI_Lobby::LobbyGuiPollMessage>("LobbyGuiPollMessage");
     scriptInterface.RegisterFunction<void, std::wstring, &JSI_Lobby::LobbySendMessage>("LobbySendMessage");
@@ -187 +189 @@
     g_XmppClient->GUIGetPlayerList(*(pCxPrivate->pScriptInterface), &playerList);
 
     return playerList;
 }
 
+void JSI_Lobby::LobbyClearPresenceUpdates(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
+{
+    if (!g_XmppClient)
+        return;
+
+    g_XmppClient->ClearPresenceUpdates();
+}
+
+int JSI_Lobby::LobbyGetMucMessageCount(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
+{
+    return g_XmppClient ? g_XmppClient->GetMucMessageCount() : 0;
+}
+
 JS::Value JSI_Lobby::GetGameList(ScriptInterface::CxPrivate* pCxPrivate)
 {
     if (!g_XmppClient)
         return JS::UndefinedValue();
 

source/lobby/scripting/JSInterface_Lobby.h

@@ -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, std::wstring nbp, std::wstring players);
     JS::Value GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate);
+    void LobbyClearPresenceUpdates(ScriptInterface::CxPrivate* pCxPrivate);
+    int LobbyGetMucMessageCount(ScriptInterface::CxPrivate* pCxPrivate);
     JS::Value GetGameList(ScriptInterface::CxPrivate* pCxPrivate);
     JS::Value GetBoardList(ScriptInterface::CxPrivate* pCxPrivate);
     JS::Value GetProfile(ScriptInterface::CxPrivate* pCxPrivate);
     JS::Value LobbyGuiPollMessage(ScriptInterface::CxPrivate* pCxPrivate);
     void LobbySendMessage(ScriptInterface::CxPrivate* pCxPrivate, std::wstring message);