iobroker.javascript 9.3.0 → 10.0.0

package/build/lib/sandbox.js

@@ -33,18 +33,19 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FORBIDDEN_CHARS = void 0;
+exports.isValidPattern = isValidPattern;
+exports.pattern2RegEx = pattern2RegEx;
 exports.isExactId = isExactId;
 exports.removeFromDispatchIndex = removeFromDispatchIndex;
 exports.sandBox = sandBox;
 const jsonataMod = __importStar(require("jsonata"));
-const adapter_core_1 = require("@iobroker/adapter-core");
 const tools_1 = require("./tools");
 const constsMod = __importStar(require("./consts"));
 const wordsMod = __importStar(require("./words"));
 const eventObjMod = __importStar(require("./eventObj"));
 const patternCompareFunctions_1 = require("./patternCompareFunctions");
 const SCRIPT_CODE_MARKER = 'script.js.';
-const pattern2RegEx = adapter_core_1.commonTools.pattern2RegEx;
 // Pre-compiled RegExp constants for formatTimeDiff – avoids recompiling on every call
 const FTD_TEST_D = /(?<!\\)[DTД]/;
 const FTD_REPL_DD = /(?<!\\)(?:DD|TT|ДД)/g;
@@ -70,6 +71,35 @@ const _SELECTOR_REGEXP_CACHE_MAX = 1000;
 const _selectorRegExpCache = new Map();
 /** Monotonically increasing handler-ID counter – avoids Date.now()+random collisions */
 let _handlerIdCounter = 1;
+/** All characters that may not appear in an object ID. */
+exports.FORBIDDEN_CHARS = /[^._\-/ :!#$%&()+=@^{}|~\p{Ll}\p{Lu}\p{Nd}]+/gu;
+/**
+ * Checks if a pattern is valid
+ *
+ * @param pattern The pattern to check for validity
+ */
+function isValidPattern(pattern) {
+    pattern = pattern.replace(/\*/g, '');
+    return !exports.FORBIDDEN_CHARS.test(pattern);
+}
+/**
+ * Converts ioB pattern into regex.
+ *
+ * This funtion was copied from js-controller, as for the tests it is required, that function must be defined here.
+ * Else the adapter-core tries to find js-controller and it is not installed.
+ *
+ * @param pattern - Regex string to use it in new RegExp(pattern)
+ */
+function pattern2RegEx(pattern) {
+    pattern = (pattern || '').toString();
+    if (!isValidPattern(pattern)) {
+        throw new Error(`The pattern "${pattern}" is not a valid ID pattern`);
+    }
+    const startsWithWildcard = pattern[0] === '*';
+    const endsWithWildcard = pattern[pattern.length - 1] === '*';
+    pattern = pattern.replace(/[-/\\^$+?.()|[\]{}]/g, '\\$&').replace(/\*/g, '.*');
+    return (startsWithWildcard ? '' : '^') + pattern + (endsWithWildcard ? '' : '$');
+}
 /** Returns true when patId is a plain exact state-ID (no wildcards, no RegExp notation). */
 function isExactId(patId) {
     return (!!patId && typeof patId === 'string' && !patId.includes('*') && !patId.includes('?') && !patId.startsWith('/'));
@@ -100,7 +130,7 @@ function removeFromDispatchIndex(ctx, sub) {
         }
     }
 }
-function sandBox(script, name, verbose, debug, context) {
+function sandBox(script, name, verbose, debug, context, logCollector) {
     const consts = constsMod;
     const words = wordsMod;
     const eventObj = eventObjMod;
@@ -435,7 +465,7 @@ function sandBox(script, name, verbose, debug, context) {
                     actualCommonType = getCommonTypeOf(stateNotNull.val);
                 }
             }
-            else if (stateNotNull !== null && stateNotNull !== undefined) {
+            else if (stateNotNull !== undefined) {
                 actualCommonType = getCommonTypeOf(stateNotNull);
             }
             // If this is not the expected one, issue a warning
@@ -489,9 +519,7 @@ function sandBox(script, name, verbose, debug, context) {
         }
         let stateAsObject;
         // modify state here, to make it available in callback
-        if (stateNotNull === null ||
-            typeof stateNotNull !== 'object' ||
-            stateNotNull.val === undefined) {
+        if (stateNotNull === null || typeof stateNotNull !== 'object' || stateNotNull.val === undefined) {
             stateAsObject = context.prepareStateObject(id, {
                 val: stateNotNull,
                 ack: isAck === true || isAck === 'true',
@@ -1126,7 +1154,7 @@ function sandBox(script, name, verbose, debug, context) {
             return result;
         },
         log: function (msg, severity) {
-            severity = severity || 'info';
+            severity ||= 'info';
             // disable log in log handler (prevent endless loops)
             if (sandbox.logHandler && (sandbox.logHandler === severity || sandbox.logHandler === '*')) {
                 return;
@@ -1138,7 +1166,10 @@ function sandBox(script, name, verbose, debug, context) {
             if (msg && typeof msg !== 'string') {
                 msg = mods.util.format(msg);
             }
-            if (debugMode) {
+            if (logCollector) {
+                logCollector(severity, msg);
+            }
+            else if (debugMode) {
                 console.log(`${severity}$$${name}$$${msg}`, Date.now());
             }
             else {
@@ -1159,8 +1190,9 @@ function sandBox(script, name, verbose, debug, context) {
             context.logSubscriptions[sandbox.scriptName].push(handler);
             context.updateLogSubscriptions();
             sandbox.__engine.__subscriptionsLog += 1;
-            sandbox.verbose &&
+            if (sandbox.verbose) {
                 sandbox.log(`onLog(severity=${severity}, id=${handler.id}) - logSubscriptions=${sandbox.__engine.__subscriptionsLog}`, 'info');
+            }
             if (sandbox.__engine.__subscriptionsLog %
                 adapter.config.maxTriggersPerScript ===
                 0) {
@@ -1171,14 +1203,16 @@ function sandBox(script, name, verbose, debug, context) {
         onLogUnregister: function (idOrCallbackOrSeverity) {
             let found = false;
             if (context.logSubscriptions?.[sandbox.scriptName]) {
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`onLogUnregister(idOrCallbackOrSeverity=${JSON.stringify(idOrCallbackOrSeverity)}) - logSubscriptions=${sandbox.__engine.__subscriptionsLog}`, 'info');
+                }
                 for (let i = 0; i < context.logSubscriptions[sandbox.scriptName].length; i++) {
                     if (context.logSubscriptions[sandbox.scriptName][i].cb === idOrCallbackOrSeverity ||
                         context.logSubscriptions[sandbox.scriptName][i].id === idOrCallbackOrSeverity ||
                         context.logSubscriptions[sandbox.scriptName][i].severity === idOrCallbackOrSeverity) {
-                        sandbox.verbose &&
+                        if (sandbox.verbose) {
                             sandbox.log(`onLogUnregister(idOrCallbackOrSeverity=${JSON.stringify(idOrCallbackOrSeverity)}, removing id=${context.logSubscriptions[sandbox.scriptName][i].id})`, 'info');
+                        }
                         context.logSubscriptions[sandbox.scriptName].splice(i, 1);
                         i--;
                         sandbox.__engine.__subscriptionsLog--;
@@ -1188,9 +1222,8 @@ function sandBox(script, name, verbose, debug, context) {
                             break;
                         }
                     }
-                    else {
-                        sandbox.verbose &&
-                            sandbox.log(`onLogUnregister(idOrCallbackOrSeverity=${JSON.stringify(idOrCallbackOrSeverity)}) NOT = ${JSON.stringify(context.logSubscriptions[sandbox.scriptName][i])}`, 'info');
+                    else if (sandbox.verbose) {
+                        sandbox.log(`onLogUnregister(idOrCallbackOrSeverity=${JSON.stringify(idOrCallbackOrSeverity)}) NOT = ${JSON.stringify(context.logSubscriptions[sandbox.scriptName][i])}`, 'info');
                     }
                 }
             }
@@ -1382,8 +1415,9 @@ function sandBox(script, name, verbose, debug, context) {
                 // create temp directory
                 tempDirPath = fs.mkdtempSync(path.join(os.tmpdir(), `${sandbox.scriptName.substring(SCRIPT_CODE_MARKER.length)}-`));
                 context.tempDirectories[sandbox.scriptName] = tempDirPath;
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`createTempFile(fileName=${fileName}, tempDirPath=${tempDirPath}) created temp directory in ${os.tmpdir()}`, 'info');
+                }
             }
             const filePath = path.join(tempDirPath, fileName);
             // is sub dir?
@@ -1396,8 +1430,9 @@ function sandBox(script, name, verbose, debug, context) {
                 return undefined;
             }
             fs.writeFileSync(filePath, data);
-            sandbox.verbose &&
+            if (sandbox.verbose) {
                 sandbox.log(`createTempFile(fileName=${fileName}, fileDir=${fileDir}, filePath=${filePath})`, 'info');
+            }
             return filePath;
         },
         subscribe: function (pattern, 
@@ -1658,8 +1693,9 @@ function sandBox(script, name, verbose, debug, context) {
                             }
                         }
                     }
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`onEnumMembers(id=${enumId}, members=${JSON.stringify(Object.keys(subscriptions))})`, 'info');
+                    }
                 };
                 init();
                 sandbox.subscribeObject(enumId, obj => obj && init());
@@ -1689,8 +1725,9 @@ function sandBox(script, name, verbose, debug, context) {
                 return fileNamePattern.map(filePattern => sandbox.onFile(id, filePattern, withFileOrCallback, callback));
             }
             sandbox.__engine.__subscriptionsFile += 1;
-            sandbox.verbose &&
+            if (sandbox.verbose) {
                 sandbox.log(`onFile(id=${id}, fileNamePattern=${fileNamePattern}) - fileSubscriptions=${sandbox.__engine.__subscriptionsFile}`, 'info');
+            }
             if (sandbox.__engine.__subscriptionsFile %
                 adapter.config.maxTriggersPerScript ===
                 0) {
@@ -1712,8 +1749,9 @@ function sandBox(script, name, verbose, debug, context) {
                 fileRegEx,
                 callback: (id, fileName, size, withFile) => {
                     try {
-                        sandbox.verbose &&
+                        if (sandbox.verbose) {
                             sandbox.log(`onFile changed(id=${id}, fileName=${fileName}, size=${size})`, 'info');
+                        }
                         if (withFile && (size || 0) > 0) {
                             adapter
                                 .readFileAsync(id, fileName)
@@ -1746,8 +1784,9 @@ function sandBox(script, name, verbose, debug, context) {
                 sandbox.log('offFile: your js-controller does not support yet file unsubscribes. Please update to js-controller@4.1.x or newer', 'warn');
                 return false;
             }
-            sandbox.verbose &&
+            if (sandbox.verbose) {
                 sandbox.log(`offFile(idOrObject=${JSON.stringify(idOrObject)}, fileNamePattern=${JSON.stringify(fileNamePattern)}) - fileSubscriptions=${sandbox.__engine.__subscriptionsFile}`, 'info');
+            }
             if (idOrObject && typeof idOrObject === 'object') {
                 if (Array.isArray(idOrObject)) {
                     const result = [];
@@ -1759,8 +1798,9 @@ function sandBox(script, name, verbose, debug, context) {
                 for (let i = context.subscriptionsFile.length - 1; i >= 0; i--) {
                     if (context.subscriptionsFile[i] === idOrObject) {
                         unsubscribeFile(script, context.subscriptionsFile[i].id, context.subscriptionsFile[i].fileNamePattern);
-                        sandbox.verbose &&
+                        if (sandbox.verbose) {
                             sandbox.log(`offFile(type=object, fileNamePattern=${JSON.stringify(fileNamePattern)}, removing id=${context.subscriptionsFile[i].id})`, 'info');
+                        }
                         context.subscriptionsFile.splice(i, 1);
                         sandbox.__engine.__subscriptionsFile--;
                         return true;
@@ -1781,8 +1821,9 @@ function sandBox(script, name, verbose, debug, context) {
                     context.subscriptionsFile[i].fileNamePattern === fileNamePattern) {
                     deleted++;
                     unsubscribeFile(script, context.subscriptionsFile[i].id, context.subscriptionsFile[i].fileNamePattern);
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`offFile(type=string, fileNamePattern=${fileNamePattern}, removing id=${context.subscriptionsFile[i].id})`, 'info');
+                    }
                     context.subscriptionsFile.splice(i, 1);
                     sandbox.__engine.__subscriptionsFile--;
                 }
@@ -1815,8 +1856,9 @@ function sandBox(script, name, verbose, debug, context) {
             }
             if ((typeof pattern === 'string' && pattern[0] === '{') ||
                 (typeof pattern === 'object' && pattern.period)) {
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`schedule(wizard=${typeof pattern === 'object' ? JSON.stringify(pattern) : pattern})`, 'info');
+                }
                 if (!context.scheduler) {
                     sandbox.log(`Cannot schedule "${typeof pattern === 'object' ? JSON.stringify(pattern) : pattern}" because scheduler is not available`, 'error');
                     return null;
@@ -1888,8 +1930,9 @@ function sandBox(script, name, verbose, debug, context) {
                     if (sandbox.__engine.__schedules % adapterConfig.maxTriggersPerScript === 0) {
                         sandbox.log(`More than ${sandbox.__engine.__schedules} schedules registered. Check your script!`, 'warn');
                     }
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`schedule(astro=${astroPattern.astro}, offset=${astroPattern.shift}) is tomorrow, waiting until ${date.toISOString()}`, 'info');
+                    }
                     // Calculate new schedule in the next day
                     sandbox.setTimeout(() => {
                         if (sandbox.__engine.__schedules > 0) {
@@ -1918,8 +1961,9 @@ function sandBox(script, name, verbose, debug, context) {
                         sandbox.schedule(astroPattern, callback);
                     }, 2000);
                 }, ts.getTime() - Date.now());
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`schedule(astro=${astroPattern.astro}, offset=${astroPattern.shift}) is today, waiting until ${ts.toISOString()}`, 'info');
+                }
             }
             else {
                 // fix a problem with sunday and 7
@@ -1998,8 +2042,9 @@ function sandBox(script, name, verbose, debug, context) {
                     if (isValid) {
                         const cronExp = `${s ?? '0'} ${m ?? '0'} ${h ?? '0'} * * *`;
                         if (cronExp !== currentExp) {
-                            sandbox.verbose &&
+                            if (sandbox.verbose) {
                                 sandbox.log(`scheduleById(id=${id}): Init with expression ${cronExp} from ${time}`, 'info');
+                            }
                             currentExp = cronExp;
                             if (scheduleId) {
                                 sandbox.clearSchedule(scheduleId);
@@ -2039,8 +2084,9 @@ function sandBox(script, name, verbose, debug, context) {
             }
             sandbox.on(triggerDef, obj => {
                 if (obj?.state?.val) {
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`scheduleById(id=${id}): Update with value ${obj.state.val}`, 'info');
+                    }
                     init(obj.state.val.toString());
                 }
             });
@@ -2190,12 +2236,14 @@ function sandBox(script, name, verbose, debug, context) {
             if (!objects[id] && objects[`${adapter.namespace}.${id}`]) {
                 id = `${adapter.namespace}.${id}`;
             }
-            sandbox.verbose &&
+            if (sandbox.verbose) {
                 sandbox.log(`setStateDelayed(id=${id}, state=${JSON.stringify(state)}, isAck=${isAck}, delay=${delay}, clearRunning=${clearRunning})`, 'info');
+            }
             if (clearRunning) {
                 if (timers[id]) {
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`setStateDelayed: clear ${timers[id].length} running timers`, 'info');
+                    }
                     // collect affected scriptNames before deleting
                     const affectedScripts = new Set(timers[id].map(e => e.scriptName));
                     for (let i = 0; i < timers[id].length; i++) {
@@ -2442,16 +2490,18 @@ function sandBox(script, name, verbose, debug, context) {
                 }
                 else {
                     if (states[id]) {
-                        sandbox.verbose &&
+                        if (sandbox.verbose) {
                             sandbox.log(`getState(id=${id}, timerId=${JSON.stringify(timers[id])}) => ${JSON.stringify(states[id])}`, 'info');
+                        }
                         if (context.interimStateValues[id] !== undefined) {
                             return context.convertBackStringifiedValues(id, context.interimStateValues[id]);
                         }
                         return context.convertBackStringifiedValues(id, states[id]);
                     }
                     else if (states[`${adapter.namespace}.${id}`]) {
-                        sandbox.verbose &&
+                        if (sandbox.verbose) {
                             sandbox.log(`getState(id=${id}, timerId=${JSON.stringify(timers[id])}) => ${JSON.stringify(states[`${adapter.namespace}.${id}`])}`, 'info');
+                        }
                         if (context.interimStateValues[`${adapter.namespace}.${id}`] !== undefined) {
                             return context.convertBackStringifiedValues(id, context.interimStateValues[`${adapter.namespace}.${id}`]);
                         }
@@ -2509,8 +2559,9 @@ function sandBox(script, name, verbose, debug, context) {
             }
         },
         getIdByName: function (name, alwaysArray) {
-            sandbox.verbose &&
+            if (sandbox.verbose) {
                 sandbox.log(`getIdByName(name=${name}, alwaysArray=${alwaysArray}) => ${JSON.stringify(context.names[name])}`, 'info');
+            }
             if (Object.prototype.hasOwnProperty.call(context.names, name)) {
                 if (alwaysArray) {
                     return !Array.isArray(context.names[name]) ? [context.names[name]] : context.names[name];
@@ -2553,15 +2604,17 @@ function sandBox(script, name, verbose, debug, context) {
                         sandbox.log(`Object "${id}" can't be copied: ${JSON.stringify(err)}`, 'error');
                         return cb(null, null);
                     }
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`getObject(id=${id}, enumName=${enumName}) => ${JSON.stringify(result)}`, 'info');
+                    }
                     cb(err, result);
                 });
             }
             else {
                 if (!objects[id]) {
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`getObject(id=${id}, enumName=${enumName}) => does not exist`, 'info');
+                    }
                     sandbox.log(`Object "${id}" does not exist`, 'warn');
                     return null;
                 }
@@ -2579,8 +2632,9 @@ function sandBox(script, name, verbose, debug, context) {
                             }
                         }
                     }
-                    sandbox.verbose &&
+                    if (sandbox.verbose) {
                         sandbox.log(`getObject(id=${id}, enumName=${enumName}) => ${JSON.stringify(obj)}`, 'info');
+                    }
                     return obj;
                 }
                 let result;
@@ -2596,8 +2650,9 @@ function sandBox(script, name, verbose, debug, context) {
                     sandbox.log(`Object "${id}" can't be copied: ${JSON.stringify(err)}`, 'error');
                     return null;
                 }
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`getObject(id=${id}, enumName=${enumName}) => ${JSON.stringify(result)}`, 'info');
+                }
                 return result;
             }
         },
@@ -3303,8 +3358,9 @@ function sandBox(script, name, verbose, debug, context) {
             }
             // If specific instance
             if (_adapter.match(/\.[0-9]+$/)) {
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`sendTo(instance=${_adapter}, cmd=${cmd}, msg=${JSON.stringify(msg)}, hasCallback=${typeof callback === 'function'})`, 'info');
+                }
                 adapter.sendTo(_adapter, cmd, msg, cbFunc, options);
             }
             else {
@@ -3312,8 +3368,9 @@ function sandBox(script, name, verbose, debug, context) {
                 const cached = context.sendToInstanceCache.get(_adapter);
                 if (cached) {
                     cached.forEach(instance => {
-                        sandbox.verbose &&
+                        if (sandbox.verbose) {
                             sandbox.log(`sendTo(instance=${instance}, cmd=${cmd}, msg=${JSON.stringify(msg)}, hasCallback=${typeof callback === 'function'}) [cached]`, 'info');
+                        }
                         adapter.sendTo(instance, cmd, msg, cbFunc, options);
                     });
                 }
@@ -3335,8 +3392,9 @@ function sandBox(script, name, verbose, debug, context) {
                         }
                         context.sendToInstanceCache.set(_adapter, instances);
                         instances.forEach(instance => {
-                            sandbox.verbose &&
+                            if (sandbox.verbose) {
                                 sandbox.log(`sendTo(instance=${instance}, cmd=${cmd}, msg=${JSON.stringify(msg)}, hasCallback=${typeof callback === 'function'})`, 'info');
+                            }
                             adapter.sendTo(instance, cmd, msg, cbFunc, options);
                         });
                     });
@@ -3370,8 +3428,9 @@ function sandBox(script, name, verbose, debug, context) {
                 }
             }
             else {
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`sendToHost(adapter=${host}, cmd=${cmd}, msg=${JSON.stringify(msg)})`, 'info');
+                }
                 adapter.sendToHost(host, cmd, msg, callback);
             }
         },
@@ -3838,8 +3897,9 @@ function sandBox(script, name, verbose, debug, context) {
                 text = text
                     .replace(FTD_REPL_SS, seconds.toString().padStart(2, '0'))
                     .replace(FTD_REPL_S, seconds.toString());
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`formatTimeDiff(format=${format}, text=${text}, seconds=${seconds})`, 'debug');
+                }
             }
             for (const [pattern, replacement] of FTD_UNESCAPE) {
                 text = text.replace(pattern, replacement);
@@ -3983,8 +4043,9 @@ function sandBox(script, name, verbose, debug, context) {
                 }
             }
             else {
-                sandbox.verbose &&
+                if (sandbox.verbose) {
                     sandbox.log(`rename(adapter=${_adapter}, oldName=${oldName}, newName=${newName})`, 'info');
+                }
                 if (callback) {
                     adapter.rename(_adapter, oldName, newName, callback);
                 }