matterbridge 3.3.5-dev-20251025-26d5c31 → 3.3.5-dev-20251029-a0d9d11

package/CHANGELOG.md

@@ -30,9 +30,19 @@ Advantages:
 
 ## [3.3.5] - 2025-10-??
 
+### Added
+
+- [thread]: Added get_log_level and set_log_level to BroadcastServer.
+- [frontend]: Added password check to WebSocket.
+
 ### Changed
 
 - [package]: Updated dependencies.
+- [frontend]: Bumped `frontend` version to 3.2.4.
+
+### Fixed
+
+- [service]: Fixed systemd configuration with local global node_modules.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">

package/README-SERVICE-LOCAL.md

@@ -51,7 +51,7 @@ Create a systemctl configuration file for Matterbridge
 sudo nano /etc/systemd/system/matterbridge.service
 ```
 
-Add the following to this file, replacing 5 times (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge, User=pi and Group=pi and Environment="NPM_CONFIG_PREFIX=/home/pi/.npm-global"):
+Add the following to this file, replacing 4 times (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge, User=pi and Group=pi and Environment="NPM_CONFIG_PREFIX=/home/pi/.npm-global"):
 
 ```
 [Unit]
@@ -171,56 +171,3 @@ save it and run
 ```bash
 sudo systemctl restart systemd-journald
 ```
-
-## Verify that with your distro you can run sudo npm install -g matterbridge without the password
-
-Run the following command to verify if you can install Matterbridge globally without being prompted for a password:
-
-```bash
-sudo npm install -g matterbridge --omit=dev
-```
-
-If you are not prompted for a password, no further action is required.
-
-If that is not the case, open the sudoers file for editing using visudo
-
-```bash
-sudo visudo
-```
-
-verify the presence of of a line
-
-```
-@includedir /etc/sudoers.d
-```
-
-exit and create a configuration file for sudoers
-
-```bash
-sudo nano /etc/sudoers.d/matterbridge
-```
-
-add this line replacing USER with your user name (e.g. radxa ALL=(ALL) NOPASSWD: ALL)
-
-```
-<USER> ALL=(ALL) NOPASSWD: ALL
-```
-
-or if you prefers to only give access to npm without password try with (e.g. radxa ALL=(ALL) NOPASSWD: /usr/bin/npm)
-
-```
-<USER> ALL=(ALL) NOPASSWD: /usr/bin/npm
-```
-
-save the file and reload the settings with:
-
-```bash
-sudo chmod 0440 /etc/sudoers.d/matterbridge
-sudo visudo -c
-```
-
-Verify if you can install Matterbridge globally without being prompted for a password:
-
-```bash
-sudo npm install -g matterbridge --omit=dev
-```

package/README.md

@@ -172,6 +172,10 @@ Config editor:
 
 [Service configurations](README-SERVICE.md)
 
+or with local global node_modules
+
+[Service configurations with local global node_modules](README-SERVICE-LOCAL.md)
+
 ### Run matterbridge as a system service with launchctl (macOS only)
 
 [Launchctl configurations](README-MACOS-PLIST.md)

package/dist/deviceManager.js

@@ -20,6 +20,13 @@ export class DeviceManager {
         if (this.server.isWorkerRequest(msg, msg.type) && (msg.dst === 'all' || msg.dst === 'devices')) {
             this.log.debug(`**Received request message ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
             switch (msg.type) {
+                case 'get_log_level':
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
+                    break;
+                case 'set_log_level':
+                    this.log.logLevel = msg.params.logLevel;
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
+                    break;
                 case 'devices_length':
                     this.server.respond({ ...msg, response: { length: this.length } });
                     break;

package/dist/frontend.js

@@ -26,6 +26,7 @@ export class Frontend extends EventEmitter {
     log;
     port = 8283;
     listening = false;
+    storedPassword = undefined;
     expressApp;
     httpServer;
     httpsServer;
@@ -46,6 +47,13 @@ export class Frontend extends EventEmitter {
         if (this.server.isWorkerRequest(msg, msg.type) && (msg.dst === 'all' || msg.dst === 'frontend')) {
             this.log.debug(`Received broadcast request ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
             switch (msg.type) {
+                case 'get_log_level':
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
+                    break;
+                case 'set_log_level':
+                    this.log.logLevel = msg.params.logLevel;
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
+                    break;
                 case 'frontend_start':
                     await this.start(msg.params.port);
                     this.server.respond({ ...msg, response: { success: true } });
@@ -54,6 +62,30 @@ export class Frontend extends EventEmitter {
                     await this.stop();
                     this.server.respond({ ...msg, response: { success: true } });
                     break;
+                case 'frontend_refreshrequired':
+                    this.wssSendRefreshRequired(msg.params.changed, { matter: msg.params.matter });
+                    this.server.respond({ ...msg, response: { success: true } });
+                    break;
+                case 'frontend_restartrequired':
+                    this.wssSendRestartRequired(msg.params.snackbar, msg.params.fixed);
+                    this.server.respond({ ...msg, response: { success: true } });
+                    break;
+                case 'frontend_restartnotrequired':
+                    this.wssSendRestartNotRequired(msg.params.snackbar);
+                    this.server.respond({ ...msg, response: { success: true } });
+                    break;
+                case 'frontend_updaterequired':
+                    this.wssSendUpdateRequired(msg.params.devVersion);
+                    this.server.respond({ ...msg, response: { success: true } });
+                    break;
+                case 'frontend_snackbarmessage':
+                    this.wssSendSnackbarMessage(msg.params.message, msg.params.timeout, msg.params.severity);
+                    this.server.respond({ ...msg, response: { success: true } });
+                    break;
+                case 'frontend_attributechanged':
+                    this.wssSendAttributeChangedMessage(msg.params.plugin, msg.params.serialNumber, msg.params.uniqueId, msg.params.number, msg.params.id, msg.params.cluster, msg.params.attribute, msg.params.value);
+                    this.server.respond({ ...msg, response: { success: true } });
+                    break;
                 default:
                     this.log.debug(`Unknown broadcast request ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}`);
             }
@@ -61,6 +93,9 @@ export class Frontend extends EventEmitter {
         if (this.server.isWorkerResponse(msg, msg.type)) {
             this.log.debug(`Received broadcast response ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
             switch (msg.type) {
+                case 'get_log_level':
+                case 'set_log_level':
+                    break;
                 case 'plugins_install':
                     this.wssSendCloseSnackbarMessage(`Installing package ${msg.response.packageName}...`);
                     if (msg.response.success) {
@@ -93,6 +128,7 @@ export class Frontend extends EventEmitter {
     }
     async start(port = 8283) {
         this.port = port;
+        this.storedPassword = await this.matterbridge.nodeContext?.get('password', '');
         this.log.debug(`Initializing the frontend ${hasParameter('ssl') ? 'https' : 'http'} server on port ${YELLOW}${this.port}${db}`);
         const multer = await import('multer');
         const uploadDir = path.join(this.matterbridge.matterbridgeDirectory, 'uploads');
@@ -100,6 +136,47 @@ export class Frontend extends EventEmitter {
         const express = await import('express');
         this.expressApp = express.default();
         this.expressApp.use(express.static(path.join(this.matterbridge.rootDirectory, 'frontend/build')));
+        this.log.debug(`Creating WebSocketServer...`);
+        const ws = await import('ws');
+        this.webSocketServer = new ws.WebSocketServer({ noServer: true });
+        this.emit('websocket_server_listening', hasParameter('ssl') ? 'wss' : 'ws');
+        this.webSocketServer.on('connection', (ws, request) => {
+            const clientIp = request.socket.remoteAddress;
+            let callbackLogLevel = "notice";
+            if (this.matterbridge.getLogLevel() === "info" || Logger.level === MatterLogLevel.INFO)
+                callbackLogLevel = "info";
+            if (this.matterbridge.getLogLevel() === "debug" || Logger.level === MatterLogLevel.DEBUG)
+                callbackLogLevel = "debug";
+            AnsiLogger.setGlobalCallback(this.wssSendLogMessage.bind(this), callbackLogLevel);
+            this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
+            this.log.info(`WebSocketServer client "${clientIp}" connected to Matterbridge`);
+            ws.on('message', (message) => {
+                this.wsMessageHandler(ws, message);
+            });
+            ws.on('ping', () => {
+                this.log.debug('WebSocket client ping');
+                ws.pong();
+            });
+            ws.on('pong', () => {
+                this.log.debug('WebSocket client pong');
+            });
+            ws.on('close', () => {
+                this.log.info('WebSocket client disconnected');
+                if (this.webSocketServer?.clients.size === 0) {
+                    AnsiLogger.setGlobalCallback(undefined);
+                    this.log.debug('All WebSocket clients disconnected. WebSocketServer logger global callback removed');
+                }
+            });
+            ws.on('error', (error) => {
+                this.log.error(`WebSocket client error: ${error}`);
+            });
+        });
+        this.webSocketServer.on('close', () => {
+            this.log.debug(`WebSocketServer closed`);
+        });
+        this.webSocketServer.on('error', (ws, error) => {
+            this.log.error(`WebSocketServer error: ${error}`);
+        });
         if (!hasParameter('ssl')) {
             const http = await import('node:http');
             try {
@@ -128,6 +205,32 @@ export class Frontend extends EventEmitter {
                     this.emit('server_listening', 'http', this.port);
                 });
             }
+            this.httpServer.on('upgrade', async (req, socket, head) => {
+                try {
+                    if ((req.headers.upgrade || '').toLowerCase() !== 'websocket') {
+                        socket.write('HTTP/1.1 400 Bad Request\r\nConnection: close\r\n\r\n');
+                        return socket.destroy();
+                    }
+                    const url = new URL(req.url ?? '/', `http://${req.headers.host || 'localhost'}`);
+                    const password = url.searchParams.get('password') ?? '';
+                    if (password !== this.storedPassword) {
+                        this.log.error(`WebSocket upgrade error: Invalid password ${password ? '[redacted]' : '(empty)'}`);
+                        socket.write('HTTP/1.1 401 Unauthorized\r\nConnection: close\r\n\r\n');
+                        return socket.destroy();
+                    }
+                    this.log.debug(`WebSocket upgrade success host ${url.host} password ${password ? '[redacted]' : '(empty)'}`);
+                    this.webSocketServer?.handleUpgrade(req, socket, head, (ws) => {
+                        this.webSocketServer?.emit('connection', ws, req);
+                    });
+                }
+                catch (err) {
+                    {
+                        inspectError(this.log, 'WebSocket upgrade error:', err);
+                        socket.write('HTTP/1.1 500 Internal Server Error\r\nConnection: close\r\n\r\n');
+                        socket.destroy();
+                    }
+                }
+            });
             this.httpServer.on('error', (error) => {
                 this.log.error(`Frontend http server error listening on ${this.port}`);
                 switch (error.code) {
@@ -233,6 +336,32 @@ export class Frontend extends EventEmitter {
                     this.emit('server_listening', 'https', this.port);
                 });
             }
+            this.httpsServer.on('upgrade', async (req, socket, head) => {
+                try {
+                    if ((req.headers.upgrade || '').toLowerCase() !== 'websocket') {
+                        socket.write('HTTP/1.1 400 Bad Request\r\nConnection: close\r\n\r\n');
+                        return socket.destroy();
+                    }
+                    const url = new URL(req.url ?? '/', `https://${req.headers.host || 'localhost'}`);
+                    const password = url.searchParams.get('password') ?? '';
+                    if (password !== this.storedPassword) {
+                        this.log.error(`WebSocket upgrade error: Invalid password ${password ? '[redacted]' : '(empty)'}`);
+                        socket.write('HTTP/1.1 401 Unauthorized\r\nConnection: close\r\n\r\n');
+                        return socket.destroy();
+                    }
+                    this.log.debug(`WebSocket upgrade success host ${url.host} password ${password ? '[redacted]' : '(empty)'}`);
+                    this.webSocketServer?.handleUpgrade(req, socket, head, (ws) => {
+                        this.webSocketServer?.emit('connection', ws, req);
+                    });
+                }
+                catch (err) {
+                    {
+                        inspectError(this.log, 'WebSocket upgrade error:', err);
+                        socket.write('HTTP/1.1 500 Internal Server Error\r\nConnection: close\r\n\r\n');
+                        socket.destroy();
+                    }
+                }
+            });
             this.httpsServer.on('error', (error) => {
                 this.log.error(`Frontend https server error listening on ${this.port}`);
                 switch (error.code) {
@@ -247,50 +376,6 @@ export class Frontend extends EventEmitter {
                 return;
             });
         }
-        const ws = await import('ws');
-        this.log.debug(`Creating WebSocketServer...`);
-        this.webSocketServer = new ws.WebSocketServer(hasParameter('ssl') ? { server: this.httpsServer } : { server: this.httpServer });
-        this.webSocketServer.on('connection', (ws, request) => {
-            const clientIp = request.socket.remoteAddress;
-            let callbackLogLevel = "notice";
-            if (this.matterbridge.getLogLevel() === "info" || Logger.level === MatterLogLevel.INFO)
-                callbackLogLevel = "info";
-            if (this.matterbridge.getLogLevel() === "debug" || Logger.level === MatterLogLevel.DEBUG)
-                callbackLogLevel = "debug";
-            AnsiLogger.setGlobalCallback(this.wssSendLogMessage.bind(this), callbackLogLevel);
-            this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
-            this.log.info(`WebSocketServer client "${clientIp}" connected to Matterbridge`);
-            ws.on('message', (message) => {
-                this.wsMessageHandler(ws, message);
-            });
-            ws.on('ping', () => {
-                this.log.debug('WebSocket client ping');
-                ws.pong();
-            });
-            ws.on('pong', () => {
-                this.log.debug('WebSocket client pong');
-            });
-            ws.on('close', () => {
-                this.log.info('WebSocket client disconnected');
-                if (this.webSocketServer?.clients.size === 0) {
-                    AnsiLogger.setGlobalCallback(undefined);
-                    this.log.debug('All WebSocket clients disconnected. WebSocketServer logger global callback removed');
-                }
-            });
-            ws.on('error', (error) => {
-                this.log.error(`WebSocket client error: ${error}`);
-            });
-        });
-        this.webSocketServer.on('close', () => {
-            this.log.debug(`WebSocketServer closed`);
-        });
-        this.webSocketServer.on('listening', () => {
-            this.log.info(`The WebSocketServer is listening`);
-            this.emit('websocket_server_listening', hasParameter('ssl') ? 'wss' : 'ws');
-        });
-        this.webSocketServer.on('error', (ws, error) => {
-            this.log.error(`WebSocketServer error: ${error}`);
-        });
         cliEmitter.removeAllListeners();
         cliEmitter.on('uptime', (systemUptime, processUptime) => {
             this.wssSendUptimeUpdate(systemUptime, processUptime);
@@ -303,25 +388,13 @@ export class Frontend extends EventEmitter {
         });
         this.expressApp.post('/api/login', express.json(), async (req, res) => {
             const { password } = req.body;
-            this.log.debug('The frontend sent /api/login', password);
-            if (!this.matterbridge.nodeContext) {
-                this.log.error('/api/login nodeContext not found');
-                res.json({ valid: false });
-                return;
+            this.log.debug(`The frontend sent /api/login with password ${password ? '[redacted]' : '(empty)'}`);
+            if (this.storedPassword === '' || password === this.storedPassword) {
+                this.log.debug('/api/login password valid');
+                res.json({ valid: true });
             }
-            try {
-                const storedPassword = await this.matterbridge.nodeContext.get('password', '');
-                if (storedPassword === '' || password === storedPassword) {
-                    this.log.debug('/api/login password valid');
-                    res.json({ valid: true });
-                }
-                else {
-                    this.log.warn('/api/login error wrong password');
-                    res.json({ valid: false });
-                }
-            }
-            catch (error) {
-                this.log.error('/api/login error getting password');
+            else {
+                this.log.warn('/api/login error wrong password');
                 res.json({ valid: false });
             }
         });
@@ -1480,6 +1553,7 @@ export class Frontend extends EventEmitter {
                     case 'setpassword':
                         if (isValidString(data.params.value)) {
                             await this.matterbridge.nodeContext?.set('password', data.params.value);
+                            this.storedPassword = data.params.value;
                             sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
                         }
                         break;

package/dist/matterbridge.js

@@ -146,6 +146,9 @@ export class Matterbridge extends EventEmitter {
         if (this.server.isWorkerResponse(msg, msg.type)) {
             this.log.debug(`**Received broadcast response ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
             switch (msg.type) {
+                case 'get_log_level':
+                case 'set_log_level':
+                    break;
                 default:
                     this.log.debug(`Unknown broadcast response ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}`);
             }

package/dist/pluginManager.js

@@ -2,6 +2,7 @@ import EventEmitter from 'node:events';
 import { AnsiLogger, UNDERLINE, UNDERLINEOFF, BLUE, db, er, nf, nt, rs, wr, debugStringify, CYAN } from 'node-ansi-logger';
 import { plg, typ } from './matterbridgeTypes.js';
 import { inspectError, logError } from './utils/error.js';
+import { hasParameter } from './utils/commandLine.js';
 import { BroadcastServer } from './broadcastServer.js';
 export class PluginManager extends EventEmitter {
     _plugins = new Map();
@@ -11,7 +12,7 @@ export class PluginManager extends EventEmitter {
     constructor(matterbridge) {
         super();
         this.matterbridge = matterbridge;
-        this.log = new AnsiLogger({ logName: 'PluginManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'PluginManager', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
         this.log.debug('Matterbridge plugin manager starting...');
         this.server = new BroadcastServer('plugins', this.log);
         this.server.on('broadcast_message', this.msgHandler.bind(this));
@@ -24,6 +25,13 @@ export class PluginManager extends EventEmitter {
         if (this.server.isWorkerRequest(msg, msg.type) && (msg.dst === 'all' || msg.dst === 'plugins')) {
             this.log.debug(`**Received request message ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
             switch (msg.type) {
+                case 'get_log_level':
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
+                    break;
+                case 'set_log_level':
+                    this.log.logLevel = msg.params.logLevel;
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
+                    break;
                 case 'plugins_length':
                     this.server.respond({ ...msg, response: { length: this.length } });
                     break;