Improved roDeviceInfo.getConnectionInfo() by getting actual network information (#181)

lvcabral · web-flow · commit 5f337cce6e54 · 2025-02-03T18:03:53.000-07:00
* Added real `gateway` data on `connectionInfo`

* Improved gateway retrieval

* Improved gateway detection in Windows

* Improved handling of async gateway retrieval

* Prevent hanging promise

* Try to get SSID

* Updated util

* Fixed getSSID()
diff --git a/package.json b/package.json
@@ -84,6 +84,7 @@
         "minimist": "^1.2.5",
         "mousetrap": "^1.6.5",
         "nanoid": "^5.0.9",
+        "network": "^0.7.0",
         "node-ssdp": "^4.0.1",
         "postman-request": "^2.88.1-postman.33",
         "restana": "^4.9.9",
diff --git a/src/helpers/settings.js b/src/helpers/settings.js
@@ -691,7 +691,7 @@ export function setDeviceInfo(section, key, notifyApp) {
         global.sharedObject.deviceInfo[key] = newValue;
         if (notifyApp) {
             const window = BrowserWindow.fromId(1);
-            window.webContents.send("setDeviceInfo", key, newValue);
+            window?.webContents.send("setDeviceInfo", key, newValue);
         }
     }
 }
diff --git a/src/helpers/util.js b/src/helpers/util.js
@@ -5,6 +5,11 @@
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
+import os from "os";
+import network from "network";
+import { execSync } from "child_process";
+
+const isWindows = process.platform === "win32";
 
 export function isValidIP(ip) {
     if (typeof ip !== "string") {
@@ -28,3 +33,105 @@ export function isValidUrl(string) {
         return false;
     }
 }
+
+export function getLocalIps() {
+    const ifaces = os.networkInterfaces();
+    const ips = [];
+    Object.keys(ifaces).forEach(function (ifname) {
+        let alias = 0;
+        ifaces[ifname].forEach(function (iface) {
+            if ("IPv4" !== iface.family || iface.internal !== false) {
+                // skip over internal (i.e. 127.0.0.1) and non-ipv4 addresses
+                return;
+            }
+            if (alias >= 1) {
+                // this single interface has multiple ipv4 addresses
+                console.log(`${ifname}:${alias}`, iface.address);
+                ips.push(`${ifname}:${alias},${iface.address}`);
+            } else {
+                // this interface has only one ipv4 address
+                console.log(ifname, iface.address);
+                ips.push(`${ifname},${iface.address}`);
+            }
+            ++alias;
+        });
+    });
+    if (ips.length === 0) {
+        ips.push("eth1,127.0.0.1");
+    }
+    return ips;
+}
+
+export async function getGateway() {
+    const gateWayData = { ip: "", name: "", type: "", ssid: "" };
+    try {
+        const gw = await getActiveInterface();
+        gateWayData.ip = gw.gateway_ip ?? "";
+        gateWayData.name = gw.name ?? "";
+        gateWayData.type = gw.type === "Wireless" ? "WiFiConnection" : "WiredConnection";
+        if (gateWayData.type === "WiFiConnection") {
+            gateWayData.ssid = getSSID() ?? "WiFi";
+        }
+        console.log(
+            `Gateway: ${gateWayData.ip} - Interface: ${gateWayData.name} - Type: ${gateWayData.type} - SSID: ${gateWayData.ssid}`
+        );
+    } catch (err) {
+        console.error(`Unable to get the Network Gateway: ${err.message}`);
+    }
+    return gateWayData;
+}
+
+async function getActiveInterface() {
+    return await new Promise((resolve, reject) => {
+        if (!isWindows) {
+            network.get_active_interface((err, obj) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    resolve(obj);
+                }
+            });
+        } else {
+            network.get_interfaces_list((err, list) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    for (let iface of list) {
+                        if (iface.gateway_ip) {
+                            resolve(iface);
+                            break;
+                        }
+                    }
+                }
+                reject(new Error("No active interface found"));
+            });
+        }
+    });
+}
+
+function getSSID() {
+    const platform = os.platform();
+    let command;
+
+    if (platform === "win32") {
+        command = "netsh wlan show interfaces";
+    } else if (platform === "darwin") {
+        command =
+            "/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport -I";
+    } else if (platform === "linux") {
+        command = "iwgetid -r";
+    }
+
+    let ssid;
+    const result = execSync(command).toString();
+    if (platform === "win32") {
+        const match = result.match(/SSID\s*:\s*(.+)/);
+        ssid = match ? match[1] : null;
+    } else if (platform === "darwin") {
+        const match = result.match(/ SSID: (.+)/);
+        ssid = match ? match[1] : null;
+    } else if (platform === "linux") {
+        ssid = result.trim();
+    }
+    return ssid;
+}
diff --git a/src/helpers/window.js b/src/helpers/window.js
@@ -1,7 +1,7 @@
 /*---------------------------------------------------------------------------------------------
  *  BrightScript Simulation Desktop Application (https://github.com/lvcabral/brs-desktop)
  *
- *  Copyright (c) 2019-2024 Marcelo Lv Cabral. All Rights Reserved.
+ *  Copyright (c) 2019-2025 Marcelo Lv Cabral. All Rights Reserved.
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
@@ -201,7 +201,7 @@ export function closeChannel() {
     }
 }
 
-export function reloadApp() {
+export function reloadDevice() {
     const window = BrowserWindow.fromId(1);
     if (window) {
         window.webContents.reloadIgnoringCache();
diff --git a/src/main.js b/src/main.js
@@ -7,10 +7,10 @@
  *--------------------------------------------------------------------------------------------*/
 import path from "path";
 import url from "url";
-import os from "os";
+import dns from "dns";
 import minimist from "minimist";
 import jetpack from "fs-jetpack";
-import { app, screen } from "electron";
+import { app, screen, BrowserWindow } from "electron";
 import { DateTime } from "luxon";
 import { setPassword, setPort, enableInstaller } from "./server/installer";
 import { initECP, enableECP } from "./server/ecp";
@@ -43,13 +43,17 @@ import {
     setAspectRatio,
     saveWindowState,
 } from "./helpers/window";
+import { getGateway, getLocalIps } from "./helpers/util";
 import { setupTitlebar, attachTitlebarToWindow } from "custom-electron-titlebar/main";
 import { randomUUID } from "crypto";
 
 const isMacOS = process.platform === "darwin";
 
+require("@electron/remote/main").initialize();
+
 // Device Information Object
 const dt = DateTime.now().setZone("system");
+const localIps = getLocalIps();
 const deviceInfo = {
     developerId: "brs-dev-id", // Unique id to segregate registry data
     friendlyName: app.getName(),
@@ -64,15 +68,31 @@ const deviceInfo = {
     locale: "en_US",
     clockFormat: "12h",
     displayMode: "720p", // Options are: 480p (SD), 720p (HD), 1080p (FHD)
-    connectionType: "WiFiConnection", // Options: "WiFiConnection", "WiredConnection", ""
-    localIps: getLocalIps(),
+    connectionInfo: {
+        type: "WiredConnection",
+        name: localIps[0].split(",")[0],
+        gateway: "127.0.0.1",
+        dns: dns.getServers(),
+        quality: "Excellent",
+    },
+    localIps: localIps,
     startTime: Date.now(),
     maxSimulStreams: 2,
     audioVolume: 40,
     appList: [],
 };
 
-require("@electron/remote/main").initialize();
+// Get Network Gateway
+getGateway().then((gateway) => {
+    if (gateway.ip !== "") {
+        deviceInfo.connectionInfo.gateway = gateway.ip;
+        deviceInfo.connectionInfo.name = gateway.name;
+        deviceInfo.connectionInfo.type = gateway.type;
+        deviceInfo.connectionInfo.ssid = gateway.ssid;
+        const window = BrowserWindow.fromId(1);
+        window?.webContents.send("setDeviceInfo", "connectionInfo", deviceInfo.connectionInfo);
+    }
+});
 
 // Parse CLI parameters
 const argv = minimist(process.argv.slice(1), {
@@ -340,29 +360,3 @@ function setupEvents(mainWindow) {
         });
     });
 }
-
-// Helper Functions
-function getLocalIps() {
-    const ifaces = os.networkInterfaces();
-    const ips = [];
-    Object.keys(ifaces).forEach(function (ifname) {
-        let alias = 0;
-        ifaces[ifname].forEach(function (iface) {
-            if ("IPv4" !== iface.family || iface.internal !== false) {
-                // skip over internal (i.e. 127.0.0.1) and non-ipv4 addresses
-                return;
-            }
-            if (alias >= 1) {
-                // this single interface has multiple ipv4 addresses
-                console.log(`${ifname}:${alias}`, iface.address);
-                ips.push(`${ifname}:${alias},${iface.address}`);
-            } else {
-                // this interface has only one ipv4 address
-                console.log(ifname, iface.address);
-                ips.push(`${ifname},${iface.address}`);
-            }
-            ++alias;
-        });
-    });
-    return ips;
-}
diff --git a/src/menu/deviceMenuTemplate.js b/src/menu/deviceMenuTemplate.js
@@ -1,15 +1,15 @@
 /*---------------------------------------------------------------------------------------------
  *  BrightScript Simulation Desktop Application (https://github.com/lvcabral/brs-desktop)
  *
- *  Copyright (c) 2019-2023 Marcelo Lv Cabral. All Rights Reserved.
+ *  Copyright (c) 2019-2025 Marcelo Lv Cabral. All Rights Reserved.
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { isECPEnabled, enableECP, disableECP } from "../server/ecp";
 import { isTelnetEnabled, enableTelnet, disableTelnet } from "../server/telnet";
 import { isInstallerEnabled, enableInstaller, disableInstaller } from "../server/installer";
 import { setLocaleId, setDisplayOption, setPeerRoku } from "../helpers/settings";
-import { reloadApp } from "../helpers/window";
+import { reloadDevice } from "../helpers/window";
 
 export const deviceMenuTemplate = {
     id: "device-menu",
@@ -190,7 +190,7 @@ export const deviceMenuTemplate = {
             label: "Reset Device",
             accelerator: "CmdOrCtrl+Shift+R",
             click: (item, window) => {
-                reloadApp();
+                reloadDevice();
             },
         },
     ],
diff --git a/yarn.lock b/yarn.lock
@@ -1626,14 +1626,19 @@ async-exit-hook@^2.0.1:
   resolved "https://registry.yarnpkg.com/async-exit-hook/-/async-exit-hook-2.0.1.tgz#8bd8b024b0ec9b1c01cccb9af9db29bd717dfaf3"
   integrity sha512-NW2cX8m1Q7KPA7a5M2ULQeZ2wR5qI5PAbw5L0UOMxdioVk9PMZ0h1TmyZEkPYrCvYjDlFICusOu1dlEKAAeXBw==
 
+async@^1.5.2:
+  version "1.5.2"
+  resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a"
+  integrity sha512-nSVgobk4rv61R9PUSDtYt7mPVB2olxNR5RWJcAsH676/ef11bUZwvu7+RGYrYauVdDPcO519v68wRhXQtxsV9w==
+
 async@^2.6.0:
   version "2.6.4"
   resolved "https://registry.yarnpkg.com/async/-/async-2.6.4.tgz#706b7ff6084664cd7eae713f6f965433b5504221"
   integrity sha512-mzo5dfJYwAn29PeiJ0zvwTo04zj8HDJj0Mn8TD7sno7q12prdbnasKJHhkm2c1LgrhlJ0teaea8860oxi51mGA==
   dependencies:
     lodash "^4.17.14"
 
-async@^3.2.3:
+async@^3.2.0, async@^3.2.3:
   version "3.2.6"
   resolved "https://registry.yarnpkg.com/async/-/async-3.2.6.tgz#1b0728e14929d51b85b449b7f06e27c1145e38ce"
   integrity sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==
@@ -2225,6 +2230,13 @@ combined-stream@^1.0.6, combined-stream@^1.0.8, combined-stream@~1.0.6:
   dependencies:
     delayed-stream "~1.0.0"
 
+commander@2.9.0:
+  version "2.9.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.9.0.tgz#9c99094176e12240cb22d6c5146098400fe0f7d4"
+  integrity sha512-bmkUukX8wAOjHdN26xj5c4ctEV22TQ7dQYhSmuckKhToXrkUn0iIaolHdIxYYqD55nhpSPA9zPQ1yP57GdXP2A==
+  dependencies:
+    graceful-readlink ">= 1.0.0"
+
 commander@^10.0.1:
   version "10.0.1"
   resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06"
@@ -3456,6 +3468,11 @@ graceful-fs@^4.1.15, graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.2.0,
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3"
   integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==
 
+"graceful-readlink@>= 1.0.0":
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/graceful-readlink/-/graceful-readlink-1.0.1.tgz#4cafad76bc62f02fa039b2f94e9a3dd3a391a725"
+  integrity sha512-8tLu60LgxF6XpdbK8OW3FA+IfTNBn1ZHGHKF4KQbEeSkajYw5PlYJcKluntgegDPTg8UkHjpet1T82vk6TQ68w==
+
 har-schema@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/har-schema/-/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92"
@@ -3693,7 +3710,14 @@ iconv-corefoundation@^1.1.7:
     cli-truncate "^2.1.0"
     node-addon-api "^1.6.3"
 
-iconv-lite@^0.6.2:
+iconv-lite@^0.5.0:
+  version "0.5.2"
+  resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.5.2.tgz#af6d628dccfb463b7364d97f715e4b74b8c8c2b8"
+  integrity sha512-kERHXvpSaB4aU3eANwidg79K8FlrN77m8G9V+0vOR3HYaRifrlwMEpT7ZBJqLSEIHnEgJTHcWK82wwLwwKwtag==
+  dependencies:
+    safer-buffer ">= 2.1.2 < 3"
+
+iconv-lite@^0.6.2, iconv-lite@^0.6.3:
   version "0.6.3"
   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.6.3.tgz#a52f80bf38da1952eb5c681790719871a1a72501"
   integrity sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==
@@ -4490,11 +4514,29 @@ nanomatch@^1.2.13:
     snapdragon "^0.8.1"
     to-regex "^3.0.1"
 
+needle@^3.0.0:
+  version "3.3.1"
+  resolved "https://registry.yarnpkg.com/needle/-/needle-3.3.1.tgz#63f75aec580c2e77e209f3f324e2cdf3d29bd049"
+  integrity sha512-6k0YULvhpw+RoLNiQCRKOl09Rv1dPLr8hHnVjHqdolKwDrdNyk+Hmrthi4lIGPPz3r39dLx0hsF5s40sZ3Us4Q==
+  dependencies:
+    iconv-lite "^0.6.3"
+    sax "^1.2.4"
+
 neo-async@^2.6.2:
   version "2.6.2"
   resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f"
   integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==
 
+network@^0.7.0:
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/network/-/network-0.7.0.tgz#beb801e34448a4cec5f5b5857d20f1593328fb8e"
+  integrity sha512-AquYHEZFrPi1WPaMg+21iTKN7aMERP70frgK41lbTt/9tTQcwgaOtlqHRmVbxJjWYWJy033jUbA8xXhFArXodw==
+  dependencies:
+    async "^1.5.2"
+    commander "2.9.0"
+    needle "^3.0.0"
+    wmic "^1.0.1"
+
 no-case@^3.0.4:
   version "3.0.4"
   resolved "https://registry.yarnpkg.com/no-case/-/no-case-3.0.4.tgz#d361fd5c9800f558551a8369fc0dcd4662b6124d"
@@ -5347,7 +5389,7 @@ safe-regex@^1.1.0:
   dependencies:
     ret "~0.1.10"
 
-"safer-buffer@>= 2.1.2 < 3.0.0", safer-buffer@^2.0.2, safer-buffer@^2.1.0, safer-buffer@~2.1.0:
+"safer-buffer@>= 2.1.2 < 3", "safer-buffer@>= 2.1.2 < 3.0.0", safer-buffer@^2.0.2, safer-buffer@^2.1.0, safer-buffer@~2.1.0:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a"
   integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==
@@ -6277,6 +6319,14 @@ wildcard@^2.0.0:
   resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.1.tgz#5ab10d02487198954836b6349f74fff961e10f67"
   integrity sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==
 
+wmic@^1.0.1:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/wmic/-/wmic-1.1.1.tgz#e77f8ddea85f23fa77514e3d8e9de9c302447bf3"
+  integrity sha512-6lbonssALks49dX9bJTE8i54OTjbbLfd3IraFfG1ZR1ZrEbEynCt471IX5SfslZaFwISJKdUFHjOWHk0Brs5eg==
+  dependencies:
+    async "^3.2.0"
+    iconv-lite "^0.5.0"
+
 "wrap-ansi-cjs@npm:wrap-ansi@^7.0.0":
   version "7.0.0"
   resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"

Original file line number	Diff line number	Diff line change
`@@ -691,7 +691,7 @@ export function setDeviceInfo(section, key, notifyApp) {`
`691`	`691`	`global.sharedObject.deviceInfo[key] = newValue;`
`692`	`692`	`if (notifyApp) {`
`693`	`693`	`const window = BrowserWindow.fromId(1);`
`694`		`- window.webContents.send("setDeviceInfo", key, newValue);`
	`694`	`+ window?.webContents.send("setDeviceInfo", key, newValue);`
`695`	`695`	`}`
`696`	`696`	`}`
`697`	`697`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/*---------------------------------------------------------------------------------------------`
`2`	`2`	`* BrightScript Simulation Desktop Application (https://github.com/lvcabral/brs-desktop)`
`3`	`3`	`*`
`4`		`- * Copyright (c) 2019-2024 Marcelo Lv Cabral. All Rights Reserved.`
	`4`	`+ * Copyright (c) 2019-2025 Marcelo Lv Cabral. All Rights Reserved.`
`5`	`5`	`*`
`6`	`6`	`* Licensed under the MIT License. See LICENSE in the repository root for license information.`
`7`	`7`	`--------------------------------------------------------------------------------------------/`
`@@ -201,7 +201,7 @@ export function closeChannel() {`
`201`	`201`	`}`
`202`	`202`	`}`
`203`	`203`
`204`		`-export function reloadApp() {`
	`204`	`+export function reloadDevice() {`
`205`	`205`	`const window = BrowserWindow.fromId(1);`
`206`	`206`	`if (window) {`
`207`	`207`	`window.webContents.reloadIgnoringCache();`