Mark removed contacts as unavailable in Swift

When removing a contact, a XMPP client will not receive an explicit unavailable presence stanza for the contact from the server. Because of that Swift used to show removed contacts still with their old presence in the Chats tab or the chat view. With this patch, the PresenceOracle will flush all known presence of a contact as soon as the JID is removed from the roster. An unavailable presence will stored under the removed bare JID and is emitted via the PresenceOracle::onPresenceChange signal. Test-Information: Added a unit test verifying this behavior. Tested the behavior with two scenarios: a) Account A and B adding each other and accepting the subscription request. Starting a chat between A and B. After removing B in A's account, B used to be shown as available in the chat view and the Chats tab. With this patch B is shown as unavailable. b) Account A and B adding each other and accepting the subscription request. A removing B, and B removing A. After A adds B again, B used to be shown with the old presence even before B accepted the subscription request. This behavior is also fixed with this patch, not showing B as online until B accepted the subscription request. Change-Id: Iba97d3bedd0ac962ea00b25a0d2ed6106ed55a55
author: Tobias Markmann <tm@ayena.de> 2015-09-14 15:08:39 (GMT)
committer: Kevin Smith <kevin.smith@isode.com> 2015-10-16 14:58:03 (GMT)
commit: 9e6ee0f262e7dc663f4c706b16a346a268f425aa (patch)
tree: 5926fd9cc9dec1233f95239b259a7730f99a5a72 /Swift/Controllers
parent: 8da6e35afab55d7232d47575faea2bde7cd44ece (diff)
download: swift-9e6ee0f262e7dc663f4c706b16a346a268f425aa.zip
swift-9e6ee0f262e7dc663f4c706b16a346a268f425aa.tar.bz2
6 files changed, 84 insertions, 48 deletions
diff --git a/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp b/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp
index 487f0f9..f276e92 100644
--- a/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp
+++ b/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp
@@ -87,11 +87,11 @@ public:
                chatWindowFactory_ = mocks_->InterfaceMock<ChatWindowFactory>();
                joinMUCWindowFactory_ = mocks_->InterfaceMock<JoinMUCWindowFactory>();
                xmppRoster_ = new XMPPRosterImpl();
                mucRegistry_ = new MUCRegistry();
                nickResolver_ = new NickResolver(jid_.toBare(), xmppRoster_, NULL, mucRegistry_);
-                presenceOracle_ = new PresenceOracle(stanzaChannel_);
+                presenceOracle_ = new PresenceOracle(stanzaChannel_, xmppRoster_);
                serverDiscoInfo_ = boost::make_shared<DiscoInfo>();
                presenceSender_ = new StanzaChannelPresenceSender(stanzaChannel_);
                directedPresenceSender_ = new DirectedPresenceSender(presenceSender_);
                mucManager_ = new MUCManager(stanzaChannel_, iqRouter_, directedPresenceSender_, mucRegistry_);
                uiEventStream_ = new UIEventStream();
diff --git a/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp b/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp
index cc4045a..bc6ada2 100644
--- a/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp
+++ b/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp
@@ -25,10 +25,11 @@
 #include <Swiften/Presence/DirectedPresenceSender.h>
 #include <Swiften/Presence/PresenceOracle.h>
 #include <Swiften/Presence/StanzaChannelPresenceSender.h>
 #include <Swiften/Queries/DummyIQChannel.h>
 #include <Swiften/Roster/XMPPRoster.h>
+#include <Swiften/Roster/XMPPRosterImpl.h>
 #include <Swiften/VCards/VCardManager.h>
 #include <Swiften/VCards/VCardMemoryStorage.h>
 #include <Swift/Controllers/Chat/ChatMessageParser.h>
 #include <Swift/Controllers/Chat/MUCController.h>
@@ -70,11 +71,12 @@ public:
                iqChannel_ = new DummyIQChannel();
                iqRouter_ = new IQRouter(iqChannel_);
                eventController_ = new EventController();
                chatWindowFactory_ = mocks_->InterfaceMock<ChatWindowFactory>();
                userSearchWindowFactory_ = mocks_->InterfaceMock<UserSearchWindowFactory>();
-                presenceOracle_ = new PresenceOracle(stanzaChannel_);
+                xmppRoster_ = new XMPPRosterImpl();
+                presenceOracle_ = new PresenceOracle(stanzaChannel_, xmppRoster_);
                presenceSender_ = new StanzaChannelPresenceSender(stanzaChannel_);
                directedPresenceSender_ = new DirectedPresenceSender(presenceSender_);
                uiEventStream_ = new UIEventStream();
                avatarManager_ = new NullAvatarManager();
                TimerFactory* timerFactory = NULL;
@@ -102,10 +104,11 @@ public:
                delete highlightManager_;
                delete settings_;
                delete entityCapsProvider_;
                delete eventController_;
                delete presenceOracle_;
+                delete xmppRoster_;
                delete mocks_;
                delete uiEventStream_;
                delete stanzaChannel_;
                delete presenceSender_;
                delete directedPresenceSender_;
@@ -440,9 +443,10 @@ private:
        boost::shared_ptr<CryptoProvider> crypto_;
        VCardManager* vcardManager_;
        VCardMemoryStorage* vcardStorage_;
        ClientBlockListManager* clientBlockListManager_;
        MUCBookmarkManager* mucBookmarkManager_;
+        XMPPRoster* xmppRoster_;
 };
 CPPUNIT_TEST_SUITE_REGISTRATION(MUCControllerTest);
diff --git a/Swift/Controllers/Roster/RosterController.cpp b/Swift/Controllers/Roster/RosterController.cpp
index 2d35b6a..73efa43 100644
--- a/Swift/Controllers/Roster/RosterController.cpp
+++ b/Swift/Controllers/Roster/RosterController.cpp
@@ -1,19 +1,20 @@
 /*
- * Copyright (c) 2010-2014 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */
 #include <Swift/Controllers/Roster/RosterController.h>
 #include <boost/bind.hpp>
 #include <boost/smart_ptr/make_shared.hpp>
+#include <Swiften/Avatars/AvatarManager.h>
+#include <Swiften/Base/Path.h>
 #include <Swiften/Base/foreach.h>
 #include <Swiften/Base/format.h>
-#include <Swiften/Base/Path.h>
 #include <Swiften/Client/ClientBlockListManager.h>
 #include <Swiften/Client/NickManager.h>
 #include <Swiften/Client/NickResolver.h>
 #include <Swiften/Disco/EntityCapsManager.h>
 #include <Swiften/Elements/DiscoInfo.h>
@@ -25,23 +26,26 @@
 #include <Swiften/Queries/IQRouter.h>
 #include <Swiften/Roster/GetRosterRequest.h>
 #include <Swiften/Roster/SetRosterRequest.h>
 #include <Swiften/Roster/XMPPRoster.h>
 #include <Swiften/Roster/XMPPRosterItem.h>
+#include <Swiften/VCards/VCardManager.h>
+#include <Swift/Controllers/FileTransfer/FileTransferOverview.h>
 #include <Swift/Controllers/Intl.h>
 #include <Swift/Controllers/Roster/GroupRosterItem.h>
-#include <Swift/Controllers/Roster/OfflineRosterFilter.h>
-#include <Swift/Controllers/Roster/Roster.h>
-#include <Swift/Controllers/Roster/RosterVCardProvider.h>
 #include <Swift/Controllers/Roster/ItemOperations/AppearOffline.h>
-#include <Swift/Controllers/Roster/ItemOperations/SetAvatar.h>
 #include <Swift/Controllers/Roster/ItemOperations/SetAvailableFeatures.h>
+#include <Swift/Controllers/Roster/ItemOperations/SetAvatar.h>
 #include <Swift/Controllers/Roster/ItemOperations/SetBlockingState.h>
 #include <Swift/Controllers/Roster/ItemOperations/SetName.h>
 #include <Swift/Controllers/Roster/ItemOperations/SetPresence.h>
 #include <Swift/Controllers/Roster/ItemOperations/SetVCard.h>
+#include <Swift/Controllers/Roster/OfflineRosterFilter.h>
+#include <Swift/Controllers/Roster/Roster.h>
+#include <Swift/Controllers/Roster/RosterGroupExpandinessPersister.h>
+#include <Swift/Controllers/Roster/RosterVCardProvider.h>
 #include <Swift/Controllers/SettingConstants.h>
 #include <Swift/Controllers/UIEvents/AddContactUIEvent.h>
 #include <Swift/Controllers/UIEvents/RemoveRosterItemUIEvent.h>
 #include <Swift/Controllers/UIEvents/RenameGroupUIEvent.h>
 #include <Swift/Controllers/UIEvents/RenameRosterItemUIEvent.h>
diff --git a/Swift/Controllers/Roster/RosterController.h b/Swift/Controllers/Roster/RosterController.h
index f4ae581..545abfc 100644
--- a/Swift/Controllers/Roster/RosterController.h
+++ b/Swift/Controllers/Roster/RosterController.h
@@ -1,55 +1,57 @@
 /*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */
 #pragma once
-#include <string>
 #include <set>
+#include <string>
 #include <boost/shared_ptr.hpp>
+#include <Swiften/Avatars/AvatarManager.h>
 #include <Swiften/Base/boost_bsignals.h>
-#include <Swiften/JID/JID.h>
-#include <Swiften/Elements/Presence.h>
 #include <Swiften/Elements/ErrorPayload.h>
+#include <Swiften/Elements/Presence.h>
 #include <Swiften/Elements/RosterPayload.h>
-#include <Swiften/Avatars/AvatarManager.h>
+#include <Swiften/Elements/VCard.h>
-#include <Swiften/VCards/VCardManager.h>
+#include <Swiften/JID/JID.h>
+#include <Swift/Controllers/Roster/ContactRosterItem.h>
 #include <Swift/Controllers/UIEvents/UIEvent.h>
-#include <Swift/Controllers/FileTransfer/FileTransferOverview.h>
-#include <Swift/Controllers/Roster/RosterGroupExpandinessPersister.h>
 namespace Swift {
+        class AvatarManager;
+        class ClientBlockListManager;
+        class EntityCapsProvider;
+        class EventController;
+        class FileTransferManager;
+        class FileTransferOverview;
        class IQRouter;
-        class Roster;
-        class XMPPRoster;
-        class XMPPRosterItem;
        class MainWindow;
        class MainWindowFactory;
-        class OfflineRosterFilter;
+        class NickManager;
        class NickResolver;
+        class OfflineRosterFilter;
        class PresenceOracle;
+        class Roster;
+        class RosterGroupExpandinessPersister;
+        class RosterVCardProvider;
+        class SettingsProvider;
        class SubscriptionManager;
-        class EventController;
        class SubscriptionRequestEvent;
        class UIEventStream;
-        class IQRouter;
+        class VCardManager;
-        class SettingsProvider;
+        class XMPPRoster;
-        class NickManager;
+        class XMPPRosterItem;
-        class EntityCapsProvider;
-        class FileTransferManager;
-        class ClientBlockListManager;
-        class RosterVCardProvider;
        class RosterController {
                public:
-                        RosterController(const JID& jid, XMPPRoster* xmppRoster, AvatarManager* avatarManager, MainWindowFactory* mainWindowFactory, NickManager* nickManager, NickResolver* nickResolver, PresenceOracle* presenceOracle, SubscriptionManager* subscriptionManager, EventController* eventController, UIEventStream* uiEventStream, IQRouter* iqRouter_, SettingsProvider* settings, EntityCapsProvider* entityCapsProvider, FileTransferOverview* fileTransferOverview, ClientBlockListManager* clientBlockListManager, VCardManager* vcardManager);
+                        RosterController(const JID& jid, XMPPRoster* xmppRoster, AvatarManager* avatarManager, MainWindowFactory* mainWindowFactory, NickManager* nickManager, NickResolver* nickResolver, PresenceOracle* presenceOracle, SubscriptionManager* subscriptionManager, EventController* eventController, UIEventStream* uiEventStream, IQRouter* iqRouter, SettingsProvider* settings, EntityCapsProvider* entityCapsProvider, FileTransferOverview* fileTransferOverview, ClientBlockListManager* clientBlockListManager, VCardManager* vcardManager);
                        ~RosterController();
                        void showRosterWindow();
                        void setJID(const JID& jid) { myJID_ = jid; }
                        MainWindow* getWindow() {return mainWindow_;}
                        boost::signal<void (StatusShow::Type, const std::string&)> onChangeStatusRequest;
diff --git a/Swift/Controllers/Roster/UnitTest/RosterControllerTest.cpp b/Swift/Controllers/Roster/UnitTest/RosterControllerTest.cpp
index c396e48..9320af1 100644
--- a/Swift/Controllers/Roster/UnitTest/RosterControllerTest.cpp
+++ b/Swift/Controllers/Roster/UnitTest/RosterControllerTest.cpp
@@ -1,8 +1,7 @@
 /*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */
 #include <cppunit/extensions/HelperMacros.h>
@@ -26,15 +25,14 @@
 #include <Swiften/Presence/PresenceOracle.h>
 #include <Swiften/Presence/SubscriptionManager.h>
 #include <Swiften/Queries/DummyIQChannel.h>
 #include <Swiften/Queries/IQRouter.h>
 #include <Swiften/Roster/XMPPRosterImpl.h>
+#include <Swiften/VCards/VCardManager.h>
 #include <Swiften/VCards/VCardMemoryStorage.h>
-// #include <Swiften/Elements/Payload.h>
-// #include <Swiften/Elements/RosterItemPayload.h>
-// #include <Swiften/Elements/RosterPayload.h>
+#include <Swift/Controllers/FileTransfer/FileTransferOverview.h>
 #include <Swift/Controllers/Roster/ContactRosterItem.h>
 #include <Swift/Controllers/Roster/GroupRosterItem.h>
 #include <Swift/Controllers/Roster/Roster.h>
 #include <Swift/Controllers/Roster/RosterController.h>
 #include <Swift/Controllers/Settings/DummySettingsProvider.h>
@@ -60,10 +58,11 @@ class RosterControllerTest : public CppUnit::TestFixture {
                CPPUNIT_TEST(testSendRename);
                CPPUNIT_TEST(testPresence);
                CPPUNIT_TEST(testHighestPresence);
                CPPUNIT_TEST(testNotHighestPresence);
                CPPUNIT_TEST(testUnavailablePresence);
+                CPPUNIT_TEST(testRemoveResultsInUnavailablePresence);
                CPPUNIT_TEST_SUITE_END();
        public:
                void setUp() {
                        jid_ = JID("testjid@swift.im/swift");
@@ -73,11 +72,11 @@ class RosterControllerTest : public CppUnit::TestFixture {
                        mucRegistry_ = new MUCRegistry();
                        nickResolver_ = new NickResolver(jid_.toBare(), xmppRoster_, NULL, mucRegistry_);
                        channel_ = new DummyIQChannel();
                        router_ = new IQRouter(channel_);
                        stanzaChannel_ = new DummyStanzaChannel();
-                        presenceOracle_ = new PresenceOracle(stanzaChannel_);
+                        presenceOracle_ = new PresenceOracle(stanzaChannel_, xmppRoster_);
                        subscriptionManager_ = new SubscriptionManager(stanzaChannel_);
                        eventController_ = new EventController();
                        uiEventStream_ = new UIEventStream();
                        settings_ = new DummySettingsProvider();
                        nickManager_ = new DummyNickManager();
@@ -317,10 +316,33 @@ class RosterControllerTest : public CppUnit::TestFixture {
                        CPPUNIT_ASSERT_EQUAL(groups.size(), item.getGroups().size());
                        assertVectorsEqual(groups, item.getGroups(), __LINE__);
                }
+                void testRemoveResultsInUnavailablePresence() {
+                        std::vector<std::string> groups;
+                        groups.push_back("testGroup1");
+                        JID from("test@testdomain.com");
+                        xmppRoster_->addContact(from, "name", groups, RosterItemPayload::Both);
+                        Presence::ref lowPresence(new Presence());
+                        lowPresence->setFrom(withResource(from, "bob"));
+                        lowPresence->setPriority(2);
+                        lowPresence->setStatus("Not here");
+                        Presence::ref highPresence(new Presence());
+                        highPresence->setFrom(withResource(from, "bert"));
+                        highPresence->setPriority(10);
+                        highPresence->setStatus("So totally here");
+                        stanzaChannel_->onPresenceReceived(highPresence);
+                        stanzaChannel_->onPresenceReceived(lowPresence);
+                        CPPUNIT_ASSERT_EQUAL(static_cast<size_t>(2), presenceOracle_->getAllPresence("test@testdomain.com").size());
+                        xmppRoster_->onJIDRemoved(JID("test@testdomain.com"));
+                        CPPUNIT_ASSERT_EQUAL(static_cast<size_t>(1), presenceOracle_->getAllPresence("test@testdomain.com").size());
+                        CPPUNIT_ASSERT_EQUAL(Presence::Unavailable, presenceOracle_->getAllPresence("test@testdomain.com")[0]->getType());
+                }
                void assertVectorsEqual(const std::vector<std::string>& v1, const std::vector<std::string>& v2, int line) {
                        foreach (const std::string& entry, v1) {
                                if (std::find(v2.begin(), v2.end(), entry) == v2.end()) {
                                        std::stringstream stream;
                                        stream <<       "Couldn't find " << entry << " in v2 (line " << line << ")";
diff --git a/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp b/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp
index 681177a..40530dc 100644
--- a/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp
+++ b/Swift/Controllers/UnitTest/PresenceNotifierTest.cpp
@@ -1,25 +1,29 @@
 /*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */
-#include <cppunit/extensions/HelperMacros.h>
-#include <cppunit/extensions/TestFactoryRegistry.h>
 #include <vector>
 #include <boost/bind.hpp>
-#include "Swift/Controllers/PresenceNotifier.h"
+#include <cppunit/extensions/HelperMacros.h>
-#include "Swiften/Client/NickResolver.h"
+#include <cppunit/extensions/TestFactoryRegistry.h>
-#include "SwifTools/Notifier/LoggingNotifier.h"
-#include "Swiften/Client/DummyStanzaChannel.h"
+#include <Swiften/Avatars/DummyAvatarManager.h>
-#include "Swiften/MUC/MUCRegistry.h"
+#include <Swiften/Client/DummyStanzaChannel.h>
-#include "Swiften/Roster/XMPPRosterImpl.h"
+#include <Swiften/Client/NickResolver.h>
-#include "Swiften/Presence/PresenceOracle.h"
+#include <Swiften/MUC/MUCRegistry.h>
-#include "Swiften/Avatars/DummyAvatarManager.h"
+#include <Swiften/Network/DummyTimerFactory.h>
-#include "Swiften/Network/DummyTimerFactory.h"
+#include <Swiften/Presence/PresenceOracle.h>
+#include <Swiften/Roster/XMPPRosterImpl.h>
+#include <Swift/Controllers/PresenceNotifier.h>
+#include <SwifTools/Notifier/LoggingNotifier.h>
 using namespace Swift;
 class PresenceNotifierTest : public CppUnit::TestFixture {
                CPPUNIT_TEST_SUITE(PresenceNotifierTest);
@@ -52,11 +56,11 @@ class PresenceNotifierTest : public CppUnit::TestFixture {
                        user1 = JID("user1@bar.com/bla");
                        user2 = JID("user2@foo.com/baz");
                        avatarManager = new DummyAvatarManager();
                        roster = new XMPPRosterImpl();
                        nickResolver = new NickResolver(JID("foo@bar.com"), roster, NULL, mucRegistry);
-                        presenceOracle = new PresenceOracle(stanzaChannel);
+                        presenceOracle = new PresenceOracle(stanzaChannel, roster);
                        timerFactory = new DummyTimerFactory();
                }
                void tearDown() {
                        delete timerFactory;
author	Tobias Markmann <tm@ayena.de>	2015-09-14 15:08:39 (GMT)
committer	Kevin Smith <kevin.smith@isode.com>	2015-10-16 14:58:03 (GMT)
commit	9e6ee0f262e7dc663f4c706b16a346a268f425aa (patch)
tree	5926fd9cc9dec1233f95239b259a7730f99a5a72 /Swift/Controllers
parent	8da6e35afab55d7232d47575faea2bde7cd44ece (diff)
download	swift-9e6ee0f262e7dc663f4c706b16a346a268f425aa.zip swift-9e6ee0f262e7dc663f4c706b16a346a268f425aa.tar.bz2