Merge pull request #1077 from deXol/developBLEHandleNotFlashedDevice

[BLE] Add option to correct serial number

Author: limpkin

src/Common.h

@@ -357,6 +357,7 @@ class Common
     static const int BLE_BUNDLE_WITH_MIRRORING = 11;
     static const int BLE_BUNDLE_WITH_MULT_DOMAINS = 11;
     static const char ZERO_BYTE = static_cast<char>(0x00);
+    static const int ALPHABET_SIZE = 26;
     static QByteArray NOT_SET_ADDR;
 };
 

src/MPDeviceBleImpl.cpp

@@ -48,6 +48,7 @@ void MPDeviceBleImpl::getPlatInfo()
     connect(jobs, &AsyncJobs::finished, [this](const QByteArray &data)
     {
         QByteArray response = bleProt->getFullPayload(data);
+        const auto messageSize = bleProt->getMessageSize(data);
         const auto mainMajor = bleProt->toIntFromLittleEndian(static_cast<quint8>(response[0]), static_cast<quint8>(response[1]));
         const auto mainMinor = bleProt->toIntFromLittleEndian(static_cast<quint8>(response[2]), static_cast<quint8>(response[3]));
         set_mainMCUVersion(QString::number(mainMajor) + "." + QString::number(mainMinor));
@@ -63,6 +64,16 @@ void MPDeviceBleImpl::getPlatInfo()
         mpDev->set_flashMbSize(memorySize);
         const auto bundleVersion = bleProt->toIntFromLittleEndian(static_cast<quint8>(response[14]), static_cast<quint8>(response[15]));
         set_bundleVersion(bundleVersion);
+        if (messageSize > PLATFORM_SERIAL_NUM_FIRST_BYTE)
+        {
+            const auto serialPlatformLower = bleProt->toIntFromLittleEndian(static_cast<quint8>(response[PLATFORM_SERIAL_NUM_FIRST_BYTE]),
+                                                                            static_cast<quint8>(response[PLATFORM_SERIAL_NUM_FIRST_BYTE+1]));
+            const auto serialPlatformUpper = bleProt->toIntFromLittleEndian(static_cast<quint8>(response[PLATFORM_SERIAL_NUM_FIRST_BYTE+2]),
+                                                                            static_cast<quint8>(response[PLATFORM_SERIAL_NUM_FIRST_BYTE+3]));
+            quint32 serialPlatformNum = serialPlatformLower;
+            serialPlatformNum |= static_cast<quint32>((serialPlatformUpper<<16));
+            set_platformSerialNumber(serialPlatformNum);
+        }
     });
 
     mpDev->enqueueAndRunJob(jobs);
@@ -1960,6 +1971,26 @@ QString MPDeviceBleImpl::getBleNameFromArray(const QByteArray &arr) const
     return bleProt->toQString(arr);
 }
 
+void MPDeviceBleImpl::setSerialNumber(quint32 serialNum, std::function<void (bool)> cb)
+{
+    QByteArray serialNumArr = bleProt->toLittleEndianFromInt32(serialNum);
+    auto *jobs = new AsyncJobs(QString("Set Serial number"), this);
+    jobs->append(new MPCommandJob(mpDev, MPCmd::SET_SERIAL_NUMBER,
+                                  serialNumArr,
+                                  [this, serialNum, cb](const QByteArray &data, bool &) -> bool
+    {
+        if (bleProt->getFirstPayloadByte(data) != MSG_SUCCESS)
+        {
+            qWarning() << "Set serial number to: " << serialNum << " failed";
+            cb(false);
+            return false;
+        }
+        cb(true);
+        return true;
+    }));
+    mpDev->enqueueAndRunJob(jobs);
+}
+
 Common::SubdomainSelection MPDeviceBleImpl::getForceSubdomainSelection() const
 {
     QSettings s;

src/MPDeviceBleImpl.h

@@ -27,6 +27,7 @@ class MPDeviceBleImpl: public QObject
     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
     {
@@ -177,6 +178,8 @@ class MPDeviceBleImpl: public QObject
     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:
@@ -280,6 +283,7 @@ public slots:
     static constexpr int FORCE_SUBDOMAIN_BUNDLE_VERSION = 8;
     static constexpr int SET_BLE_NAME_BUNDLE_VERSION = 9;
     static constexpr int POINTED_TO_ADDR_SIZE = 2;
+    static constexpr int PLATFORM_SERIAL_NUM_FIRST_BYTE = 16;
     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";
 };

src/MainWindow.cpp

@@ -41,6 +41,7 @@ const QString MainWindow::MANUAL_STRING = "<a href=\"%1\">" + tr("User Manual")
 const QString MainWindow::BLE_MANUAL_URL = "https://raw.githubusercontent.com/mooltipass/minible/master/MooltipassMiniBLEUserManual.pdf";
 const QString MainWindow::MINI_MANUAL_URL = "https://raw.githubusercontent.com/limpkin/mooltipass/master/user_manual_mini.pdf";
 const QString MainWindow::BUNDLE_OUTDATED_TEXT = tr("New bundle update available <a href=\"https://www.themooltipass.com/updates/index.php?sn=%1&bundlev=%2\">here.</a>");
+const QString MainWindow::SERIAL_STR_START = "MOOLTIP";
 
 void MainWindow::initHelpLabels()
 {
@@ -130,6 +131,11 @@ MainWindow::MainWindow(WSClient *client, DbMasterController *mc, QWidget *parent
     ui->labelAboutAuxMCU->setText(tr("Aux MCU version:"));
     ui->labelAboutMainMCU->setText(tr("Main MCU version:"));
 
+    ui->widgetNotFlashedWarning->hide();
+    ui->labelNotFlashedWarningIcon->setPixmap(AppGui::qtAwesome()->icon(fa::warning).pixmap(QSize(20, 20)));
+    ui->labelSerialNumberIncorrect->setStyleSheet("QLabel {color: blue;}");
+    connect(ui->labelSerialNumberIncorrect, &ClickableLabel::clicked, this, &MainWindow::onIncorrectSerialNumberClicked);
+
     ui->pbBleBattery->setStyleSheet("border: 1px solid black");
     ui->pbBleBattery->hide();
 
@@ -484,6 +490,7 @@ MainWindow::MainWindow(WSClient *client, DbMasterController *mc, QWidget *parent
     connect(wsClient, &WSClient::fwVersionChanged, this, &MainWindow::updateSerialInfos);
     connect(wsClient, &WSClient::hwSerialChanged, this, &MainWindow::updateSerialInfos);
     connect(wsClient, &WSClient::hwMemoryChanged, this, &MainWindow::updateSerialInfos);
+    connect(wsClient, &WSClient::platformSerialChanged, this, &MainWindow::updateSerialInfos);
     connect(wsClient, &WSClient::bundleVersionChanged, this, &MainWindow::displayBundleVersion);
     connect(wsClient, &WSClient::bundleVersionChanged, this, &MainWindow::sendRequestNotes);
     connect(wsClient, &WSClient::bundleVersionChanged, this, &MainWindow::onBundleVersionChanged);
@@ -628,6 +635,8 @@ MainWindow::MainWindow(WSClient *client, DbMasterController *mc, QWidget *parent
 
     connect(wsClient, &WSClient::bleNameChanged, this, &MainWindow::onBleNameChanged);
 
+    connect(wsClient, &WSClient::serialNumberChanged, this, &MainWindow::onSerialNumberChanged);
+
     wsClient->settingsHelper()->setMainWindow(this);
 #ifdef Q_OS_WIN
     const auto keyboardLayoutWidth = 150;
@@ -957,14 +966,24 @@ void MainWindow::updateSerialInfos() {
     if(connected)
     {
         ui->labelAboutFwVersValue->setText(wsClient->get_fwVersion());
-        ui->labelAbouHwSerialValue->setText(wsClient->get_hwSerial() > 0 ? QString::number(wsClient->get_hwSerial()) : NONE_STRING);
+        auto serialNum = QString::number(wsClient->get_hwSerial());
+        ui->labelAbouHwSerialValue->setText(wsClient->get_hwSerial() > 0 ? serialNum : NONE_STRING);
         ui->labelAbouHwMemoryValue->setText(wsClient->get_hwMemory() > 0 ? tr("%1Mb").arg(wsClient->get_hwMemory()): NONE_STRING);
         displayMCUVersion(wsClient->isMPBLE());
         //When ble is detected not displaying fw version
         ui->labelAboutFwVers->setVisible(!wsClient->isMPBLE());
         ui->labelAboutFwVersValue->setVisible(!wsClient->isMPBLE());
         ui->label_UserManual->setText(MANUAL_STRING.arg(wsClient->isMPBLE() ? BLE_MANUAL_URL : MINI_MANUAL_URL));
         ui->label_UserManual->show();
+        if (wsClient->isMPBLE() && serialNum > STARTING_NOT_FLASHED_SERIAL &&
+                wsClient->get_hwSerial() != wsClient->get_platformSerial())
+        {
+            ui->widgetNotFlashedWarning->show();
+        }
+        else
+        {
+            ui->widgetNotFlashedWarning->hide();
+        }
     }
     else
     {
@@ -977,6 +996,7 @@ void MainWindow::updateSerialInfos() {
         wsClient->set_auxMCUVersion(NONE_STRING);
         wsClient->set_mainMCUVersion(NONE_STRING);
         wsClient->set_bundleVersion(0);
+        wsClient->set_platformSerial(0);
         ui->label_UserManual->hide();
     }
 }
@@ -1923,6 +1943,46 @@ void MainWindow::fillInitialCurrentCategories()
     ui->comboBoxBleCurrentCategory->blockSignals(false);
 }
 
+bool MainWindow::validateSerialString(const QString &serialStr, uint &serialNum)
+{
+    /*
+     *  Correct serial string: MOOLTIPXXXXY,
+     *  XXXX is the new serial number
+     *  Y is a char which is 'A' + (XXXX)%26
+     */
+
+    const int serialStartSize = SERIAL_STR_START.size();
+    const int serialStringSize = serialStartSize + SERIAL_NUM_LENGTH + 1;
+    if (serialStr.size() != serialStringSize)
+    {
+        qCritical() << "Serial string has an incorrect size";
+        return false;
+    }
+
+    if (!serialStr.startsWith(SERIAL_STR_START))
+    {
+        qCritical() << "Serial string is not started with " << SERIAL_STR_START;
+        return false;
+    }
+    QString serialPart = serialStr.mid(serialStartSize, SERIAL_NUM_LENGTH);
+    bool ok = false;
+    serialNum = serialPart.toUInt(&ok);
+    if (!ok)
+    {
+        qCritical() << "Serial number part is not a number";
+        return false;
+    }
+
+    int hash = serialStr.toStdString()[serialStringSize - 1] - 'A';
+    if (hash != serialNum % Common::ALPHABET_SIZE)
+    {
+        serialNum = 0;
+        qCritical() << "Incorrect hash in serial string";
+        return false;
+    }
+    return true;
+}
+
 void MainWindow::on_toolButton_clearBackupFilePath_released()
 {
     ui->lineEdit_dbBackupFilePath->clear();
@@ -2405,3 +2465,48 @@ void MainWindow::onBleNameChanged(const QString &name)
     ui->lineEditBleName->setText(name);
     checkSettingsChanged();
 }
+
+void MainWindow::onIncorrectSerialNumberClicked()
+{
+    bool ok = false;
+    QString serialNumStr = QInputDialog::getText(this, tr("Incorrect Serial Number"),
+                             tr("It looks like your device serial number doesn't match the one present on your device's case.\n") +
+                             tr("Please reach out to support@themooltipass.com for the right code to enter below"),
+                             QLineEdit::Normal, "", &ok);
+    if (ok)
+    {
+        uint serialNum = 0;
+        if (validateSerialString(serialNumStr, serialNum))
+        {
+            wsClient->sendSetSerialNumber(serialNum);
+        }
+        else
+        {
+            qCritical() << "The entered serial number is incorrect: " << serialNumStr;
+            QMessageBox::critical(this, tr("Incorrect Serial Number"),
+                                  tr("The entered serial number is incorrect!"));
+        }
+    }
+}
+
+void MainWindow::onSerialNumberChanged(bool success, int serialNumber)
+{
+    auto title = tr("Serial number change");
+    if (success)
+    {
+        wsClient->set_hwSerial(serialNumber);
+        if (wsClient->get_hwSerial() == wsClient->get_platformSerial())
+        {
+            QMessageBox::information(this, title, tr("Set serial number successfully."));
+            ui->widgetNotFlashedWarning->hide();
+        }
+        else
+        {
+            QMessageBox::critical(this, title, tr("Serial number still does not match platform serial."));
+        }
+    }
+    else
+    {
+        QMessageBox::critical(this, title, tr("Set serial number failed."));
+    }
+}

src/MainWindow.h

@@ -211,6 +211,10 @@ private slots:
 
     void onBleNameChanged(const QString& name);
 
+    void onIncorrectSerialNumberClicked();
+
+    void onSerialNumberChanged(bool success, int serialNumber);
+
 protected:
     virtual void keyPressEvent(QKeyEvent *event) override;
     virtual void keyReleaseEvent(QKeyEvent *event) override;
@@ -256,6 +260,8 @@ private slots:
 
     void fillInitialCurrentCategories();
 
+    bool validateSerialString(const QString& serialStr, uint& serialNum);
+
     Ui::MainWindow *ui = nullptr;
     QtAwesome* awesome;
 
@@ -319,9 +325,12 @@ private slots:
     static const QString BLE_MANUAL_URL;
     static const QString MINI_MANUAL_URL;
     static const QString BUNDLE_OUTDATED_TEXT;
+    static const QString SERIAL_STR_START;
+    static constexpr int SERIAL_NUM_LENGTH = 4;
 #ifdef Q_OS_MAC
     static constexpr int MAC_DEFAULT_HEIGHT = 500;
 #endif
+    static constexpr int STARTING_NOT_FLASHED_SERIAL = 2000;
 };
 
 #endif // MAINWINDOW_H