MPDeviceBleImpl.h

#ifndef MPDEVICEBLEIMPL_H
#define MPDEVICEBLEIMPL_H

#include "MPDevice.h"
#include "BleCommon.h"
#include "MPBLEFreeAddressProvider.h"
#include "MPMiniToBleNodeConverter.h"

#include <atomic>

class MessageProtocolBLE;

/**
 * @brief The MPDeviceBleImpl class
 * Implementations of only BLE related commands
 * and helper functions
 */
class MPDeviceBleImpl: public QObject
{
    Q_OBJECT

    QT_WRITABLE_PROPERTY(QString, mainMCUVersion, QString())
    QT_WRITABLE_PROPERTY(QString, auxMCUVersion, QString())
    QT_WRITABLE_PROPERTY(int, bundleVersion, 0)
    QT_WRITABLE_PROPERTY(bool, loginPrompt, false)
    QT_WRITABLE_PROPERTY(bool, PINforMMM, false)
    QT_WRITABLE_PROPERTY(bool, storagePrompt, false)
    QT_WRITABLE_PROPERTY(bool, advancedMenu, false)
    QT_WRITABLE_PROPERTY(bool, bluetoothEnabled, false)
    QT_WRITABLE_PROPERTY(bool, knockDisabled, false)
    QT_WRITABLE_PROPERTY(bool, chargingStatus, false)
    QT_WRITABLE_PROPERTY(quint32, platformSerialNumber, 0)

    enum UserSettingsMask : quint8
    {
        LOGIN_PROMPT      = 0x01,
        PIN_FOR_MMM       = 0x02,
        STORAGE_PROMPT    = 0x04,
        ADVANCED_MENU     = 0x08,
        BLUETOOTH_ENABLED = 0x10,
        KNOCK_DISABLED    = 0x20
    };

    struct FreeAddressInfo
    {
        QByteArray addressPackage = {};
        int parentNodeRequested = 0;
        int childNodeRequested = 0;
        int startingPosition = 0;
    };

public:
    MPDeviceBleImpl(MessageProtocolBLE *mesProt, MPDevice *dev);

    bool isFirstPacket(const QByteArray &data);
    bool isLastPacket(const QByteArray &data);

    void getPlatInfo();
    void enforceCategory(int category);
    void getDebugPlatInfo(const MessageHandlerCbData &cb);
    QVector<int> calcDebugPlatInfo(const QByteArray &platInfo);

    void flashMCU(const MessageHandlerCb &cb);
    void uploadBundle(QString filePath, QString password, const MessageHandlerCb &cb, const MPDeviceProgressCb &cbProgress);
    void fetchData(QString filePath, MPCmd::Command cmd);
    inline void stopFetchData() { fetchState = Common::FetchState::STOPPED; }
    void fetchDataFiles();
    void fetchDataFiles(AsyncJobs *jobs, QByteArray addr);
    void addDataFile(const QString& file);
    QList<QString> getDataFiles() const { return m_dataFiles; }
    void deleteFile(QString file, bool isNote, std::function<void(bool)> cb);

    void fetchNotes();
    void fetchNotes(AsyncJobs *jobs, QByteArray addr);
    void fetchNotesLater();
    QList<QString> getNotes() const { return m_notes; }
    void getNoteNode(QString note, std::function<void(bool, QString, QString, QByteArray)> cb);

    bool isNoteAvailable() const;
    void loadNotes(AsyncJobs * jobs, const MPDeviceProgressCb &cbProgress);

    void checkAndStoreCredential(const BleCredential &cred, MessageHandlerCb cb);
    void storeCredential(const BleCredential &cred, MessageHandlerCb cb, AsyncJobs *jobs = nullptr);
    void changePassword(const QByteArray& address, const QString& pwd, MessageHandlerCb cb);
    void getCredential(const QString& service, const QString& login, const QString& reqid, const QString& fallbackService, const MessageHandlerCbData &cb);
    void getTotpCode(const QString& service, const QString& login, const MessageHandlerCbData &cb);
    void getFallbackServiceCredential(AsyncJobs *jobs, const QString& fallbackService, const QString& login, const MessageHandlerCbData &cb);
    BleCredential retrieveCredentialFromResponse(QByteArray response, QString service, QString login) const;
    QString retrieveTotpCodeFromResponse(const QByteArray& response);

    void sendWakeUp();

    void sendResetFlipBit();
    void setCurrentFlipBit(QByteArray &msg);
    void flipMessageBit(QVector<QByteArray> &msg);
    void flipMessageBit(QByteArray &msg);
    /**
     * @brief processReceivedData
     * @param data actual packet from the device
     * @param dataReceived full message data
     * @return true if data is last packet of the message
     */
    bool processReceivedData(const QByteArray& data, QByteArray& dataReceived);

    QVector<QByteArray> processReceivedStartNodes(const QByteArray& data) const;
    QVector<QByteArray> getDataStartNodes(const QByteArray& data) const;
    bool readDataNode(AsyncJobs *jobs, const QByteArray& data, bool isFile = true);
    void createBLEDataChildNodes(MPDevice::ExportPayloadData id, QByteArray& firstAddr, QVector<QByteArray>& miniDataArray);
    bool hasNextAddress(char addr1, char addr2);
    void readExportDataChildNodes(const QJsonArray& nodes, MPDevice::ExportPayloadData id);

    bool isAfterAuxFlash();

    void getUserCategories(const MessageHandlerCbData &cb);
    void setUserCategories(const QJsonObject &categories, const MessageHandlerCbData &cb);
    void fillGetCategory(const QByteArray& data, QJsonObject &categories);
    QByteArray createUserCategoriesMsg(const QJsonObject &categories);
    void createTOTPCredMessage(const QString& service, const QString& login, const QJsonObject& totp);
    bool storeTOTPCreds();

    void readUserSettings(const QByteArray& settings);
    void sendUserSettings();
    void readBatteryPercent(const QByteArray& statusData);
    void getBattery();

    void nihmReconditioning(bool enableRestart, int ratedCapacity);
    void getSecurityChallenge(const QString& key, const MessageHandlerCb &cb);

    void processDebugMsg(const QByteArray& data, bool& isDebugMsg);
    MPBLEFreeAddressProvider& getFreeAddressProvider() { return freeAddressProv; }

    void updateChangeNumbers(AsyncJobs *jobs, quint8 flags);

    QJsonObject getUserCategories() const { return m_categories; }
    void updateUserCategories(const QJsonObject &categories);
    bool areCategoriesFetched() const { return m_categoriesFetched; }
    bool isUserCategoriesChanged(const QJsonObject &categories) const;
    void setImportUserCategories(const QJsonObject &categories);
    void importUserCategories();
    void setNodeCategory(MPNode* node, int category);
    void setNodeKeyAfterLogin(MPNode* node, int key);
    void setNodeKeyAfterPwd(MPNode* node, int key);
    void setNodePwdBlankFlag(MPNode* node);
    bool setNodePointedToAddr(MPNode* node, QByteArray addr);
    bool setNodeMultipleDomains(MPNode* node, const QString& domains);

    QList<QByteArray> getFavorites(const QByteArray& data);

    QByteArray getStartAddressToSet(const QVector<QByteArray>& startNodeArray, Common::AddressType addrType) const;

    void readLanguages(bool onlyCheck, const MessageHandlerCb &cb);

    void loadWebAuthnNodes(AsyncJobs * jobs, const MPDeviceProgressCb &cbProgress);
    void appendLoginNode(MPNode* loginNode, MPNode* loginNodeClone, Common::AddressType addrType);
    void appendLoginChildNode(MPNode* loginChildNode, MPNode* loginChildNodeClone, Common::AddressType addrType);
    void appendDataNode(MPNode* loginNode, MPNode* loginNodeClone, Common::DataAddressType addrType);
    void appendDataChildNode(MPNode* loginChildNode, MPNode* loginChildNodeClone, Common::DataAddressType addrType);
    void generateExportData(QJsonArray& exportTopArray);

    static char toChar(const QJsonValue &val) { return static_cast<char>(val.toInt()); }
    void addUnknownCardPayload(const QJsonValue &val);
    void fillAddUnknownCard(const QJsonArray& dataArray);
    void addUserIdPlaceholder(QByteArray &array);
    void fillMiniExportPayload(QByteArray &unknownCardPayload);

    void convertMiniToBleNode(QByteArray &array, bool isData);

    void storeFileData(int current, AsyncJobs * jobs, const MPDeviceProgressCb &cbProgress, bool isFile = true);

    void sendInitialStatusRequest();
    void checkNoBundle(Common::MPStatus& status, Common::MPStatus prevStatus);
    bool isNoBundle(MPCmd::Command cmd);

    bool isFirstMessageWritten() const { return m_isFirstMessageWritten; }
    void handleFirstBluetoothMessage(MPCommand& cmd);

    void activateEnforceLayout() { m_enforceLayout = true; }
    void enforceLayout();

    bool resetDefaultSettings();

    void setBleName(QString name, std::function<void(bool)> cb);
    void getBleName(const MessageHandlerCbData &cb);
    QString getBleNameFromArray(const QByteArray& arr) const;

    void setSerialNumber(quint32 serialNum, std::function<void(bool)> cb);

    Common::SubdomainSelection getForceSubdomainSelection() const;

signals:
    void userSettingsChanged(QJsonObject settings);
    void bleDeviceLanguage(const QJsonObject& langs);
    void bleKeyboardLayout(const QJsonObject& layouts);
    void batteryPercentChanged(int batteryPct);
    void userCategoriesFetched(QJsonObject categories);
    void notesFetched();
    void nimhReconditionFinished(bool success, QString response, bool restarted = false);
    void changeBleName(const QString& name);

private slots:
    void handleLongMessageTimeout();

public slots:
    void fetchCategories();
    void handleFirstBluetoothMessageTimeout();

private:
    void checkDataFlash(const QByteArray &data, QElapsedTimer *timer, AsyncJobs *jobs, QString filePath, const MPDeviceProgressCb &cbProgress);
    void sendBundleToDevice(QString filePath, AsyncJobs *jobs, const MPDeviceProgressCb &cbProgress);
    void writeFetchData(QFile *file, MPCmd::Command cmd);
    inline bool isBundleFileReadable(const QString& filePath);

    QByteArray createStoreCredMessage(const BleCredential &cred);
    QByteArray createGetCredMessage(QString service, QString login);
    QByteArray createCheckCredMessage(const BleCredential &cred);
    QByteArray createCredentialMessage(const CredMap &credMap);
    QByteArray createChangePasswordMsg(const QByteArray& address, QString pwd);
    QByteArray createUploadPasswordMessage(const QString& uploadPassword);

    void createAndAddCustomJob(QString name, std::function<void()> fn);

    inline void flipBit();
    void resetFlipBit();

    MessageProtocolBLE *bleProt;
    MPDevice *mpDev;
    Common::FetchState fetchState = Common::FetchState::STOPPED;

    quint8 m_flipBit = 0x00;
    quint8 m_currentUserSettings = 0x00;
    QString m_debugMsg = "";

    MPBLEFreeAddressProvider freeAddressProv;
    QJsonObject m_categories;
    QJsonObject m_categoriesToImport;
    bool m_categoriesFetched = false;
    QJsonObject m_deviceLanguages;
    QJsonObject m_keyboardLayouts;
    MPMiniToBleNodeConverter m_bleNodeConverter;
    QList<QByteArray> mmmTOTPStoreArray;

    static constexpr int INVALID_BATTERY = -1;
    int m_battery = INVALID_BATTERY;

    bool m_noBundle = false;
    QList<MPCmd::Command> m_noBundleCommands;

    bool m_isFirstMessageWritten = false;
    QList<QString> m_dataFiles;
    QList<QString> m_notes;
    std::atomic_bool m_fetchingNotes = {false};

    bool m_enforceLayout = false;
    quint32 m_nimhResultSec = 0;
    quint32 m_nimhRestartUnderSec = RECONDITION_RESTART_UNDER_SECS_STOCK;

    int m_miniFilePartCounter = 0;

    static int s_LangNum;
    static int s_LayoutNum;

    static constexpr quint8 MESSAGE_FLIP_BIT = 0x80;
    static constexpr quint8 MESSAGE_ACK_AND_PAYLOAD_LENGTH = 0x7F;
    static constexpr int BUNBLE_DATA_WRITE_SIZE = 256;
    static constexpr int BUNBLE_DATA_ADDRESS_SIZE = 4;
    static constexpr int USER_CATEGORY_COUNT = 4;
    static constexpr int USER_CATEGORY_LENGTH = 66;
    static constexpr int FAV_DATA_SIZE = 4;
    static constexpr int FAV_NUMBER = 50;
    static constexpr int LONG_MESSAGE_TIMEOUT_MS = 2000;
    static constexpr int BLUETOOTH_FIRST_MSG_TIMEOUT_MS = 4000;
    static constexpr int FIRST_PACKET_PAYLOAD_SIZE = 58;
    static constexpr int PAYLOAD_SIZE = 62;
    static constexpr int INVALID_LAYOUT_LANG_SIZE = 0xFFFF;
    const QString AFTER_AUX_FLASH_SETTING = "settings/after_aux_flash";
    static constexpr int UNKNOWN_CARD_PAYLOAD_SIZE = 72;
    const static char ZERO_BYTE = static_cast<char>(0x00);
    const static int BLE_DATA_BLOCK_SIZE = 512;
    const static int FIRST_DATA_STARTING_ADDR = 10;
    const static int STATUS_MSG_SIZE_WITH_BATTERY = 5;
    const static int BATTERY_BYTE = 1;
    const static int BATTERY_CHARGING_BIT = 0x80;
    const static int SECRET_KEY_LENGTH = 64;
    static constexpr int UPLOAD_PASSWORD_BYTE_SIZE = 16;
    static constexpr int DATA_FETCH_NO_NEXT_ADDR_SIZE = 2;
    static constexpr int RECONDITION_RESPONSE_SIZE = 4;
    static constexpr int NEXT_ADDRESS_STARTING = 2;
    static constexpr int MINI_FILE_FULL_SIZE_LENGTH = 4;
    static constexpr int MINI_FILE_BLOCK_SIZE = 128;
    static constexpr int FORCE_SUBDOMAIN_BUNDLE_VERSION = 8;
    static constexpr int SET_BLE_NAME_BUNDLE_VERSION = 9;
    static constexpr int WAKEUP_DEVICE_BUNDLE_VERSION = 10;
    static constexpr int POINTED_TO_ADDR_SIZE = 2;
    static constexpr int PLATFORM_SERIAL_NUM_FIRST_BYTE = 16;    
    static constexpr int STOCK_BATTERY_CAPACITY_MAH = 300;
    static constexpr int RECONDITION_RESTART_UNDER_SECS_STOCK = 2500;
    const QByteArray DEFAULT_BUNDLE_PASSWORD = "\x63\x44\x31\x91\x3a\xfd\x23\xff\xb3\xac\x93\x69\x22\x5b\xf3\xc0";
    const QString DEFAULT_BLE_NAME = "Mooltipass Mini BLE";
};

#endif // MPDEVICEBLEIMPL_H