Ticket #3386: t3386_clear_muc_messages_v2.patch

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

@@ -174 +174 @@
     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)
         {
@@ -697 +697 @@
             var ratingList = playersBox.list_rating;
             var nickIndex = nickList.indexOf(nick);
             switch(message.level)
             {
             case "join":
+                if (nickIndex != -1)
+                {
+                    error("User " + nick + " joined, but is present already!");
+                    break;
+                }
                 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?)
+                if (nickIndex == -1)
+                {
+                    error("User " + nick + " left, but has not been online!");
                     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)
+                if (nickIndex == -1)
+                {
+                    error("User " + nick + " changed nickname, but is not online!");
                     break;
+                }
                 if (!isValidNick(message.data))
                 {
                     addChatMessage({ "from": "system", "text": sprintf(translate("Invalid nickname: %(nick)s"), { nick: message.data })});
                     break;
                 }
@@ -728 +739 @@
                 // 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)
+                if (nickIndex == -1)
+                {
+                    if (nick != g_Name) // we change presence on init(), before downloading the playerlist
+                        error("User " + nick + " changed presence, but is not online!");
                     break;
+                }
                 var [name, status, rating] = formatPlayerListEntry(nick, presence, stripColorCodes(ratingList[nickIndex]));
                 presenceList[nickIndex] = status;
                 playerList[nickIndex] = name;
                 ratingList[nickIndex] = rating;
                 break;

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

@@ -234 +234 @@
 
             <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

@@ -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
@@ -46 +46 @@
     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 GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret, bool clearPresenceUpdates) = 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

@@ -492 +492 @@
 /**
  * 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)
+void XmppClient::GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret, bool clearPresenceUpdates)
 {
+    if (clearPresenceUpdates)
+    {
+        m_GuiMessageQueue.erase(
+            std::remove_if(m_GuiMessageQueue.begin(), m_GuiMessageQueue.end(),
+                [](XmppClient::GUIMessage& message)
+                {
+                    return message.type == L"muc" && message.level != L"subject";
+                }
+        ), m_GuiMessageQueue.end());
+    }
+
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
 
     scriptInterface.Eval("([])", ret);
 

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();
 
@@ -74 +76 @@
     void SetPresence(const std::string& presence);
     void GetPresence(const std::string& nickname, std::string& presence);
     void GetRole(const std::string& nickname, std::string& role);
     void GetSubject(std::string& subject);
 
-    void GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret);
+    void GUIGetPlayerList(ScriptInterface& scriptInterface, JS::MutableHandleValue ret, bool clearPresenceUpdates);
     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;

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)
 {
     if (!g_XmppClient)
         return JS::UndefinedValue();
 
     JSContext* cx = pCxPrivate->pScriptInterface->GetContext();
     JSAutoRequest rq(cx);
         
     JS::RootedValue playerList(cx);
-    g_XmppClient->GUIGetPlayerList(*(pCxPrivate->pScriptInterface), &playerList);
+    g_XmppClient->GUIGetPlayerList(*(pCxPrivate->pScriptInterface), &playerList, clearPresenceUpdates);
 
     return playerList;
 }
 
 JS::Value JSI_Lobby::GetGameList(ScriptInterface::CxPrivate* pCxPrivate)

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);