QXmppRegisterIq: Add registerType for registered/remove

3 files changed, 138 insertions, 34 deletions

diff --git a/src/base/QXmppRegisterIq.cpp b/src/base/QXmppRegisterIq.cpp
index 3bd9431a..9f1c35fd 100644
--- a/src/base/QXmppRegisterIq.cpp
+++ b/src/base/QXmppRegisterIq.cpp
@@ -3,6 +3,7 @@
  *
  * Author:
  *  Jeremy Lainé
+ *  Linus Jahn
  *
  * Source:
  *  https://github.com/qxmpp-project/qxmpp
@@ -22,22 +23,37 @@
  */
 
 #include <QDomElement>
+#include <QSharedData>
 
 #include "QXmppConstants_p.h"
 #include "QXmppRegisterIq.h"
 #include "QXmppBitsOfBinaryDataList.h"
 
+static const QStringList REGISTER_TYPES = {
+    QString(),
+    QStringLiteral("registered"),
+    QStringLiteral("remove")
+};
+
 class QXmppRegisterIqPrivate : public QSharedData
 {
 public:
+    QXmppRegisterIqPrivate();
+
     QXmppDataForm form;
     QString email;
     QString instructions;
     QString password;
     QString username;
+    QXmppRegisterIq::RegisterType registerType;
     QXmppBitsOfBinaryDataList bitsOfBinaryData;
 };
 
+QXmppRegisterIqPrivate::QXmppRegisterIqPrivate()
+    : registerType(QXmppRegisterIq::None)
+{
+}
+
 QXmppRegisterIq::QXmppRegisterIq()
     : d(new QXmppRegisterIqPrivate)
 {
@@ -47,7 +63,7 @@ QXmppRegisterIq::QXmppRegisterIq(const QXmppRegisterIq &other) = default;
 
 QXmppRegisterIq::~QXmppRegisterIq() = default;
 
-QXmppRegisterIq &QXmppRegisterIq::operator=(const QXmppRegisterIq& other) = default;
+QXmppRegisterIq &QXmppRegisterIq::operator=(const QXmppRegisterIq &other) = default;
 
 /// Returns the email for this registration IQ.
 
@@ -154,6 +170,20 @@ void QXmppRegisterIq::setBitsOfBinaryData(const QXmppBitsOfBinaryDataList &bitsO
     d->bitsOfBinaryData = bitsOfBinaryData;
 }
 
+/// Returns the type of the action or registration state.
+
+QXmppRegisterIq::RegisterType QXmppRegisterIq::registerType() const
+{
+    return d->registerType;
+}
+
+/// Sets the type of the action or registration state.
+
+void QXmppRegisterIq::setRegisterType(const QXmppRegisterIq::RegisterType &type)
+{
+    d->registerType = type;
+}
+
 /// \cond
 bool QXmppRegisterIq::isRegisterIq(const QDomElement &element)
 {
@@ -169,15 +199,30 @@ void QXmppRegisterIq::parseElementFromChild(const QDomElement &element)
     d->email = queryElement.firstChildElement("email").text();
     d->form.parse(queryElement.firstChildElement("x"));
     d->bitsOfBinaryData.parse(queryElement);
+
+    d->registerType = QXmppRegisterIq::None;
+
+    // The loop starts with the second element, because there cannot be an
+    // empty element for QXmppRegisterIq::None
+    for (int i = 1; i < REGISTER_TYPES.size(); i++) {
+        if (!queryElement.firstChildElement(REGISTER_TYPES.at(i)).isNull()) {
+            d->registerType = RegisterType(i);
+            break;
+        }
+    }
 }
 
 void QXmppRegisterIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
 {
     writer->writeStartElement("query");
     writer->writeAttribute("xmlns", ns_register);
+
     if (!d->instructions.isEmpty())
         writer->writeTextElement("instructions", d->instructions);
 
+    if (d->registerType != QXmppRegisterIq::None)
+        writer->writeEmptyElement(REGISTER_TYPES.at(int(d->registerType)));
+
     if (!d->username.isEmpty())
         writer->writeTextElement("username", d->username);
     else if (!d->username.isNull())
diff --git a/src/base/QXmppRegisterIq.h b/src/base/QXmppRegisterIq.h
index 91f0d873..52b4ffba 100644
--- a/src/base/QXmppRegisterIq.h
+++ b/src/base/QXmppRegisterIq.h
@@ -3,6 +3,7 @@
  *
  * Author:
  *  Jeremy Lainé
+ *  Linus Jahn
  *
  * Source:
  *  https://github.com/qxmpp-project/qxmpp
@@ -27,8 +28,8 @@
 #include "QXmppDataForm.h"
 #include "QXmppIq.h"
 
-class QXmppRegisterIqPrivate;
 class QXmppBitsOfBinaryDataList;
+class QXmppRegisterIqPrivate;
 
 /// \brief The QXmppRegisterIq class represents a registration IQ
 /// as defined by XEP-0077: In-Band Registration.
@@ -40,6 +41,12 @@ class QXmppBitsOfBinaryDataList;
 class QXMPP_EXPORT QXmppRegisterIq : public QXmppIq
 {
 public:
+    enum RegisterType {
+        None,        ///< No special register IQ.
+        Registered,  ///< Used by the service to indicate that an account is already registered.
+        Remove       ///< Used by the client to request account removal.
+    };
+
     QXmppRegisterIq();
     QXmppRegisterIq(const QXmppRegisterIq &other);
     ~QXmppRegisterIq();
@@ -61,6 +68,9 @@ public:
     QString username() const;
     void setUsername(const QString &username);
 
+    RegisterType registerType() const;
+    void setRegisterType(const RegisterType &registerType);
+
     QXmppBitsOfBinaryDataList bitsOfBinaryData() const;
     QXmppBitsOfBinaryDataList &bitsOfBinaryData();
     void setBitsOfBinaryData(const QXmppBitsOfBinaryDataList &bitsOfBinaryData);
diff --git a/tests/qxmppregisteriq/tst_qxmppregisteriq.cpp b/tests/qxmppregisteriq/tst_qxmppregisteriq.cpp
index 2ff55759..a2f01afb 100644
--- a/tests/qxmppregisteriq/tst_qxmppregisteriq.cpp
+++ b/tests/qxmppregisteriq/tst_qxmppregisteriq.cpp
@@ -3,6 +3,7 @@
  *
  * Author:
  *  Jeremy Lainé
+ *  Linus Jahn
  *
  * Source:
  *  https://github.com/qxmpp-project/qxmpp
@@ -40,6 +41,8 @@ private slots:
     void testSet();
     void testSetWithForm();
     void testBobData();
+    void testRegistered();
+    void testRemove();
 };
 
 void tst_QXmppRegisterIq::testGet()
@@ -56,6 +59,7 @@ void tst_QXmppRegisterIq::testGet()
     QCOMPARE(iq.from(), QString());
     QCOMPARE(iq.type(), QXmppIq::Get);
     QCOMPARE(iq.instructions(), QString());
+    QCOMPARE(iq.registerType(), QXmppRegisterIq::None);
     QVERIFY(iq.username().isNull());
     QVERIFY(iq.password().isNull());
     QVERIFY(iq.email().isNull());
@@ -205,39 +209,37 @@ void tst_QXmppRegisterIq::testBobData()
 {
     const QByteArray xml = QByteArrayLiteral(
         "<iq type=\"result\">"
-            "<query xmlns=\"jabber:iq:register\">"
-                "<data xmlns=\"urn:xmpp:bob\" "
-                      "cid=\"sha1+5a4c38d44fc64805cbb2d92d8b208be13ff40c0f@bob.xmpp.org\" "
-                      "type=\"image/png\">"
-                    "iVBORw0KGgoAAAANSUhEUgAAALQAAAA8BAMAAAA9AI20AAAAG1BMVEX///8AAADf39+"
-                    "/v79/f39fX1+fn58/Pz8fHx/8ACGJAAAACXBIWXMAAA7EAAAOxAGVKw4bAAADS0lEQV"
-                    "RYhe2WS3MSQRCAYTf7OKY1kT0CxsRjHmh5BENIjqEk6pHVhFzdikqO7CGyP9t59Ox2z"
-                    "y6UeWBVqugLzM70Nz39mqnV1lIWgBWiYXV0BYfNZ0mvwypds1r62vH/gf76ZL/88Qlc"
-                    "41zeAnQrpx5H3z1Npfr5ovmHusa9SpRiNNIOcdrto6PJ5LLfb5bp9zM+VDq/vptxDEa"
-                    "a1sql9I3R5KhtfQsA5gNCWYyulV3TyTUDdfL56BvdDl4x7RiybDq9uBgxh1TTPUHDvA"
-                    "qNQb+LpT5sWehxJZKKcU2MZ6sDE7PMgW2mdlBGdy6ODe6fJFdMI+us95dNqftDMdwU6"
-                    "+MhpuTS9slcy5TFAcwq0Jt6qssJMTQGp4BGURlmSsNoo5oHL4kqc66NdkDO75mIfCxm"
-                    "RAlvHxMLdcb7JONavMJbttXXKoMSneYu3OQTlwkUh4mNayi6js55/2VcsZOQfXIYelz"
-                    "xLcntEGc3WVCsCORJVCc5r0ajAcq+EO1Q0oPm7n7+X/3jEReGdL6qT7Ml6FCjY+quJC"
-                    "r+D01f6BG0SaHG56ZG32DnY2jcEV1+pU0kxTaEwaGcekN7jyu50U/TV4q6YeieyiNTu"
-                    "klDKZLukyjKVNwotCUB3B0XO1WjHT3c0DHSO2zACwut8GOiljJIHaJsrlof/fpWNzGM"
-                    "os6TgIY0hZNpJshzSi4igOhy3cl4qK+YgnqHkAYcZEgdW6/HyrEK7afoY7RCFzArLl2"
-                    "LLDdrdmmHZfROajwIDfWj8yQG+rzwlA3WvdJiMHtjUekiNrp1oCbmyZDEyKROGjFVDr"
-                    "PRzlkR9UAfG/OErnPxrop5BwpoEpXQorq2zcGxbnBJndx8Bh0yljGiGv0B4E8+YP3Xp"
-                    "2rGydZNy4csW8W2pIvWhvijoujRJ0luXsoymV+8AXvE9HjII72+oReS6OfomHe3xWg/"
-                    "f2coSbDa1XZ1CvGMjy1nH9KBl83oPnQKi+vAXKLjCrRvvT2WCMkPmSFbquiVuTH1qjv"
-                    "p4j/u7CWyI5/Hn3KAaJJ90eP0Zp1Kjets4WPaElkxheF7cpBESzXuIdLwyFjSub07tB"
-                    "6JjxH3DGiu+zwHHimdtFsMvKqG/nBxm2TwbvyU6LWs5RnJX4dSldg3QhDLAAAAAElFT"
-                    "kSuQmCC"
-                "</data>"
-            "</query>"
-        "</iq>"
-    );
+        "<query xmlns=\"jabber:iq:register\">"
+        "<data xmlns=\"urn:xmpp:bob\" "
+        "cid=\"sha1+5a4c38d44fc64805cbb2d92d8b208be13ff40c0f@bob.xmpp.org\" "
+        "type=\"image/png\">"
+        "iVBORw0KGgoAAAANSUhEUgAAALQAAAA8BAMAAAA9AI20AAAAG1BMVEX///8AAADf39+"
+        "/v79/f39fX1+fn58/Pz8fHx/8ACGJAAAACXBIWXMAAA7EAAAOxAGVKw4bAAADS0lEQV"
+        "RYhe2WS3MSQRCAYTf7OKY1kT0CxsRjHmh5BENIjqEk6pHVhFzdikqO7CGyP9t59Ox2z"
+        "y6UeWBVqugLzM70Nz39mqnV1lIWgBWiYXV0BYfNZ0mvwypds1r62vH/gf76ZL/88Qlc"
+        "41zeAnQrpx5H3z1Npfr5ovmHusa9SpRiNNIOcdrto6PJ5LLfb5bp9zM+VDq/vptxDEa"
+        "a1sql9I3R5KhtfQsA5gNCWYyulV3TyTUDdfL56BvdDl4x7RiybDq9uBgxh1TTPUHDvA"
+        "qNQb+LpT5sWehxJZKKcU2MZ6sDE7PMgW2mdlBGdy6ODe6fJFdMI+us95dNqftDMdwU6"
+        "+MhpuTS9slcy5TFAcwq0Jt6qssJMTQGp4BGURlmSsNoo5oHL4kqc66NdkDO75mIfCxm"
+        "RAlvHxMLdcb7JONavMJbttXXKoMSneYu3OQTlwkUh4mNayi6js55/2VcsZOQfXIYelz"
+        "xLcntEGc3WVCsCORJVCc5r0ajAcq+EO1Q0oPm7n7+X/3jEReGdL6qT7Ml6FCjY+quJC"
+        "r+D01f6BG0SaHG56ZG32DnY2jcEV1+pU0kxTaEwaGcekN7jyu50U/TV4q6YeieyiNTu"
+        "klDKZLukyjKVNwotCUB3B0XO1WjHT3c0DHSO2zACwut8GOiljJIHaJsrlof/fpWNzGM"
+        "os6TgIY0hZNpJshzSi4igOhy3cl4qK+YgnqHkAYcZEgdW6/HyrEK7afoY7RCFzArLl2"
+        "LLDdrdmmHZfROajwIDfWj8yQG+rzwlA3WvdJiMHtjUekiNrp1oCbmyZDEyKROGjFVDr"
+        "PRzlkR9UAfG/OErnPxrop5BwpoEpXQorq2zcGxbnBJndx8Bh0yljGiGv0B4E8+YP3Xp"
+        "2rGydZNy4csW8W2pIvWhvijoujRJ0luXsoymV+8AXvE9HjII72+oReS6OfomHe3xWg/"
+        "f2coSbDa1XZ1CvGMjy1nH9KBl83oPnQKi+vAXKLjCrRvvT2WCMkPmSFbquiVuTH1qjv"
+        "p4j/u7CWyI5/Hn3KAaJJ90eP0Zp1Kjets4WPaElkxheF7cpBESzXuIdLwyFjSub07tB"
+        "6JjxH3DGiu+zwHHimdtFsMvKqG/nBxm2TwbvyU6LWs5RnJX4dSldg3QhDLAAAAAElFT"
+        "kSuQmCC"
+        "</data>"
+        "</query>"
+        "</iq>");
 
     QXmppBitsOfBinaryData data;
     data.setCid(QXmppBitsOfBinaryContentId::fromContentId(
-        QStringLiteral("sha1+5a4c38d44fc64805cbb2d92d8b208be13ff40c0f@bob.xmpp.org")
-    ));
+        QStringLiteral("sha1+5a4c38d44fc64805cbb2d92d8b208be13ff40c0f@bob.xmpp.org")));
     data.setContentType(QMimeDatabase().mimeTypeForName(QStringLiteral("image/png")));
     data.setData(QByteArray::fromBase64(QByteArrayLiteral(
         "iVBORw0KGgoAAAANSUhEUgAAALQAAAA8BAMAAAA9AI20AAAAG1BMVEX///8AAADf39+"
@@ -259,8 +261,7 @@ void tst_QXmppRegisterIq::testBobData()
         "f2coSbDa1XZ1CvGMjy1nH9KBl83oPnQKi+vAXKLjCrRvvT2WCMkPmSFbquiVuTH1qjv"
         "p4j/u7CWyI5/Hn3KAaJJ90eP0Zp1Kjets4WPaElkxheF7cpBESzXuIdLwyFjSub07tB"
         "6JjxH3DGiu+zwHHimdtFsMvKqG/nBxm2TwbvyU6LWs5RnJX4dSldg3QhDLAAAAAElFT"
-        "kSuQmCC"
-    )));
+        "kSuQmCC")));
 
     QXmppRegisterIq parsedIq;
     parsePacket(parsedIq, xml);
@@ -295,5 +296,53 @@ void tst_QXmppRegisterIq::testBobData()
     QCOMPARE(constIq.bitsOfBinaryData(), iq.bitsOfBinaryData());
 }
 
+void tst_QXmppRegisterIq::testRegistered()
+{
+    const QByteArray xml = QByteArrayLiteral(
+        "<iq type=\"result\">"
+        "<query xmlns=\"jabber:iq:register\">"
+        "<registered/>"
+        "<username>juliet</username>"
+        "</query>"
+        "</iq>");
+
+    QXmppRegisterIq iq;
+    parsePacket(iq, xml);
+    QCOMPARE(iq.registerType(), QXmppRegisterIq::Registered);
+    QCOMPARE(iq.username(), QStringLiteral("juliet"));
+    serializePacket(iq, xml);
+
+    iq = QXmppRegisterIq();
+    iq.setId(QStringLiteral(""));
+    iq.setType(QXmppIq::Result);
+    iq.setRegisterType(QXmppRegisterIq::Registered);
+    iq.setUsername(QStringLiteral("juliet"));
+    serializePacket(iq, xml);
+}
+
+void tst_QXmppRegisterIq::testRemove()
+{
+    const QByteArray xml = QByteArrayLiteral(
+        "<iq type=\"result\">"
+        "<query xmlns=\"jabber:iq:register\">"
+        "<remove/>"
+        "<username>juliet</username>"
+        "</query>"
+        "</iq>");
+
+    QXmppRegisterIq iq;
+    parsePacket(iq, xml);
+    QCOMPARE(iq.registerType(), QXmppRegisterIq::Remove);
+    QCOMPARE(iq.username(), QStringLiteral("juliet"));
+    serializePacket(iq, xml);
+
+    iq = QXmppRegisterIq();
+    iq.setId(QStringLiteral(""));
+    iq.setType(QXmppIq::Result);
+    iq.setRegisterType(QXmppRegisterIq::Remove);
+    iq.setUsername(QStringLiteral("juliet"));
+    serializePacket(iq, xml);
+}
+
 QTEST_MAIN(tst_QXmppRegisterIq)
 #include "tst_qxmppregisteriq.moc"