From 9073ea57506e4081881355a508a29ea5325b9e8b Mon Sep 17 00:00:00 2001
From: Linus Jahn <lnj@kaidan.im>
Date: Mon, 4 Apr 2022 12:51:32 +0200
Subject: ClientExtension: Add handleStanza() overload with e2ee metdata

For handling end-to-end-encrypted stanzas it is important to know
whether and which encryption was used. This is especially important for
replying to IQ stanzas (with the correct encryption).

Currently the e2eeMetadata parameter is unused (always nullopt). This is
going to change in the following commits.
---
 src/client/QXmppClient.cpp          |  3 ++-
 src/client/QXmppClientExtension.cpp | 37 +++++++++++++++++++++++++++++++++++++
 src/client/QXmppClientExtension.h   | 12 ++++--------
 3 files changed, 43 insertions(+), 9 deletions(-)

(limited to 'src/client')

diff --git a/src/client/QXmppClient.cpp b/src/client/QXmppClient.cpp
index 6f993a46..2af1274d 100644
--- a/src/client/QXmppClient.cpp
+++ b/src/client/QXmppClient.cpp
@@ -753,8 +753,9 @@ QXmppVersionManager &QXmppClient::versionManager()
 
 void QXmppClient::_q_elementReceived(const QDomElement &element, bool &handled)
 {
+    const std::optional<QXmppE2eeMetadata> e2eeMetadata;
     for (auto *extension : std::as_const(d->extensions)) {
-        if (extension->handleStanza(element)) {
+        if (extension->handleStanza(element, e2eeMetadata) || extension->handleStanza(element)) {
             handled = true;
             return;
         }
diff --git a/src/client/QXmppClientExtension.cpp b/src/client/QXmppClientExtension.cpp
index 5e16d52a..c5e00c21 100644
--- a/src/client/QXmppClientExtension.cpp
+++ b/src/client/QXmppClientExtension.cpp
@@ -45,6 +45,43 @@ QList<QXmppDiscoveryIq::Identity> QXmppClientExtension::discoveryIdentities() co
     return QList<QXmppDiscoveryIq::Identity>();
 }
 
+///
+/// \brief You need to implement this method to process incoming XMPP
+/// stanzas.
+///
+/// You should return true if the stanza was handled and no further
+/// processing should occur, or false to let other extensions process
+/// the stanza.
+///
+/// \deprecated This is deprecated since QXmpp 1.5. Please use
+/// QXmppClientExtension::handleStanza(const QDomElement &stanza,
+/// const std::optional<QXmppE2eeMetadata> &e2eeMetadata).
+/// Currently both methods are called by the client, so only implement one!
+///
+bool QXmppClientExtension::handleStanza(const QDomElement &)
+{
+    return false;
+}
+
+///
+/// \brief You need to implement this method to process incoming XMPP
+/// stanzas.
+///
+/// \param stanza The DOM element to be handled.
+/// \param e2eeMetadata If the element has been decrypted this contains metdata
+/// about the encryption.
+///
+/// \return You should return true if the stanza was handled and no further
+/// processing should occur, or false to let other extensions process the
+/// stanza.
+///
+/// \since QXmpp 1.5
+///
+bool QXmppClientExtension::handleStanza(const QDomElement &, const std::optional<QXmppE2eeMetadata> &)
+{
+    return false;
+}
+
 /// Returns the client which loaded this extension.
 ///
 
diff --git a/src/client/QXmppClientExtension.h b/src/client/QXmppClientExtension.h
index 355f12b3..0cf81fc3 100644
--- a/src/client/QXmppClientExtension.h
+++ b/src/client/QXmppClientExtension.h
@@ -14,6 +14,7 @@ class QXmppClient;
 class QXmppClientExtensionPrivate;
 class QXmppStream;
 
+///
 /// \brief The QXmppClientExtension class is the base class for QXmppClient
 /// extensions.
 ///
@@ -23,7 +24,7 @@ class QXmppStream;
 /// client instance using QXmppClient::addExtension().
 ///
 /// \ingroup Core
-
+///
 class QXMPP_EXPORT QXmppClientExtension : public QXmppLoggable
 {
     Q_OBJECT
@@ -35,13 +36,8 @@ public:
     virtual QStringList discoveryFeatures() const;
     virtual QList<QXmppDiscoveryIq::Identity> discoveryIdentities() const;
 
-    /// \brief You need to implement this method to process incoming XMPP
-    /// stanzas.
-    ///
-    /// You should return true if the stanza was handled and no further
-    /// processing should occur, or false to let other extensions process
-    /// the stanza.
-    virtual bool handleStanza(const QDomElement &stanza) = 0;
+    virtual bool handleStanza(const QDomElement &stanza);
+    virtual bool handleStanza(const QDomElement &stanza, const std::optional<QXmppE2eeMetadata> &e2eeMetadata);
 
 protected:
     QXmppClient *client();
-- 
cgit v1.2.3