Implement XEP-0382: Spoiler messages (v0.2.0)

This adds parsing and serialization of spoilers in the QXmppMessage class.

4 files changed, 73 insertions, 0 deletions

diff --git a/src/base/QXmppConstants.cpp b/src/base/QXmppConstants.cpp
index b5c2215b..190a10f5 100644
--- a/src/base/QXmppConstants.cpp
+++ b/src/base/QXmppConstants.cpp
@@ -141,6 +141,8 @@ const char* ns_mix_node_participants = "urn:xmpp:mix:nodes:participants";
 const char* ns_mix_node_presence = "urn:xmpp:mix:nodes:presence";
 const char* ns_mix_node_config = "urn:xmpp:mix:nodes:config";
 const char* ns_mix_node_info = "urn:xmpp:mix:nodes:info";
+// XEP-0382: Spoiler messages
+const char* ns_spoiler = "urn:xmpp:spoiler:0";
 // XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements
 const char* ns_mix_pam = "urn:xmpp:mix:pam:0";
 const char* ns_mix_roster = "urn:xmpp:mix:roster:0";
diff --git a/src/base/QXmppConstants_p.h b/src/base/QXmppConstants_p.h
index e425485c..04cb820f 100644
--- a/src/base/QXmppConstants_p.h
+++ b/src/base/QXmppConstants_p.h
@@ -153,6 +153,8 @@ extern const char* ns_mix_node_participants;
 extern const char* ns_mix_node_presence;
 extern const char* ns_mix_node_config;
 extern const char* ns_mix_node_info;
+// XEP-0382: Spoiler messages
+extern const char* ns_spoiler;
 // XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements
 extern const char* ns_mix_pam;
 extern const char* ns_mix_roster;
diff --git a/src/base/QXmppMessage.cpp b/src/base/QXmppMessage.cpp
index 0bd28da6..dae2308b 100644
--- a/src/base/QXmppMessage.cpp
+++ b/src/base/QXmppMessage.cpp
@@ -106,6 +106,10 @@ public:
     // XEP-0369: Mediated Information eXchange (MIX)
     QString mixUserJid;
     QString mixUserNick;
+
+    // XEP-0382: Spoiler messages
+    bool isSpoiler = false;
+    QString spoilerHint;
 };
 
 /// Constructs a QXmppMessage.
@@ -545,6 +549,52 @@ void QXmppMessage::setMixUserNick(const QString& mixUserNick)
     d->mixUserNick = mixUserNick;
 }
 
+/// Returns true, if this is a spoiler message according to XEP-0382: Spoiler
+/// messages. The spoiler hint however can still be empty.
+///
+/// A spoiler message's content should not be visible to the user by default.
+
+bool QXmppMessage::isSpoiler() const
+{
+    return d->isSpoiler;
+}
+
+/// Sets whether this is a spoiler message as specified in XEP-0382: Spoiler
+/// messages.
+///
+/// The content of spoiler messages will not be displayed by default to the
+/// user. However, clients not supporting spoiler messages will still display
+/// the content as usual.
+
+void QXmppMessage::setIsSpoiler(bool isSpoiler)
+{
+    d->isSpoiler = isSpoiler;
+}
+
+/// Returns the spoiler hint as specified in XEP-0382: Spoiler messages.
+///
+/// The hint may be empty, even if isSpoiler is true.
+
+QString QXmppMessage::spoilerHint() const
+{
+    return d->spoilerHint;
+}
+
+/// Sets a spoiler hint for XEP-0382: Spoiler messages. If the spoiler hint
+/// is not empty, isSpoiler will be set to true.
+///
+/// A spoiler hint is optional for spoiler messages.
+///
+/// Keep in mind that the spoiler hint is not displayed at all by clients not
+/// supporting spoiler messages.
+
+void QXmppMessage::setSpoilerHint(const QString &spoilerHint)
+{
+    d->spoilerHint = spoilerHint;
+    if (!spoilerHint.isEmpty())
+        d->isSpoiler = true;
+}
+
 /// \cond
 void QXmppMessage::parse(const QDomElement &element)
 {
@@ -690,6 +740,10 @@ void QXmppMessage::parse(const QDomElement &element)
         } else if (xElement.tagName() == "mix" && xElement.namespaceURI() == ns_mix) {
             d->mixUserJid = xElement.firstChildElement("jid").text();
             d->mixUserNick = xElement.firstChildElement("nick").text();
+        // XEP-0382: Spoiler messages
+        } else if (xElement.tagName() == "spoiler" && xElement.namespaceURI() == ns_spoiler) {
+            d->isSpoiler = true;
+            d->spoilerHint = xElement.text();
         } else if (!knownElems.contains(qMakePair(xElement.tagName(), xElement.namespaceURI())) &&
                    !knownElems.contains(qMakePair(xElement.tagName(), QString()))) {
             // other extensions
@@ -836,6 +890,14 @@ void QXmppMessage::toXml(QXmlStreamWriter *xmlWriter) const
         xmlWriter->writeEndElement();
     }
 
+    // XEP-0382: Spoiler messages
+    if (d->isSpoiler) {
+        xmlWriter->writeStartElement("spoiler");
+        xmlWriter->writeAttribute("xmlns", ns_spoiler);
+        xmlWriter->writeCharacters(d->spoilerHint);
+        xmlWriter->writeEndElement();
+    }
+
     // other extensions
     QXmppStanza::extensionsToXml(xmlWriter);
 
diff --git a/src/base/QXmppMessage.h b/src/base/QXmppMessage.h
index 36f5d3e0..0101e211 100644
--- a/src/base/QXmppMessage.h
+++ b/src/base/QXmppMessage.h
@@ -150,6 +150,13 @@ public:
     QString mixUserNick() const;
     void setMixUserNick(const QString&);
 
+    // XEP-0382: Spoiler messages
+    bool isSpoiler() const;
+    void setIsSpoiler(bool);
+
+    QString spoilerHint() const;
+    void setSpoilerHint(const QString&);
+
     /// \cond
     void parse(const QDomElement &element);
     void toXml(QXmlStreamWriter *writer) const;