Add QXmppTrustMessageElement

4 files changed, 297 insertions, 0 deletions

diff --git a/src/base/QXmppMessage.cpp b/src/base/QXmppMessage.cpp
index 5186692d..f0e74735 100644
--- a/src/base/QXmppMessage.cpp
+++ b/src/base/QXmppMessage.cpp
@@ -28,6 +28,7 @@
 #include "QXmppBitsOfBinaryDataList.h"
 #include "QXmppConstants_p.h"
 #include "QXmppMixInvitation.h"
+#include "QXmppTrustMessageElement.h"
 #include "QXmppUtils.h"
 
 #include <optional>
@@ -175,6 +176,9 @@ public:
 
     // XEP-0428: Fallback Indication
     bool isFallback;
+
+    // XEP-0434: Trust Messages (TM)
+    std::optional<QXmppTrustMessageElement> trustMessageElement;
 };
 
 QXmppMessagePrivate::QXmppMessagePrivate()
@@ -1131,6 +1135,27 @@ void QXmppMessage::setIsFallback(bool isFallback)
     d->isFallback = isFallback;
 }
 
+///
+/// Returns an included trust message element as defined by
+/// \xep{0434, Trust Messages (TM)}.
+///
+/// \since QXmpp 1.5
+///
+std::optional<QXmppTrustMessageElement> QXmppMessage::trustMessageElement() const
+{
+    return d->trustMessageElement;
+}
+
+///
+/// Sets a trust message element as defined by \xep{0434, Trust Messages (TM)}.
+///
+/// \since QXmpp 1.5
+///
+void QXmppMessage::setTrustMessageElement(const std::optional<QXmppTrustMessageElement> &trustMessageElement)
+{
+    d->trustMessageElement = trustMessageElement;
+}
+
 /// \cond
 void QXmppMessage::parse(const QDomElement &element)
 {
@@ -1328,6 +1353,11 @@ bool QXmppMessage::parseExtension(const QDomElement &element)
     } else if (checkElement(element, QStringLiteral("fallback"), ns_fallback_indication)) {
         // XEP-0428: Fallback Indication
         d->isFallback = true;
+    } else if (QXmppTrustMessageElement::isTrustMessageElement(element)) {
+        // XEP-0434: Trust Messages (TM)
+        QXmppTrustMessageElement trustMessageElement;
+        trustMessageElement.parse(element);
+        d->trustMessageElement = trustMessageElement;
     } else {
         return false;
     }
@@ -1524,4 +1554,9 @@ void QXmppMessage::serializeExtensions(QXmlStreamWriter *xmlWriter) const
         xmlWriter->writeDefaultNamespace(ns_fallback_indication);
         xmlWriter->writeEndElement();
     }
+
+    // XEP-0434: Trust Messages (TM)
+    if (d->trustMessageElement) {
+        d->trustMessageElement->toXml(xmlWriter);
+    }
 }
diff --git a/src/base/QXmppMessage.h b/src/base/QXmppMessage.h
index d717b226..edd0c5c1 100644
--- a/src/base/QXmppMessage.h
+++ b/src/base/QXmppMessage.h
@@ -36,6 +36,7 @@
 class QXmppMessagePrivate;
 class QXmppBitsOfBinaryDataList;
 class QXmppMixInvitation;
+class QXmppTrustMessageElement;
 
 ///
 /// \brief The QXmppMessage class represents an XMPP message.
@@ -254,6 +255,10 @@ public:
     bool isFallback() const;
     void setIsFallback(bool isFallback);
 
+    // XEP-0434: Trust Messages (TM)
+    std::optional<QXmppTrustMessageElement> trustMessageElement() const;
+    void setTrustMessageElement(const std::optional<QXmppTrustMessageElement> &trustMessageElement);
+
     /// \cond
     void parse(const QDomElement &element) override;
     void toXml(QXmlStreamWriter *writer) const override;
diff --git a/src/base/QXmppTrustMessageElement.cpp b/src/base/QXmppTrustMessageElement.cpp
new file mode 100644
index 00000000..b15dc6fe
--- /dev/null
+++ b/src/base/QXmppTrustMessageElement.cpp
@@ -0,0 +1,188 @@
+/*
+ * Copyright (C) 2008-2021 The QXmpp developers
+ *
+ * Author:
+ *  Melvin Keskin
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#include "QXmppTrustMessageElement.h"
+
+#include "QXmppConstants_p.h"
+#include "QXmppTrustMessageKeyOwner.h"
+
+#include <QDomElement>
+
+///
+/// \class QXmppTrustMessageElement
+///
+/// \brief The QXmppTrustMessageElement class represents a trust message element
+/// as defined by \xep{0434, Trust Messages (TM)}.
+///
+/// \since QXmpp 1.5
+///
+
+class QXmppTrustMessageElementPrivate : public QSharedData
+{
+public:
+    QString usage;
+    QString encryption;
+    QList<QXmppTrustMessageKeyOwner> keyOwners;
+};
+
+///
+/// Constructs a trust message element.
+///
+QXmppTrustMessageElement::QXmppTrustMessageElement()
+    : d(new QXmppTrustMessageElementPrivate)
+{
+}
+
+///
+/// Constructs a copy of \a other.
+///
+/// \param other
+///
+QXmppTrustMessageElement::QXmppTrustMessageElement(const QXmppTrustMessageElement &other) = default;
+
+QXmppTrustMessageElement::~QXmppTrustMessageElement() = default;
+
+///
+/// Assigns \a other to this trust message element.
+///
+/// \param other
+///
+QXmppTrustMessageElement &QXmppTrustMessageElement::operator=(const QXmppTrustMessageElement &other) = default;
+
+///
+/// Returns the namespace of the trust management protocol.
+///
+/// \return the trust management protocol namespace
+///
+QString QXmppTrustMessageElement::usage() const
+{
+    return d->usage;
+}
+
+///
+/// Sets the namespace of the trust management protocol.
+///
+/// \param usage trust management protocol namespace
+///
+void QXmppTrustMessageElement::setUsage(const QString &usage)
+{
+    d->usage = usage;
+}
+
+///
+/// Returns the namespace of the keys' encryption protocol.
+///
+/// \return the encryption protocol namespace
+///
+QString QXmppTrustMessageElement::encryption() const
+{
+    return d->encryption;
+}
+
+///
+/// Sets the namespace of the keys' encryption protocol.
+///
+/// \param encryption encryption protocol namespace
+///
+void QXmppTrustMessageElement::setEncryption(const QString &encryption)
+{
+    d->encryption = encryption;
+}
+
+///
+/// Returns the key owners containing the corresponding information for
+/// trusting or distrusting their keys.
+///
+/// \return the owners of the keys for trusting or distrusting
+///
+QList<QXmppTrustMessageKeyOwner> QXmppTrustMessageElement::keyOwners() const
+{
+    return d->keyOwners;
+}
+
+///
+/// Sets the key owners containing the corresponding information for trusting or
+/// distrusting their keys.
+///
+/// \param keyOwners owners of the keys for trusting or distrusting
+///
+void QXmppTrustMessageElement::setKeyOwners(const QList<QXmppTrustMessageKeyOwner> &keyOwners)
+{
+    d->keyOwners = keyOwners;
+}
+
+///
+/// Adds a key owner containing the corresponding information for trusting or
+/// distrusting the owners keys.
+///
+/// \param keyOwner owner of the keys for trusting or distrusting
+///
+void QXmppTrustMessageElement::addKeyOwner(const QXmppTrustMessageKeyOwner &keyOwner)
+{
+    d->keyOwners.append(keyOwner);
+}
+
+/// \cond
+void QXmppTrustMessageElement::parse(const QDomElement &element)
+{
+    d->usage = element.attribute("usage");
+    d->encryption = element.attribute("encryption");
+
+    for (auto keyOwnerElement = element.firstChildElement("key-owner");
+         !keyOwnerElement.isNull();
+         keyOwnerElement = keyOwnerElement.nextSiblingElement("key-owner")) {
+        if (QXmppTrustMessageKeyOwner::isTrustMessageKeyOwner(keyOwnerElement)) {
+            QXmppTrustMessageKeyOwner keyOwner;
+            keyOwner.parse(keyOwnerElement);
+            d->keyOwners.append(keyOwner);
+        }
+    }
+}
+
+void QXmppTrustMessageElement::toXml(QXmlStreamWriter *writer) const
+{
+    writer->writeStartElement("trust-message");
+    writer->writeDefaultNamespace(ns_tm);
+    writer->writeAttribute("usage", d->usage);
+    writer->writeAttribute("encryption", d->encryption);
+
+    for (const auto &keyOwner : d->keyOwners) {
+        keyOwner.toXml(writer);
+    }
+
+    writer->writeEndElement();
+}
+/// \endcond
+
+///
+/// Determines whether the given DOM element is a trust message element.
+///
+/// \param element DOM element being checked
+///
+/// \return true if element is a trust message element, otherwise false
+///
+bool QXmppTrustMessageElement::isTrustMessageElement(const QDomElement &element)
+{
+    return element.tagName() == QStringLiteral("trust-message") &&
+        element.namespaceURI() == ns_tm;
+}
diff --git a/src/base/QXmppTrustMessageElement.h b/src/base/QXmppTrustMessageElement.h
new file mode 100644
index 00000000..6cb3b3bc
--- /dev/null
+++ b/src/base/QXmppTrustMessageElement.h
@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2008-2021 The QXmpp developers
+ *
+ * Author:
+ *  Melvin Keskin
+ *
+ * Source:
+ *  https://github.com/qxmpp-project/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+#ifndef QXMPPTRUSTMESSAGEELEMENT_H
+#define QXMPPTRUSTMESSAGEELEMENT_H
+
+#include "QXmppGlobal.h"
+
+#include <QDomElement>
+#include <QList>
+#include <QSharedDataPointer>
+#include <QXmlStreamWriter>
+
+class QXmppTrustMessageElementPrivate;
+class QXmppTrustMessageKeyOwner;
+
+class QXMPP_EXPORT QXmppTrustMessageElement
+{
+public:
+    QXmppTrustMessageElement();
+    QXmppTrustMessageElement(const QXmppTrustMessageElement &other);
+    ~QXmppTrustMessageElement();
+
+    QXmppTrustMessageElement &operator=(const QXmppTrustMessageElement &other);
+
+    QString usage() const;
+    void setUsage(const QString &usage);
+
+    QString encryption() const;
+    void setEncryption(const QString &encryption);
+
+    QList<QXmppTrustMessageKeyOwner> keyOwners() const;
+    void setKeyOwners(const QList<QXmppTrustMessageKeyOwner> &keyOwners);
+    void addKeyOwner(const QXmppTrustMessageKeyOwner &keyOwner);
+
+    /// \cond
+    void parse(const QDomElement &element);
+    void toXml(QXmlStreamWriter *writer) const;
+    /// \endcond
+
+    static bool isTrustMessageElement(const QDomElement &element);
+
+private:
+    QSharedDataPointer<QXmppTrustMessageElementPrivate> d;
+};
+
+Q_DECLARE_TYPEINFO(QXmppTrustMessageElement, Q_MOVABLE_TYPE);
+
+#endif  // QXMPPTRUSTMESSAGEELEMENT_H