Merge pull request #570 from taiBsu/feature/jingle-message-initiationHEADmaster

XEP-0353: Jingle Message Initiation

1 files changed, 126 insertions, 0 deletions

diff --git a/src/client/QXmppJingleMessageInitiationManager.h b/src/client/QXmppJingleMessageInitiationManager.h
new file mode 100644
index 00000000..cd5bb494
--- /dev/null
+++ b/src/client/QXmppJingleMessageInitiationManager.h
@@ -0,0 +1,126 @@
+// SPDX-FileCopyrightText: 2023 Tibor Csötönyi <work@taibsu.de>
+// SPDX-FileCopyrightText: 2023 Melvin Keskin <melvo@olomono.de>
+//
+// SPDX-License-Identifier: LGPL-2.1-or-later
+
+#ifndef QXMPPJINGLEMESSAGEINITIATIONMANAGER_H
+#define QXMPPJINGLEMESSAGEINITIATIONMANAGER_H
+
+#include "QXmppClientExtension.h"
+#include "QXmppError.h"
+#include "QXmppJingleIq.h"
+#include "QXmppMessageHandler.h"
+#include "QXmppSendResult.h"
+#include "QXmppTask.h"
+
+class QXmppJingleMessageInitiationManager;
+class QXmppJingleMessageInitiationPrivate;
+class QXmppJingleMessageInitiationManagerPrivate;
+
+class QXMPP_EXPORT QXmppJingleMessageInitiation : public QObject
+{
+    Q_OBJECT
+public:
+    struct Rejected
+    {
+        std::optional<QXmppJingleReason> reason;
+        bool containsTieBreak;
+    };
+
+    struct Retracted
+    {
+        std::optional<QXmppJingleReason> reason;
+        bool containsTieBreak;
+    };
+
+    struct Finished
+    {
+        std::optional<QXmppJingleReason> reason;
+        QString migratedTo;
+    };
+
+    /// Variant of Rejected, Retracted, Finished or Error result types
+    using Result = std::variant<Rejected, Retracted, Finished, QXmppError>;
+
+    QXmppJingleMessageInitiation(QXmppJingleMessageInitiationManager *manager);
+    ~QXmppJingleMessageInitiation();
+
+    QXmppTask<QXmpp::SendResult> ring();
+    QXmppTask<QXmpp::SendResult> proceed();
+    QXmppTask<QXmpp::SendResult> reject(std::optional<QXmppJingleReason> reason, bool containsTieBreak = false);
+    QXmppTask<QXmpp::SendResult> retract(std::optional<QXmppJingleReason> reason, bool containsTieBreak = false);
+    QXmppTask<QXmpp::SendResult> finish(std::optional<QXmppJingleReason> reason, const QString &migratedTo = {});
+
+    Q_SIGNAL void ringing();
+    Q_SIGNAL void proceeded(const QString &id, const QString &callPartnerResource);
+    Q_SIGNAL void closed(const Result &result);
+
+private:
+    QString id() const;
+    void setId(const QString &id);
+    void setCallPartnerJid(const QString &callPartnerJid);
+    QString callPartnerJid() const;
+    bool isProceeded() const;
+    void setIsProceeded(bool isProceeded);
+
+    std::unique_ptr<QXmppJingleMessageInitiationPrivate> d;
+
+    friend class QXmppJingleMessageInitiationManager;
+    friend class tst_QXmppJingleMessageInitiationManager;
+};
+
+class QXMPP_EXPORT QXmppJingleMessageInitiationManager : public QXmppClientExtension, public QXmppMessageHandler
+{
+    Q_OBJECT
+public:
+    using ProposeResult = std::variant<std::shared_ptr<QXmppJingleMessageInitiation>, QXmppError>;
+
+    QXmppJingleMessageInitiationManager();
+    ~QXmppJingleMessageInitiationManager();
+
+    /// \cond
+    QStringList discoveryFeatures() const override;
+    /// \endcond
+
+    QXmppTask<ProposeResult> propose(
+        const QString &callPartnerJid,
+        const QXmppJingleDescription &description);
+
+    Q_SIGNAL void proposed(
+        const std::shared_ptr<QXmppJingleMessageInitiation> &jmi,
+        const QString &id,
+        const std::optional<QXmppJingleDescription> &description);
+
+protected:
+    /// \cond
+    bool handleMessage(const QXmppMessage &) override;
+    void setClient(QXmppClient *client) override;
+    /// \endcond
+
+private:
+    QXmppTask<QXmpp::SendResult> sendMessage(
+        const QXmppJingleMessageInitiationElement &jmiElement,
+        const QString &callPartnerJid);
+
+    void clear(const std::shared_ptr<QXmppJingleMessageInitiation> &jmi);
+    void clearAll();
+
+    bool handleJmiElement(QXmppJingleMessageInitiationElement &&jmiElement, const QString &senderJid);
+    bool handleExistingJmi(const std::shared_ptr<QXmppJingleMessageInitiation> &existingJmi, const QXmppJingleMessageInitiationElement &jmiElement, const QString &callPartnerResource);
+    bool handleProposeJmiElement(const QXmppJingleMessageInitiationElement &jmiElement, const QString &callPartnerJid);
+    bool handleTieBreak(const std::shared_ptr<QXmppJingleMessageInitiation> &existingJmi, const QXmppJingleMessageInitiationElement &jmiElement, const QString &callPartnerResource);
+    bool handleExistingSession(const std::shared_ptr<QXmppJingleMessageInitiation> &existingJmi, const QString &jmiElementId);
+    bool handleNonExistingSession(const std::shared_ptr<QXmppJingleMessageInitiation> &existingJmi, const QString &jmiElementId, const QString &callPartnerResource);
+    std::shared_ptr<QXmppJingleMessageInitiation> addJmi(const QString &callPartnerJid);
+    const QVector<std::shared_ptr<QXmppJingleMessageInitiation>> &jmis() const;
+
+private:
+    std::unique_ptr<QXmppJingleMessageInitiationManagerPrivate> d;
+
+    friend class QXmppJingleMessageInitiationPrivate;
+    friend class tst_QXmppJingleMessageInitiationManager;
+};
+
+Q_DECLARE_METATYPE(QXmppJingleMessageInitiation::Result)
+
+#endif  // QXMPPJINGLEMESSAGEINITIATIONMANAGER_H