Swiftdiff options
| author | Tarun Gupta <tarun1995gupta@gmail.com> | 2017-06-15 11:04:26 (GMT) |
|---|---|---|
| committer | Tobias Markmann <tm@ayena.de> | 2017-06-26 13:06:37 (GMT) |
| commit | e142d11c3fa6ae2bdfc95ee9cea54bb0000917c9 (patch) | |
| tree | 591fce5f344a983a2c0dfd6b3affd08c68b02fc9 /Swiften/Parser/PayloadParsers | |
| parent | cfd0f09744c543efb52dcfeaef8a760a766a4d71 (diff) | |
| download | swift-e142d11c3fa6ae2bdfc95ee9cea54bb0000917c9.zip swift-e142d11c3fa6ae2bdfc95ee9cea54bb0000917c9.tar.bz2 | |
Adds MIX Join Element, its Parser and Serializer.
Add MIXDestroySerializer to FullPayloadSerializerCollection.
License:
This patch is BSD-licensed, see Documentation/Licenses/BSD-simplified.txt for details.
Test-Information:
Added tests for MIX Join Parser and Serializer based on examples in XEP 0369, which passes.
Tested on Ubuntu 16.04 LTS.
Change-Id: Ibf7446dd65714dccdd39c485549fd9fb9faba40c
Diffstat (limited to 'Swiften/Parser/PayloadParsers')
7 files changed, 384 insertions, 0 deletions
diff --git a/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp b/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp index dbfcb6b..76827bb 100644 --- a/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp +++ b/Swiften/Parser/PayloadParsers/FullPayloadParserFactoryCollection.cpp @@ -53,6 +53,7 @@ #include <Swiften/Parser/PayloadParsers/MAMResultParser.h> #include <Swiften/Parser/PayloadParsers/MIXParticipantParserFactory.h> #include <Swiften/Parser/PayloadParsers/MIXDestroyParser.h> +#include <Swiften/Parser/PayloadParsers/MIXJoinParserFactory.h> #include <Swiften/Parser/PayloadParsers/MUCAdminPayloadParser.h> #include <Swiften/Parser/PayloadParsers/MUCDestroyPayloadParser.h> #include <Swiften/Parser/PayloadParsers/MUCInvitationPayloadParser.h> @@ -171,6 +172,7 @@ FullPayloadParserFactoryCollection::FullPayloadParserFactoryCollection() { factories_.push_back(std::make_shared<GenericPayloadParserFactory2<CarbonsReceivedParser> >("received", "urn:xmpp:carbons:2", this)); factories_.push_back(std::make_shared<GenericPayloadParserFactory2<CarbonsSentParser> >("sent", "urn:xmpp:carbons:2", this)); factories_.push_back(std::make_shared<GenericPayloadParserFactory<CarbonsPrivateParser> >("private", "urn:xmpp:carbons:2")); + factories_.push_back(std::make_shared<MIXJoinParserFactory>()); for (auto& factory : factories_) { addFactory(factory.get()); diff --git a/Swiften/Parser/PayloadParsers/MIXJoinParser.cpp b/Swiften/Parser/PayloadParsers/MIXJoinParser.cpp new file mode 100644 index 0000000..2509667 --- /dev/null +++ b/Swiften/Parser/PayloadParsers/MIXJoinParser.cpp @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2017 Tarun Gupta + * Licensed under the simplified BSD license. + * See Documentation/Licenses/BSD-simplified.txt for more information. + */ + +#include <Swiften/Parser/PayloadParsers/MIXJoinParser.h> + +#include <boost/optional.hpp> + +#include <Swiften/Parser/PayloadParserFactory.h> +#include <Swiften/Parser/PayloadParsers/MIXSubscribeParser.h> +#include <Swiften/Parser/PayloadParsers/FormParser.h> + +using namespace Swift; + +MIXJoinParser::MIXJoinParser() : level_(0) { +} + +MIXJoinParser::~MIXJoinParser() { +} + +void MIXJoinParser::handleStartElement(const std::string& element, const std::string& ns, const AttributeMap& attributes) { + if (level_ == 0) { + if (boost::optional<std::string> attributeValue = attributes.getAttributeValue("channel")) { + if (boost::optional<JID> jid = JID::parse(*attributeValue)) { + getPayloadInternal()->setChannel(*jid); + } + } + if (boost::optional<std::string> attributeValue = attributes.getAttributeValue("jid")) { + if (boost::optional<JID> jid = JID::parse(*attributeValue)) { + getPayloadInternal()->setJID(*jid); + } + } + } + + if (level_ == 1) { + if (element == "subscribe" && ns == "urn:xmpp:mix:1") { + currentPayloadParser_ = std::make_shared<MIXSubscribeParser>(); + } + if (element == "x" && ns == "jabber:x:data") { + currentPayloadParser_ = std::make_shared<FormParser>(); + } + } + + if (level_ >= 1 && currentPayloadParser_) { + currentPayloadParser_->handleStartElement(element, ns, attributes); + } + ++level_; +} + +void MIXJoinParser::handleEndElement(const std::string& element, const std::string& ns) { + --level_; + if (currentPayloadParser_) { + if (level_ >= 1) { + currentPayloadParser_->handleEndElement(element, ns); + } + + if (level_ == 1) { + if (element == "subscribe" && ns == "urn:xmpp:mix:1") { + getPayloadInternal()->addSubscription(std::dynamic_pointer_cast<MIXSubscribe>(currentPayloadParser_->getPayload())); + } + if (element == "x" && ns == "jabber:x:data") { + getPayloadInternal()->setForm(std::dynamic_pointer_cast<Form>(currentPayloadParser_->getPayload())); + } + currentPayloadParser_.reset(); + } + } +} + +void MIXJoinParser::handleCharacterData(const std::string& data) { + if (level_ > 1 && currentPayloadParser_) { + currentPayloadParser_->handleCharacterData(data); + } +} diff --git a/Swiften/Parser/PayloadParsers/MIXJoinParser.h b/Swiften/Parser/PayloadParsers/MIXJoinParser.h new file mode 100644 index 0000000..c0ded7b --- /dev/null +++ b/Swiften/Parser/PayloadParsers/MIXJoinParser.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/MIXJoin.h> +#include <Swiften/Parser/GenericPayloadParser.h> + +namespace Swift { + class PayloadParser; + + class SWIFTEN_API MIXJoinParser : public GenericPayloadParser<MIXJoin> { + public: + MIXJoinParser(); + virtual ~MIXJoinParser(); + + 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/MIXJoinParserFactory.h b/Swiften/Parser/PayloadParsers/MIXJoinParserFactory.h new file mode 100644 index 0000000..6103c70 --- /dev/null +++ b/Swiften/Parser/PayloadParsers/MIXJoinParserFactory.h @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2017 Tarun Gupta + * Licensed under the simplified BSD license. + * See Documentation/Licenses/BSD-simplified.txt for more information. + */ + +#pragma once + +#include <Swiften/Base/API.h> +#include <Swiften/Parser/GenericPayloadParserFactory.h> +#include <Swiften/Parser/PayloadParsers/MIXJoinParser.h> + +namespace Swift { + class SWIFTEN_API MIXJoinParserFactory : public PayloadParserFactory { + public: + MIXJoinParserFactory() { + } + + virtual bool canParse(const std::string& element, const std::string& ns, const AttributeMap&) const { + return element == "join" && ns == "urn:xmpp:mix:1"; + } + + virtual PayloadParser* createPayloadParser() { + return new MIXJoinParser(); + } + }; +} diff --git a/Swiften/Parser/PayloadParsers/MIXSubscribeParser.cpp b/Swiften/Parser/PayloadParsers/MIXSubscribeParser.cpp new file mode 100644 index 0000000..1500716 --- /dev/null +++ b/Swiften/Parser/PayloadParsers/MIXSubscribeParser.cpp @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2017 Tarun Gupta + * Licensed under the simplified BSD license. + * See Documentation/Licenses/BSD-simplified.txt for more information. + */ + +#include <Swiften/Parser/PayloadParsers/MIXSubscribeParser.h> + +#include <boost/optional.hpp> + +#include <Swiften/Parser/PayloadParserFactory.h> +#include <Swiften/Parser/PayloadParserFactoryCollection.h> + +using namespace Swift; + +MIXSubscribeParser::MIXSubscribeParser() : level_(0) { +} + +MIXSubscribeParser::~MIXSubscribeParser() { +} + +void MIXSubscribeParser::handleStartElement(const std::string&, const std::string&, const AttributeMap& attributes) { + if (level_ == 0) { + if (boost::optional<std::string> attributeValue = attributes.getAttributeValue("node")) { + getPayloadInternal()->setNode(*attributeValue); + } + } + ++level_; +} + +void MIXSubscribeParser::handleEndElement(const std::string& , const std::string& ) { + --level_; +} + +void MIXSubscribeParser::handleCharacterData(const std::string& ) { +} diff --git a/Swiften/Parser/PayloadParsers/MIXSubscribeParser.h b/Swiften/Parser/PayloadParsers/MIXSubscribeParser.h new file mode 100644 index 0000000..eecc0d2 --- /dev/null +++ b/Swiften/Parser/PayloadParsers/MIXSubscribeParser.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/MIXSubscribe.h> +#include <Swiften/Parser/GenericPayloadParser.h> + +namespace Swift { + class PayloadParserFactoryCollection; + class PayloadParser; + + class SWIFTEN_API MIXSubscribeParser : public GenericPayloadParser<MIXSubscribe> { + public: + MIXSubscribeParser(); + virtual ~MIXSubscribeParser(); + + 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_; + }; +} diff --git a/Swiften/Parser/PayloadParsers/UnitTest/MIXJoinParserTest.cpp b/Swiften/Parser/PayloadParsers/UnitTest/MIXJoinParserTest.cpp new file mode 100644 index 0000000..7a422f4 --- /dev/null +++ b/Swiften/Parser/PayloadParsers/UnitTest/MIXJoinParserTest.cpp @@ -0,0 +1,180 @@ +/* + * 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/MIXJoin.h> +#include <Swiften/Parser/PayloadParsers/UnitTest/PayloadsParserTester.h> + +using namespace Swift; + +TEST(MIXJoinParserTest, XEP0369_Example22) { + PayloadsParserTester parser; + ASSERT_TRUE(parser.parse( + "<join xmlns=\"urn:xmpp:mix:1\" channel=\"coven@mix.shakespeare.example\">" + "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:participants\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>" + "</join>" + )); + + MIXJoin::ref payload = parser.getPayload<MIXJoin>(); + ASSERT_TRUE(payload); + + ASSERT_TRUE(payload->getChannel()); + ASSERT_EQ(JID("coven@mix.shakespeare.example"), *payload->getChannel()); + ASSERT_FALSE(payload->getJID()); + ASSERT_FALSE(payload->getForm()); + + const std::vector<MIXSubscribe::ref> items = payload->getSubscriptions(); + ASSERT_EQ(static_cast<size_t>(4), items.size()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:messages"), items[0]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:presence"), items[1]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:participants"), items[2]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:config"), items[3]->getNode()); +} + +TEST(MIXJoinParserTest, XEP0369_Example23) { + PayloadsParserTester parser; + ASSERT_TRUE(parser.parse( + "<join xmlns=\"urn:xmpp:mix:1\">" + "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:participants\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>" + "</join>" + )); + + MIXJoin::ref payload = parser.getPayload<MIXJoin>(); + ASSERT_TRUE(payload); + + ASSERT_FALSE(payload->getChannel()); + ASSERT_FALSE(payload->getJID()); + ASSERT_FALSE(payload->getForm()); + + const std::vector<MIXSubscribe::ref> items = payload->getSubscriptions(); + ASSERT_EQ(static_cast<size_t>(4), items.size()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:messages"), items[0]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:presence"), items[1]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:participants"), items[2]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:config"), items[3]->getNode()); +} + +TEST(MIXJoinParserTest, XEP0369_Example24) { + PayloadsParserTester parser; + ASSERT_TRUE(parser.parse( + "<join xmlns=\"urn:xmpp:mix:1\" jid=\"123456#coven@mix.shakespeare.example\">" + "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:participants\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:config\"/>" + "</join>" + )); + + MIXJoin::ref payload = parser.getPayload<MIXJoin>(); + ASSERT_TRUE(payload); + + ASSERT_FALSE(payload->getChannel()); + ASSERT_TRUE(payload->getJID()); + ASSERT_EQ(JID("123456#coven@mix.shakespeare.example"), *payload->getJID()); + ASSERT_FALSE(payload->getForm()); + + const std::vector<MIXSubscribe::ref> items = payload->getSubscriptions(); + ASSERT_EQ(static_cast<size_t>(4), items.size()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:messages"), items[0]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:presence"), items[1]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:participants"), items[2]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:config"), items[3]->getNode()); +} + +TEST(MIXJoinParserTest, XEP0369_Example29) { + PayloadsParserTester parser; + ASSERT_TRUE(parser.parse( + "<join xmlns=\"urn:xmpp:mix:1\">" + "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>" + "<x xmlns=\"jabber:x:data\" type=\"submit\">" + "<field var=\"FORM_TYPE\" type=\"hidden\">" + "<value>urn:xmpp:mix:1</value>" + "</field>" + "<field var=\"JID Visibility\">" + "<value>never</value>" + "</field>" + "</x>" + "</join>")); + + MIXJoin::ref payload = parser.getPayload<MIXJoin>(); + ASSERT_TRUE(payload); + + ASSERT_FALSE(payload->getChannel()); + ASSERT_FALSE(payload->getJID()); + const std::vector<MIXSubscribe::ref> items = payload->getSubscriptions(); + ASSERT_EQ(static_cast<size_t>(2), items.size()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:messages"), items[0]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:presence"), items[1]->getNode()); + + ASSERT_TRUE(payload->getForm()); + ASSERT_EQ(Form::Type::SubmitType, payload->getForm()->getType()); + std::shared_ptr<FormField> fieldType = payload->getForm()->getField("FORM_TYPE"); + ASSERT_TRUE(fieldType); + + std::shared_ptr<FormField> fieldJIDVisibility = payload->getForm()->getField("JID Visibility"); + ASSERT_TRUE(fieldJIDVisibility); + ASSERT_EQ(std::string("never"), fieldJIDVisibility->getTextSingleValue()); +} + +TEST(MIXJoinParserTest, XEP0369_Example30) { + PayloadsParserTester parser; + ASSERT_TRUE(parser.parse( + "<join xmlns=\"urn:xmpp:mix:1\" jid=\"hag66@shakespeare.example\">" + "<subscribe node=\"urn:xmpp:mix:nodes:messages\"/>" + "<subscribe node=\"urn:xmpp:mix:nodes:presence\"/>" + "<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>" + "</join>")); + + MIXJoin::ref payload = parser.getPayload<MIXJoin>(); + ASSERT_TRUE(payload); + + ASSERT_FALSE(payload->getChannel()); + ASSERT_TRUE(payload->getJID()); + ASSERT_EQ(JID("hag66@shakespeare.example"), *payload->getJID()); + + const std::vector<MIXSubscribe::ref> items = payload->getSubscriptions(); + ASSERT_EQ(static_cast<size_t>(2), items.size()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:messages"), items[0]->getNode()); + ASSERT_EQ(std::string("urn:xmpp:mix:nodes:presence"), items[1]->getNode()); + + ASSERT_TRUE(payload->getForm()); + ASSERT_EQ(Form::Type::ResultType, payload->getForm()->getType()); + std::shared_ptr<FormField> fieldType = payload->getForm()->getField("FORM_TYPE"); + ASSERT_TRUE(fieldType); + + std::shared_ptr<FormField> fieldJIDVisibility = payload->getForm()->getField("JID Visibility"); + ASSERT_TRUE(fieldJIDVisibility); + ASSERT_EQ(std::string("never"), fieldJIDVisibility->getTextSingleValue()); + + std::shared_ptr<FormField> fieldprivateMessages = payload->getForm()->getField("Private Messages"); + ASSERT_TRUE(fieldprivateMessages); + ASSERT_EQ(std::string("allow"), fieldprivateMessages->getTextSingleValue()); + + std::shared_ptr<FormField> vCard = payload->getForm()->getField("vCard"); + ASSERT_TRUE(vCard); + ASSERT_EQ(std::string("block"), vCard->getTextSingleValue()); +} |