Ticket #3171: t3171_clear_muc_messages_v7_16836.patch

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

@@ -12 +12 @@
 var g_mapSizes = {};
 const g_mapTypesText = [translateWithContext("map", "Skirmish"), translateWithContext("map", "Random"), translate("Scenario")];
 const g_mapTypes = ["skirmish", "random", "scenario"];
 var g_userRating = ""; // Rating of user, defaults to Unrated
 var g_modPrefix = "@";
-var g_joined = false;
 // Block spammers for 30 seconds.
 var SPAM_BLOCK_LENGTH = 30;
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
@@ -163 +162 @@
         logo.size = "50%-110 40 50%+110 140";
     }
 }
 
 /**
- * Do a full update of the player listing, including ratings from cached C++ information.
+ * Replace the playerlist with the current list cached in C++.
  *
  * @return Array containing the player, presence, nickname, and rating listings.
  */
 function updatePlayerList()
 {
     var playersBox = Engine.GetGUIObjectByName("playersBox");
     var playerList = [];
     var presenceList = [];
     var nickList = [];
     var ratingList = [];
-    var cleanPlayerList = Engine.GetPlayerList();
+    var cleanPlayerList = Engine.GetPlayerList(true);
     // Sort the player list, ignoring case.
     cleanPlayerList.sort(function(a,b)
     {
         switch (g_PlayerListSortBy)
         {
@@ -701 +700 @@
             case "join":
                 if (nick == g_Name)
                 {
                     // We just joined, we need to get the full player list
                     [playerList, presenceList, nickList, ratingList] = updatePlayerList();
-                    // Don't display any joins until our join request bounces back
-                    // Our join message should be the last one as we just got added to the stack
-                    g_joined = true;
-                    break;
                 }
-                else if (g_joined)
+                else
                 {
                     var [name, status, rating] = formatPlayerListEntry(nick, presence, "-");
                     playerList.push(name);
                     presenceList.push(status);
                     nickList.push(nick);
@@ -727 +722 @@
                 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) // This shouldn't ever happen
+                if (nickIndex == -1) // Changed nick, but not present
                     break;
                 if (!isValidNick(message.data))
                 {
                     addChatMessage({ "from": "system", "text": sprintf(translate("Invalid nickname: %(nick)s"), { nick: message.data })});
                     break;
@@ -742 +737 @@
                 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 });
                 Engine.SendGetRatingList();
                 break;
             case "presence":
-                if (nickIndex == -1) // This shouldn't ever happen
+                if (nickIndex == -1) // Changed presence, but not online
                     break;
                 var [name, status, rating] = formatPlayerListEntry(nick, presence, stripColorCodes(ratingList[nickIndex]));
                 presenceList[nickIndex] = status;
                 playerList[nickIndex] = name;
                 ratingList[nickIndex] = rating;

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

@@ -233 +233 @@
 
             <object name="chatPanel" size="0 49% 100% 100%" type="image" sprite="ModernDarkBoxGold">
                 <object name="chatText" size="0 0 100% 94%" type="text" style="ChatPanel" font="sans-13"/>
                 <object name="chatInput" size="0 94% 100% 100%" type="input" style="ModernInput" font="sans-13">
                     <action on="Press">submitChatInput();</action>
-                    <action on="Tab">autoCompleteNick("chatInput", Engine.GetPlayerList());</action>
+                    <action on="Tab">autoCompleteNick("chatInput", Engine.GetPlayerList(false));</action>
                 </object>
             </object>
         </object>
 
         <!-- START Window for leaderboard stats -->

source/lobby/IXmppClient.h

@@ -52 +52 @@
     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;
+    virtual void ClearPresenceUpdates() = 0;
     virtual void SendMUCMessage(const std::string& message) = 0;
 };
 
 extern IXmppClient *g_XmppClient;
 extern bool g_rankedGame;

source/lobby/XmppClient.cpp

@@ -77 +77 @@
 
     m_xpartamuppId = sXpartamupp + "@" + sServer + "/CC";
     glooxwrapper::JID clientJid(sUsername + "@" + sServer + "/0ad");
     glooxwrapper::JID roomJid(sRoom + "@conference." + sServer + "/" + sNick);
 
+    m_Joined = false;
+
     // If we are connecting, use the full jid and a password
     // If we are registering, only use the server name
     if (!regOpt)
         m_client = new glooxwrapper::Client(clientJid, sPassword);
     else
@@ -486 +488 @@
 /*****************************************************
  * Requests from GUI                                 *
  *****************************************************/
 
 /**
+ * If someone plays a game while being connected to the lobby, those presence updats
+ * will pile up for the duration of the game (up to some thousands of updates in 1-2 hours) -
+ * thus freezing the game for some seconds and spamming the lobby with joins and disconnects.
+ *
+ * The messages are also invalidated since lobby.js applies them to the refreshed playerlist
+ * instead of the one from the time when the update arrived. This creates dupes that remain
+ * online after the player left. More information on #3171.
+ *
+ * Therefore we remove all presence updates when replacing the playerlist with a current one.
+ */
+void XmppClient::ClearPresenceUpdates()
+{
+    std::remove_if(m_GuiMessageQueue.begin(), m_GuiMessageQueue.end(),
+        [](XmppClient::GUIMessage& message)
+        {
+            return message.type == L"muc" && message.level != L"subject";
+        }
+    );
+}
+
+/**
  * Handle requests from the GUI for the list of players.
  *
  * @return A JS array containing all known players and their presences
  */
 void XmppClient::GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret)
@@ -789 +812 @@
             // we have a nick change
             std::string newNick = participant.newNick.to_string();
             m_PlayerMap[newNick].resize(3);
             m_PlayerMap[newNick][0] = presenceString;
             m_PlayerMap[newNick][2] = roleString;
-            CreateSimpleMessage("muc", nick, "nick", participant.newNick.to_string());
+            if (m_Joined)
+                CreateSimpleMessage("muc", nick, "nick", participant.newNick.to_string());
         }
-        else
+        else if (m_Joined)
             CreateSimpleMessage("muc", nick, "leave");
 
         DbgXMPP(nick << " left the room");
         m_PlayerMap.erase(nick);
     }
     else
     {
-        if (m_PlayerMap.find(nick) == m_PlayerMap.end())
-            CreateSimpleMessage("muc", nick, "join");
-        else
-            CreateSimpleMessage("muc", nick, "presence");
+        if (nick == m_mucRoom->nick().to_string())
+            m_Joined = true;
+
+        // Only send updates after we joined the room
+        if (m_Joined)
+        {
+            if (m_PlayerMap.find(nick) == m_PlayerMap.end())
+                CreateSimpleMessage("muc", nick, "join");
+            else
+                CreateSimpleMessage("muc", nick, "presence");
+        }
 
         DbgXMPP(nick << " is in the room, presence : " << (int)presenceType);
         m_PlayerMap[nick].resize(3);
         m_PlayerMap[nick][0] = presenceString;
         m_PlayerMap[nick][2] = roleString;

source/lobby/XmppClient.h

@@ -132 +132 @@
         std::wstring from;
         std::wstring message;
         std::string datetime;
     };
     void GuiPollMessage(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
+    void ClearPresenceUpdates();
     void SendMUCMessage(const std::string& message);
     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:
+    // Whether or not we have successfully joined the lobby
+    bool m_Joined;
     /// Map of players
     std::map<std::string, std::vector<std::string> > m_PlayerMap;
     /// List of games
     std::vector<const glooxwrapper::Tag*> m_GameList;
     /// List of rankings

source/lobby/scripting/JSInterface_Lobby.cpp

@@ -44 +44 @@
     scriptInterface.RegisterFunction<void, std::wstring, &JSI_Lobby::SendGetProfile>("SendGetProfile");
     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<JS::Value, bool, &JSI_Lobby::GetPlayerList>("GetPlayerList");
     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");
@@ -173 +173 @@
     if (!g_XmppClient)
         return;
     g_XmppClient->SendIqChangeStateGame(utf8_from_wstring(nbp), utf8_from_wstring(players));
 }
 
-JS::Value JSI_Lobby::GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate)
+JS::Value JSI_Lobby::GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate, bool clearPresenceUpdates = false)
 {
     if (!g_XmppClient)
         return JS::UndefinedValue();
 
     JSContext* cx = pCxPrivate->pScriptInterface->GetContext();
     JSAutoRequest rq(cx);
         
+    if (clearPresenceUpdates)
+        g_XmppClient->ClearPresenceUpdates();
+
     JS::RootedValue playerList(cx);
     g_XmppClient->GUIGetPlayerList(*(pCxPrivate->pScriptInterface), &playerList);
 
     return playerList;
 }

source/lobby/scripting/JSInterface_Lobby.h

@@ -42 +42 @@
     void SendGetProfile(ScriptInterface::CxPrivate* pCxPrivate, std::wstring player);
     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);
+    JS::Value GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate, bool clearPresenceUpdates);
     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);