@iobroker/socket-classes 1.1.5 → 1.3.1

package/lib/socketCommands.js

@@ -67,6 +67,7 @@ class SocketCommands {
         this.commands   = {};
         this.subscribes = {};
         this.logEnabled = false;
+        this.clientSubscribes = {};
 
         this._updateSession = updateSession;
 
@@ -230,6 +231,20 @@ class SocketCommands {
         return false;
     }
 
+    publishInstanceMessage(socket, sourceInstance, messageType, data) {
+        if (this.clientSubscribes[socket.id] &&
+            this.clientSubscribes[socket.id][sourceInstance] &&
+            this.clientSubscribes[socket.id][sourceInstance].includes(messageType)
+        ) {
+            socket.emit('im', messageType, sourceInstance, data);
+            return true;
+        } else {
+            // inform instance about missing subscription
+            this.adapter.sendTo(sourceInstance, 'clientSubscribeError', {type: messageType, sid: socket.id});
+            return false;
+        }
+    }
+
     _showSubscribes(socket, type) {
         if (socket && socket.subscribe) {
             const s = socket.subscribe[type] || [];
@@ -264,7 +279,13 @@ class SocketCommands {
             key = pattern;
         }
 
-        p = pattern2RegEx(key);
+        try {
+            p = pattern2RegEx(key);
+        } catch (e) {
+            this.adapter.log.error(`Invalid pattern on subscribe: ${e.message}`)
+            return
+        }
+
         if (p === null) {
             return this.adapter.log.warn('Empty pattern on subscribe!');
         }
@@ -293,8 +314,8 @@ class SocketCommands {
                     this.logEnabled = true;
                     this.adapter.requireLog(true, options);
                 }
-            } else if (type === 'fileChange') {
-                this.adapter.subscribeForeignFiles && this.adapter.subscribeForeignFiles(pattern, patternFile, options);
+            } else if (type === 'fileChange' && this.adapter.subscribeForeignFiles) {
+                 this.adapter.subscribeForeignFiles(pattern, patternFile, options);
             }
         } else {
             this.subscribes[type][key]++;
@@ -358,7 +379,7 @@ class SocketCommands {
                 }
             }
         } else if (key) {
-            // Remove pattern from global list
+            // Remove a pattern from a global list
             if (this.subscribes[type][key] !== undefined) {
                 this.subscribes[type][key]--;
                 if (this.subscribes[type][key] <= 0) {
@@ -445,6 +466,8 @@ class SocketCommands {
         if (!socket || !socket.subscribe) {
             return;
         }
+        // inform all instances about disconnected socket
+        this._informAboutDisconnect(socket.id);
 
         if (!type) {
             // all
@@ -689,10 +712,10 @@ class SocketCommands {
 
         // commands
         this.commands['sendTo'] = (socket, adapterInstance, command, message, callback) => {
-            // Send message to specific instance
+            // Send the message to specific instance
             // @param {string} adapterInstance - instance name, e.g. `history.0`
             // @param {string} command - command name
-            // @param {object} message - message is instance dependent
+            // @param {object} message - the message is instance dependent
             // @param {function} callback - `function (result)`
             if (this._checkPermissions(socket, 'sendTo', callback, command)) {
                 try {
@@ -709,11 +732,11 @@ class SocketCommands {
         const protectedCommands = ['cmdExec', 'getLocationOnDisk', 'getDiagData', 'getDevList', 'delLogs', 'writeDirAsZip', 'writeObjectsAsZip', 'readObjectsAsZip', 'checkLogging', 'updateMultihost', 'rebuildAdapter'];
 
         this.commands['sendToHost'] = (socket, host, command, message, callback) => {
-            // Send message to specific host.
-            // Host can answer following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
+            // Send a message to the specific host.
+            // Host can answer to the following commands: `cmdExec, getRepository, getInstalled, getInstalledAdapter, getVersion, getDiagData, getLocationOnDisk, getDevList, getLogs, getHostInfo, delLogs, readDirAsZip, writeDirAsZip, readObjectsAsZip, writeObjectsAsZip, checkLogging, updateMultihost`.
             // @param {string} host - instance name, e.g. `history.0`
             // @param {string} command - command name
-            // @param {object} message - message is command specific
+            // @param {object} message - the message is command-specific
             // @param {function} callback - `function (result)`
             if (this._checkPermissions(socket, protectedCommands.includes(command) ? 'cmdExec' : 'sendToHost', callback, command)) {
                 // Try to decode this file locally as redis has a limitation for files bigger than 20MB
@@ -731,7 +754,7 @@ class SocketCommands {
                     zipFiles
                         .writeDirAsZip(
                             this.adapter, // normally we have to pass here the internal "objects" object, but as
-                            // only writeFile is used, and it has the same name we can pass here the
+                            // only writeFile is used, and it has the same name, we can pass here the
                             // adapter, which has the function with the same name and arguments
                             message.id,
                             message.name,
@@ -757,7 +780,7 @@ class SocketCommands {
         };
 
         this.commands['authEnabled'] = (socket, callback) => {
-            // Ask server is authentication enabled and if the user authenticated
+            // Ask server is authentication enabled, and if the user authenticated
             // @param {function} callback - `function (isAuthenticationUsed, userName)`
             if (this._checkPermissions(socket, 'authEnabled', callback)) {
                 if (typeof callback === 'function') {
@@ -797,7 +820,7 @@ class SocketCommands {
         };
 
         this.commands['getVersion'] = (socket, callback) => {
-            // Get adapter version. Not the socket-classes version!
+            // Get the adapter version. Not the socket-classes version!
             // @param {function} callback - `function (error, adapterVersion, adapterName)`
             if (this._checkPermissions(socket, 'getVersion', callback)) {
                 if (typeof callback === 'function') {
@@ -826,7 +849,7 @@ class SocketCommands {
         this.commands['readFile'] = (socket, _adapter, fileName, callback) => {
             // Read file from ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
             // @param {function} callback - `function (error, data, mimeType)`
             if (this._checkPermissions(socket, 'readFile', callback, fileName)) {
                 try {
@@ -842,7 +865,7 @@ class SocketCommands {
         this.commands['readFile64'] = (socket, _adapter, fileName, callback) => {
             // Read file from ioBroker DB as base64 string
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
             // @param {function} callback - `function (error, base64, mimeType)`
             if (this._checkPermissions(socket, 'readFile64', callback, fileName)) {
                 try {
@@ -881,7 +904,7 @@ class SocketCommands {
         this.commands['writeFile64'] = (socket, _adapter, fileName, data64, options, callback) => {
             // Write file into ioBroker DB as base64 string
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
             // @param {string} data64 - file content as base64 string
             // @param {object} options - optional `{mode: 0x0644}`
             // @param {function} callback - `function (error)`
@@ -914,7 +937,7 @@ class SocketCommands {
         this.commands['writeFile'] = (socket, _adapter, fileName, data, options, callback) => {
             // Write file into ioBroker DB as text **DEPRECATED**
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
             // @param {string} data64 - file content as base64 string
             // @param {object} options - optional `{mode: 0x644}`
             // @param {function} callback - `function (error)`
@@ -940,7 +963,7 @@ class SocketCommands {
         this.commands['unlink'] = (socket, _adapter, name, callback) => {
             // Delete file in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} name - file name, e.g `main/vis-views.json`
+            // @param {string} name - file name, e.g. `main/vis-views.json`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unlink', callback, name)) {
                 try {
@@ -957,7 +980,7 @@ class SocketCommands {
         this.commands['deleteFile'] = (socket, _adapter, name, callback) => {
             // Delete file in ioBroker DB (same as unlink, but only for files)
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} name - file name, e.g `main/vis-views.json`
+            // @param {string} name - file name, e.g. `main/vis-views.json`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unlink', callback, name)) {
                 try {
@@ -973,7 +996,7 @@ class SocketCommands {
         this.commands['deleteFolder'] = (socket, _adapter, name, callback) => {
             // Delete file in ioBroker DB (same as unlink, but only for folders)
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} name - folder name, e.g `main`
+            // @param {string} name - folder name, e.g. `main`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unlink', callback, name)) {
                 try {
@@ -990,8 +1013,8 @@ class SocketCommands {
         this.commands['renameFile'] = (socket, _adapter, oldName, newName, callback) => {
             // Rename file in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} oldName - current file name, e.g `main/vis-views.json`
-            // @param {string} newName - new file name, e.g `main/vis-views-new.json`
+            // @param {string} oldName - current file name, e.g. `main/vis-views.json`
+            // @param {string} newName - new file name, e.g. `main/vis-views-new.json`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'rename', callback, oldName)) {
                 try {
@@ -1007,8 +1030,8 @@ class SocketCommands {
         this.commands['rename'] = (socket, _adapter, oldName, newName, callback) => {
             // Rename file or folder in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} oldName - current file name, e.g `main/vis-views.json`
-            // @param {string} newName - new file name, e.g `main/vis-views-new.json`
+            // @param {string} oldName - current file name, e.g. `main/vis-views.json`
+            // @param {string} newName - new file name, e.g. `main/vis-views-new.json`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'rename', callback, oldName)) {
                 try {
@@ -1025,7 +1048,7 @@ class SocketCommands {
         this.commands['mkdir'] = (socket, _adapter, dirName, callback) => {
             // Create folder in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} dirName - desired folder name, e.g `main`
+            // @param {string} dirName - desired folder name, e.g. `main`
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'mkdir', callback, dirName)) {
                 try {
@@ -1041,7 +1064,7 @@ class SocketCommands {
         this.commands['readDir'] = (socket, _adapter, dirName, options, callback) => {
             // Read content of folder in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} dirName - folder name, e.g `main`
+            // @param {string} dirName - folder name, e.g. `main`
             // @param {object} options - optional `{filter: '*'}` or `{filter: '*.json'}`
             // @param {function} callback - `function (error, files)` where `files` is an array of objects, like `{file: 'vis-views.json', isDir: false, stats: {size: 123}, modifiedAt: 1661336290090, acl: {owner: 'system.user.admin', ownerGroup: 'system.group.administrator', permissions: 1632, read: true, write: true}`
             if (typeof options === 'function') {
@@ -1069,8 +1092,8 @@ class SocketCommands {
         this.commands['chmodFile'] = (socket, _adapter, fileName, options, callback) => {
             // Change file mode in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
-            // @param {object} options - `{mode: 0x644}` or 0x644. First digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
+            // @param {object} options - `{mode: 0x644}` or 0x644. The first digit is user, second group, third others. Bit 1 is `execute`, bit 2 is `write`, bit 3 is `read`
             // @param {function} callback - `function (error)`
             if (typeof options === 'function') {
                 callback = options;
@@ -1097,7 +1120,7 @@ class SocketCommands {
         this.commands['chownFile'] = (socket, _adapter, fileName, options, callback) => {
             // Change file owner in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
             // @param {object} options - `{owner: 'system.user.user', ownerGroup: ''system.group.administrator'}` or 'system.user.user'. If ownerGroup is not defined, it will be taken from owner.
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'chownFile', callback, fileName)) {
@@ -1114,9 +1137,9 @@ class SocketCommands {
         };
 
         this.commands['fileExists'] = (socket, _adapter, fileName, callback) => {
-            // Checks if the file or folder exists in ioBroker DB
+            // Check if the file or folder exists in ioBroker DB
             // @param {string} _adapter - instance name, e.g. `vis.0`
-            // @param {string} fileName - file name, e.g `main/vis-views.json`
+            // @param {string} fileName - file name, e.g. `main/vis-views.json`
             // @param {function} callback - `function (error, isExist)`
             if (this._checkPermissions(socket, 'fileExists', callback, fileName)) {
                 try {
@@ -1130,17 +1153,17 @@ class SocketCommands {
         };
 
         this.commands['subscribeFiles'] = (socket, id, pattern, callback) => {
-            // Subscribe on file changes in ioBroker DB
+            // Subscribe to file changes in ioBroker DB
             // @param {string} id - instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
-            // @param {string} pattern - file name pattern, e.g `main/*.json`
+            // @param {string} pattern - file name pattern, e.g. `main/*.json`
             // @param {function} callback - `function (error)`
             return this._subscribeFiles(socket, id, pattern, callback);
         }
 
         this.commands['unsubscribeFiles'] = (socket, id, pattern, callback) => {
-            // Unsubscribe on file changes in ioBroker DB
+            // Unsubscribe from file changes in ioBroker DB
             // @param {string} id - instance name, e.g. `vis.0` or any object ID of type `meta`. `id` could have wildcards `*` too.
-            // @param {string} pattern - file name pattern, e.g `main/*.json`
+            // @param {string} pattern - file name pattern, e.g. `main/*.json`
             // @param {function} callback - `function (error)`
 
             return this._unsubscribeFiles(socket, id, pattern, callback);
@@ -1148,7 +1171,7 @@ class SocketCommands {
 
         this.commands['getAdapterInstances'] = (socket, adapterName, callback) => {
             // Read all instances of the given adapter, or all instances of all adapters if adapterName is not defined
-            // @param {string} adapterName - optional adapter name, e.g `history`.
+            // @param {string} adapterName - optional adapter name, e.g. `history`.
             // @param {function} callback - `function (error, instanceList)`, where instanceList is an array of instance objects, e.g. `{_id: 'system.adapter.history.0', common: {name: 'history', ...}, native: {...}}`
             if (typeof callback === 'function') {
                 if (this._checkPermissions(socket, 'getObject', callback)) {
@@ -1212,7 +1235,7 @@ class SocketCommands {
 
         this.commands['getForeignStates'] = (socket, pattern, callback) => {
             // Read all states (which might not belong to this adapter) which match the given pattern
-            // @param {string} pattern - pattern like
+            // @param {string} pattern - pattern like `system.adapter.*` or array of state IDs
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'getStates', callback)) {
                 if (typeof callback === 'function') {
@@ -1320,7 +1343,7 @@ class SocketCommands {
         this.commands['setBinaryState'] = (socket, id, base64, callback) => {
             // Write one binary state.
             // @param {string} id - State ID like, 'javascript.0.binary'
-            // @param {string} base64 - State value as base64 string. Binary states has no acknowledge flag.
+            // @param {string} base64 - State value as base64 string. Binary states have no acknowledged flag.
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'setState', callback, id)) {
                 if (typeof callback === 'function') {
@@ -1350,14 +1373,14 @@ class SocketCommands {
         };
 
         this.commands['subscribe'] = (socket, pattern, callback) => {
-            // Subscribe on state changes by pattern. The events will come as 'stateChange' events to the socket.
+            // Subscribe to state changes by pattern. The events will come as 'stateChange' events to the socket.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             return this._subscribeStates(socket, pattern, callback);
         };
 
         this.commands['subscribeStates'] = (socket, pattern, callback) => {
-            // Subscribe on state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
+            // Subscribe to state changes by pattern. Same as `subscribe`. The events will come as 'stateChange' events to the socket.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of states like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             return this._subscribeStates(socket, pattern, callback);
@@ -1401,11 +1424,30 @@ class SocketCommands {
 
         // not admin version of "all objects"
         // this function is overloaded in admin
-        this.commands['getObjects'] = (socket, callback) => {
+        this.commands['getObjects'] = (socket, list, callback) => {
             // Get all objects that are relevant for web: all states and enums with rooms
             // @param {string} id - object ID.
+            // @param {string[]} list - optional list of IDs.
             // @param {function} callback - `function (error, obj)`
-            if (this._checkPermissions(socket, 'getObjects', callback)) {
+            if (typeof list === 'function') {
+                callback = list;
+                list = null;
+            }
+            if (list && list.length) {
+                if (this._checkPermissions(socket, 'getObject', callback)) {
+                    if (typeof callback === 'function') {
+                        try {
+                            this.adapter.getForeignObjects(list, {user: socket._acl.user}, (error, objs) =>
+                                SocketCommands._fixCallback(callback, error, objs));
+                        } catch (error) {
+                            this.adapter.log.error(`[getObjects] ERROR: ${error.toString()}`);
+                            SocketCommands._fixCallback(callback, error);
+                        }
+                    } else {
+                        this.adapter.log.warn('[getObjects] Invalid callback');
+                    }
+                }
+            } else if (this._checkPermissions(socket, 'getObjects', callback)) {
                 try {
                     if (typeof callback === 'function') {
                         this.adapter.getForeignObjects('*', 'state', 'rooms', {user: socket._acl.user}, async (error, objs) => {
@@ -1437,7 +1479,7 @@ class SocketCommands {
         };
 
         this.commands['subscribeObjects'] = (socket, pattern, callback) => {
-            // Subscribe on object changes by pattern. The events will come as 'objectChange' events to the socket.
+            // Subscribe to object changes by pattern. The events will come as 'objectChange' events to the socket.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'subscribeObjects', callback, pattern)) {
@@ -1461,7 +1503,7 @@ class SocketCommands {
         };
 
         this.commands['unsubscribeObjects'] = (socket, pattern, callback) => {
-            // Unsubscribe on object changes by pattern.
+            // Unsubscribe from object changes by pattern.
             // @param {string} pattern - pattern like 'system.adapter.*' or array of IDs like ['system.adapter.admin.0.memRss', 'system.adapter.admin.0.memHeapTotal']
             // @param {function} callback - `function (error)`
             if (this._checkPermissions(socket, 'unsubscribeObjects', callback, pattern)) {
@@ -1540,6 +1582,48 @@ class SocketCommands {
                 SocketCommands._fixCallback(callback, SocketCommands.ERROR_PERMISSION);
             }
         };
+
+        this.commands['clientSubscribe'] = (socket, targetInstance, messageType, data, callback) => {
+            // Client informs specific instance about subscription on its messages. After subscription the socket will receive "im" messages from desired instance
+            // @param {string} targetInstance - instance name, e.g. "cameras.0"
+            // @param {string} messageType - message type, e.g. "startRecording/cam1"
+            // @param {object} data - optional data object, e.g. {width: 640, height: 480}
+            // @param {function} callback - `function (error, result)`, target instance MUST acknowledge the subscription and return some object as result
+            if (typeof data === 'function') {
+                callback = data;
+                data = null;
+            }
+            const sid = socket.id;
+            // GUI subscribes for messages from targetInstance
+            this.clientSubscribes[sid] = this.clientSubscribes[sid] || {};
+            this.clientSubscribes[sid][targetInstance] = this.clientSubscribes[sid][targetInstance] || [];
+            if (!this.clientSubscribes[sid][targetInstance].includes(messageType)) {
+                this.clientSubscribes[sid][targetInstance].push(messageType);
+            }
+            // inform instance about new subscription
+            this.adapter.sendTo(targetInstance, 'clientSubscribe', {type: messageType, sid, data}, result =>
+                SocketCommands._fixCallback(callback, null, result));
+        };
+
+        this.commands['clientUnsubscribe'] = (socket, targetInstance, messageType, callback) => {
+            // Client unsubscribes from specific instance's messages
+            // @param {string} targetInstance - instance name, e.g. "cameras.0"
+            // @param {string} messageType - message type, e.g. "startRecording/cam1"
+            // @param {function} callback - `function (error, wasSubscribed)`, target instance MUST NOT acknowledge the un-subscription
+            const sid = socket.id;
+            // GUI unsubscribes for messages from targetInstance
+            if (this.clientSubscribes[sid] && this.clientSubscribes[sid][targetInstance]) {
+                const pos = this.clientSubscribes[sid][targetInstance].indexOf(messageType);
+                if (pos !== -1) {
+                    this.clientSubscribes[sid][targetInstance].splice(pos, 1);
+                    // inform instance about unsubscription
+                    this.adapter.sendTo(targetInstance, 'clientUnsubscribe', {type: [messageType], sid});
+                    SocketCommands._fixCallback(callback, null, true);
+                    return;
+                }
+            }
+            SocketCommands._fixCallback(callback, null, false);
+        };
     }
 
     _initCommands() {
@@ -1549,6 +1633,20 @@ class SocketCommands {
         this.__initCommandsFiles();
     }
 
+    _informAboutDisconnect(socketId) {
+        // say to all instances, that this socket was disconnected
+        if (this.clientSubscribes[socketId]) {
+            Object.keys(this.clientSubscribes[socketId]).forEach(targetInstance => {
+                this.adapter.sendTo(targetInstance, 'clientUnsubscribe', {
+                    message: this.clientSubscribes[socketId][targetInstance],
+                    sid: socketId,
+                    provider: this.adapter.namespace
+                });
+            });
+            delete this.clientSubscribes[socketId];
+        }
+    }
+
     applyCommands(socket) {
         Object.keys(this.commands)
             .forEach(command => socket.on(command, (...args) => {