QXmppClient.h

// SPDX-FileCopyrightText: 2009 Manjeet Dahiya <manjeetdahiya@gmail.com>
// SPDX-FileCopyrightText: 2019 Linus Jahn <lnj@kaidan.im>
// SPDX-FileCopyrightText: 2023 Melvin Keskin <melvo@olomono.de>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#ifndef QXMPPCLIENT_H
#define QXMPPCLIENT_H
 
#include "QXmppConfiguration.h"
#include "QXmppLogger.h"
#include "QXmppPresence.h"
#include "QXmppSendResult.h"
#include "QXmppSendStanzaParams.h"
#include "QXmppStreamError.h"
 
#include <memory>
#include <variant>
 
#include <QAbstractSocket>
#include <QObject>
#include <QSslError>
 
template<typename T>
class QXmppTask;
 
class QXmppE2eeExtension;
class QXmppClientExtension;
class QXmppClientPrivate;
class QXmppMessage;
class QXmppOutgoingClient;
class QXmppPresence;
class QXmppIq;
 
// managers
class QXmppDiscoveryIq;
class QXmppRosterManager;
class QXmppVCardManager;
class QXmppVersionManager;
 
namespace QXmpp::Private {
struct SessionBegin;
}
 
 
 
class QXMPP_EXPORT QXmppClient : public QXmppLoggable
{
    Q_OBJECT
 
    Q_PROPERTY(QXmppLogger *logger READ logger WRITE setLogger NOTIFY loggerChanged)
    Q_PROPERTY(State state READ state NOTIFY stateChanged)
 
public:
    using IqResult = std::variant<QDomElement, QXmppError>;
    using EmptyResult = std::variant<QXmpp::Success, QXmppError>;
 
    enum Error {
        NoError,          
        SocketError,      
        KeepAliveError,   
        XmppStreamError,  
    };
    Q_ENUM(Error)
 
    
    enum State {
        DisconnectedState,  
        ConnectingState,    
        ConnectedState      
    };
    Q_ENUM(State)
 
    
    enum StreamManagementState {
        NoStreamManagement,
        NewStream,
        ResumedStream
    };
 
    enum InitialExtensions {
        NoExtensions,
        BasicExtensions,
    };
 
    QXmppClient(InitialExtensions, QObject *parent = nullptr);
    QXmppClient(QObject *parent = nullptr);
    ~QXmppClient() override;
 
    bool addExtension(QXmppClientExtension *extension);
    template<typename T, typename... Args>
    T *addNewExtension(Args... args)
    {
        // it's impossible that addExtension() returns false: ext is a new object
        auto *ext = new T(args...);
        addExtension(ext);
        return ext;
    }
    bool insertExtension(int index, QXmppClientExtension *extension);
    bool removeExtension(QXmppClientExtension *extension);
    QXmppE2eeExtension *encryptionExtension() const;
    void setEncryptionExtension(QXmppE2eeExtension *);
 
    QList<QXmppClientExtension *> extensions() const;
 
    template<typename T>
    T *findExtension() const
    {
        const QList<QXmppClientExtension *> list = extensions();
        for (auto ext : list) {
            T *extension = qobject_cast<T *>(ext);
            if (extension) {
                return extension;
            }
        }
        return nullptr;
    }
 
    template<typename T>
    int indexOfExtension() const
    {
        auto list = extensions();
        for (int i = 0; i < list.size(); ++i) {
            if (qobject_cast<T *>(list.at(i)) != nullptr) {
                return i;
            }
        }
        return -1;
    }
 
    bool isAuthenticated() const;
    bool isConnected() const;
 
    bool isActive() const;
    void setActive(bool active);
 
    StreamManagementState streamManagementState() const;
 
    QXmppPresence clientPresence() const;
    void setClientPresence(const QXmppPresence &presence);
 
    QXmppConfiguration &configuration();
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    QXmppLogger *logger() const;
    void setLogger(QXmppLogger *logger);
 
    QAbstractSocket::SocketError socketError();
    QString socketErrorString() const;
 
    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
    State state() const;
    QXmppStanza::Error::Condition xmppStreamError();
 
    QXmppTask<QXmpp::SendResult> sendSensitive(QXmppStanza &&, const std::optional<QXmppSendStanzaParams> & = {});
    QXmppTask<QXmpp::SendResult> send(QXmppStanza &&, const std::optional<QXmppSendStanzaParams> & = {});
    QXmppTask<QXmpp::SendResult> reply(QXmppStanza &&stanza, const std::optional<QXmppE2eeMetadata> &e2eeMetadata, const std::optional<QXmppSendStanzaParams> & = {});
    QXmppTask<IqResult> sendIq(QXmppIq &&, const std::optional<QXmppSendStanzaParams> & = {});
    QXmppTask<IqResult> sendSensitiveIq(QXmppIq &&, const std::optional<QXmppSendStanzaParams> & = {});
    QXmppTask<EmptyResult> sendGenericIq(QXmppIq &&, const std::optional<QXmppSendStanzaParams> & = {});
 
#if QXMPP_DEPRECATED_SINCE(1, 1)
    QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppRosterManager>() instead")
    QXmppRosterManager &rosterManager();
 
    QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppVCardManager>() instead")
    QXmppVCardManager &vCardManager();
 
    QT_DEPRECATED_X("Use QXmppClient::findExtension<QXmppVersionManager>() instead")
    QXmppVersionManager &versionManager();
#endif
 
    Q_SIGNAL void connected();
 
    Q_SIGNAL void disconnected();
 
    Q_SIGNAL void error(QXmppClient::Error);
 
    Q_SIGNAL void errorOccurred(const QXmppError &error);
 
    Q_SIGNAL void loggerChanged(QXmppLogger *logger);
 
    Q_SIGNAL void messageReceived(const QXmppMessage &message);
 
    Q_SIGNAL void presenceReceived(const QXmppPresence &presence);
 
    Q_SIGNAL void iqReceived(const QXmppIq &iq);
 
    Q_SIGNAL void sslErrors(const QList<QSslError> &errors);
 
    Q_SIGNAL void stateChanged(QXmppClient::State state);
 
    Q_SIGNAL void credentialsChanged();
 
public Q_SLOTS:
    void connectToServer(const QXmppConfiguration &,
                         const QXmppPresence &initialPresence =
                             QXmppPresence());
    void connectToServer(const QString &jid,
                         const QString &password);
    void disconnectFromServer();
    bool sendPacket(const QXmppNonza &);
    void sendMessage(const QString &bareJid, const QString &message);
 
private:
    QXmppOutgoingClient *stream() const;
    void injectIq(const QDomElement &element, const std::optional<QXmppE2eeMetadata> &e2eeMetadata);
    bool injectMessage(QXmppMessage &&message);
 
    void setIgnoredStreamErrors(const QVector<QXmpp::StreamError> &);
 
    void _q_elementReceived(const QDomElement &element, bool &handled);
    void _q_reconnect();
    void onInternalSocketStateChanged();
    void _q_streamConnected(const QXmpp::Private::SessionBegin &);
    void _q_streamDisconnected();
 
private:
    const std::unique_ptr<QXmppClientPrivate> d;
 
    friend class QXmppClientExtension;
    friend class QXmppCarbonManagerV2;
    friend class QXmppRegistrationManager;
    friend class TestClient;
};
 
#endif  // QXMPPCLIENT_H