Implement support for displaying nickname changes.

This implements Swiften API for changing nicknames in MUC and correctly detecting nick name changes. In addition Swift now displays nickname changes as such and not as join/leave of a user. In addition, handling of nickname changes is integrated in ChatsManager and ChatControllers so that they are forwarded to PM chats of MUCs. Test-Information: Added unit tests for change of own nickname and nickname changes of others. Tested correct detection of nickname changes in a MUC with a Psi user changing its nickname and Swift correctly detecting and displaying it. Change-Id: I3287ba6ceeccd3be5cfb591acd6f88bffc9a43b2
author: Tobias Markmann <tm@ayena.de> 2014-10-07 11:58:34 (GMT)
committer: Swift Review <review@swift.im> 2014-10-17 18:18:54 (GMT)
commit: 1722d220533a78e8b2acbcd571631960656e78f8 (patch)
tree: 4da1095da990626652774962bab8a1c8db9ff2ea
parent: 0e7940bf2ede0147ee1eafced53bc9ad08a4015e (diff)
download: swift-contrib-1722d220533a78e8b2acbcd571631960656e78f8.zip
swift-contrib-1722d220533a78e8b2acbcd571631960656e78f8.tar.bz2
10 files changed, 187 insertions, 6 deletions
diff --git a/Swift/Controllers/Chat/ChatsManager.cpp b/Swift/Controllers/Chat/ChatsManager.cpp
index c180024..32e25a2 100644
--- a/Swift/Controllers/Chat/ChatsManager.cpp
+++ b/Swift/Controllers/Chat/ChatsManager.cpp
@@ -825,4 +825,5 @@ MUC::ref ChatsManager::handleJoinMUCRequest(const JID &mucJID, const boost::opti
 		controller->onUserLeft.connect(boost::bind(&ChatsManager::handleUserLeftMUC, this, controller));
 		controller->onUserJoined.connect(boost::bind(&ChatsManager::handleChatActivity, this, mucJID.toBare(), "", true));
+		controller->onUserNicknameChanged.connect(boost::bind(&ChatsManager::handleUserNicknameChanged, this, controller, _1, _2));
 		controller->onActivity.connect(boost::bind(&ChatsManager::handleChatActivity, this, mucJID.toBare(), _1, true));
 		controller->onUnreadCountChanged.connect(boost::bind(&ChatsManager::handleUnreadCountChanged, this, controller));
@@ -838,4 +839,27 @@ void ChatsManager::handleSearchMUCRequest() {
 }
 
+void ChatsManager::handleUserNicknameChanged(MUCController* mucController, const std::string& oldNickname, const std::string& newNickname) {
+	JID oldMUCChatJID = mucController->getToJID().withResource(oldNickname);
+	JID newMUCChatJID = mucController->getToJID().withResource(newNickname);
+
+	SWIFT_LOG(debug) << "nickname change in " << mucController->getToJID().toString() << " from " << oldNickname << " to " << newNickname << std::endl;
+
+	// get current chat controller
+	ChatController *chatController = getChatControllerIfExists(oldMUCChatJID);
+	if (chatController) {
+		// adjust chat controller
+		chatController->setToJID(newMUCChatJID);
+		nickResolver_->onNickChanged(newMUCChatJID, oldNickname);
+		chatControllers_.erase(oldMUCChatJID);
+		chatControllers_[newMUCChatJID] = chatController;
+
+		chatController->onActivity.disconnect(boost::bind(&ChatsManager::handleChatActivity, this, oldMUCChatJID, _1, false));
+		chatController->onActivity.connect(boost::bind(&ChatsManager::handleChatActivity, this, newMUCChatJID, _1, false));
+		/*for (std::list<ChatListWindow::Chat>::iterator i = recentChats_.begin(); i != recentChats_.end(); i++) {
+			if (i->jid ==
+		}*/
+	}
+}
+
 void ChatsManager::handleIncomingMessage(boost::shared_ptr<Message> message) {
 	JID jid = message->getFrom();
diff --git a/Swift/Controllers/Chat/ChatsManager.h b/Swift/Controllers/Chat/ChatsManager.h
index 575b3cb..82daf67 100644
--- a/Swift/Controllers/Chat/ChatsManager.h
+++ b/Swift/Controllers/Chat/ChatsManager.h
@@ -102,4 +102,5 @@ namespace Swift {
 			void handleMUCBookmarkRemoved(const MUCBookmark& bookmark);
 			void handleUserLeftMUC(MUCController* mucController);
+			void handleUserNicknameChanged(MUCController* mucController, const std::string& oldNickname, const std::string& newNickname);
 			void handleBookmarksReady();
 			void handleChatActivity(const JID& jid, const std::string& activity, bool isMUC);
diff --git a/Swift/Controllers/Chat/MUCController.cpp b/Swift/Controllers/Chat/MUCController.cpp
index b467227..fe90c60 100644
--- a/Swift/Controllers/Chat/MUCController.cpp
+++ b/Swift/Controllers/Chat/MUCController.cpp
@@ -104,4 +104,5 @@ MUCController::MUCController (
 	muc_->onJoinFailed.connect(boost::bind(&MUCController::handleJoinFailed, this, _1));
 	muc_->onOccupantJoined.connect(boost::bind(&MUCController::handleOccupantJoined, this, _1));
+	muc_->onOccupantNicknameChanged.connect(boost::bind(&MUCController::handleOccupantNicknameChanged, this, _1, _2));
 	muc_->onOccupantPresenceChange.connect(boost::bind(&MUCController::handleOccupantPresenceChange, this, _1));
 	muc_->onOccupantLeft.connect(boost::bind(&MUCController::handleOccupantLeft, this, _1, _2, _3));
@@ -484,5 +485,5 @@ std::string MUCController::roleToSortName(MUCOccupant::Role role) {
 
 JID MUCController::nickToJID(const std::string& nick) {
-	return JID(toJID_.getNode(), toJID_.getDomain(), nick);
+	return muc_->getJID().withResource(nick);
 }
 
@@ -692,4 +693,42 @@ void MUCController::handleOccupantLeft(const MUCOccupant& occupant, MUC::Leaving
 }
 
+void MUCController::handleOccupantNicknameChanged(const std::string& oldNickname, const std::string& newNickname) {
+	addPresenceMessage(generateNicknameChangeString(oldNickname, newNickname));
+	JID oldJID = muc_->getJID().withResource(oldNickname);
+	JID newJID = muc_->getJID().withResource(newNickname);
+
+	// adjust occupants
+	currentOccupants_.erase(oldNickname);
+	currentOccupants_.insert(newNickname);
+
+	// adjust completer
+	completer_->removeWord(oldNickname);
+	completer_->addWord(newNickname);
+
+	// update contact
+	roster_->removeContact(oldJID);
+	MUCOccupant occupant = muc_->getOccupant(newNickname);
+
+	JID realJID;
+	if (occupant.getRealJID()) {
+		realJID = occupant.getRealJID().get();
+	}
+	MUCOccupant::Role role = MUCOccupant::Participant;
+	MUCOccupant::Affiliation affiliation = MUCOccupant::NoAffiliation;
+	if (!isImpromptu_) {
+		role = occupant.getRole();
+		affiliation = occupant.getAffiliation();
+	}
+	std::string groupName(roleToGroupName(role));
+	roster_->addContact(newJID, realJID, newNickname, groupName, avatarManager_->getAvatarPath(newJID));
+	roster_->applyOnItems(SetMUC(newJID, role, affiliation));
+	if (avatarManager_ != NULL) {
+		handleAvatarChanged(newJID);
+	}
+
+	clearPresenceQueue();
+	onUserNicknameChanged(oldNickname, newNickname);
+}
+
 void MUCController::handleOccupantPresenceChange(boost::shared_ptr<Presence> presence) {
 	receivedActivity();
@@ -819,4 +858,8 @@ std::string MUCController::generateJoinPartString(const std::vector<NickJoinPart
 }
 
+std::string MUCController::generateNicknameChangeString(const std::string& oldNickname, const std::string& newNickname) {
+	return str(boost::format(QT_TRANSLATE_NOOP("", "%1% is now known as %2%.")) % oldNickname % newNickname);
+}
+
 void MUCController::handleChangeSubjectRequest(const std::string& subject) {
 	muc_->changeSubject(subject);
diff --git a/Swift/Controllers/Chat/MUCController.h b/Swift/Controllers/Chat/MUCController.h
index b5b5837..2d732a1 100644
--- a/Swift/Controllers/Chat/MUCController.h
+++ b/Swift/Controllers/Chat/MUCController.h
@@ -56,4 +56,5 @@ namespace Swift {
 			boost::signal<void ()> onUserJoined;
 			boost::signal<void ()> onImpromptuConfigCompleted;
+			boost::signal<void (const std::string&, const std::string& )> onUserNicknameChanged;
 			virtual void setOnline(bool online);
 			void rejoin();
@@ -61,4 +62,5 @@ namespace Swift {
 			static std::string generateJoinPartString(const std::vector<NickJoinPart>& joinParts, bool isImpromptu);
 			static std::string concatenateListOfNames(const std::vector<NickJoinPart>& joinParts);
+			static std::string generateNicknameChangeString(const std::string& oldNickname, const std::string& newNickname);
 			bool isJoined();
 			const std::string& getNick();
@@ -87,4 +89,5 @@ namespace Swift {
 			void handleAvatarChanged(const JID& jid);
 			void handleOccupantJoined(const MUCOccupant& occupant);
+			void handleOccupantNicknameChanged(const std::string& oldNickname, const std::string& newNickname);
 			void handleOccupantLeft(const MUCOccupant& occupant, MUC::LeavingType type, const std::string& reason);
 			void handleOccupantPresenceChange(boost::shared_ptr<Presence> presence);
diff --git a/Swiften/JID/JID.h b/Swiften/JID/JID.h
index 126a7b1..aefd3df 100644
--- a/Swiften/JID/JID.h
+++ b/Swiften/JID/JID.h
@@ -135,4 +135,12 @@ namespace Swift {
 			}
 
+			/**
+			 * Get the full JID with the supplied resource.
+			 */
+			JID withResource(const std::string& resource) const {
+				JID result(this->getNode(), this->getDomain(), resource);
+				return result;
+			}
+
 			std::string toString() const;
 
diff --git a/Swiften/MUC/MUC.h b/Swiften/MUC/MUC.h
index 0dcccd9..8815489 100644
--- a/Swiften/MUC/MUC.h
+++ b/Swiften/MUC/MUC.h
@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2010-2013 Kevin Smith
+ * Copyright (c) 2010-2014 Kevin Smith
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
@@ -56,4 +56,5 @@ namespace Swift {
 			/*virtual std::string getCurrentNick() = 0; */
 			virtual std::map<std::string, MUCOccupant> getOccupants() const = 0;
+			virtual void changeNickname(const std::string& newNickname) = 0;
 			virtual void part() = 0;
 			/*virtual void handleIncomingMessage(Message::ref message) = 0; */
@@ -88,4 +89,5 @@ namespace Swift {
 			boost::signal<void (const std::string&, const MUCOccupant::Affiliation& /*new*/, const MUCOccupant::Affiliation& /*old*/)> onOccupantAffiliationChanged;
 			boost::signal<void (const MUCOccupant&)> onOccupantJoined;
+			boost::signal<void (const std::string& /*oldNickname*/, const std::string& /*newNickname*/ )> onOccupantNicknameChanged;
 			boost::signal<void (const MUCOccupant&, LeavingType, const std::string& /*reason*/)> onOccupantLeft;
 			boost::signal<void (Form::ref)> onConfigurationFormReceived;
diff --git a/Swiften/MUC/MUCImpl.cpp b/Swiften/MUC/MUCImpl.cpp
index a1854e3..ab5faf4 100644
--- a/Swiften/MUC/MUCImpl.cpp
+++ b/Swiften/MUC/MUCImpl.cpp
@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2010-2013 Kevin Smith
+ * Copyright (c) 2010-2014 Kevin Smith
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
@@ -91,4 +91,10 @@ void MUCImpl::internalJoin(const std::string &nick) {
 }
 
+void MUCImpl::changeNickname(const std::string& newNickname) {
+	Presence::ref changeNicknamePresence = boost::make_shared<Presence>();
+	changeNicknamePresence->setTo(ownMUCJID.toBare().toString() + std::string("/") + newNickname);
+	presenceSender->sendPresence(changeNicknamePresence);
+}
+
 void MUCImpl::part() {
 	presenceSender->removeDirectedPresenceReceiver(ownMUCJID, DirectedPresenceSender::AndSendPresence);
@@ -155,4 +161,5 @@ void MUCImpl::handleIncomingPresence(Presence::ref presence) {
 	if (presence->getType() == Presence::Unavailable) {
 		LeavingType type = LeavePart;
+		boost::optional<std::string> newNickname;
 		if (mucPayload) {
 			if (boost::dynamic_pointer_cast<MUCDestroyPayload>(mucPayload->getPayload())) {
@@ -169,7 +176,22 @@ void MUCImpl::handleIncomingPresence(Presence::ref presence) {
 					type = LeaveNotMember;
 				}
+				else if (status.code == 303) {
+					if (mucPayload->getItems().size() == 1) {
+						newNickname = mucPayload->getItems()[0].nick;
 					}
 				}
-
+			}
+		}
+		if (newNickname) {
+			std::map<std::string,MUCOccupant>::iterator i = occupants.find(nick);
+			if (i != occupants.end()) {
+				MUCOccupant occupant = i->second;
+				occupants.erase(i);
+				occupant.setNick(newNickname.get());
+				occupants.insert(std::make_pair(newNickname.get(), occupant));
+				onOccupantNicknameChanged(nick, newNickname.get());
+			}
+		}
+		else {
 			if (presence->getFrom() == ownMUCJID) {
 				handleUserLeft(type);
@@ -186,4 +208,5 @@ void MUCImpl::handleIncomingPresence(Presence::ref presence) {
 			}
 		}
+	} 
 	else if (presence->getType() == Presence::Available) {
 		std::map<std::string, MUCOccupant>::iterator it = occupants.find(nick);
diff --git a/Swiften/MUC/MUCImpl.h b/Swiften/MUC/MUCImpl.h
index 846ddcf..8eabb80 100644
--- a/Swiften/MUC/MUCImpl.h
+++ b/Swiften/MUC/MUCImpl.h
@@ -59,4 +59,10 @@ namespace Swift {
 			/*virtual std::string getCurrentNick(); */
 			virtual std::map<std::string, MUCOccupant> getOccupants() const;
+
+			/**
+			 * Send a new presence to the MUC indicating a nickname change. Any custom status the user had in the is cleared.
+			 * @param newNickname The nickname to change to.
+			 */
+			virtual void changeNickname(const std::string& newNickname);
 			virtual void part();
 			/*virtual void handleIncomingMessage(Message::ref message); */
diff --git a/Swiften/MUC/UnitTest/MUCTest.cpp b/Swiften/MUC/UnitTest/MUCTest.cpp
index d1a21b0..773edb6 100644
--- a/Swiften/MUC/UnitTest/MUCTest.cpp
+++ b/Swiften/MUC/UnitTest/MUCTest.cpp
@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2010 Remko Tronçon
+ * Copyright (c) 2010-2014 Remko Tronçon
  * Licensed under the GNU General Public License v3.
  * See Documentation/Licenses/GPLv3.txt for more information.
@@ -31,4 +31,5 @@ class MUCTest : public CppUnit::TestFixture {
 		CPPUNIT_TEST(testCreateInstant);
 		CPPUNIT_TEST(testReplicateBug);
+		CPPUNIT_TEST(testNicknameChange);
 		/*CPPUNIT_TEST(testJoin_Success);
 		CPPUNIT_TEST(testJoin_Fail);*/
@@ -42,4 +43,5 @@ class MUCTest : public CppUnit::TestFixture {
 			stanzaChannelPresenceSender = new StanzaChannelPresenceSender(channel);
 			presenceSender = new DirectedPresenceSender(stanzaChannelPresenceSender);
+			nickChanges = 0;
 		}
 
@@ -142,4 +144,65 @@ class MUCTest : public CppUnit::TestFixture {
 		}
 
+		void testNicknameChange() {
+			MUC::ref testling = createMUC(JID("foo@bar.com"));
+			// Join as Rabbit
+			testling->joinAs("Rabbit");
+
+			// Rabbit joins
+			Presence::ref rabbitJoins = boost::make_shared<Presence>();
+			rabbitJoins->setTo("test@swift.im/6913d576d55f0b67");
+			rabbitJoins->setFrom(testling->getJID().toString() + "/Rabbit");
+			channel->onPresenceReceived(rabbitJoins);
+			CPPUNIT_ASSERT_EQUAL(true, testling->hasOccupant("Rabbit"));
+
+			// Alice joins
+			Presence::ref aliceJoins = boost::make_shared<Presence>();
+			aliceJoins->setTo("test@swift.im/6913d576d55f0b67");
+			aliceJoins->setFrom(testling->getJID().toString() + "/Alice");
+			channel->onPresenceReceived(aliceJoins);
+			CPPUNIT_ASSERT_EQUAL(true, testling->hasOccupant("Alice"));
+
+			// Change nick to Dodo
+			testling->changeNickname("Dodo");
+			Presence::ref stanza = channel->getStanzaAtIndex<Presence>(1);
+			CPPUNIT_ASSERT(stanza);
+			CPPUNIT_ASSERT_EQUAL(std::string("Dodo"), stanza->getTo().getResource());
+
+			// Alice changes nick to Alice2
+			stanza = boost::make_shared<Presence>();
+			stanza->setFrom(JID("foo@bar.com/Alice"));
+			stanza->setTo(JID(router->getJID()));
+			stanza->setType(Presence::Unavailable);
+			MUCUserPayload::ref mucPayload(new MUCUserPayload());
+			MUCItem myItem;
+			myItem.affiliation = MUCOccupant::Member;
+			myItem.nick = "Alice2";
+			myItem.role = MUCOccupant::Participant;
+			mucPayload->addItem(myItem);
+			mucPayload->addStatusCode(303);
+			stanza->addPayload(mucPayload);
+			channel->onPresenceReceived(stanza);
+			CPPUNIT_ASSERT_EQUAL(1, nickChanges);
+			CPPUNIT_ASSERT_EQUAL(false, testling->hasOccupant("Alice"));
+			CPPUNIT_ASSERT_EQUAL(true, testling->hasOccupant("Alice2"));
+
+			// We (Rabbit) change nick to Robot
+			stanza = boost::make_shared<Presence>();
+			stanza->setFrom(JID("foo@bar.com/Rabbit"));
+			stanza->setTo(JID(router->getJID()));
+			stanza->setType(Presence::Unavailable);
+			mucPayload = MUCUserPayload::ref(new MUCUserPayload());
+			myItem.affiliation = MUCOccupant::Member;
+			myItem.nick = "Robot";
+			myItem.role = MUCOccupant::Participant;
+			mucPayload->addItem(myItem);
+			mucPayload->addStatusCode(303);
+			stanza->addPayload(mucPayload);
+			channel->onPresenceReceived(stanza);
+			CPPUNIT_ASSERT_EQUAL(2, nickChanges);
+			CPPUNIT_ASSERT_EQUAL(false, testling->hasOccupant("Rabbit"));
+			CPPUNIT_ASSERT_EQUAL(true, testling->hasOccupant("Robot"));
+		}
+
 		/*void testJoin_Success() {
 			MUC::ref testling = createMUC(JID("foo@bar.com"));
@@ -159,5 +222,7 @@ class MUCTest : public CppUnit::TestFixture {
 	private:
 		MUC::ref createMUC(const JID& jid) {
-			return boost::make_shared<MUCImpl>(channel, router, presenceSender, jid, mucRegistry);
+			MUC::ref muc = boost::make_shared<MUCImpl>(channel, router, presenceSender, jid, mucRegistry);
+			muc->onOccupantNicknameChanged.connect(boost::bind(&MUCTest::handleOccupantNicknameChanged, this, _1, _2));
+			return muc;
 		}
 
@@ -178,4 +243,8 @@ class MUCTest : public CppUnit::TestFixture {
 		}
 
+		void handleOccupantNicknameChanged(const std::string&, const std::string&) {
+			nickChanges++;
+		}
+
 	private:
 		DummyStanzaChannel* channel;
@@ -189,4 +258,5 @@ class MUCTest : public CppUnit::TestFixture {
 		};
 		std::vector<JoinResult> joinResults;
+		int nickChanges;
 };
 
diff --git a/Swiften/MUC/UnitTest/MockMUC.h b/Swiften/MUC/UnitTest/MockMUC.h
index 78c2fb5..8673a90 100644
--- a/Swiften/MUC/UnitTest/MockMUC.h
+++ b/Swiften/MUC/UnitTest/MockMUC.h
@@ -59,4 +59,5 @@ namespace Swift {
 			/*virtual std::string getCurrentNick() = 0; */
 			virtual std::map<std::string, MUCOccupant> getOccupants() const { return occupants_; }
+			virtual void changeNickname(const std::string&) { }
 			virtual void part() {}
 			/*virtual void handleIncomingMessage(Message::ref message) = 0; */
author	Tobias Markmann <tm@ayena.de>	2014-10-07 11:58:34 (GMT)
committer	Swift Review <review@swift.im>	2014-10-17 18:18:54 (GMT)
commit	1722d220533a78e8b2acbcd571631960656e78f8 (patch)
tree	4da1095da990626652774962bab8a1c8db9ff2ea
parent	0e7940bf2ede0147ee1eafced53bc9ad08a4015e (diff)
download	swift-contrib-1722d220533a78e8b2acbcd571631960656e78f8.zip swift-contrib-1722d220533a78e8b2acbcd571631960656e78f8.tar.bz2