Add test for pubsub item

Author: jbruechert

src/base/QXmppMessage.h

@@ -257,9 +257,9 @@ class QXMPP_EXPORT QXmppMessage : public QXmppStanza
     const QVector<QXmppFileShare> &sharedFiles() const;
     void setSharedFiles(const QVector<QXmppFileShare> &sharedFiles);
 
-	// XEP-0449: Stickers
-	const std::optional<QString> &stickerPackId() const;
-	void setStickerPackId(const std::optional<QString> &stickerPackId);
+    // XEP-0449: Stickers
+    const std::optional<QString> &stickerPackId() const;
+    void setStickerPackId(const std::optional<QString> &stickerPackId);
 
     /// \cond
 #ifdef BUILD_OMEMO

src/base/QXmppStickerPackItem.cpp

@@ -7,6 +7,7 @@
 #include "QXmppConstants_p.h"
 #include "QXmppEncryptedFileSource.h"
 #include "QXmppFileMetadata.h"
+#include "qdebug.h"
 
 #include <QXmlStreamWriter>
 
@@ -16,13 +17,16 @@ class QXmppStickerItemPrivate : public QSharedData
     QXmppFileMetadata metadata;
     QVector<QXmppHttpFileSource> httpSources;
     QVector<QXmppEncryptedFileSource> encryptedSources;
+    std::optional<QString> suggest;
 };
 
 QXmppStickerItem::QXmppStickerItem()
     : d(new QXmppStickerItemPrivate())
 {
 }
 
+QXMPP_PRIVATE_DEFINE_RULE_OF_SIX(QXmppStickerItem)
+
 ///
 /// \class QXmppStickerItem
 ///
@@ -77,20 +81,34 @@ void QXmppStickerItem::setEncryptedSources(const QVector<QXmppEncryptedFileSourc
     d->encryptedSources = encryptedSources;
 }
 
-QXMPP_PRIVATE_DEFINE_RULE_OF_SIX(QXmppStickerItem)
+const std::optional<QString> &QXmppStickerItem::suggest() const
+{
+    return d->suggest;
+}
+
+void QXmppStickerItem::setSuggest(const std::optional<QString> &suggest)
+{
+    d->suggest = suggest;
+}
 
 /// \cond
 void QXmppStickerItem::toXml(QXmlStreamWriter *writer) const
 {
     writer->writeStartElement("item");
     d->metadata.toXml(writer);
+    writer->writeStartElement("sources");
+    writer->writeDefaultNamespace(ns_sfs);
     for (const auto &httpSource : d->httpSources) {
         httpSource.toXml(writer);
     }
     for (const auto &encryptedSource : d->encryptedSources) {
         encryptedSource.toXml(writer);
     }
     writer->writeEndElement();
+    if (d->suggest) {
+        writer->writeTextElement("suggest", *d->suggest);
+    }
+    writer->writeEndElement();
 }
 
 bool QXmppStickerItem::parse(const QDomElement &element)
@@ -115,6 +133,10 @@ bool QXmppStickerItem::parse(const QDomElement &element)
         }
     }
 
+    if (auto el = element.firstChildElement("suggest"); !el.isNull()) {
+        d->suggest = el.text();
+    }
+
     return true;
 }
 /// \endcond
@@ -125,13 +147,16 @@ class QXmppStickerPackItemPrivate : public QSharedData
     QString name;
     QString summary;
     QVector<QXmppStickerItem> items;
+    QXmppHash hash;
 };
 
 QXmppStickerPackItem::QXmppStickerPackItem()
     : d(new QXmppStickerPackItemPrivate())
 {
 }
 
+QXMPP_PRIVATE_DEFINE_RULE_OF_SIX(QXmppStickerPackItem)
+
 ///
 /// \class QXmppStickerPackitem
 ///
@@ -186,21 +211,21 @@ void QXmppStickerPackItem::setItems(const QVector<QXmppStickerItem> &items)
     d->items = items;
 }
 
-QXMPP_PRIVATE_DEFINE_RULE_OF_SIX(QXmppStickerPackItem)
-
 void QXmppStickerPackItem::parsePayload(const QDomElement &payloadElement)
 {
     d->name = payloadElement.firstChildElement("name").text();
     d->summary = payloadElement.firstChildElement("summary").text();
 
     for (auto firstChild = payloadElement.firstChildElement("item");
          !firstChild.isNull();
-         firstChild.nextSibling()) {
+         firstChild = firstChild.nextSiblingElement("item")) {
         QXmppStickerItem stickerItem;
-        stickerItem.parse(payloadElement);
+        stickerItem.parse(firstChild);
 
         d->items.push_back(std::move(stickerItem));
     }
+
+    d->hash.parse(payloadElement.firstChildElement("hash"));
 }
 
 void QXmppStickerPackItem::serializePayload(QXmlStreamWriter *writer) const
@@ -215,5 +240,6 @@ void QXmppStickerPackItem::serializePayload(QXmlStreamWriter *writer) const
         item.toXml(writer);
     }
 
+    d->hash.toXml(writer);
     writer->writeEndElement();
 }

src/base/QXmppStickerPackItem.h

@@ -9,6 +9,8 @@
 
 #include <QVector>
 
+#include <optional>
+
 class QXmppFileMetadata;
 class QXmppHttpFileSource;
 class QXmppEncryptedFileSource;
@@ -31,6 +33,9 @@ class QXMPP_EXPORT QXmppStickerItem
     const QVector<QXmppEncryptedFileSource> &encryptedSources() const;
     void setEncryptedSources(const QVector<QXmppEncryptedFileSource> &encryptedSources);
 
+    const std::optional<QString> &suggest() const;
+    void setSuggest(const std::optional<QString> &suggest);
+
     /// \cond
     bool parse(const QDomElement &element);
     void toXml(QXmlStreamWriter *writer) const;

tests/qxmppmessage/tst_qxmppmessage.cpp

@@ -1283,6 +1283,7 @@ void tst_QXmppMessage::testStickers()
     parsePacket(message1, xml);
     QVERIFY(!message1.sharedFiles().empty());
     QVERIFY(message1.stickerPackId().has_value());
+    Q_ASSERT(message1.stickerPackId().value() == QStringLiteral("EpRv28DHHzFrE4zd"));
     serializePacket(message1, xml);
 }
 

tests/qxmpppubsub/tst_qxmpppubsub.cpp

@@ -4,6 +4,7 @@
 
 #include "QXmppPubSubAffiliation.h"
 #include "QXmppPubSubSubscription.h"
+#include "QXmppStickerPackItem.h"
 
 #include "pubsubutil.h"
 #include "util.h"
@@ -55,6 +56,7 @@ class tst_QXmppPubSub : public QObject
     Q_SLOT void testIsItem_data();
     Q_SLOT void testIsItem();
     Q_SLOT void testTestItem();
+    Q_SLOT void testStickerPackItem();
 };
 
 void tst_QXmppPubSub::testAffiliation_data()
@@ -280,5 +282,49 @@ void tst_QXmppPubSub::testTestItem()
     QVERIFY(!TestItem::isItem(xmlToDom(invalidXml)));
 }
 
+void tst_QXmppPubSub::testStickerPackItem()
+{
+    QByteArray xml(
+        "<item id='EpRv28DHHzFrE4zd+xaNpVb4'>"
+        "<pack xmlns='urn:xmpp:stickers:0'>"
+        "<name>Marsey the Cat</name>"
+        "<summary>Be cute or be cynical, this little kitten works both ways.</summary>"
+        "<item>"
+        "<file xmlns='urn:xmpp:file:metadata:0'>"
+        "<desc>👍</desc>"
+        "<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>0AdP8lJOWJrugSKOIAqfEKqFatIpG5JBCjjxY253ojQ=</hash>"
+        "<height>512</height>"
+        "<media-type>image/png</media-type>"
+        "<size>71045</size>"
+        "<width>512</width>"
+        "</file>"
+        "<sources xmlns='urn:xmpp:sfs:0'>"
+        "<url-data xmlns='http://jabber.org/protocol/url-data' target='https://download.montague.lit/51078299-d071-46e1-b6d3-3de4a8ab67d6/sticker_marsey_thumbs_up.png'/>"
+        "</sources>"
+        "<suggest>+1</suggest>"
+        "</item>"
+        "<item>"
+        "<file xmlns='urn:xmpp:file:metadata:0'>"
+        "<desc>😘</desc>"
+        "<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>gw+6xdCgOcvCYSKuQNrXH33lV9NMzuDf/s0huByCDsY=</hash>"
+        "<height>512</height>"
+        "<media-type>image/png</media-type>"
+        "<size>67016</size>"
+        "<width>512</width>"
+        "</file>"
+        "<sources xmlns='urn:xmpp:sfs:0'>"
+        "<url-data xmlns='http://jabber.org/protocol/url-data' target='https://download.montague.lit/51078299-d071-46e1-b6d3-3de4a8ab67d6/sticker_marsey_kiss.png'/>"
+        "</sources>"
+        "</item>"
+        "<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>EpRv28DHHzFrE4zd+xaNpVb4jbu4s74XtioExNjQzZ0=</hash>"
+        "</pack>"
+        "</item>");
+
+    QXmppStickerPackItem item;
+    parsePacket(item, xml);
+    QCOMPARE(item.items().size(), 2);
+    serializePacket(item, xml);
+}
+
 QTEST_MAIN(tst_QXmppPubSub)
 #include "tst_qxmpppubsub.moc"