Change stanza body to boost::optional<std::string> type

Changed MUCController to only handle message stanzas as subject change if <subject/> is present and neither <body/> nor <thread/> is present in the message stanza. Test-Information: Added unit tests verifying behavior described in XEP-0045 section 8.1. Unit tests pass on OS X 10.11.2. Change-Id: I1d22272da1675176be131ab360b214a98f20533f
author: Tobias Markmann <tm@ayena.de> 2016-01-12 17:23:05 (GMT)
committer: Kevin Smith <kevin.smith@isode.com> 2016-02-02 11:33:06 (GMT)
commit: 1b9ccc1fef6104eaf951153ddccdc6bb15899e9a (patch)
tree: 428232448e9846265605820db6f380a5b98c018a /Swift/Controllers
parent: 3afd061b713ce5fff604dee62dec8410a1de6a9c (diff)
download: swift-1b9ccc1fef6104eaf951153ddccdc6bb15899e9a.zip
swift-1b9ccc1fef6104eaf951153ddccdc6bb15899e9a.tar.bz2
8 files changed, 148 insertions, 36 deletions
diff --git a/Swift/Controllers/Chat/ChatController.cpp b/Swift/Controllers/Chat/ChatController.cpp
index eb86766..11ba89e 100644
--- a/Swift/Controllers/Chat/ChatController.cpp
+++ b/Swift/Controllers/Chat/ChatController.cpp
@@ -177,7 +177,7 @@ void ChatController::preHandleIncomingMessage(boost::shared_ptr<MessageEvent> me
 		if (toJID_.equals(from, JID::WithoutResource)  && toJID_.isBare()){
 			// Bind controller to a full JID if message contains body text or is a typing chat state.
 			ChatState::ref chatState = message->getPayload<ChatState>();
-			if (!message->getBody().empty() || (chatState && chatState->getChatState() == ChatState::Composing)) {
+			if (!message->getBody().get_value_or("").empty() || (chatState && chatState->getChatState() == ChatState::Composing)) {
 				setToJID(from);
 			}
 		}
diff --git a/Swift/Controllers/Chat/ChatControllerBase.cpp b/Swift/Controllers/Chat/ChatControllerBase.cpp
index 4a84a6e..fef3e7a 100644
--- a/Swift/Controllers/Chat/ChatControllerBase.cpp
+++ b/Swift/Controllers/Chat/ChatControllerBase.cpp
@@ -172,8 +172,8 @@ void ChatControllerBase::handleSendMessageRequest(const std::string &body, bool
 	}
 	message->setID(lastSentMessageStanzaID_ = idGenerator_.generateID());
 	stanzaChannel_->sendMessage(message);
-	postSendMessage(message->getBody(), boost::dynamic_pointer_cast<Stanza>(message));
-	onActivity(message->getBody());
+	postSendMessage(message->getBody().get(), boost::dynamic_pointer_cast<Stanza>(message));
+	onActivity(message->getBody().get());
 
 #ifdef SWIFT_EXPERIMENTAL_HISTORY
 	logMessage(body, selfJID_, toJID_, now, false);
@@ -237,7 +237,7 @@ void ChatControllerBase::handleIncomingMessage(boost::shared_ptr<MessageEvent> m
 		}
 	}
 	boost::shared_ptr<Message> message = messageEvent->getStanza();
-	std::string body = message->getBody();
+	std::string body = message->getBody().get_value_or("");
 	HighlightAction highlight;
 	if (message->isError()) {
 		if (!message->getTo().getResource().empty()) {
@@ -286,7 +286,7 @@ void ChatControllerBase::handleIncomingMessage(boost::shared_ptr<MessageEvent> m
 
 		boost::shared_ptr<Replace> replace = message->getPayload<Replace>();
 		if (replace) {
-			std::string body = message->getBody();
+			std::string body = message->getBody().get_value_or("");
 			// Should check if the user has a previous message
 			std::map<JID, std::string>::iterator lastMessage;
 			lastMessage = lastMessagesUIID_.find(from);
diff --git a/Swift/Controllers/Chat/ChatsManager.cpp b/Swift/Controllers/Chat/ChatsManager.cpp
index 1a69982..49caee4 100644
--- a/Swift/Controllers/Chat/ChatsManager.cpp
+++ b/Swift/Controllers/Chat/ChatsManager.cpp
@@ -917,7 +917,7 @@ void ChatsManager::handleIncomingMessage(boost::shared_ptr<Message> message) {
 		// Do not bind a controller to a full JID, for delivery receipts or chat state notifications.
 		bool bindControllerToJID = false;
 		ChatState::ref chatState = message->getPayload<ChatState>();
-		if (!message->getBody().empty() || (chatState && chatState->getChatState() == ChatState::Composing)) {
+		if (!message->getBody().get_value_or("").empty() || (chatState && chatState->getChatState() == ChatState::Composing)) {
 			bindControllerToJID = true;
 		}
 
diff --git a/Swift/Controllers/Chat/MUCController.cpp b/Swift/Controllers/Chat/MUCController.cpp
index e6c16b7..409fe1f 100644
--- a/Swift/Controllers/Chat/MUCController.cpp
+++ b/Swift/Controllers/Chat/MUCController.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2015 Isode Limited.
+ * Copyright (c) 2010-2016 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -22,6 +22,7 @@
 #include <Swiften/Client/StanzaChannel.h>
 #include <Swiften/Disco/EntityCapsProvider.h>
 #include <Swiften/Elements/Delay.h>
+#include <Swiften/Elements/Thread.h>
 #include <Swiften/MUC/MUC.h>
 #include <Swiften/MUC/MUCBookmark.h>
 #include <Swiften/MUC/MUCBookmarkManager.h>
@@ -531,7 +532,7 @@ JID MUCController::nickToJID(const std::string& nick) {
 bool MUCController::messageTargetsMe(boost::shared_ptr<Message> message) {
 	std::string stringRegexp(".*\\b" + boost::to_lower_copy(nick_) + "\\b.*");
 	boost::regex myRegexp(stringRegexp);
-	return boost::regex_match(boost::to_lower_copy(message->getBody()), myRegexp);
+	return boost::regex_match(boost::to_lower_copy(message->getBody().get_value_or("")), myRegexp);
 }
 
 void MUCController::preHandleIncomingMessage(boost::shared_ptr<MessageEvent> messageEvent) {
@@ -559,7 +560,7 @@ void MUCController::preHandleIncomingMessage(boost::shared_ptr<MessageEvent> mes
 	receivedActivity();
 	joined_ = true;
 
-	if (message->hasSubject() && message->getBody().empty()) {
+	if (message->hasSubject() && !message->getPayload<Body>() && !message->getPayload<Thread>()) {
 		chatWindow_->addSystemMessage(chatMessageParser_->parseMessageBody(str(format(QT_TRANSLATE_NOOP("", "The room subject is now: %1%")) % message->getSubject())), ChatWindow::DefaultDirection);
 		chatWindow_->setSubject(message->getSubject());
 		doneGettingHistory_ = true;
@@ -1078,7 +1079,7 @@ void MUCController::addRecentLogs() {
 }
 
 void MUCController::checkDuplicates(boost::shared_ptr<Message> newMessage) {
-	std::string body = newMessage->getBody();
+	std::string body = newMessage->getBody().get_value_or("");
 	JID jid = newMessage->getFrom();
 	boost::optional<boost::posix_time::ptime> time = newMessage->getTimestamp();
 
diff --git a/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp b/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp
index bc6ada2..e8fc41d 100644
--- a/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp
+++ b/Swift/Controllers/Chat/UnitTest/MUCControllerTest.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2015 Isode Limited.
+ * Copyright (c) 2010-2016 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -19,6 +19,7 @@
 #include <Swiften/Crypto/PlatformCryptoProvider.h>
 #include <Swiften/Disco/DummyEntityCapsProvider.h>
 #include <Swiften/Elements/MUCUserPayload.h>
+#include <Swiften/Elements/Thread.h>
 #include <Swiften/MUC/MUCBookmarkManager.h>
 #include <Swiften/MUC/UnitTest/MockMUC.h>
 #include <Swiften/Network/TimerFactory.h>
@@ -58,6 +59,10 @@ class MUCControllerTest : public CppUnit::TestFixture {
 	CPPUNIT_TEST(testMessageWithLabelItem);
 	CPPUNIT_TEST(testCorrectMessageWithLabelItem);
 	CPPUNIT_TEST(testRoleAffiliationStates);
+	CPPUNIT_TEST(testSubjectChangeCorrect);
+	CPPUNIT_TEST(testSubjectChangeIncorrectA);
+	CPPUNIT_TEST(testSubjectChangeIncorrectB);
+	CPPUNIT_TEST(testSubjectChangeIncorrectC);
 	CPPUNIT_TEST_SUITE_END();
 
 public:
@@ -215,7 +220,7 @@ public:
 		CPPUNIT_ASSERT(window_->labelsEnabled_);
 		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
 		CPPUNIT_ASSERT(message);
-		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody());
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get());
 		CPPUNIT_ASSERT(!message->getPayload<SecurityLabel>());
 	}
 
@@ -242,7 +247,7 @@ public:
 		CPPUNIT_ASSERT(window_->labelsEnabled_);
 		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
 		CPPUNIT_ASSERT(message);
-		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody());
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get());
 		CPPUNIT_ASSERT_EQUAL(label, message->getPayload<SecurityLabel>());
 	}
 
@@ -274,13 +279,13 @@ public:
 		CPPUNIT_ASSERT(window_->labelsEnabled_);
 		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
 		CPPUNIT_ASSERT(message);
-		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody());
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get());
 		CPPUNIT_ASSERT_EQUAL(label, message->getPayload<SecurityLabel>());
 		window_->label_ = labelItem2;
 		window_->onSendMessageRequest(messageBody, true);
 		rawStanza = stanzaChannel_->sentStanzas[stanzaChannel_->sentStanzas.size() - 1];
 		message = boost::dynamic_pointer_cast<Message>(rawStanza);
-		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody());
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get());
 		CPPUNIT_ASSERT_EQUAL(label, message->getPayload<SecurityLabel>());
 	}
 
@@ -398,6 +403,106 @@ public:
 		}
 	}
 
+	void testSubjectChangeCorrect() {
+		std::string messageBody("test message");
+		window_->onSendMessageRequest(messageBody, false);
+		boost::shared_ptr<Stanza> rawStanza = stanzaChannel_->sentStanzas[stanzaChannel_->sentStanzas.size() - 1];
+		Message::ref message = boost::dynamic_pointer_cast<Message>(rawStanza);
+		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
+		CPPUNIT_ASSERT(message);
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get_value_or(""));
+
+		{
+			Message::ref message = boost::make_shared<Message>();
+			message->setType(Message::Groupchat);
+			message->setTo(self_);
+			message->setFrom(mucJID_.withResource("SomeNickname"));
+			message->setID(iqChannel_->getNewIQID());
+			message->setSubject("New Room Subject");
+
+			controller_->handleIncomingMessage(boost::make_shared<MessageEvent>(message));
+			CPPUNIT_ASSERT_EQUAL(std::string("The room subject is now: New Room Subject"), boost::dynamic_pointer_cast<ChatWindow::ChatTextMessagePart>(window_->lastAddedSystemMessage_.getParts()[0])->text);
+		}
+	}
+
+	/*
+	 * Test that message stanzas with subject element and non-empty body element do not cause a subject change.
+	 */
+	void testSubjectChangeIncorrectA() {
+		std::string messageBody("test message");
+		window_->onSendMessageRequest(messageBody, false);
+		boost::shared_ptr<Stanza> rawStanza = stanzaChannel_->sentStanzas[stanzaChannel_->sentStanzas.size() - 1];
+		Message::ref message = boost::dynamic_pointer_cast<Message>(rawStanza);
+		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
+		CPPUNIT_ASSERT(message);
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get_value_or(""));
+
+		{
+			Message::ref message = boost::make_shared<Message>();
+			message->setType(Message::Groupchat);
+			message->setTo(self_);
+			message->setFrom(mucJID_.withResource("SomeNickname"));
+			message->setID(iqChannel_->getNewIQID());
+			message->setSubject("New Room Subject");
+			message->setBody("Some body text that prevents this stanza from being a subject change.");
+
+			controller_->handleIncomingMessage(boost::make_shared<MessageEvent>(message));
+			CPPUNIT_ASSERT_EQUAL(std::string("Trying to enter room teaparty@rooms.wonderland.lit"), boost::dynamic_pointer_cast<ChatWindow::ChatTextMessagePart>(window_->lastAddedSystemMessage_.getParts()[0])->text);
+		}
+	}
+
+	/*
+	 * Test that message stanzas with subject element and thread element do not cause a subject change.
+	 */
+	void testSubjectChangeIncorrectB() {
+		std::string messageBody("test message");
+		window_->onSendMessageRequest(messageBody, false);
+		boost::shared_ptr<Stanza> rawStanza = stanzaChannel_->sentStanzas[stanzaChannel_->sentStanzas.size() - 1];
+		Message::ref message = boost::dynamic_pointer_cast<Message>(rawStanza);
+		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
+		CPPUNIT_ASSERT(message);
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get_value_or(""));
+
+		{
+			Message::ref message = boost::make_shared<Message>();
+			message->setType(Message::Groupchat);
+			message->setTo(self_);
+			message->setFrom(mucJID_.withResource("SomeNickname"));
+			message->setID(iqChannel_->getNewIQID());
+			message->setSubject("New Room Subject");
+			message->addPayload(boost::make_shared<Thread>("Thread that prevents the subject change."));
+
+			controller_->handleIncomingMessage(boost::make_shared<MessageEvent>(message));
+			CPPUNIT_ASSERT_EQUAL(std::string("Trying to enter room teaparty@rooms.wonderland.lit"), boost::dynamic_pointer_cast<ChatWindow::ChatTextMessagePart>(window_->lastAddedSystemMessage_.getParts()[0])->text);
+		}
+	}
+
+	/*
+	 * Test that message stanzas with subject element and empty body element do not cause a subject change.
+	 */
+	void testSubjectChangeIncorrectC() {
+		std::string messageBody("test message");
+		window_->onSendMessageRequest(messageBody, false);
+		boost::shared_ptr<Stanza> rawStanza = stanzaChannel_->sentStanzas[stanzaChannel_->sentStanzas.size() - 1];
+		Message::ref message = boost::dynamic_pointer_cast<Message>(rawStanza);
+		CPPUNIT_ASSERT(stanzaChannel_->isAvailable()); /* Otherwise will prevent sends. */
+		CPPUNIT_ASSERT(message);
+		CPPUNIT_ASSERT_EQUAL(messageBody, message->getBody().get_value_or(""));
+
+		{
+			Message::ref message = boost::make_shared<Message>();
+			message->setType(Message::Groupchat);
+			message->setTo(self_);
+			message->setFrom(mucJID_.withResource("SomeNickname"));
+			message->setID(iqChannel_->getNewIQID());
+			message->setSubject("New Room Subject");
+			message->setBody("");
+
+			controller_->handleIncomingMessage(boost::make_shared<MessageEvent>(message));
+			CPPUNIT_ASSERT_EQUAL(std::string("Trying to enter room teaparty@rooms.wonderland.lit"), boost::dynamic_pointer_cast<ChatWindow::ChatTextMessagePart>(window_->lastAddedSystemMessage_.getParts()[0])->text);
+		}
+	}
+
 	void testRoleAffiliationStatesVerify(const std::map<std::string, MUCOccupant> &occupants) {
 		/* verify that the roster is in sync */
 		GroupRosterItem* group = window_->getRosterModel()->getRoot();
diff --git a/Swift/Controllers/EventNotifier.cpp b/Swift/Controllers/EventNotifier.cpp
index 47bb888..626fd40 100644
--- a/Swift/Controllers/EventNotifier.cpp
+++ b/Swift/Controllers/EventNotifier.cpp
@@ -1,27 +1,29 @@
 /*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2016 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
 
-#include "Swift/Controllers/EventNotifier.h"
+#include <Swift/Controllers/EventNotifier.h>
 
-#include <boost/bind.hpp>
 #include <boost/algorithm/string.hpp>
+#include <boost/bind.hpp>
 
-#include <Swift/Controllers/Intl.h>
-#include <Swiften/Base/format.h>
+#include <Swiften/Avatars/AvatarManager.h>
+#include <Swiften/Client/NickResolver.h>
+#include <Swiften/JID/JID.h>
 #include <Swiften/Base/String.h>
-#include "Swift/Controllers/XMPPEvents/EventController.h"
-#include "SwifTools/Notifier/Notifier.h"
-#include "Swiften/Avatars/AvatarManager.h"
-#include "Swiften/Client/NickResolver.h"
-#include "Swiften/JID/JID.h"
-#include "Swift/Controllers/XMPPEvents/MessageEvent.h"
-#include "Swift/Controllers/XMPPEvents/SubscriptionRequestEvent.h"
-#include "Swift/Controllers/XMPPEvents/ErrorEvent.h"
-#include "Swift/Controllers/XMPPEvents/MUCInviteEvent.h"
-#include "Swift/Controllers/Settings/SettingsProvider.h"
+#include <Swiften/Base/format.h>
+
+#include <Swift/Controllers/Settings/SettingsProvider.h>
+#include <Swift/Controllers/XMPPEvents/ErrorEvent.h>
+#include <Swift/Controllers/XMPPEvents/EventController.h>
+#include <Swift/Controllers/XMPPEvents/MUCInviteEvent.h>
+#include <Swift/Controllers/XMPPEvents/MessageEvent.h>
+#include <Swift/Controllers/XMPPEvents/SubscriptionRequestEvent.h>
+#include <Swift/Controllers/Intl.h>
+
+#include <SwifTools/Notifier/Notifier.h>
 
 namespace Swift {
 
@@ -41,12 +43,12 @@ void EventNotifier::handleEventAdded(boost::shared_ptr<StanzaEvent> event) {
 	if (boost::shared_ptr<MessageEvent> messageEvent = boost::dynamic_pointer_cast<MessageEvent>(event)) {
 		JID jid = messageEvent->getStanza()->getFrom();
 		std::string title = nickResolver->jidToNick(jid);
-		if (!messageEvent->getStanza()->isError() && !messageEvent->getStanza()->getBody().empty()) {
+		if (!messageEvent->getStanza()->isError() && !messageEvent->getStanza()->getBody().get_value_or("").empty()) {
 			JID activationJID = jid;
 			if (messageEvent->getStanza()->getType() == Message::Groupchat) {
 				activationJID = jid.toBare();
 			}
-			std::string messageText = messageEvent->getStanza()->getBody();
+			std::string messageText = messageEvent->getStanza()->getBody().get_value_or("");
 			if (boost::starts_with(messageText, "/me ")) {
 				messageText = "*" + String::getSplittedAtFirst(messageText, ' ').second + "*";
 			}
diff --git a/Swift/Controllers/UnitTest/MockChatWindow.h b/Swift/Controllers/UnitTest/MockChatWindow.h
index 4523d29..dddea6c 100644
--- a/Swift/Controllers/UnitTest/MockChatWindow.h
+++ b/Swift/Controllers/UnitTest/MockChatWindow.h
@@ -25,7 +25,8 @@ namespace Swift {
 
 			virtual std::string addAction(const ChatMessage& /*message*/, const std::string& /*senderName*/, bool /*senderIsSelf*/, boost::shared_ptr<SecurityLabel> /*label*/, const std::string& /*avatarPath*/, const boost::posix_time::ptime& /*time*/, const HighlightAction& /*highlight*/) {return "id";}
 
-			virtual std::string addSystemMessage(const ChatMessage& /*message*/, Direction /*direction*/) {
+			virtual std::string addSystemMessage(const ChatMessage& message, Direction /*direction*/) {
+				lastAddedSystemMessage_ = message;
 				return "id";
 			}
 
@@ -103,6 +104,7 @@ namespace Swift {
 			std::string lastMessageBody_;
 			ChatMessage lastAddedPresence_;
 			ChatMessage lastReplacedMessage_;
+			ChatMessage lastAddedSystemMessage_;
 			std::vector<SecurityLabelsCatalog::Item> labels_;
 			bool labelsEnabled_;
 			bool impromptuMUCSupported_;
diff --git a/Swift/Controllers/XMPPEvents/MessageEvent.h b/Swift/Controllers/XMPPEvents/MessageEvent.h
index be8b1b0..b5b1215 100644
--- a/Swift/Controllers/XMPPEvents/MessageEvent.h
+++ b/Swift/Controllers/XMPPEvents/MessageEvent.h
@@ -1,17 +1,19 @@
 /*
- * Copyright (c) 2010-2012 Isode Limited.
+ * Copyright (c) 2010-2016 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
 
 #pragma once 
+
 #include <cassert>
 
 #include <boost/shared_ptr.hpp>
 
-#include <Swift/Controllers/XMPPEvents/StanzaEvent.h>
 #include <Swiften/Elements/Message.h>
 
+#include <Swift/Controllers/XMPPEvents/StanzaEvent.h>
+
 namespace Swift {
 	class MessageEvent : public StanzaEvent {
 		public:
@@ -22,7 +24,7 @@ namespace Swift {
 			boost::shared_ptr<Message> getStanza() {return stanza_;}
 
 			bool isReadable() {
-				return getStanza()->isError() || !getStanza()->getBody().empty();
+				return getStanza()->isError() || !getStanza()->getBody().get_value_or("").empty();
 			}
 
 			void read() {
author	Tobias Markmann <tm@ayena.de>	2016-01-12 17:23:05 (GMT)
committer	Kevin Smith <kevin.smith@isode.com>	2016-02-02 11:33:06 (GMT)
commit	1b9ccc1fef6104eaf951153ddccdc6bb15899e9a (patch)
tree	428232448e9846265605820db6f380a5b98c018a /Swift/Controllers
parent	3afd061b713ce5fff604dee62dec8410a1de6a9c (diff)
download	swift-1b9ccc1fef6104eaf951153ddccdc6bb15899e9a.zip swift-1b9ccc1fef6104eaf951153ddccdc6bb15899e9a.tar.bz2