iobroker.lovelace 4.1.9 → 4.1.10

package/README.md

@@ -473,6 +473,10 @@ After that checkout modified version in `./build` folder. Then.
 	PLACEHOLDER for the next version:
 	### **WORK IN PROGRESS**
 -->
+### 4.1.10 (2024-05-23)
+* (Garfonso) device icons work again.
+* (Garfonso) default user sometimes was not found in system.
+
 ### 4.1.9 (2024-04-26)
 * (Garfonso) add support for new service call structure.
 * (Garfonso) add support for delivering files from other adapters, for example, local cover images.
@@ -489,9 +493,6 @@ After that checkout modified version in `./build` folder. Then.
 ### 4.1.5 (2024-03-05)
 * (Garfonso) fixed: possible crashes during startup
 
-### 4.1.4 (2024-02-10)
-* (Garfonso) improved fix: lamp icons now turn gray on switch off.
-
 ## License
 
 Copyright 2019-2024, bluefox <dogafox@gmail.com>

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "lovelace",
-    "version": "4.1.9",
+    "version": "4.1.10",
     "news": {
+      "4.1.10": {
+        "en": "device icons work again (if authorization is required).\ndefault user sometimes was not found in system.",
+        "de": "gerätesymbole funktionieren wieder (wenn authorisierung notwendig).\nder eingestellte standard-benutzer wurde manchmal nicht im system gefunden.",
+        "ru": "иконки устройства снова работают.\nпользователь по умолчанию иногда не был найден в системе.",
+        "pt": "ícones do dispositivo funcionam novamente.\nusuário padrão às vezes não foi encontrado no sistema.",
+        "nl": "apparaatpictogrammen werken opnieuw.\nde standaardgebruiker werd soms niet gevonden in het systeem.",
+        "fr": "les icônes du périphérique fonctionnent à nouveau.\nl'utilisateur par défaut n'a parfois pas été trouvé dans le système.",
+        "it": "le icone del dispositivo funzionano di nuovo.\nutente predefinito a volte non è stato trovato nel sistema.",
+        "es": "los iconos del dispositivo funcionan de nuevo.\nusuario predeterminado a veces no se encontró en el sistema.",
+        "pl": "ikony urządzenia działają ponownie.\ndomyślny użytkownik czasami nie został znaleziony w systemie.",
+        "uk": "знову працюють іконки пристрою.\nне знайдено типовий користувач.",
+        "zh-cn": "设备图标再次工作.\n默认用户有时在系统中找不到 ."
+      },
       "4.1.9": {
         "en": "add support for new service call structure.\nadd support for delivering files from other adapters, for example, local cover images.\ncleaned up service descriptions.",
         "de": "unterstützung für neue service call-struktur hinzufügen.\nhinzufügen von unterstützung für die bereitstellung von dateien von anderen adaptern, zum beispiel lokale cover-bilder.\ngereinigte servicebeschreibungen.",
@@ -53,10 +66,6 @@
       "4.1.4": {
         "en": "improved fix: lamp icons now turn gray on switch off.",
         "de": "verbesserter fix: lampensymbole werden nun grau beim ausschalten."
-      },
-      "4.1.3": {
-        "en": "prevent warning for browser_mod/recall_id service call\nfix: lamp icons now turn gray on switch off.\nfix: notifications via sendTo work again.",
-        "de": "Verhindere warnung für browser_mod/recall_id service call\nfix: Lampensymbole werden nun grau beim ausschalten.\nfix: Benachrichtigung mittels sendTo funktionieren wieder."
       }
     },
     "titleLang": {
@@ -308,6 +317,18 @@
         "def": false
       }
     },
+    {
+      "_id": "info.configUpdateProcessed",
+      "type": "state",
+      "common": {
+        "name": "If a config update was processed",
+        "type": "boolean",
+        "read": true,
+        "write": false,
+        "role": "state",
+        "def": false
+      }
+    },
     {
       "_id": "info.readyForClients",
       "type": "state",

package/lib/modules/history.js

@@ -221,6 +221,7 @@ class HistoryModule {
     constructor(options) {
         this.adapter = options.adapter;
         this.entityData = options.entityData;
+        this.personModule = options.personModule;
     }
 
     async processRequest(req, res) {
@@ -233,7 +234,7 @@ class HistoryModule {
             entities.push(entity || id);
         }
 
-        const newResult = await getHistory(this.adapter, entities, new Date(req.params.start).getTime(), new Date(req.query.end_time).getTime(), req.query.noAttributes, req._user || this.adapter.config.defaultUser);
+        const newResult = await getHistory(this.adapter, entities, new Date(req.params.start).getTime(), new Date(req.query.end_time).getTime(), req.query.noAttributes, this.personModule.getUserIDFromName(req._user));
         const oldResult = [];
         for (const [entity_id, states] of Object.entries(newResult)) {
             const entityResult = [];
@@ -307,7 +308,7 @@ class HistoryModule {
                 entities.push(entity || id);
             }
 
-            const historyData = await getHistory(this.adapter, entities, parameters.startTime, Date.now(), parameters.noAttributes, this.adapter.config.defaultUser);
+            const historyData = await getHistory(this.adapter, entities, parameters.startTime, Date.now(), parameters.noAttributes, this.personModule.getUserIDFromName(ws.__auth?.username));
             sendHistoryResponse(ws, message.id, historyData, parameters);
             return true;
         }

package/lib/modules/person.js

@@ -28,24 +28,36 @@ class PersonModule {
      * @returns {string}
      */
     getUserIDFromName(name) {
+        if (!this.adapter.config.auth || name === this.adapter.config.defaultUser) {
+            return this.adapter.config.defaultUser;
+        }
+
+        if (typeof name !== 'string') { //prevent error if no user supplied.
+            throw new Error('Username supplied is not a string, can not find id: ' + name);
+        }
+
         for (const userObj of Object.values(this.usersCache)) {
             if (userObj.name === name) {
                 return userObj.iobId;
             }
         }
 
-        //fallback, default user "admin" is misleading, if user renamed admin.. hm. :-/
-        if (this.adapter.config.auth && name === 'admin') {
-            return 'system.user.admin';
-        }
-
         this.adapter.log.warn(`Could not get user id for ${name} - Trying with username` + JSON.stringify(this.usersCache['system.user.' + name.toLowerCase()]));
         return 'system.user.' + name.toLowerCase(); //hack and not correct since js-controller 3.2
     }
 
+    /**
+     * Get username for id. Needed for default user -> name conversion, for example.
+     * @param {string} id
+     * @returns {string | undefined}
+     */
+    getUserNameFromID(id) {
+        return this.usersCache[id]?.name;
+    }
+
     onObjectChange(id, obj) {
         if (id.startsWith('system.user.')) {
-            if (obj && obj.common && obj.common.enabled()) {
+            if (obj && obj.common && obj.common.enabled) {
                 this.usersCache[id] = {
                     iobId: obj._id,
                     name: obj.common.name || '',
@@ -62,6 +74,9 @@ class PersonModule {
 
     async init() {
         const userObjects = await this.adapter.getForeignObjectsAsync('system.user.*', 'user');
+        if (!this.adapter.config.defaultUser.startsWith('system.user.')) { //augment default user to be full id here once.
+            this.adapter.config.defaultUser = `system.user.${this.adapter.config.defaultUser}`;
+        }
         let defaultUserObject = null;
         for (const [id, obj] of Object.entries(userObjects)) {
             if (obj.common && obj.common.enabled) { //only show enabled persons?
@@ -72,7 +87,7 @@ class PersonModule {
                     picture: obj.common.icon,
                     description: obj.common.desc
                 };
-                if (obj.common.name === this.adapter.config.defaultUser) {
+                if (id === this.adapter.config.defaultUser) {
                     defaultUserObject = obj;
                 }
             }
@@ -80,16 +95,14 @@ class PersonModule {
 
         //default user only relevant for !auth.
         if (!defaultUserObject) {
-            //Ok, we did not find defaultUser object. Might be renamed admin?
-            defaultUserObject = userObjects['system.user.admin'];
-            this.adapter.config.defaultUser = defaultUserObject.common.name;
-            if (this.adapter.config.defaultUser !== 'admin' && !this.adapter.config.auth) {
-                //Activating auth will hide this setting. Not sure what to do then... In general: all users will be able to read everything in this case.
-                this.adapter.log.warn(`Could not find default user ${this.adapter.config.defaultUser} - Using admin - Please update your configuration.`);
+            if (!defaultUserObject && !this.adapter.config.auth) {
+                const configuredUserNotFound = `Could not find default user ${this.adapter.config.defaultUser}. Please update your configuration.`;
+                this.adapter.log.error(configuredUserNotFound);
+
+                throw new Error(configuredUserNotFound);
             }
         }
 
-
         await this.adapter.subscribeObjectsAsync('system.user.*');
     }
 }

package/lib/server.js

@@ -165,10 +165,6 @@ class WebServer {
                 adapter: this.adapter,
                 objects: this._objectData.objects
             }),
-            history: new HistoryModule({
-                adapter: this.adapter,
-                entityData: entityData
-            }),
             conversation: new ConversationModule({
                 adapter: this.adapter,
                 sendResponse: this._sendResponse,
@@ -198,6 +194,11 @@ class WebServer {
                 adapter: this.adapter
             })
         };
+        this._modules.history = new HistoryModule({
+            adapter: this.adapter,
+            entityData: entityData,
+            personModule: this._modules.person
+        });
 
         this.converter = {
             [Types.socket]:                 converterSwitch.processSocket,
@@ -276,6 +277,13 @@ class WebServer {
             }
             this.adapter.setState('info.readyForClients', true, true);
             this.log.debug('Initialization done.');
+        }).catch((err) => {
+            this.log.error(`Initialization error: ${err}`);
+            if (typeof this.adapter.terminate === 'function') {
+                this.adapter.terminate(utils.EXIT_CODES.INVALID_ADAPTER_CONFIG);
+            } else {
+                process.exit(utils.EXIT_CODES.INVALID_ADAPTER_CONFIG);
+            }
         });
     }
 
@@ -297,6 +305,7 @@ class WebServer {
         }
         await this._getAllStates();
         await this._manageSubscribesFromConfig();
+        this.log.debug('entitiesUpdated for startup.');
         await this.adapter.setStateAsync('info.entitiesUpdated', true, true);
     }
 
@@ -525,7 +534,7 @@ class WebServer {
     }
 
     async _processSingleCall(ws, data, entity_id) {
-        const user = this._modules.person.getUserIDFromName(ws.__auth.username || this.config.defaultUser);
+        const user = this._modules.person.getUserIDFromName(ws.__auth?.username);
 
         const entity = entityData.entityId2Entity[entity_id];
         const id = entity.context.STATE.setId;
@@ -696,7 +705,7 @@ class WebServer {
             entity.state = 'unknown';
             if (entity.context.STATE && entity.context.STATE.getId) {
                 try {
-                    const user = this._modules.person.getUserIDFromName(this.config.defaultUser); // TODO: why is this always defaultUser?
+                    const user = this.config.defaultUser;
                     const state = await this.adapter.getForeignStateAsync(entity.context.STATE.getId, {user});
                     if (state) {
                         await this.onStateChange(entity.context.STATE.getId, state);
@@ -1495,7 +1504,7 @@ class WebServer {
             file = file.substring(0, pos);
         }
         try {
-            const user = this._modules.person.getUserIDFromName(this.config.defaultUser); // TODO: why is this always default user?
+            const user = this._modules.person.getUserIDFromName(req._user);
             let data;
             if (file.startsWith('/lovelace/')) {
                 file = file.replace('/lovelace/', '');
@@ -1519,7 +1528,7 @@ class WebServer {
             file = file.substring(0, pos);
         }
         try {
-            const user = this._modules.person.getUserIDFromName(this.config.defaultUser); // TODO: why is this always default user?
+            const user = this._modules.person.getUserIDFromName(req._user);
             const data = await this.adapter.readFileAsync(this.adapter.namespace, file.replace('/local/custom_ui/', '/cards/'), {user});
             const pos = req.url.lastIndexOf('.');
             res.setHeader('content-type', (mime.getType || mime.lookup).call(data.mimeType, file.substring(pos + 1).toLowerCase()));
@@ -1864,15 +1873,17 @@ class WebServer {
                             }
                         }
                     }
-                } else {
-                    req._user = this.config.defaultUser;
                 }
 
+                //if no auth or page does not require auth, use default user:
+                //invalid token run into return above and close connection.
+                req._user = req._user || this.config.defaultUser;
+
                 next();
             }
         });
 
-        //handle local images  that are content of some states:
+        //handle local images that are content of some states:
         this._app.use(async (req, res, next) => {
             if (this._requestableFiles.includes(req.url)) {
                 if (!req._user) { //sadly frontend does not send auth info with most request.... :-/
@@ -1925,7 +1936,7 @@ class WebServer {
                 if (obj && obj.common.type === 'file')  {
                     contentType = (mime.getType || mime.lookup).call(mime, fileName[0]);
                 }
-                const user = this._modules.person.getUserIDFromName(this.config.defaultUser);
+                const user = this._modules.person.getUserIDFromName(req._user);
                 const data = await this.adapter.getBinaryStateAsync(fileName[0], {user});
                 if (data !== null && obj !== undefined) {
                     if (data && typeof data === 'object' && data.val !== undefined && data.ack !== undefined) {
@@ -1994,7 +2005,7 @@ class WebServer {
                 return res.status(404).json({error: 'Start or end misformated'});
             }
 
-            const user = this._modules.person.getUserIDFromName(this.config.defaultUser);
+            const user = this._modules.person.getUserIDFromName(req._user);
             try {
                 const state = await this.adapter.getForeignStateAsync(entity.context.STATE.getId, {user});
                 if (state && state.val) {
@@ -2076,10 +2087,10 @@ class WebServer {
     }
 
     async _getCurrentUser(ws) {
-        const user = this._modules.person.getUserIDFromName(ws.__auth.username || this.config.defaultUser);
+        const user = this._modules.person.getUserIDFromName(ws.__auth.username);
         const userObj = {
             id: user,
-            name: ws.__auth.username || this.config.defaultUser,
+            name: ws.__auth.username || this._modules.person.getUserNameFromID(this.config.defaultUser),
             is_owner: user === 'system.user.admin',
             is_admin: user === 'system.user.admin',
             credentials: [{auth_provider_type: 'iobroker', auth_provider_id: null}],
@@ -2165,7 +2176,7 @@ class WebServer {
             throw new Error('no entity found');
         } else {
             let id;
-            let userName = this.config.defaultUser;
+            let userName; // will be ignored in case of no authentication enabled.
             if (this.config.auth !== false && (token || access_token)) {
                 if (access_token) {
                     const now = Date.now();
@@ -2669,7 +2680,8 @@ class WebServer {
         if (id === `${this.adapter.namespace}.configuration`) {
             this._lovelaceConfig = obj.native;
             await this._manageSubscribesFromConfig();
-            await this.adapter.setStateAsync('info.entitiesUpdated', true, true);
+            this.log.debug(`configUpdateProcessed for config.`);
+            await this.adapter.setStateAsync('info.configUpdateProcessed', true, true);
         } else if (id === 'system.config') {
             if (obj && obj.common) {
                 this.lang = obj.common.language || this.lang || 'en';
@@ -2677,6 +2689,7 @@ class WebServer {
                 this.systemConfig = obj.common;
                 this._updateConstantEntities();
                 this.log.debug(`${id} -> config updated, constant entities updated.`);
+                this.log.debug('entitiesUpdated for system.config.');
                 await this.adapter.setStateAsync('info.entitiesUpdated', true, true);
             }
         } else {
@@ -2753,6 +2766,7 @@ class WebServer {
                     for (const id of idsWithUpdate) {
                         await this.onStateChange(id, null, true);
                     }
+                    this.log.debug('entitiesUpdated for object changes.');
                     await this.adapter.setStateAsync('info.entitiesUpdated', true, true);
                     this.log.debug('Had changes, updated states and notified entitiesUpdated state.');
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.lovelace",
-  "version": "4.1.9",
+  "version": "4.1.10",
   "description": "With this adapter you can build visualization for ioBroker with Home Assistant Lovelace UI",
   "author": {
     "name": "bluefox",