From bad27d3d15e01b61df612e297376d84bb2016f09 Mon Sep 17 00:00:00 2001
From: Mark Haslinghuis <mark@numloq.nl>
Date: Mon, 10 Jan 2022 01:22:24 +0100
Subject: [PATCH] Make virtual mode an option using msp backup and restore

---
 locales/en/messages.json |  4 ++++
 src/js/port_handler.js   | 30 ++++++++++++++++--------
 src/js/serial.js         |  4 +---
 src/js/tabs/options.js   | 13 +++++++++++
 src/js/tabs/setup.js     | 50 ++++++++++++++++++++--------------------
 src/tabs/options.html    |  6 +++++
 6 files changed, 69 insertions(+), 38 deletions(-)

diff --git a/locales/en/messages.json b/locales/en/messages.json
index 5f263e09..faac0797 100644
--- a/locales/en/messages.json
+++ b/locales/en/messages.json
@@ -109,6 +109,10 @@
         "message": "Show all serial devices (for manufacturers or development)",
         "description": "Do not filter serial devices using VID/PID values (for manufacturers or development)"
     },
+    "showVirtualMode": {
+        "message": "Enable virtual connection mode",
+        "description": "Text for the option to enable or disable the virtual FC"
+    },
     "cordovaForceComputerUI": {
         "message": "Use computers interface instead of phones interface"
     },
diff --git a/src/js/port_handler.js b/src/js/port_handler.js
index 2b534420..ee01a1f5 100644
--- a/src/js/port_handler.js
+++ b/src/js/port_handler.js
@@ -13,6 +13,8 @@ const PortHandler = new function () {
     this.port_removed_callbacks = [];
     this.dfu_available = false;
     this.port_available = false;
+    this.showAllSerialDevices = false;
+    this.showVirtualMode = false;
 };
 
 PortHandler.initialize = function () {
@@ -31,6 +33,9 @@ PortHandler.initialize = function () {
 PortHandler.check = function () {
     const self = this;
 
+    ConfigStorage.get('showVirtualMode', res => self.showVirtualMode = res.showVirtualMode);
+    ConfigStorage.get('showAllSerialDevices', res => self.showAllSerialDevices = res.showAllSerialDevices);
+
     self.check_usb_devices();
     self.check_serial_devices();
 
@@ -79,17 +84,20 @@ PortHandler.check_usb_devices = function (callback) {
                     data: {isDFU: true},
                 }));
 
-                self.portPickerElement.append($('<option/>', {
-                    value: 'virtual',
-                    text: i18n.getMessage('portsSelectVirtual'),
-                    data: {isVirtual: true},
-                }));
+                if (self.showVirtualMode) {
+                    self.portPickerElement.append($('<option/>', {
+                        value: 'virtual',
+                        text: i18n.getMessage('portsSelectVirtual'),
+                        data: {isVirtual: true},
+                    }));
+                }
 
                 self.portPickerElement.append($('<option/>', {
                     value: 'manual',
                     text: i18n.getMessage('portsSelectManual'),
                     data: {isManual: true},
                 }));
+
                 self.portPickerElement.val('DFU').change();
                 self.setPortsInputWidth();
             }
@@ -241,11 +249,13 @@ PortHandler.updatePortSelect = function (ports) {
         }));
     }
 
-    this.portPickerElement.append($("<option/>", {
-        value: 'virtual',
-        text: i18n.getMessage('portsSelectVirtual'),
-        data: {isVirtual: true},
-    }));
+    if (this.showVirtualMode) {
+        this.portPickerElement.append($("<option/>", {
+            value: 'virtual',
+            text: i18n.getMessage('portsSelectVirtual'),
+            data: {isVirtual: true},
+        }));
+    }
 
     this.portPickerElement.append($("<option/>", {
         value: 'manual',
diff --git a/src/js/serial.js b/src/js/serial.js
index a282137f..51feedb0 100644
--- a/src/js/serial.js
+++ b/src/js/serial.js
@@ -270,13 +270,11 @@ const serial = {
 
         chrome.serial.getDevices(function (devices_array) {
             const devices = [];
-            let showAllSerialDevices = false;
 
             devices_array.forEach(function (device) {
-                ConfigStorage.get('showAllSerialDevices', res => showAllSerialDevices = res.showAllSerialDevices);
                 const isKnownSerialDevice = self.serialDevices.some(el => el.vendorId === device.vendorId) && self.serialDevices.some(el => el.productId === device.productId);
 
-                if (isKnownSerialDevice || showAllSerialDevices) {
+                if (isKnownSerialDevice || PortHandler.showAllSerialDevices) {
                     devices.push({
                         path: device.path,
                         displayName: device.displayName,
diff --git a/src/js/tabs/options.js b/src/js/tabs/options.js
index 61a6ac27..62d852bb 100644
--- a/src/js/tabs/options.js
+++ b/src/js/tabs/options.js
@@ -16,6 +16,7 @@ options.initialize = function (callback) {
         TABS.options.initCliAutoComplete();
         TABS.options.initAutoConnectConnectionTimeout();
         TABS.options.initShowAllSerialDevices();
+        TABS.options.initShowVirtualMode();
         TABS.options.initCordovaForceComputerUI();
         TABS.options.initDarkTheme();
 
@@ -142,7 +143,19 @@ options.initShowAllSerialDevices = function() {
             .on('change', () => ConfigStorage.set({ showAllSerialDevices: showAllSerialDevicesElement.is(':checked') }))
             .trigger('change');
     });
+};
 
+options.initShowVirtualMode = function() {
+    const showVirtualModeElement = $('div.showVirtualMode input');
+    ConfigStorage.get('showVirtualMode', result => {
+        showVirtualModeElement
+            .prop('checked', !!result.showVirtualMode)
+            .on('change', () => {
+                ConfigStorage.set({ showVirtualMode: showVirtualModeElement.is(':checked') });
+                PortHandler.initialPorts = false;
+            })
+            .trigger('change');
+    });
 };
 
 options.initCordovaForceComputerUI = function () {
diff --git a/src/js/tabs/setup.js b/src/js/tabs/setup.js
index 3a2beace..81bd75d6 100644
--- a/src/js/tabs/setup.js
+++ b/src/js/tabs/setup.js
@@ -29,34 +29,34 @@ TABS.setup.initialize = function (callback) {
         // translate to user-selected language
         i18n.localizePage();
 
-        if (CONFIGURATOR.virtualMode || semver.lt(FC.CONFIG.apiVersion, API_VERSION_1_44)) {
-            const backupButton = $('#content .backup');
+        const backupButton = $('#content .backup');
+        const restoreButton = $('#content .restore');
 
-            if (semver.lt(FC.CONFIG.apiVersion, CONFIGURATOR.API_VERSION_MIN_SUPPORTED_BACKUP_RESTORE)) {
-                backupButton.addClass('disabled');
-                $('#content .restore').addClass('disabled');
+        backupButton.on('click', () => configuration_backup(() => GUI.log(i18n.getMessage('initialSetupBackupSuccess'))));
 
-                GUI.log(i18n.getMessage('initialSetupBackupAndRestoreApiVersion', [FC.CONFIG.apiVersion, CONFIGURATOR.API_VERSION_MIN_SUPPORTED_BACKUP_RESTORE]));
+        restoreButton.on('click', () => configuration_restore(() => {
+            // get latest settings
+            TABS.setup.initialize();
+
+            GUI.log(i18n.getMessage('initialSetupRestoreSuccess'));
+        }));
+
+        if (semver.lt(FC.CONFIG.apiVersion, CONFIGURATOR.API_VERSION_MIN_SUPPORTED_BACKUP_RESTORE)) {
+            backupButton.addClass('disabled');
+            restoreButton.addClass('disabled');
+
+            GUI.log(i18n.getMessage('initialSetupBackupAndRestoreApiVersion', [FC.CONFIG.apiVersion, CONFIGURATOR.API_VERSION_MIN_SUPPORTED_BACKUP_RESTORE]));
+        }
+
+        if (CONFIGURATOR.virtualMode) {
+            // saving and uploading an imaginary config to hardware is a bad idea
+            backupButton.addClass('disabled');
+        } else if (semver.gte(FC.CONFIG.apiVersion, API_VERSION_1_44)) {
+            restoreButton.addClass('disabled');
+
+            if (!PortHandler.showVirtualMode) {
+                $('.backupRestore').hide();
             }
-
-            if (CONFIGURATOR.virtualMode) {
-                // saving and uploading an imaginary config to hardware is a bad idea
-                backupButton.addClass('disabled');
-            }
-
-            backupButton.on('click', () => configuration_backup(() => GUI.log(i18n.getMessage('initialSetupBackupSuccess'))));
-
-            $('#content .restore').on('click', () => {
-                configuration_restore(() => {
-                    // get latest settings
-                    TABS.setup.initialize();
-
-                    GUI.log(i18n.getMessage('initialSetupRestoreSuccess'));
-                });
-            });
-
-        } else {
-            $('.backupRestore').hide();
         }
 
         // initialize 3D Model
diff --git a/src/tabs/options.html b/src/tabs/options.html
index 1ee30052..8d901cd3 100644
--- a/src/tabs/options.html
+++ b/src/tabs/options.html
@@ -52,6 +52,12 @@
                     </div>
                     <span class="freelabel" i18n="showAllSerialDevices"></span>
                 </div>
+                <div class="showVirtualMode margin-bottom">
+                    <div>
+                        <input type="checkbox" class="toggle" />
+                    </div>
+                    <span class="freelabel" i18n="showVirtualMode"></span>
+                </div>
                 <div class="cordovaForceComputerUI margin-bottom">
                     <div>
                         <input type="checkbox" class="toggle" />