Adds MIXUserPreference Element, its Parser and Serializer

License: This patch is BSD-licensed, see Documentation/Licenses/BSD-simplified.txt for details. Test-Information: Added tests for MIXUserPreference Parser and Serializer based on examples in XEP 0369, which passes. Change-Id: I06595325f4cc2b34d5ab5a93a6caa00330fe0737
author: Tarun Gupta <tarun1995gupta@gmail.com> 2017-06-19 09:42:31 (GMT)
committer: Tobias Markmann <tm@ayena.de> 2017-07-05 20:38:46 (GMT)
commit: 1f69a24bc609ce40bab2bcb40b29438b63c9bc73 (patch)
tree: 585e7579abc5a906705f10d4b283883fd6b18da6 /Swiften
parent: 93a0f41d4af17db3e3eedb61e786fec23dbd8db9 (diff)
download: swift-1f69a24bc609ce40bab2bcb40b29438b63c9bc73.zip
swift-1f69a24bc609ce40bab2bcb40b29438b63c9bc73.tar.bz2
11 files changed, 326 insertions, 0 deletions
diff --git a/Swiften/Elements/MIXUserPreference.h b/Swiften/Elements/MIXUserPreference.h
new file mode 100644
index 0000000..cd1311c
--- /dev/null
+++ b/Swiften/Elements/MIXUserPreference.h
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#pragma once
+
+#include <memory>
+
+#include <Swiften/Base/API.h>
+#include <Swiften/Elements/Form.h>
+#include <Swiften/Elements/Payload.h>
+
+namespace Swift {
+    class SWIFTEN_API MIXUserPreference : public Payload {
+        public:
+            using ref = std::shared_ptr<MIXUserPreference>;
+
+        public:
+
+            MIXUserPreference() {}
+
+            std::shared_ptr<Form> getData() const {
+                return data_;
+            }
+
+            void setData(std::shared_ptr<Form> value) {
+                this->data_ = value ;
+            }
+
+
+        private:
+            std::shared_ptr<Form> data_;
+    };
+}
diff --git a/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp b/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp
index bd9bdaa..ea7bdbf 100644
--- a/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp
+++ b/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp
@@ -55,6 +55,7 @@
 #include <Swiften/Parser/PayloadParsers/MIXCreateParser.h>
 #include <Swiften/Parser/PayloadParsers/MIXDestroyParser.h>
 #include <Swiften/Parser/PayloadParsers/MIXJoinParserFactory.h>
+#include <Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.h>
 #include <Swiften/Parser/PayloadParsers/MUCAdminPayloadParser.h>
 #include <Swiften/Parser/PayloadParsers/MUCDestroyPayloadParser.h>
 #include <Swiften/Parser/PayloadParsers/MUCInvitationPayloadParser.h>
@@ -136,6 +137,7 @@ FullPayloadParserFactoryCollection::FullPayloadParserFactoryCollection() {
     factories_.push_back(std::make_shared<MIXParticipantParserFactory>());
     factories_.push_back(std::make_shared<GenericPayloadParserFactory<MIXDestroyParser> >("destroy", "urn:xmpp:mix:1"));
     factories_.push_back(std::make_shared<GenericPayloadParserFactory<MIXCreateParser> >("create", "urn:xmpp:mix:1"));
+    factories_.push_back(std::make_shared<GenericPayloadParserFactory<MIXUserPreferenceParser> >("user-preference", "urn:xmpp:mix:1"));
     factories_.push_back(std::make_shared<MUCUserPayloadParserFactory>(this));
     factories_.push_back(std::make_shared<MUCOwnerPayloadParserFactory>(this));
     factories_.push_back(std::make_shared<GenericPayloadParserFactory<MUCInvitationPayloadParser> >("x", "jabber:x:conference"));
diff --git a/Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.cpp b/Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.cpp
new file mode 100644
index 0000000..f40547d
--- /dev/null
+++ b/Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.cpp
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#include <Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.h>
+
+#include <boost/optional.hpp>
+
+#include <Swiften/Parser/PayloadParserFactory.h>
+#include <Swiften/Parser/PayloadParsers/FormParser.h>
+
+namespace Swift {
+
+MIXUserPreferenceParser::MIXUserPreferenceParser() : level_(0) {
+}
+
+MIXUserPreferenceParser::~MIXUserPreferenceParser() {
+}
+
+void MIXUserPreferenceParser::handleStartElement(const std::string& element, const std::string& ns, const AttributeMap& attributes) {
+
+
+    if (level_ == 1) {
+        if (element == "x" && ns == "jabber:x:data") {
+            currentPayloadParser_ = std::make_shared<FormParser>();
+        }
+    }
+
+    if (level_ >= 1 && currentPayloadParser_) {
+        currentPayloadParser_->handleStartElement(element, ns, attributes);
+    }
+    ++level_;
+}
+
+void MIXUserPreferenceParser::handleEndElement(const std::string& element, const std::string& ns) {
+    --level_;
+    if (currentPayloadParser_) {
+        if (level_ >= 1) {
+            currentPayloadParser_->handleEndElement(element, ns);
+        }
+
+        if (level_ == 1) {
+            if (element == "x" && ns == "jabber:x:data") {
+                getPayloadInternal()->setData(std::dynamic_pointer_cast<Form>(currentPayloadParser_->getPayload()));
+            }
+            currentPayloadParser_.reset();
+        }
+    }
+}
+
+void MIXUserPreferenceParser::handleCharacterData(const std::string& data) {
+    if (level_ > 1 && currentPayloadParser_) {
+        currentPayloadParser_->handleCharacterData(data);
+    }
+}
+}
diff --git a/Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.h b/Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.h
new file mode 100644
index 0000000..505087d
--- /dev/null
+++ b/Swiften/Parser/PayloadParsers/MIXUserPreferenceParser.h
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#pragma once
+
+#include <memory>
+
+#include <Swiften/Base/API.h>
+#include <Swiften/Base/Override.h>
+#include <Swiften/Elements/MIXUserPreference.h>
+#include <Swiften/Parser/GenericPayloadParser.h>
+
+namespace Swift {
+    class PayloadParser;
+
+    class SWIFTEN_API MIXUserPreferenceParser : public GenericPayloadParser<MIXUserPreference> {
+        public:
+            MIXUserPreferenceParser();
+            virtual ~MIXUserPreferenceParser();
+
+            virtual void handleStartElement(const std::string& element, const std::string&, const AttributeMap& attributes) SWIFTEN_OVERRIDE;
+            virtual void handleEndElement(const std::string& element, const std::string&) SWIFTEN_OVERRIDE;
+            virtual void handleCharacterData(const std::string& data) SWIFTEN_OVERRIDE;
+
+        private:
+            int level_;
+            std::shared_ptr<PayloadParser> currentPayloadParser_;
+    };
+}
diff --git a/Swiften/Parser/PayloadParsers/UnitTest/MIXUserPreferenceParserTest.cpp b/Swiften/Parser/PayloadParsers/UnitTest/MIXUserPreferenceParserTest.cpp
new file mode 100644
index 0000000..3d048a5
--- /dev/null
+++ b/Swiften/Parser/PayloadParsers/UnitTest/MIXUserPreferenceParserTest.cpp
@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#include <gtest/gtest.h>
+
+#include <Swiften/Elements/MIXUserPreference.h>
+#include <Swiften/Parser/PayloadParsers/UnitTest/PayloadsParserTester.h>
+
+using namespace Swift;
+
+TEST(MIXUserPreferenceParserTest, XEP0369_Example31) {
+    PayloadsParserTester parser;
+    ASSERT_TRUE(parser.parse(
+                "<user-preference xmlns='urn:xmpp:mix:1'/>"
+                ));
+
+    auto payload = parser.getPayload<MIXUserPreference>();
+    ASSERT_TRUE(payload);
+
+    ASSERT_FALSE(payload->getData());
+}
+
+TEST(MIXUserPreferenceParserTest, XEP0369_Example32) {
+    PayloadsParserTester parser;
+    ASSERT_TRUE(parser.parse(
+                "<user-preference xmlns='urn:xmpp:mix:1'>"
+                    "<x xmlns='jabber:x:data' type='result'>"
+                        "<field var='FORM_TYPE' type='hidden'>"
+                            "<value>urn:xmpp:mix:1</value>"
+                        "</field>"
+                        "<field var='JID Visibility'>"
+                            "<value>never</value>"
+                        "</field>"
+                        "<field var='Private Messages'>"
+                           "<value>allow</value>"
+                         "</field>"
+                        "<field var='vCard'>"
+                          "<value>block</value>"
+                        "</field>"
+                    "</x>"
+                "</user-preference>"
+                ));
+
+    auto payload = parser.getPayload<MIXUserPreference>();
+    ASSERT_TRUE(payload);
+
+    ASSERT_TRUE(payload->getData());
+    ASSERT_EQ(Form::Type::ResultType, payload->getData()->getType());
+    std::shared_ptr<FormField> fieldType = payload->getData()->getField("FORM_TYPE");
+    ASSERT_TRUE(fieldType);
+
+    std::shared_ptr<FormField> fieldJIDVisibility = payload->getData()->getField("JID Visibility");
+    ASSERT_TRUE(fieldJIDVisibility);
+    ASSERT_EQ(std::string("never"), fieldJIDVisibility->getTextSingleValue());
+
+    std::shared_ptr<FormField> fieldprivateMessages = payload->getData()->getField("Private Messages");
+    ASSERT_TRUE(fieldprivateMessages);
+    ASSERT_EQ(std::string("allow"), fieldprivateMessages->getTextSingleValue());
+
+    std::shared_ptr<FormField> vCard = payload->getData()->getField("vCard");
+    ASSERT_TRUE(vCard);
+    ASSERT_EQ(std::string("block"), vCard->getTextSingleValue());
+}
diff --git a/Swiften/Parser/SConscript b/Swiften/Parser/SConscript
index eccc941..3c778f5 100644
--- a/Swiften/Parser/SConscript
+++ b/Swiften/Parser/SConscript
@@ -72,6 +72,7 @@ sources = [
         "PayloadParsers/MIXCreateParser.cpp",
         "PayloadParsers/MIXJoinParser.cpp",
         "PayloadParsers/MIXSubscribeParser.cpp",
+        "PayloadParsers/MIXUserPreferenceParser.cpp",
         "PayloadParsers/MUCUserPayloadParser.cpp",
         "PayloadParsers/MUCAdminPayloadParser.cpp",
         "PayloadParsers/MUCOwnerPayloadParser.cpp",
diff --git a/Swiften/SConscript b/Swiften/SConscript
index 6e30b26..e0f87ce 100644
--- a/Swiften/SConscript
+++ b/Swiften/SConscript
@@ -210,6 +210,7 @@ if env["SCONS_STAGE"] == "build" :
             "Serializer/PayloadSerializers/MIXParticipantSerializer.cpp",
             "Serializer/PayloadSerializers/MIXDestroySerializer.cpp",
             "Serializer/PayloadSerializers/MIXCreateSerializer.cpp",
+            "Serializer/PayloadSerializers/MIXUserPreferenceSerializer.cpp",
             "Serializer/PayloadSerializers/MIXJoinSerializer.cpp",
             "Serializer/PayloadSerializers/MIXSubscribeSerializer.cpp",
             "Serializer/PayloadSerializers/MUCPayloadSerializer.cpp",
@@ -438,6 +439,7 @@ if env["SCONS_STAGE"] == "build" :
             File("Parser/PayloadParsers/UnitTest/MIXParticipantParserTest.cpp"),
             File("Parser/PayloadParsers/UnitTest/MIXDestroyParserTest.cpp"),
             File("Parser/PayloadParsers/UnitTest/MIXCreateParserTest.cpp"),
+            File("Parser/PayloadParsers/UnitTest/MIXUserPreferenceParserTest.cpp"),
             File("Parser/PayloadParsers/UnitTest/SearchPayloadParserTest.cpp"),
             File("Parser/PayloadParsers/UnitTest/SecurityLabelParserTest.cpp"),
             File("Parser/PayloadParsers/UnitTest/SecurityLabelsCatalogParserTest.cpp"),
@@ -521,6 +523,7 @@ if env["SCONS_STAGE"] == "build" :
             File("Serializer/PayloadSerializers/UnitTest/MIXParticipantSerializerTest.cpp"),
             File("Serializer/PayloadSerializers/UnitTest/MIXDestroySerializerTest.cpp"),
             File("Serializer/PayloadSerializers/UnitTest/MIXCreateSerializerTest.cpp"),
+            File("Serializer/PayloadSerializers/UnitTest/MIXUserPreferenceSerializerTest.cpp"),
             File("Serializer/PayloadSerializers/UnitTest/JingleSerializersTest.cpp"),
             File("Serializer/PayloadSerializers/UnitTest/DeliveryReceiptSerializerTest.cpp"),
             File("Serializer/PayloadSerializers/UnitTest/IdleSerializerTest.cpp"),
diff --git a/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp b/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp
index 4c3cf66..9832bd5 100644
--- a/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp
+++ b/Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.cpp
@@ -49,6 +49,7 @@
 #include <Swiften/Serializer/PayloadSerializers/MIXDestroySerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXParticipantSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MIXCreateSerializer.h>
+#include <Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MUCAdminPayloadSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MUCDestroyPayloadSerializer.h>
 #include <Swiften/Serializer/PayloadSerializers/MUCInvitationPayloadSerializer.h>
@@ -160,6 +161,7 @@ FullPayloadSerializerCollection::FullPayloadSerializerCollection() {
     serializers_.push_back(new ForwardedSerializer(this));
     serializers_.push_back(new MIXParticipantSerializer());
     serializers_.push_back(new MIXCreateSerializer());
+    serializers_.push_back(new MIXUserPreferenceSerializer());
     serializers_.push_back(new MIXJoinSerializer());
     serializers_.push_back(new MIXDestroySerializer());
     serializers_.push_back(new MAMResultSerializer(this));
diff --git a/Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.cpp b/Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.cpp
new file mode 100644
index 0000000..2d057ad
--- /dev/null
+++ b/Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.cpp
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#include <Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.h>
+
+#include <memory>
+
+#include <Swiften/Serializer/PayloadSerializers/FormSerializer.h>
+#include <Swiften/Serializer/XML/XMLElement.h>
+#include <Swiften/Serializer/XML/XMLRawTextNode.h>
+
+namespace Swift {
+
+MIXUserPreferenceSerializer::MIXUserPreferenceSerializer() {
+}
+
+MIXUserPreferenceSerializer::~MIXUserPreferenceSerializer() {
+}
+
+std::string MIXUserPreferenceSerializer::serializePayload(std::shared_ptr<MIXUserPreference> payload) const {
+    if (!payload) {
+        return "";
+    }
+    XMLElement element("user-preference", "urn:xmpp:mix:1");
+    if(payload->getData()) {
+        element.addNode(std::make_shared<XMLRawTextNode>(FormSerializer().serialize(payload->getData())));
+    }
+    return element.serialize();
+}
+}
diff --git a/Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.h b/Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.h
new file mode 100644
index 0000000..301083a
--- /dev/null
+++ b/Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.h
@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#pragma once
+
+#include <memory>
+
+#include <Swiften/Base/API.h>
+#include <Swiften/Base/Override.h>
+#include <Swiften/Elements/MIXUserPreference.h>
+#include <Swiften/Serializer/GenericPayloadSerializer.h>
+
+namespace Swift {
+
+    class SWIFTEN_API MIXUserPreferenceSerializer : public GenericPayloadSerializer<MIXUserPreference> {
+        public:
+            MIXUserPreferenceSerializer();
+            virtual ~MIXUserPreferenceSerializer();
+
+            virtual std::string serializePayload(std::shared_ptr<MIXUserPreference>) const SWIFTEN_OVERRIDE;
+    };
+}
diff --git a/Swiften/Serializer/PayloadSerializers/UnitTest/MIXUserPreferenceSerializerTest.cpp b/Swiften/Serializer/PayloadSerializers/UnitTest/MIXUserPreferenceSerializerTest.cpp
new file mode 100644
index 0000000..7cbfbfc
--- /dev/null
+++ b/Swiften/Serializer/PayloadSerializers/UnitTest/MIXUserPreferenceSerializerTest.cpp
@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2017 Tarun Gupta
+ * Licensed under the simplified BSD license.
+ * See Documentation/Licenses/BSD-simplified.txt for more information.
+ */
+
+#include <gtest/gtest.h>
+
+#include <Swiften/Serializer/PayloadSerializers/MIXUserPreferenceSerializer.h>
+#include <Swiften/Serializer/PayloadSerializers/FullPayloadSerializerCollection.h>
+
+using namespace Swift;
+
+TEST(MIXUserPreferenceSerializerTest, XEP0369_Example31) {
+    MIXUserPreferenceSerializer testling;
+
+    auto userpreference = std::shared_ptr<MIXUserPreference>(new MIXUserPreference());
+    std::string expectedResult = "<user-preference xmlns=\"urn:xmpp:mix:1\"/>";
+    ASSERT_EQ(expectedResult, testling.serialize(userpreference));
+}
+
+TEST(MIXUserPreferenceSerializerTest, XEP0369_Example32) {
+    MIXUserPreferenceSerializer testling;
+
+    auto userpreference = std::shared_ptr<MIXUserPreference>(new MIXUserPreference());
+    std::shared_ptr<Form> parameters(std::make_shared<Form>());
+    parameters->setType(Form::Type::ResultType);
+
+    std::shared_ptr<FormField> fieldType = std::make_shared<FormField>(FormField::HiddenType);
+    fieldType->setName("FORM_TYPE");
+    fieldType->addValue("urn:xmpp:mix:1");
+    parameters->addField(fieldType);
+
+    std::shared_ptr<FormField> fieldJIDVisibility = std::make_shared<FormField>();
+    fieldJIDVisibility->setName("JID Visibility");
+    fieldJIDVisibility->addValue("never");
+    parameters->addField(fieldJIDVisibility);
+
+    std::shared_ptr<FormField> fieldprivateMessages = std::make_shared<FormField>();
+    fieldprivateMessages->setName("Private Messages");
+    fieldprivateMessages->addValue("allow");
+    parameters->addField(fieldprivateMessages);
+
+    std::shared_ptr<FormField> vCard = std::make_shared<FormField>();
+    vCard->setName("vCard");
+    vCard->addValue("block");
+    parameters->addField(vCard);
+
+    userpreference->setData(parameters);
+
+    std::string expectedResult = "<user-preference xmlns=\"urn:xmpp:mix:1\">"
+                                    "<x type=\"result\" xmlns=\"jabber:x:data\">"
+                                        "<field type=\"hidden\" var=\"FORM_TYPE\">"
+                                             "<value>urn:xmpp:mix:1</value>"
+                                        "</field>"
+                                        "<field var=\"JID Visibility\">"
+                                            "<value>never</value>"
+                                        "</field>"
+                                        "<field var=\"Private Messages\">"
+                                            "<value>allow</value>"
+                                        "</field>"
+                                        "<field var=\"vCard\">"
+                                            "<value>block</value>"
+                                        "</field>"
+                                    "</x>"
+                                "</user-preference>";
+    ASSERT_EQ(expectedResult, testling.serialize(userpreference));
+}
author	Tarun Gupta <tarun1995gupta@gmail.com>	2017-06-19 09:42:31 (GMT)
committer	Tobias Markmann <tm@ayena.de>	2017-07-05 20:38:46 (GMT)
commit	1f69a24bc609ce40bab2bcb40b29438b63c9bc73 (patch)
tree	585e7579abc5a906705f10d4b283883fd6b18da6 /Swiften
parent	93a0f41d4af17db3e3eedb61e786fec23dbd8db9 (diff)
download	swift-1f69a24bc609ce40bab2bcb40b29438b63c9bc73.zip swift-1f69a24bc609ce40bab2bcb40b29438b63c9bc73.tar.bz2