2 files changed, 114 insertions, 23 deletions
diff --git a/Swift/Controllers/Chat/UnitTest/ChatMessageParserTest.cpp b/Swift/Controllers/Chat/UnitTest/ChatMessageParserTest.cpp
index 1b92bb6..6748b9e 100644
--- a/Swift/Controllers/Chat/UnitTest/ChatMessageParserTest.cpp
+++ b/Swift/Controllers/Chat/UnitTest/ChatMessageParserTest.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013-2015 Isode Limited.
+ * Copyright (c) 2013-2016 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -49,9 +49,11 @@ public:
 		CPPUNIT_ASSERT_EQUAL(path, part->imagePath);
 	}
 
-	void assertHighlight(const ChatWindow::ChatMessage& result, size_t index, const std::string& text) {
-		boost::shared_ptr<ChatWindow::ChatHighlightingMessagePart> part = boost::dynamic_pointer_cast<ChatWindow::ChatHighlightingMessagePart>(result.getParts()[index]);
-		CPPUNIT_ASSERT_EQUAL(text, part->text);
+#define assertHighlight(RESULT, INDEX, TEXT, EXPECTED_HIGHLIGHT) \
+	{ \
+		boost::shared_ptr<ChatWindow::ChatHighlightingMessagePart> part = boost::dynamic_pointer_cast<ChatWindow::ChatHighlightingMessagePart>(RESULT.getParts()[INDEX]); \
+		CPPUNIT_ASSERT_EQUAL(std::string(TEXT), part->text); \
+		CPPUNIT_ASSERT(EXPECTED_HIGHLIGHT == part->action); \
 	}
 
 	void assertURL(const ChatWindow::ChatMessage& result, size_t index, const std::string& text) {
@@ -108,13 +110,14 @@ public:
 		ChatWindow::ChatMessage result = testling.parseMessageBody(no_special_message);
 		assertText(result, 0, no_special_message);
 
-		testling = ChatMessageParser(emoticons_, ruleListFromKeyword("trigger", false, false));
+		HighlightRulesListPtr highlightRuleList = ruleListFromKeyword("trigger", false, false);
+		testling = ChatMessageParser(emoticons_, highlightRuleList);
 		result = testling.parseMessageBody(":) shiny :( trigger :) http://wonderland.lit/blah http://denmark.lit boom boom");
 		assertEmoticon(result, 0, smile1_, smile1Path_);
 		assertText(result, 1, " shiny ");
 		assertEmoticon(result, 2, smile2_, smile2Path_);
 		assertText(result, 3, " ");
-		assertHighlight(result, 4, "trigger");
+		assertHighlight(result, 4, "trigger", highlightRuleList->getRule(0).getAction());
 		assertText(result, 5, " ");
 		assertEmoticon(result, 6, smile1_, smile1Path_);
 		assertText(result, 7, " ");
@@ -126,7 +129,7 @@ public:
 		testling = ChatMessageParser(emoticons_, ruleListFromKeyword("trigger", false, false));
 		result = testling.parseMessageBody("testtriggermessage");
 		assertText(result, 0, "test");
-		assertHighlight(result, 1, "trigger");
+		assertHighlight(result, 1, "trigger", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, "message");
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeyword("trigger", false, true));
@@ -139,32 +142,32 @@ public:
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeyword("trigger", false, false));
 		result = testling.parseMessageBody("TrIgGeR");
-		assertHighlight(result, 0, "TrIgGeR");
+		assertHighlight(result, 0, "TrIgGeR", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeyword("trigger", false, false));
 		result = testling.parseMessageBody("partialTrIgGeRmatch");
 		assertText(result, 0, "partial");
-		assertHighlight(result, 1, "TrIgGeR");
+		assertHighlight(result, 1, "TrIgGeR", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, "match");
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", false, false), ruleFromKeyword("three", false, false)));
 		result = testling.parseMessageBody("zero one two three");
 		assertText(result, 0, "zero ");
-		assertHighlight(result, 1, "one");
+		assertHighlight(result, 1, "one", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, " two ");
-		assertHighlight(result, 3, "three");
+		assertHighlight(result, 3, "three", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", false, false), ruleFromKeyword("three", false, false)));
 		result = testling.parseMessageBody("zero oNe two tHrEe");
 		assertText(result, 0, "zero ");
-		assertHighlight(result, 1, "oNe");
+		assertHighlight(result, 1, "oNe", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, " two ");
-		assertHighlight(result, 3, "tHrEe");
+		assertHighlight(result, 3, "tHrEe", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", false, false), ruleFromKeyword("three", true, false)));
 		result = testling.parseMessageBody("zero oNe two tHrEe");
 		assertText(result, 0, "zero ");
-		assertHighlight(result, 1, "oNe");
+		assertHighlight(result, 1, "oNe", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, " two tHrEe");
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", true, false), ruleFromKeyword("three", true, false)));
@@ -174,19 +177,19 @@ public:
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", false, false), ruleFromKeyword("three", false, false)));
 		result = testling.parseMessageBody("zeroonetwothree");
 		assertText(result, 0, "zero");
-		assertHighlight(result, 1, "one");
+		assertHighlight(result, 1, "one", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, "two");
-		assertHighlight(result, 3, "three");
+		assertHighlight(result, 3, "three", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", true, false), ruleFromKeyword("three", false, false)));
 		result = testling.parseMessageBody("zeroOnEtwoThReE");
 		assertText(result, 0, "zeroOnEtwo");
-		assertHighlight(result, 1, "ThReE");
+		assertHighlight(result, 1, "ThReE", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", false, true), ruleFromKeyword("three", false, false)));
 		result = testling.parseMessageBody("zeroonetwothree");
 		assertText(result, 0, "zeroonetwo");
-		assertHighlight(result, 1, "three");
+		assertHighlight(result, 1, "three", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListFromKeywords(ruleFromKeyword("one", false, true), ruleFromKeyword("three", false, true)));
 		result = testling.parseMessageBody("zeroonetwothree");
@@ -194,7 +197,7 @@ public:
 
 		testling = ChatMessageParser(emoticons_, ruleListWithNickHighlight());
 		result = testling.parseMessageBody("Alice", "Alice");
-		assertHighlight(result, 0, "Alice");
+		assertHighlight(result, 0, "Alice", highlightRuleList->getRule(0).getAction());
 
 		testling = ChatMessageParser(emoticons_, ruleListWithNickHighlight());
 		result = testling.parseMessageBody("TextAliceText", "Alice");
@@ -203,18 +206,18 @@ public:
 		testling = ChatMessageParser(emoticons_, ruleListWithNickHighlight());
 		result = testling.parseMessageBody("Text Alice Text", "Alice");
 		assertText(result, 0, "Text ");
-		assertHighlight(result, 1, "Alice");
+		assertHighlight(result, 1, "Alice", highlightRuleList->getRule(0).getAction());
 		assertText(result, 2, " Text");
 
 		testling = ChatMessageParser(emoticons_, ruleListWithNickHighlight());
 		result = testling.parseMessageBody("Alice Text", "Alice");
-		assertHighlight(result, 0, "Alice");
+		assertHighlight(result, 0, "Alice", highlightRuleList->getRule(0).getAction());
 		assertText(result, 1, " Text");
 
 		testling = ChatMessageParser(emoticons_, ruleListWithNickHighlight());
 		result = testling.parseMessageBody("Text Alice", "Alice");
 		assertText(result, 0, "Text ");
-		assertHighlight(result, 1, "Alice");
+		assertHighlight(result, 1, "Alice", highlightRuleList->getRule(0).getAction());
 	}
 
 	void testOneEmoticon() {
diff --git a/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp b/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp
index 4f8cf5a..31d54db 100644
--- a/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp
+++ b/Swift/Controllers/Chat/UnitTest/ChatsManagerTest.cpp
@@ -4,6 +4,9 @@
  * See the COPYING file for more information.
  */
 
+#include <set>
+#include <map>
+
 #include <boost/bind.hpp>
 
 #include <cppunit/extensions/HelperMacros.h>
@@ -75,6 +78,8 @@ class ChatsManagerTest : public CppUnit::TestFixture {
 	CPPUNIT_TEST(testChatControllerFullJIDBindingOnTypingAndNotActive);
 	CPPUNIT_TEST(testChatControllerPMPresenceHandling);
 	CPPUNIT_TEST(testLocalMUCServiceDiscoveryResetOnDisconnect);
+	CPPUNIT_TEST(testChatControllerHighlightingNotificationTesting);
+	CPPUNIT_TEST(testChatControllerHighlightingNotificationDeduplicateSounds);
 	CPPUNIT_TEST_SUITE_END();
 
 public:
@@ -110,6 +115,9 @@ public:
 		wbSessionManager_ = new WhiteboardSessionManager(iqRouter_, stanzaChannel_, presenceOracle_, entityCapsProvider_);
 		wbManager_ = new WhiteboardManager(whiteboardWindowFactory_, uiEventStream_, nickResolver_, wbSessionManager_);
 		highlightManager_ = new HighlightManager(settings_);
+		handledHighlightActions_ = 0;
+		soundsPlayed_.clear();
+		highlightManager_->onHighlight.connect(boost::bind(&ChatsManagerTest::handleHighlightAction, this, _1));
 
 		crypto_ = PlatformCryptoProvider::create();
 		vcardStorage_ = new VCardMemoryStorage(crypto_);
@@ -156,7 +164,7 @@ public:
 	void testFirstOpenWindowIncoming() {
 		JID messageJID("testling@test.com/resource1");
 		
-		MockChatWindow* window = new MockChatWindow();//mocks_->InterfaceMock<ChatWindow>();
+		MockChatWindow* window = new MockChatWindow();
 		mocks_->ExpectCall(chatWindowFactory_, ChatWindowFactory::createChatWindow).With(messageJID, uiEventStream_).Return(window);
 
 		boost::shared_ptr<Message> message(new Message());
@@ -724,6 +732,77 @@ public:
 		CPPUNIT_ASSERT(stanzaContactOnRoster->getPayload<DeliveryReceipt>() != 0);
 	}
 
+	void testChatControllerHighlightingNotificationTesting() {
+		HighlightRule keywordRuleA;
+		keywordRuleA.setMatchChat(true);
+		std::vector<std::string> keywordsA;
+		keywordsA.push_back("Romeo");
+		keywordRuleA.setKeywords(keywordsA);
+		keywordRuleA.getAction().setTextColor("yellow");
+		keywordRuleA.getAction().setPlaySound(true);
+		highlightManager_->insertRule(0, keywordRuleA);
+
+		HighlightRule keywordRuleB;
+		keywordRuleB.setMatchChat(true);
+		std::vector<std::string> keywordsB;
+		keywordsB.push_back("Juliet");
+		keywordRuleB.setKeywords(keywordsB);
+		keywordRuleB.getAction().setTextColor("green");
+		keywordRuleB.getAction().setPlaySound(true);
+		keywordRuleB.getAction().setSoundFile("/tmp/someotherfile.wav");
+		highlightManager_->insertRule(0, keywordRuleB);
+
+		JID messageJID = JID("testling@test.com");
+
+		MockChatWindow* window = new MockChatWindow();
+		mocks_->ExpectCall(chatWindowFactory_, ChatWindowFactory::createChatWindow).With(messageJID, uiEventStream_).Return(window);
+
+		boost::shared_ptr<Message> message(new Message());
+		message->setFrom(messageJID);
+		std::string body("This message should cause two sounds: Juliet and Romeo.");
+		message->setBody(body);
+		manager_->handleIncomingMessage(message);
+
+		CPPUNIT_ASSERT_EQUAL(2, handledHighlightActions_);
+		CPPUNIT_ASSERT(soundsPlayed_.find(keywordRuleA.getAction().getSoundFile()) != soundsPlayed_.end());
+		CPPUNIT_ASSERT(soundsPlayed_.find(keywordRuleB.getAction().getSoundFile()) != soundsPlayed_.end());
+	}
+
+	void testChatControllerHighlightingNotificationDeduplicateSounds() {
+		HighlightRule keywordRuleA;
+		keywordRuleA.setMatchChat(true);
+		std::vector<std::string> keywordsA;
+		keywordsA.push_back("Romeo");
+		keywordRuleA.setKeywords(keywordsA);
+		keywordRuleA.getAction().setTextColor("yellow");
+		keywordRuleA.getAction().setPlaySound(true);
+		highlightManager_->insertRule(0, keywordRuleA);
+
+		HighlightRule keywordRuleB;
+		keywordRuleB.setMatchChat(true);
+		std::vector<std::string> keywordsB;
+		keywordsB.push_back("Juliet");
+		keywordRuleB.setKeywords(keywordsB);
+		keywordRuleB.getAction().setTextColor("green");
+		keywordRuleB.getAction().setPlaySound(true);
+		highlightManager_->insertRule(0, keywordRuleB);
+
+		JID messageJID = JID("testling@test.com");
+
+		MockChatWindow* window = new MockChatWindow();
+		mocks_->ExpectCall(chatWindowFactory_, ChatWindowFactory::createChatWindow).With(messageJID, uiEventStream_).Return(window);
+
+		boost::shared_ptr<Message> message(new Message());
+		message->setFrom(messageJID);
+		std::string body("This message should cause one sound, because both actions have the same sound: Juliet and Romeo.");
+		message->setBody(body);
+		manager_->handleIncomingMessage(message);
+
+		CPPUNIT_ASSERT_EQUAL(1, handledHighlightActions_);
+		CPPUNIT_ASSERT(soundsPlayed_.find(keywordRuleA.getAction().getSoundFile()) != soundsPlayed_.end());
+		CPPUNIT_ASSERT(soundsPlayed_.find(keywordRuleB.getAction().getSoundFile()) != soundsPlayed_.end());
+	}
+
 private:
 	boost::shared_ptr<Message> makeDeliveryReceiptTestMessage(const JID& from, const std::string& id) {
 		boost::shared_ptr<Message> message = boost::make_shared<Message>();
@@ -738,6 +817,13 @@ private:
 		return static_cast<size_t>(i);
 	}
 
+	void handleHighlightAction(const HighlightAction& action) {
+		handledHighlightActions_++;
+		if (action.playSound()) {
+			soundsPlayed_.insert(action.getSoundFile());
+		}
+	}
+
 private:
 	JID jid_;
 	ChatsManager* manager_;
@@ -775,6 +861,8 @@ private:
 	CryptoProvider* crypto_;
 	VCardStorage* vcardStorage_;
 	std::map<std::string, std::string> emoticons_;
+	int handledHighlightActions_;
+	std::set<std::string> soundsPlayed_;
 };
 
 CPPUNIT_TEST_SUITE_REGISTRATION(ChatsManagerTest);