iobroker.admin 7.1.1 → 7.1.2

package/build-backend/main.js

@@ -25,7 +25,6 @@ const web_1 = require("./lib/web");
 const adapterName = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), { encoding: 'utf-8' }))
     .name.split('.')
     .pop();
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const { getInstalledInfo } = utils.commonTools;
 const ONE_HOUR_MS = 3_600_000;
 const ERROR_PERMISSION = 'permissionError';
@@ -46,7 +45,6 @@ class Admin extends utils.Adapter {
     updaterTimeout;
     ratingTimeout;
     timerNews;
-    _running;
     _tasks;
     constructor(options = {}) {
         options = {
@@ -67,8 +65,9 @@ class Admin extends utils.Adapter {
     }
     /**
      * Is called if a subscribed object changes
-     * @param id
-     * @param obj
+     *
+     * @param id object ID that changed
+     * @param obj the changed object value
      */
     onObjectChange(id, obj) {
         if (obj) {
@@ -87,7 +86,7 @@ class Admin extends utils.Adapter {
                 }
                 this.updaterTimeout = setTimeout(() => {
                     this.updaterTimeout = null;
-                    this.writeUpdateInfo();
+                    void this.writeUpdateInfo();
                 }, 5_000);
             }
         }
@@ -102,8 +101,9 @@ class Admin extends utils.Adapter {
     }
     /**
      * Is called if a subscribed state was changed
-     * @param id
-     * @param state
+     *
+     * @param id state ID that changed
+     * @param state the changed state value
      */
     onStateChange(id, state) {
         if (socket) {
@@ -118,38 +118,38 @@ class Admin extends utils.Adapter {
     /**
      * Is called when databases are connected and adapter received configuration.
      */
-    onReady() {
-        this.getForeignObject('system.config', (err, obj) => {
-            if (!err && obj) {
-                obj.native = obj.native || {};
-                if (this.config.language) {
-                    systemLanguage = this.config.language;
-                }
-                else if (obj.common?.language) {
-                    systemLanguage = obj.common.language;
-                }
-                if (!obj.native.secret) {
-                    crypto.randomBytes(24, (_ex, buf) => {
-                        this.secret = buf.toString('hex');
-                        this.extendForeignObject('system.config', { native: { secret: this.secret } });
-                        this.init();
-                    });
-                }
-                else {
-                    this.secret = obj.native.secret;
+    async onReady() {
+        const systemConfig = await this.getForeignObjectAsync('system.config');
+        if (systemConfig) {
+            systemConfig.native = systemConfig.native || {};
+            if (this.config.language) {
+                systemLanguage = this.config.language;
+            }
+            else if (systemConfig.common?.language) {
+                systemLanguage = systemConfig.common.language;
+            }
+            if (!systemConfig.native.secret) {
+                crypto.randomBytes(24, (_ex, buf) => {
+                    this.secret = buf.toString('hex');
+                    this.extendForeignObject('system.config', { native: { secret: this.secret } });
                     this.init();
-                }
+                });
             }
             else {
-                this.secret = secret;
-                this.log.error('Cannot find object system.config');
+                this.secret = systemConfig.native.secret;
+                this.init();
             }
-        });
+        }
+        else {
+            this.secret = secret;
+            this.log.error('Cannot find object system.config');
+        }
     }
     /**
      * Some message was sent to this instance over the message box. Used by email, pushover, text2speech, ...
      * Using this method requires "common.messagebox" property to be set to true in io-package.json
-     * @param obj
+     *
+     * @param obj the message object
      */
     onMessage(obj) {
         if (!obj) {
@@ -212,7 +212,8 @@ class Admin extends utils.Adapter {
     }
     /**
      * Is called when adapter shuts down - callback has to be called under any circumstances!
-     * @param callback
+     *
+     * @param callback Callback after unloading
      */
     onUnload(callback) {
         if (this.timerRepo) {
@@ -248,7 +249,7 @@ class Admin extends utils.Adapter {
     }
     async createUpdateInfo() {
         const promises = [];
-        // create connected object and state
+        // create a connected object and state
         const updatesNumberObj = objects[`${this.namespace}.info.updatesNumber`];
         if (!updatesNumberObj || !updatesNumberObj.common || updatesNumberObj.common.type !== 'number') {
             const obj = {
@@ -276,7 +277,7 @@ class Admin extends utils.Adapter {
                 },
                 native: {},
             };
-            this.setObject(obj._id, obj);
+            await this.setObject(obj._id, obj);
         }
         const updatesListObj = objects[`${this.namespace}.info.updatesList`];
         if (!updatesListObj || !updatesListObj.common || updatesListObj.common.type !== 'string') {
@@ -305,7 +306,7 @@ class Admin extends utils.Adapter {
                 },
                 native: {},
             };
-            this.setObject(obj._id, obj);
+            await this.setObject(obj._id, obj);
         }
         const newUpdatesObj = objects[`${this.namespace}.info.newUpdates`];
         if (!newUpdatesObj || !newUpdatesObj.common || newUpdatesObj.common.type !== 'boolean') {
@@ -402,29 +403,30 @@ class Admin extends utils.Adapter {
     /**
      * Write the update information to the states
      */
-    writeUpdateInfo(
+    async writeUpdateInfo(
     /** current sources, if given */
     sources) {
         if (!objects['system.config'] || !objects['system.config'].common) {
             return this.log.warn('Repository cannot be read. Invalid "system.config" object.');
         }
-        const { activeRepo } = objects['system.config'].common;
+        const activeRepo = objects['system.config']
+            .common?.activeRepo;
         const systemRepos = objects['system.repositories'];
         if (!sources) {
             sources = {};
             // If multi-repo case
             if (Array.isArray(activeRepo)) {
                 if (systemRepos?.native?.repositories) {
-                    activeRepo.forEach(repo => {
+                    for (const repo of activeRepo) {
                         if (systemRepos.native.repositories[repo]?.json) {
                             Object.assign(sources, systemRepos.native.repositories[repo].json);
                         }
                         else {
-                            this.setState('info.updatesNumber', 0, true);
-                            this.setState('info.updatesList', '', true);
-                            this.setState('info.newUpdates', false, true);
-                            this.setState('info.updatesJson', '{}', true);
-                            this.setState('info.lastUpdateCheck', Date.now(), true);
+                            await this.setState('info.updatesNumber', 0, true);
+                            await this.setState('info.updatesList', '', true);
+                            await this.setState('info.newUpdates', false, true);
+                            await this.setState('info.updatesJson', '{}', true);
+                            await this.setState('info.lastUpdateCheck', Date.now(), true);
                             if (systemRepos.native.repositories[repo]) {
                                 this.log.warn(`Repository cannot be read: Active repo - ${repo}`);
                             }
@@ -432,7 +434,7 @@ class Admin extends utils.Adapter {
                                 this.log.warn('No repository source configured');
                             }
                         }
-                    });
+                    }
                 }
             }
             else if (systemRepos?.native?.repositories?.[activeRepo]?.json) {
@@ -440,11 +442,11 @@ class Admin extends utils.Adapter {
             }
         }
         if (!Object.keys(sources).length) {
-            this.setState('info.updatesNumber', 0, true);
-            this.setState('info.updatesList', '', true);
-            this.setState('info.newUpdates', false, true);
-            this.setState('info.updatesJson', '{}', true);
-            this.setState('info.lastUpdateCheck', Date.now(), true);
+            await this.setState('info.updatesNumber', 0, true);
+            await this.setState('info.updatesList', '', true);
+            await this.setState('info.newUpdates', false, true);
+            await this.setState('info.updatesJson', '{}', true);
+            await this.setState('info.lastUpdateCheck', Date.now(), true);
             if (Array.isArray(activeRepo)) {
                 let found = false;
                 if (systemRepos?.native?.repositories) {
@@ -462,7 +464,7 @@ class Admin extends utils.Adapter {
                 }
             }
             else if (systemRepos?.native?.repositories?.[activeRepo]) {
-                this.log.warn(`Repository cannot be read. Active repo: ${activeRepo}`);
+                this.log.warn(`Repository cannot be read. Active repo: "${activeRepo}"`);
             }
             else {
                 this.log.warn(`No repository source configured. Possible values: ${systemRepos?.native?.repositories
@@ -475,65 +477,64 @@ class Admin extends utils.Adapter {
         const list = [];
         const updatesJson = {};
         let newUpdateIndicator = false;
-        this.getState('info.updatesJson', (_err, state) => {
-            let oldUpdates;
-            if (typeof state?.val === 'string') {
-                try {
-                    oldUpdates = JSON.parse(state.val) || {};
-                }
-                catch (e) {
-                    oldUpdates = {};
-                    this.log.warn(`Cannot parse info.updatesJson: ${e}`);
-                }
+        const state = await this.getStateAsync('info.updatesJson');
+        let oldUpdates;
+        if (typeof state?.val === 'string') {
+            try {
+                oldUpdates = JSON.parse(state.val) || {};
             }
-            else {
+            catch (e) {
                 oldUpdates = {};
+                this.log.warn(`Cannot parse info.updatesJson: ${e}`);
             }
-            Object.keys(sources).forEach(name => {
-                try {
-                    if (installed[name]?.version && sources[name].version) {
-                        if (sources[name].version !== installed[name].version &&
-                            !this.upToDate(sources[name].version, installed[name].version)) {
-                            // Check if updates are new or already known to user
-                            if (!oldUpdates ||
-                                !oldUpdates[name] ||
-                                oldUpdates[name].availableVersion !== sources[name].version) {
-                                newUpdateIndicator = true;
-                            } // endIf
-                            updatesJson[name] = {
-                                availableVersion: sources[name].version,
-                                installedVersion: installed[name].version,
-                            };
-                            // remove first part of the name
-                            const n = name.indexOf('.');
-                            list.push(n === -1 ? name : name.substring(n + 1));
-                        }
+        }
+        else {
+            oldUpdates = {};
+        }
+        Object.keys(sources).forEach(name => {
+            try {
+                if (installed[name]?.version && sources[name].version) {
+                    if (sources[name].version !== installed[name].version &&
+                        !this.upToDate(sources[name].version, installed[name].version)) {
+                        // Check if updates are new or already known to user
+                        if (!oldUpdates ||
+                            !oldUpdates[name] ||
+                            oldUpdates[name].availableVersion !== sources[name].version) {
+                            newUpdateIndicator = true;
+                        } // endIf
+                        updatesJson[name] = {
+                            availableVersion: sources[name].version,
+                            installedVersion: installed[name].version,
+                        };
+                        // remove the first part of the name
+                        const n = name.indexOf('.');
+                        list.push(n === -1 ? name : name.substring(n + 1));
                     }
                 }
-                catch (err) {
-                    this.log.warn(`Error on version check for ${name}: ${err}`);
-                }
-            });
-            this.setState('info.updatesNumber', list.length, true);
-            this.setState('info.updatesList', list.join(', '), true);
-            this.setState('info.newUpdates', newUpdateIndicator, true);
-            this.setState('info.updatesJson', JSON.stringify(updatesJson), true);
-            this.setState('info.lastUpdateCheck', Date.now(), true);
-            if (!newUpdateIndicator) {
-                return;
             }
-            const textArr = [];
-            for (const [adapter, updateInfo] of Object.entries(updatesJson)) {
-                const text = (0, translations_1.getAdapterUpdateText)({
-                    adapter,
-                    installedVersion: updateInfo.installedVersion,
-                    newVersion: updateInfo.availableVersion,
-                    lang: systemLanguage,
-                });
-                textArr.push(text);
+            catch (err) {
+                this.log.warn(`Error on version check for ${name}: ${err}`);
             }
-            this.registerNotification('admin', 'adapterUpdates', textArr.join('\n'));
         });
+        await this.setState('info.updatesNumber', list.length, true);
+        await this.setState('info.updatesList', list.join(', '), true);
+        await this.setState('info.newUpdates', newUpdateIndicator, true);
+        await this.setState('info.updatesJson', JSON.stringify(updatesJson), true);
+        await this.setState('info.lastUpdateCheck', Date.now(), true);
+        if (!newUpdateIndicator) {
+            return;
+        }
+        const textArr = [];
+        for (const [adapter, updateInfo] of Object.entries(updatesJson)) {
+            const text = (0, translations_1.getAdapterUpdateText)({
+                adapter,
+                installedVersion: updateInfo.installedVersion,
+                newVersion: updateInfo.availableVersion,
+                lang: systemLanguage,
+            });
+            textArr.push(text);
+        }
+        await this.registerNotification('admin', 'adapterUpdates', textArr.join('\n'));
     }
     initSocket(server, store) {
         socket = new socket_classes_1.SocketAdmin(this.config, this, objects);
@@ -557,29 +558,11 @@ class Admin extends utils.Adapter {
         })
             .catch(error => this.log.error(`Cannot read UUID: ${error}`));
     }
-    processTasks() {
-        if (!this._running && this._tasks.length) {
-            this._running = true;
-            const obj = this._tasks.shift();
-            if (!obj.acl || obj.acl.owner !== this.config.defaultUser) {
-                obj.acl.owner = this.config.defaultUser;
-                this.setForeignObject(obj._id, obj, () => setImmediate(() => {
-                    this._running = false;
-                    this.processTasks();
-                }));
-            }
-            else {
-                setImmediate(() => {
-                    this._running = false;
-                    this.processTasks();
-                });
-            }
-        }
-    }
     async applyRightsToObjects(pattern, types) {
+        let len = 0;
         if (typeof types === 'object') {
             for (const type of types) {
-                this.applyRightsToObjects(pattern, type);
+                len += await this.applyRightsToObjects(pattern, type);
             }
         }
         else {
@@ -590,52 +573,53 @@ class Admin extends utils.Adapter {
                 });
                 this._tasks = this._tasks || [];
                 for (const row of doc.rows) {
-                    this._tasks.push(row.value);
+                    const obj = row.value;
+                    if (!obj.acl || obj.acl.owner !== this.config.defaultUser) {
+                        obj.acl.owner = this.config.defaultUser;
+                        await this.setForeignObjectAsync(obj._id, obj);
+                        len++;
+                    }
                 }
-                this.processTasks();
             }
             catch (e) {
                 this.log.error(`Error applying rights to objects: ${e.message}`);
             }
         }
+        return len;
     }
-    applyRights() {
-        const promises = [];
+    async applyRights() {
         this.config.accessAllowedConfigs = this.config.accessAllowedConfigs || [];
         this.config.accessAllowedTabs = this.config.accessAllowedTabs || [];
-        this.config.accessAllowedConfigs.forEach(id => promises.push(new Promise(resolve => this.getForeignObject(`system.adapter.${id}`, (err, obj) => {
+        let len = 0;
+        for (const id of this.config.accessAllowedConfigs) {
+            const obj = await this.getForeignObjectAsync(`system.adapter.${id}`);
             if (obj?.acl && obj.acl.owner !== this.config.defaultUser) {
                 obj.acl.owner = this.config.defaultUser;
-                this.setForeignObject(`system.adapter.${id}`, obj, err => resolve(!err));
+                await this.setForeignObjectAsync(`system.adapter.${id}`, obj);
+                len++;
             }
-            else {
-                resolve(false);
-            }
-        }))));
-        this.config.accessAllowedTabs.forEach(id => {
+        }
+        for (const id of this.config.accessAllowedTabs) {
             if (id.startsWith('devices.')) {
-                // change rights of all alias.*
-                this.applyRightsToObjects('alias', ['state', 'channel']);
+                // change rights of all `alias.*`
+                len += await this.applyRightsToObjects('alias', ['state', 'channel']);
             }
             else if (id.startsWith('javascript.')) {
                 // change rights of all script.js.*
-                this.applyRightsToObjects('javascript', ['script', 'channel']);
+                len += await this.applyRightsToObjects('javascript', ['script', 'channel']);
             }
             else if (id.startsWith('fullcalendar.')) {
                 // change rights of all fullcalendar.*
-                this.applyRightsToObjects('fullcalendar', ['schedule']);
+                len += await this.applyRightsToObjects('fullcalendar', ['schedule']);
             }
             else if (id.startsWith('scenes.')) {
                 // change rights of all scenes.*
-                this.applyRightsToObjects('scenes', ['state', 'channel']);
-            }
-        });
-        Promise.all(promises).then(results => {
-            const len = results.filter(r => !!r).length;
-            if (len) {
-                this.log.info(`Updated ${len} objects`);
+                len += await this.applyRightsToObjects('scenes', ['state', 'channel']);
             }
-        });
+        }
+        if (len) {
+            this.log.info(`Updated ${len} objects`);
+        }
     }
     /**
      * Read news from server and register them as notifications
@@ -830,8 +814,8 @@ class Admin extends utils.Adapter {
     /**
      * Check if adapter is active
      *
-     * @param adapterName
-     * @param instances
+     * @param adapterName name of the adapter
+     * @param instances list of instances
      */
     checkActive(adapterName, instances) {
         return !!Object.keys(instances)
@@ -841,8 +825,8 @@ class Admin extends utils.Adapter {
     /**
      * Check if conditions met
      *
-     * @param condition
-     * @param installedVersion
+     * @param condition condition to check
+     * @param installedVersion installed version
      */
     checkConditions(condition, installedVersion) {
         if (condition.startsWith('equals')) {
@@ -1161,7 +1145,7 @@ class Admin extends utils.Adapter {
                     this.config.tmpPath = tmpPath;
                     this.config.tmpPathAllow = true;
                 }
-                this.createUpdateInfo().then(() => this.writeUpdateInfo());
+                void this.createUpdateInfo().then(() => this.writeUpdateInfo());
             }
             if (callback) {
                 callback(this);
@@ -1244,9 +1228,9 @@ class Admin extends utils.Adapter {
                 this.timerRepo = null;
             }
             this.log.debug(`Next repo update on ${new Date(Date.now() + this.config.autoUpdate * ONE_HOUR_MS + 1).toLocaleString()}`);
-            this.timerRepo = setTimeout(() => {
+            this.timerRepo = setTimeout(async () => {
                 this.timerRepo = null;
-                this.updateRegister();
+                await this.updateRegister();
             }, this.config.autoUpdate * ONE_HOUR_MS + 1);
         }
     }
@@ -1270,17 +1254,15 @@ class Admin extends utils.Adapter {
     /**
      * Read repository information from active repository
      */
-    updateRegister() {
+    async updateRegister() {
         if (lastRepoUpdate && Date.now() - lastRepoUpdate < 3600000) {
             this.log.error('Automatic repository update is not allowed more than once a hour');
             this.restartRepoUpdate();
             return;
         }
         lastRepoUpdate = Date.now();
-        this.getForeignObject('system.config', async (err, systemConfig) => {
-            if (err) {
-                this.log.error('May not read "system.config"');
-            }
+        try {
+            const systemConfig = await this.getForeignObjectAsync('system.config');
             if (systemConfig?.common) {
                 try {
                     const repos = await this.getForeignObjectAsync('system.repositories');
@@ -1294,14 +1276,12 @@ class Admin extends utils.Adapter {
                     const active = systemConfig.common.activeRepo;
                     // if repo is valid and actual
                     if (Array.isArray(active)) {
-                        if (!err &&
-                            Date.now() < repos.ts + this.config.autoUpdate * ONE_HOUR_MS &&
+                        if (Date.now() < repos.ts + this.config.autoUpdate * ONE_HOUR_MS &&
                             !active.find(repo => !repos?.native?.repositories?.[repo]?.json)) {
                             exists = true;
                         }
                     }
-                    else if (!err &&
-                        repos?.native?.repositories?.[active]?.json &&
+                    else if (repos?.native?.repositories?.[active]?.json &&
                         Date.now() < repos.ts + this.config.autoUpdate * ONE_HOUR_MS) {
                         exists = true;
                     }
@@ -1342,9 +1322,9 @@ class Admin extends utils.Adapter {
                         if (this.timerRepo) {
                             clearTimeout(this.timerRepo);
                         }
-                        this.timerRepo = setTimeout(() => {
+                        this.timerRepo = setTimeout(async () => {
                             this.timerRepo = null;
-                            this.updateRegister();
+                            await this.updateRegister();
                         }, interval);
                     }
                 }
@@ -1352,7 +1332,10 @@ class Admin extends utils.Adapter {
                     this.log.error(`May not read "system.repositories": ${err}`);
                 }
             }
-        });
+        }
+        catch {
+            this.log.error('May not read "system.config"');
+        }
     }
     // this function re-check if the common objects like '0_userdata.0' exist
     async checkCommonObjects() {
@@ -1435,13 +1418,13 @@ class Admin extends utils.Adapter {
         if (!this.config.defaultUser.match(/^system\.user\./)) {
             this.config.defaultUser = `system.user.${this.config.defaultUser}`;
         }
-        this.checkCommonObjects().catch((e) => this.log.warn(`Cannot check common objects: ${e}`));
+        this.checkCommonObjects().catch((e) => this.log.warn(`Cannot check common objects: ${e?.message}`));
         this.getData(adapter => (webServer = new web_1.default(adapter.config, adapter, this.initSocket.bind(this), { systemLanguage })));
         if (this.config.accessApplyRights &&
             this.config.accessLimit &&
             !this.config.auth &&
             this.config.defaultUser !== 'system.user.admin') {
-            this.applyRights();
+            this.applyRights().catch((e) => this.log.warn(`Cannot apply rights: ${e?.message}`));
         }
         // By default, update repository every 24 hours
         if (this.config.autoUpdate === undefined || this.config.autoUpdate === null) {
@@ -1457,7 +1440,7 @@ class Admin extends utils.Adapter {
             this.config.autoUpdate = 590; // max interval is 2147483647 milliseconds
         }
         // check info.connected
-        this.getObjectAsync('info.connected').then(obj => {
+        void this.getObjectAsync('info.connected').then(obj => {
             if (!obj) {
                 const packageJson = JSON.parse(fs.readFileSync(`${__dirname}/../io-package.json`).toString('utf8'));
                 const obj = packageJson.instanceObjects.find((o) => o._id === 'info.connected');
@@ -1467,33 +1450,39 @@ class Admin extends utils.Adapter {
             }
         });
         if (this.config.autoUpdate) {
-            this.updateRegister();
+            void this.updateRegister().catch(e => this.log.error(`Cannot update repository: ${e}`));
         }
-        this.updateNews();
+        void this.updateNews().catch(e => this.log.error(`Cannot update news: ${e}`));
         this.updateIcons();
-        this.validateUserData0();
+        void this.validateUserData0().catch(e => this.log.error(`Cannot validate 0_userdata: ${e}`));
     }
     /**
      * Create 0_userdata if it does not exist
      */
-    validateUserData0() {
-        this.getForeignObject('0_userdata.0', (err, obj) => {
-            if (!obj) {
-                try {
-                    const ioContent = fs.readFileSync(`${utils.controllerDir}/io-package.json`).toString('utf8');
-                    const io = JSON.parse(ioContent);
-                    if (io.objects) {
-                        const userData = io.objects.find((obj) => obj._id === '0_userdata.0');
-                        if (userData) {
-                            this.setForeignObject(userData._id, userData, () => this.log.info('Object 0_userdata.0 was re-created'));
-                        }
+    async validateUserData0() {
+        let obj;
+        try {
+            obj = await this.getForeignObjectAsync('0_userdata.0');
+        }
+        catch {
+            // ignore
+        }
+        if (!obj) {
+            try {
+                const ioContent = fs.readFileSync(`${utils.controllerDir}/io-package.json`).toString('utf8');
+                const io = JSON.parse(ioContent);
+                if (io.objects) {
+                    const userData = io.objects.find((obj) => obj._id === '0_userdata.0');
+                    if (userData) {
+                        await this.setForeignObjectAsync(userData._id, userData);
+                        this.log.info('Object 0_userdata.0 was re-created');
                     }
                 }
-                catch (e) {
-                    this.log.error(`Cannot read ${utils.controllerDir}/io-package.json: ${e}`);
-                }
             }
-        });
+            catch (e) {
+                this.log.error(`Cannot read ${utils.controllerDir}/io-package.json: ${e}`);
+            }
+        }
     }
 }
 if (require.main !== module) {