nymea-remoteproxy/libnymea-remoteproxyclient/tunnelproxy/tunnelproxysocketserver.h

// SPDX-License-Identifier: LGPL-3.0-or-later

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* nymea-remoteproxy
* Tunnel proxy server for the nymea remote access
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of nymea-remoteproxy.
*
* nymea-remoteproxy 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 3
* of the License, or (at your option) any later version.
*
* nymea-remoteproxy 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with nymea-remoteproxy. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef TUNNELPROXYSOCKETSERVER_H
#define TUNNELPROXYSOCKETSERVER_H

#include <QUrl>
#include <QUuid>
#include <QTimer>
#include <QObject>
#include <QSslError>
#include <QLoggingCategory>

#include "tunnelproxysocket.h"

Q_DECLARE_LOGGING_CATEGORY(dcTunnelProxySocketServer)
Q_DECLARE_LOGGING_CATEGORY(dcTunnelProxySocketServerTraffic)

namespace remoteproxyclient {

class JsonRpcClient;
class ProxyConnection;

class TunnelProxySocketServer : public QObject
{
    Q_OBJECT

    friend class TunnelProxySocket;

public:
    enum State {
        StateConnecting,
        StateHostLookup,
        StateConnected,
        StateInitializing,
        StateRegister,
        StateRunning,
        StateDiconnecting,
        StateDisconnected,
    };
    Q_ENUM(State)

    enum ConnectionType {
        ConnectionTypeWebSocket,
        ConnectionTypeTcpSocket
    };
    Q_ENUM(ConnectionType)

    enum Error {
        ErrorNoError,
        ErrorConnectionError,
        ErrorInvalidAddress,
        ErrorNotConnected,
        ErrorNotRegistered
    };
    Q_ENUM(Error)

    explicit TunnelProxySocketServer(const QUuid &serverUuid, const QString &serverName, QObject *parent = nullptr);
    explicit TunnelProxySocketServer(const QUuid &serverUuid, const QString &serverName, ConnectionType connectionType, QObject *parent = nullptr);
    ~TunnelProxySocketServer();

    bool running() const;

    QAbstractSocket::SocketError error() const;
    Error serverError() const;

    State state() const;

    void ignoreSslErrors();
    void ignoreSslErrors(const QList<QSslError> &errors);

    QUrl serverUrl() const;

    QString remoteProxyServer() const;
    QString remoteProxyServerName() const;
    QString remoteProxyServerVersion() const;
    QString remoteProxyApiVersion() const;

public slots:
    bool startServer(const QUrl &serverUrl);
    void stopServer();

signals:
    void stateChanged(TunnelProxySocketServer::State state);
    void errorOccurred(QAbstractSocket::SocketError error);
    void serverErrorOccurred(Error error);
    void sslErrors(const QList<QSslError> &errors);

    void runningChanged(bool running);

    void clientConnected(TunnelProxySocket *tunnelProxySocket);
    void clientDisconnected(TunnelProxySocket *tunnelProxySocket);

private slots:
    void onConnectionChanged(bool connected);
    void onConnectionDataAvailable(const QByteArray &data);

    void onConnectionSocketError(QAbstractSocket::SocketError error);
    void onConnectionStateChanged(QAbstractSocket::SocketState state);

    // Initialization calls
    void onHelloFinished();
    void onServerRegistrationFinished();

    // Client notifications
    void onTunnelProxyClientConnected(const QString &clientName, const QUuid &clientUuid, const QString &clientPeerAddress, quint16 socketAddress);
    void onTunnelProxyClientDisconnected(quint16 socketAddress);

private:
    // This server information
    QUuid m_serverUuid;
    QString m_serverName;
    ConnectionType m_connectionType = ConnectionTypeTcpSocket;

    // Remote proxy server information
    QString m_remoteProxyServer;
    QString m_remoteProxyServerName;
    QString m_remoteProxyServerVersion;
    QString m_remoteProxyApiVersion;

    bool m_running = false;
    QUrl m_serverUrl;
    QAbstractSocket::SocketError m_error = QAbstractSocket::UnknownSocketError;
    Error m_serverError = ErrorNoError;
    State m_state = StateDisconnected;

    QTimer m_reconnectTimer;
    QTimer m_keepAliveTimer;
    bool m_enabled = false;

    ProxyConnection *m_connection = nullptr;
    JsonRpcClient *m_jsonClient = nullptr;

    QHash<quint16, TunnelProxySocket *> m_tunnelProxySockets;

    QByteArray m_dataBuffer;

    void requestSocketDisconnect(quint16 socketAddress);
    void setupTimers();

    void setState(State state);
    void setRunning(bool running);
    void setError(QAbstractSocket::SocketError error);
    void setServerError(Error error);

    void cleanUp();
};

}

#endif // TUNNELPROXYSOCKETSERVER_H