QXmppOutgoingClient.h

// SPDX-FileCopyrightText: 2010 Manjeet Dahiya <manjeetdahiya@gmail.com>
// SPDX-FileCopyrightText: 2010 Jeremy Lainé <jeremy.laine@m4x.org>
// SPDX-FileCopyrightText: 2020 Linus Jahn <lnj@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#ifndef QXMPPOUTGOINGCLIENT_H
#define QXMPPOUTGOINGCLIENT_H

#include "QXmppAuthenticationError.h"
#include "QXmppBindError.h"
#include "QXmppClient.h"
#include "QXmppPromise.h"
#include "QXmppStanza.h"
#include "QXmppStreamError.h"

#include <QAbstractSocket>

class QDomElement;
class QSslError;
class QSslSocket;

class QXmppConfiguration;
class QXmppPresence;
class QXmppIq;
class QXmppMessage;
class QXmppStreamFeatures;
class QXmppOutgoingClientPrivate;
class TestClient;

namespace QXmpp::Private {
class C2sStreamManager;
class CarbonManager;
class CsiManager;
class OutgoingIqManager;
class PingManager;
class SendDataInterface;
class StreamAckManager;
class XmppSocket;
struct Bind2Request;
struct Bind2Bound;
struct SmEnabled;
struct SmFailed;
struct SmResumed;
struct StreamErrorElement;
struct StreamOpen;

enum HandleElementResult {
    Accepted,
    Rejected,
    Finished,
};

enum class AuthenticationMethod {
    NonSasl,
    Sasl,
    Sasl2,
};

struct SessionBegin {
    bool smEnabled;
    bool smResumed;
    bool bind2Used;
    bool fastTokenChanged;
    AuthenticationMethod authenticationMethod;
};

struct SessionEnd {
    bool smCanResume;
};
}  // namespace QXmpp::Private

namespace QXmpp::Private::Sasl2 {
struct Authenticate;
struct StreamFeature;
struct Success;
}  // namespace QXmpp::Private::Sasl2

// The QXmppOutgoingClient class represents an outgoing XMPP stream to an XMPP server.
class QXMPP_EXPORT QXmppOutgoingClient : public QXmppLoggable
{
    Q_OBJECT

public:
    using IqResult = std::variant<QDomElement, QXmppError>;
    using ConnectionError = std::variant<QAbstractSocket::SocketError, QXmpp::TimeoutError, QXmpp::StreamError, QXmpp::AuthenticationError, QXmpp::BindError>;
    static constexpr QStringView TaskName = u"client session";

    explicit QXmppOutgoingClient(QObject *parent);
    ~QXmppOutgoingClient() override;

    void connectToHost();
    void disconnectFromHost();
    bool isAuthenticated() const;
    bool isConnected() const;
    QXmppTask<IqResult> sendIq(QXmppIq &&);

    QXmppStanza::Error::Condition xmppStreamError();

    QXmppConfiguration &configuration();

    QXmpp::Private::XmppSocket &xmppSocket() const;
    QXmpp::Private::StreamAckManager &streamAckManager() const;
    QXmpp::Private::OutgoingIqManager &iqManager() const;
    QXmpp::Private::C2sStreamManager &c2sStreamManager() const;
    QXmpp::Private::CarbonManager &carbonManager() const;
    QXmpp::Private::CsiManager &csiManager() const;

    Q_SIGNAL void connected(const QXmpp::Private::SessionBegin &);

    Q_SIGNAL void disconnected(const QXmpp::Private::SessionEnd &);

    Q_SIGNAL void errorOccurred(const QString &text, const QXmppOutgoingClient::ConnectionError &details, QXmppClient::Error oldError);

    Q_SIGNAL void elementReceived(const QDomElement &element, bool &handled);

    Q_SIGNAL void presenceReceived(const QXmppPresence &);

    Q_SIGNAL void messageReceived(const QXmppMessage &);

    Q_SIGNAL void iqReceived(const QXmppIq &);

    Q_SIGNAL void sslErrors(const QList<QSslError> &errors);

private:
    void handleStart();
    void handleStream(const QXmpp::Private::StreamOpen &stream);
    void handlePacketReceived(const QDomElement &element);
    QXmpp::Private::HandleElementResult handleElement(const QDomElement &nodeRecv);
    void handleStreamFeatures(const QXmppStreamFeatures &features);
    void handleStreamError(const QXmpp::Private::StreamErrorElement &streamError);
    bool handleStanza(const QDomElement &);
    bool handleStarttls(const QXmppStreamFeatures &features);

    void handleSocketDisconnected();
    void handleSocketError(const QString &text, std::variant<QXmpp::StreamError, QAbstractSocket::SocketError>);
    void handleSocketSslErrors(const QList<QSslError> &);

    void startSasl2Auth(const QXmpp::Private::Sasl2::StreamFeature &sasl2Feature);
    void startNonSaslAuth();
    void startSmResume();
    void startSmEnable();
    void startResourceBinding();
    void openSession();
    void closeSession();
    void setError(const QString &text, ConnectionError &&details);
    void throwKeepAliveError();

    // for unit tests, see TestClient
    void enableStreamManagement(bool resetSequenceNumber);
    bool handleIqResponse(const QDomElement &);

    friend class QXmppOutgoingClientPrivate;
    friend class QXmpp::Private::PingManager;
    friend class QXmpp::Private::C2sStreamManager;
    friend class QXmppRegistrationManager;
    friend class TestClient;

    const std::unique_ptr<QXmppOutgoingClientPrivate> d;
};

namespace QXmpp::Private {

class C2sStreamManager
{
public:
    using Result = std::variant<Success, QXmppError>;
    static constexpr QStringView TaskName = u"stream management";

    explicit C2sStreamManager(QXmppOutgoingClient *q);

    HandleElementResult handleElement(const QDomElement &);
    bool hasResumeAddress() const { return m_canResume && !m_resumeHost.isEmpty() && m_resumePort; }
    std::pair<QString, quint16> resumeAddress() const { return { m_resumeHost, m_resumePort }; }
    void onStreamStart();
    void onStreamFeatures(const QXmppStreamFeatures &);
    void onStreamClosed();
    void onSasl2Authenticate(Sasl2::Authenticate &auth, const Sasl2::StreamFeature &feature);
    void onSasl2Success(const Sasl2::Success &success);
    void onBind2Request(Bind2Request &request, const std::vector<QString> &bind2Features);
    void onBind2Bound(const Bind2Bound &);
    bool canResume() const { return m_canResume; }
    bool enabled() const { return m_enabled; }
    bool streamResumed() const { return m_streamResumed; }
    bool canRequestResume() const { return m_smAvailable && !m_enabled && m_canResume; }
    QXmppTask<void> requestResume();
    bool canRequestEnable() const { return m_smAvailable && !m_enabled; }
    QXmppTask<void> requestEnable();
    bool hasOngoingRequest() const { return !std::holds_alternative<NoRequest>(m_request); }

private:
    friend class ::TestClient;

    void onEnabled(const SmEnabled &enabled);
    void onEnableFailed(const SmFailed &failed);
    void onResumed(const SmResumed &resumed);
    void onResumeFailed(const SmFailed &failed);
    bool setResumeAddress(const QString &address);
    void setEnabled(bool enabled) { m_enabled = enabled; }
    void setResumed(bool resumed) { m_streamResumed = resumed; }

    struct NoRequest { };
    struct ResumeRequest {
        QXmppPromise<void> p;
    };
    struct EnableRequest {
        QXmppPromise<void> p;
    };

    QXmppOutgoingClient *q;

    std::variant<NoRequest, ResumeRequest, EnableRequest> m_request;
    bool m_smAvailable = false;
    QString m_smId;
    bool m_canResume = false;
    QString m_resumeHost;
    quint16 m_resumePort = 0;
    bool m_enabled = false;
    bool m_streamResumed = false;
};

// XEP-0280: Message Carbons
class CarbonManager
{
public:
    void setEnableViaBind2(bool enable) { m_enableViaBind2 = enable; }
    bool enabled() const { return m_enabled; }
    void onBind2Request(Bind2Request &request, const std::vector<QString> &bind2Features);
    void onSessionOpened(const SessionBegin &session);

private:
    // whether to enable carbons via bind2 if available
    bool m_enableViaBind2 = false;
    // whether carbons have been enabled via bind2
    bool m_enabled = false;
    bool m_requested = false;
};

// XEP-0352: Client State Indication
class CsiManager
{
public:
    enum State {
        Active,
        Inactive,
    };

    explicit CsiManager(QXmppOutgoingClient *client);

    State state() const { return m_state; }
    void setState(State);
    void onSessionOpened(const SessionBegin &);
    void onStreamFeatures(const QXmppStreamFeatures &);
    void onBind2Request(Bind2Request &request, const std::vector<QString> &bind2Features);

private:
    void sendState();

    QXmppOutgoingClient *m_client;
    State m_state = Active;
    bool m_synced = true;
    bool m_featureAvailable = false;
    bool m_bind2InactiveSet = false;
};

}  // namespace QXmpp::Private

#endif  // QXMPPOUTGOINGCLIENT_H