Ticket #3171: t3171_clear_muc_messages_v3_r16728.patch

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

@@ -8 +8 @@
 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;
 
 ////////////////////////////////////////////////////////////////////////////////////////////////
 
@@ -634 +633 @@
             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);

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

source/lobby/XmppClient.cpp

@@ -492 +492 @@
  *
  * @return A JS array containing all known players and their presences
  */
 void XmppClient::GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret)
 {
+    // Clear outdated presence updates, see #3171
+    this->ClearMucMessages();
+
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
     
     scriptInterface.Eval("([])", ret);
 
@@ -620 +623 @@
 
     m_GuiMessageQueue.pop_front();
 }
 
 /**
+ * Remove all muc updates from the message queue.
+ */
+void XmppClient::ClearMucMessages()
+{
+    // TODO: use mutex lock here?
+    bool clean;
+    do
+    {
+        clean = true;
+        for (std::deque<GUIMessage>::iterator it = m_GuiMessageQueue.begin(); it!=m_GuiMessageQueue.end(); ++it)
+        {
+            GUIMessage message = *it;
+            if (message.type == L"muc")
+            {
+                m_GuiMessageQueue.erase(it);
+                clean = false;
+                break;
+            }
+        }
+    } while (!clean);
+}
+
+/**
  * Send a standard MUC textual message.
  */
 void XmppClient::SendMUCMessage(const std::string& message)
 {
     m_mucRoom->send(message);

source/lobby/XmppClient.h

@@ -132 +132 @@
         std::wstring from;
         std::wstring message;
         std::string datetime;
     };
     void GuiPollMessage(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
+    void ClearMucMessages();
     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 = "");