WSClient.h

/******************************************************************************
 **  Copyright (c) Raoul Hecky. All Rights Reserved.
 **
 **  Moolticute is free software; you can redistribute it and/or modify
 **  it under the terms of the GNU General Public License as published by
 **  the Free Software Foundation; either version 3 of the License, or
 **  (at your option) any later version.
 **
 **  Moolticute 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 General Public License for more details.
 **
 **  You should have received a copy of the GNU General Public License
 **  along with Foobar; if not, write to the Free Software
 **  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 **
 ******************************************************************************/
#ifndef WSCLIENT_H
#define WSCLIENT_H

#include <QtCore>
#include <QWebSocket>
#include <QJsonDocument>
#include "Common.h"
#include "QtHelper.h"

class SettingsGuiHelper;

class WSClient: public QObject
{
    Q_OBJECT

    QT_WRITABLE_PROPERTY(bool, connected, false)
    QT_WRITABLE_PROPERTY(Common::MPStatus, status, Common::UnknownStatus)
    QT_WRITABLE_PROPERTY(bool, memMgmtMode, false)

    QT_WRITABLE_PROPERTY(Common::MPHwVersion, mpHwVersion, Common::MP_Unknown)
    QT_WRITABLE_PROPERTY(QString, fwVersion, QString())
    QT_WRITABLE_PROPERTY(quint32, hwSerial, 0)
    QT_WRITABLE_PROPERTY(int, hwMemory, 0)

    QT_WRITABLE_PROPERTY(qint64, uid, -1)

    QT_WRITABLE_PROPERTY(QString, cardId, QString())
    QT_WRITABLE_PROPERTY(int, credentialsDbChangeNumber, 0)
    QT_WRITABLE_PROPERTY(int, dataDbChangeNumber, 0)

    QT_WRITABLE_PROPERTY(QString, mainMCUVersion, QString())
    QT_WRITABLE_PROPERTY(QString, auxMCUVersion, QString())
    QT_WRITABLE_PROPERTY(int, bundleVersion, 0)
    QT_WRITABLE_PROPERTY(bool, advancedMenu, false)

    QT_WRITABLE_PROPERTY(quint32, platformSerial, 0)

public:
    explicit WSClient(QObject *parent = nullptr);
    ~WSClient();

    void openWebsocket();
    void closeWebsocket();

    QJsonObject &getMemoryData() { return memData; }
    QJsonArray &getFilesCache() { return filesCache; }

    bool isMPMini() const;

    bool isMPBLE() const;

    bool isConnected() const;

    bool isDeviceConnected() const;

    bool isCredMirroringAvailable() const;

    bool isMultipleDomainsAvailable() const;

    bool requestDeviceUID(const QByteArray &key);

    void sendEnterMMRequest(bool wantData = false, bool wantFido = false);
    void sendLeaveMMRequest();

    void sendFetchNotes();

    void addOrUpdateCredential(const QString &service, const QString &login,
                               const QString &password, const QString &description = {});

    void requestPassword(const QString &service, const QString &login);

    void requestDataFile(const QString &service);
    void requestDeleteDataFile(const QString &file);
    void sendDataFile(const QString &service, const QByteArray &data, bool isFile = true);
    void deleteDataFilesAndLeave(const QStringList &services, const QStringList &notes);
    void deleteFidoAndLeave(const QList<FidoCredential> &fidoCredentials);

    void requestNote(const QString &noteName);
    void requestDeleteNoteFile(const QString &note);

    void requestResetCard();
    void requestAvailableUserNumber();

    void serviceExists(bool isDatanode, const QString &service);

    void sendCredentialsMM(const QJsonArray &creds);

    void exportDbFile(const QString &encryption);
    void importDbFile(const QByteArray &fileData, bool noDelete);
    void importCSVFile(const QList<QStringList> &fileData);

    void sendListFilesCacheRequest();
    void sendRefreshFilesCacheRequest();

    void sendPlatInfoRequest();
    void sendFlashMCU();
    void sendUploadBundle(QString bundleFilePath, QString password);
    void sendFetchData(QString fileName, Common::FetchType fetchType);
    void sendStopFetchData();
    void sendGetUserCategories();
    void sendSetUserCategories(const QString& cat1, const QString& cat2, const QString& cat3, const QString& cat4);
    void sendUserSettingsRequest();
    void sendLoadParams();
    void sendBatteryRequest();
    void sendBleNameRequest();
    void sendCurrentCategory(int category);
    void sendNiMHReconditioning(bool enableRestart, int ratedCapacity);
    void sendSecurityChallenge(QString str);
    void sendSetBleName(QString name);
    void sendSetSerialNumber(uint serialNum);

    void sendChangedParam(const QString& paramName, int value);

    inline bool isFw12() const { return isFwVersion(12); }
    inline bool isFw13() const { return isFwVersion(13); }

    void requestBleKeyboardLayout(bool onlyCheck);

    void sendLockDevice();
    void sendInformLocked();
    void sendInformUnlocked();
    SettingsGuiHelper* settingsHelper();

    bool areSettingsFetched() const { return m_settingsFetched; };

signals:
    void wsConnected();
    void wsDisconnected();
    void memoryDataChanged();
    void passwordUnlocked(const QString & service, const QString & login, const QString & password, bool success);
    void credentialsUpdated(const QString & service, const QString & login, const QString & description, bool success, const QString& msg);
    void showAppRequested();
    void progressChanged(int total, int current, QString statusMsg);
    void memcheckFinished(bool success, int freeBlocks = 0, int totalBlocks = 0);
    void dataFileRequested(const QString &service, const QByteArray &data, bool success);
    void dataFileSent(const QString &service, bool success);
    void dataFileDeleted(const QString &service, bool success);
    void credentialsExists(const QString &service, bool exists);
    void dataNodeExists(const QString &service, bool exists);
    void dbExported(const QByteArray &fileData, bool success);
    void dbImported(bool success, QString message);
    void memMgmtModeFailed(int errCode, QString errMsg);
    void filesCacheChanged(bool isInSync);
    void cardDbMetadataChanged(QString cardId, int credentialsDbChangeNumber, int dataDbChangeNumber);
    void cardResetFinished(bool successfully);
    void displayStatusWarning();
    void displayDebugPlatInfo(int auxMajor, int auxMinor, int mainMajor, int mainMinor);
    void displayUploadBundleResult(bool success);
    void displayAvailableUsers(const QString& num);
    void displayUserCategories(const QString& cat1, const QString& cat2, const QString& cat3, const QString& cat4);
    void updateCurrentCategories(const QString& cat1, const QString& cat2, const QString& cat3, const QString& cat4);
    void updateUserSettingsOnUI(const QJsonObject& userSettings);
    void deviceConnected();
    void deviceDisconnected();
    void deleteDataNodesFinished();
    void updateBLEDeviceLanguage(const QJsonObject& langs);
    void updateBLEKeyboardLayout(const QJsonObject& layouts);
    void updateBatteryPercent(int battery);
    void updateChargingStatus(int charging);
    void challengeResultReceived(QString result);
    void challengeResultFailed();
    void reconditionFinished(bool success, double dischargeTime, bool restarted);
    void deleteFidoNodesFailed();
    void showExportPrompt();
    void displayMiniImportWarning();

    void notesFetched(const QJsonArray& notes);
    void noteReceived(const QString &note, const QByteArray &data, bool success);
    void noteSaved(const QString &note, bool success);
    void noteDeleted(bool success, const QString& note);

    void fileDeleted(bool success, const QString& file);

    void bleNameChanged(const QString& name);

    void serialNumberChanged(bool success, int serialNumber);

public slots:
    void sendJsonData(const QJsonObject &data);
    void queryRandomNumbers();
    void sendLoginJson(QString message, QString loginName);
    void sendDomainJson(QString message, QString serviceName);

private slots:
    void onWsConnected();
    void onWsDisconnected();
    void onWsError();
    void onTextMessageReceived(const QString &message);

private:
    bool isFwVersion(int version) const;

    QWebSocket *wsocket = nullptr;

    QJsonObject memData;
    QJsonArray filesCache;

    SettingsGuiHelper* m_settingsHelper = nullptr;

    QTimer *randomNumTimer = nullptr;
    QString HIBP_COMPROMISED_FORMAT = tr("this password has been compromised %1 times.");
    bool m_settingsFetched = true;
};

#endif // WSCLIENT_H