216 lines
8.8 KiB
C++
216 lines
8.8 KiB
C++
// SPDX-License-Identifier: LGPL-3.0-or-later
|
|
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
*
|
|
* Copyright (C) 2013 - 2024, nymea GmbH
|
|
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
|
|
*
|
|
* This file is part of libnymea-app.
|
|
*
|
|
* libnymea-app 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.
|
|
*
|
|
* libnymea-app 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 libnymea-app. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#ifndef NYMEAJSONRPCCLIENT_H
|
|
#define NYMEAJSONRPCCLIENT_H
|
|
|
|
#include <QObject>
|
|
#include <QVariantMap>
|
|
#include <QPointer>
|
|
#include <QVersionNumber>
|
|
|
|
#include "connection/nymeaconnection.h"
|
|
#include "types/userinfo.h"
|
|
|
|
class JsonRpcReply;
|
|
class Param;
|
|
class Params;
|
|
|
|
class JsonRpcClient : public QObject
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(NymeaConnection::BearerTypes availableBearerTypes READ availableBearerTypes NOTIFY availableBearerTypesChanged)
|
|
Q_PROPERTY(NymeaConnection::ConnectionStatus connectionStatus READ connectionStatus NOTIFY connectionStatusChanged)
|
|
Q_PROPERTY(bool connected READ connected NOTIFY connectedChanged)
|
|
Q_PROPERTY(NymeaHost* currentHost READ currentHost NOTIFY currentHostChanged)
|
|
Q_PROPERTY(Connection* currentConnection READ currentConnection NOTIFY currentConnectionChanged)
|
|
Q_PROPERTY(bool initialSetupRequired READ initialSetupRequired NOTIFY initialSetupRequiredChanged)
|
|
Q_PROPERTY(bool authenticationRequired READ authenticationRequired NOTIFY authenticationRequiredChanged)
|
|
Q_PROPERTY(bool pushButtonAuthAvailable READ pushButtonAuthAvailable NOTIFY pushButtonAuthAvailableChanged)
|
|
Q_PROPERTY(bool authenticated READ authenticated NOTIFY authenticatedChanged)
|
|
Q_PROPERTY(QString serverVersion READ serverVersion NOTIFY handshakeReceived)
|
|
Q_PROPERTY(QString jsonRpcVersion READ jsonRpcVersion NOTIFY handshakeReceived)
|
|
Q_PROPERTY(QUuid serverUuid READ serverUuid NOTIFY handshakeReceived)
|
|
Q_PROPERTY(QString serverName READ serverName NOTIFY serverNameChanged)
|
|
Q_PROPERTY(QString serverQtVersion READ serverQtVersion NOTIFY serverQtVersionChanged)
|
|
Q_PROPERTY(QString serverQtBuildVersion READ serverQtBuildVersion NOTIFY serverQtVersionChanged)
|
|
Q_PROPERTY(QVariantMap certificateIssuerInfo READ certificateIssuerInfo NOTIFY currentConnectionChanged)
|
|
Q_PROPERTY(QVariantMap experiences READ experiences NOTIFY currentConnectionChanged)
|
|
Q_PROPERTY(UserInfo::PermissionScopes permissions READ permissions NOTIFY permissionsChanged)
|
|
|
|
public:
|
|
explicit JsonRpcClient(QObject *parent = nullptr);
|
|
|
|
void registerNotificationHandler(QObject *handler, const QString &nameSpace, const QString &method);
|
|
void unregisterNotificationHandler(QObject *handler);
|
|
|
|
int sendCommand(const QString &method, const QVariantMap ¶ms, QObject *caller = nullptr, const QString &callbackMethod = QString());
|
|
int sendCommand(const QString &method, QObject *caller = nullptr, const QString &callbackMethod = QString());
|
|
|
|
NymeaConnection::BearerTypes availableBearerTypes() const;
|
|
NymeaConnection::ConnectionStatus connectionStatus() const;
|
|
bool connected() const;
|
|
NymeaHost *currentHost() const;
|
|
Connection *currentConnection() const;
|
|
QVariantMap certificateIssuerInfo() const;
|
|
bool initialSetupRequired() const;
|
|
bool authenticationRequired() const;
|
|
bool pushButtonAuthAvailable() const;
|
|
bool authenticated() const;
|
|
QHash<QString, QString> cacheHashes() const;
|
|
// Note: This does not reflect the actual permission scopes of the user but is translated to effective permissions
|
|
// That, is, if the user has the admin permission, all of the other scopes will be set too even if they might not be explicitly set
|
|
UserInfo::PermissionScopes permissions() const;
|
|
|
|
QString serverVersion() const;
|
|
QString jsonRpcVersion() const;
|
|
QUuid serverUuid() const;
|
|
QString serverName() const;
|
|
QString serverQtVersion();
|
|
QString serverQtBuildVersion();
|
|
QVariantMap experiences() const;
|
|
|
|
// ui methods
|
|
Q_INVOKABLE void connectToHost(NymeaHost *host, Connection *connection = nullptr);
|
|
Q_INVOKABLE void disconnectFromHost();
|
|
Q_INVOKABLE void acceptCertificate(const QUuid &serverUuid, const QByteArray &pem);
|
|
Q_INVOKABLE bool tokenExists(const QString &serverUuid) const;
|
|
Q_INVOKABLE void addToken(const QString &serverUuid, const QByteArray &token);
|
|
|
|
Q_INVOKABLE bool ensureServerVersion(const QString &jsonRpcVersion);
|
|
|
|
Q_INVOKABLE int createUser(const QString &username, const QString &password, const QString &displayName, const QString &email);
|
|
Q_INVOKABLE int authenticate(const QString &username, const QString &password, const QString &deviceName);
|
|
Q_INVOKABLE int requestPushButtonAuth(const QString &deviceName);
|
|
|
|
|
|
signals:
|
|
void availableBearerTypesChanged();
|
|
void connectionStatusChanged();
|
|
void connectedChanged(bool connected);
|
|
void currentHostChanged();
|
|
void currentConnectionChanged();
|
|
void handshakeReceived();
|
|
void newSslCertificate();
|
|
void verifyConnectionCertificate(const QString &serverUuid, const QVariantMap &issuerInfo, const QByteArray &pem);
|
|
void initialSetupRequiredChanged();
|
|
void authenticationRequiredChanged();
|
|
void pushButtonAuthAvailableChanged();
|
|
void authenticatedChanged();
|
|
void tokenChanged();
|
|
void invalidMinimumVersion(const QString &actualVersion, const QString &minVersion);
|
|
void invalidMaximumVersion(const QString &actualVersion, const QString &maxVersion);
|
|
void invalidServerUuid(const QUuid &uuid);
|
|
void authenticationFailed();
|
|
void pushButtonAuthFailed();
|
|
void createUserSucceeded();
|
|
void createUserFailed(const QString &error);
|
|
void serverQtVersionChanged();
|
|
void serverNameChanged();
|
|
void permissionsChanged();
|
|
|
|
void responseReceived(const int &commandId, const QVariantMap &response);
|
|
|
|
private slots:
|
|
void onInterfaceConnectedChanged(bool connected);
|
|
void dataReceived(const QByteArray &data);
|
|
|
|
void helloReply(int commandId, const QVariantMap ¶ms);
|
|
|
|
private:
|
|
int m_id;
|
|
// < namespace, method> >
|
|
QHash<QObject *, QString> m_notificationHandlerMethods;
|
|
QMultiHash<QString, QObject *> m_notificationHandlers;
|
|
QHash<int, JsonRpcReply *> m_replies;
|
|
NymeaConnection *m_connection = nullptr;
|
|
|
|
JsonRpcReply *createReply(const QString &method, const QVariantMap ¶ms, QObject *caller, const QString &callback);
|
|
|
|
bool m_connected = false;
|
|
bool m_initialSetupRequired = false;
|
|
bool m_authenticationRequired = false;
|
|
bool m_pushButtonAuthAvailable = false;
|
|
bool m_authenticated = false;
|
|
int m_pendingPushButtonTransaction = -1;
|
|
QUuid m_serverUuid;
|
|
QVersionNumber m_jsonRpcVersion;
|
|
QString m_serverVersion;
|
|
QString m_serverQtVersion;
|
|
QString m_serverQtBuildVersion;
|
|
QByteArray m_token;
|
|
QByteArray m_receiveBuffer;
|
|
QHash<QString, QString> m_cacheHashes;
|
|
QVariantMap m_experiences;
|
|
UserInfo::PermissionScopes m_permissionScopes = UserInfo::PermissionScopeNone;
|
|
QString m_username;
|
|
|
|
void setNotificationsEnabled();
|
|
|
|
// json handler
|
|
Q_INVOKABLE void processAuthenticate(int commandId, const QVariantMap &data);
|
|
Q_INVOKABLE void processCreateUser(int commandId, const QVariantMap &data);
|
|
Q_INVOKABLE void processRequestPushButtonAuth(int commandId, const QVariantMap &data);
|
|
|
|
Q_INVOKABLE void setNotificationsEnabledResponse(int commandId, const QVariantMap ¶ms);
|
|
Q_INVOKABLE void notificationReceived(const QVariantMap &data);
|
|
Q_INVOKABLE void getVersionsReply(int commandId, const QVariantMap &data);
|
|
|
|
void sendRequest(const QVariantMap &request);
|
|
|
|
bool loadPem(const QUuid &serverUud, QByteArray &pem);
|
|
bool storePem(const QUuid &serverUuid, const QByteArray &pem);
|
|
|
|
};
|
|
|
|
|
|
class JsonRpcReply : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit JsonRpcReply(int commandId, QString nameSpace, QString method, QVariantMap params = QVariantMap(), QPointer<QObject> caller = QPointer<QObject>(), const QString &callback = QString());
|
|
~JsonRpcReply();
|
|
|
|
int commandId() const;
|
|
QString nameSpace() const;
|
|
QString method() const;
|
|
QVariantMap params() const;
|
|
QVariantMap requestMap();
|
|
|
|
QPointer<QObject> caller() const;
|
|
QString callback() const;
|
|
|
|
private:
|
|
int m_commandId;
|
|
QString m_nameSpace;
|
|
QString m_method;
|
|
QVariantMap m_params;
|
|
|
|
QPointer<QObject> m_caller;
|
|
QString m_callback;
|
|
};
|
|
|
|
|
|
#endif // NYMEAJSONRPCCLIENT_H
|