iobroker.ical 1.13.6 → 1.14.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2023, bluefox <dogafox@gmail.com>
+Copyright (c) 2014-2024, bluefox <dogafox@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -32,6 +32,10 @@ Sentry reporting, starting with js-controller 3.0, means that this adapter can u
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 1.14.0 (2024-01-07)
+* (klein0r) Allow to set custom http user agent
+* (klein0r) Added option to use files tab for calendar files
+
 ### 1.13.6 (2023-12-25)
 * (mcm1957) Incorrect jsonConfig has been fixed [#602]
 * (mcm1957) Dependencies have been updated
@@ -49,14 +53,11 @@ Sentry reporting, starting with js-controller 3.0, means that this adapter can u
 * (klein0r) Dropped Admin 4 UI
 * (klein0r) Added Ukrainian language
 
-### 1.13.2 (2022-08-29)
-* (Apollon77) fix strange log messages by downgrading RRule again
-
 ## License
 
 The MIT License (MIT)
 
-Copyright (c) 2014-2023, bluefox <dogafox@gmail.com>
+Copyright (c) 2014-2024, bluefox <dogafox@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/admin/i18n/de/translations.json

@@ -30,5 +30,7 @@
     "user": "Benutzername",
     "Options": "Optionen",
     "Set ID": "ID festlegen",
-    "Set Ack": "Bestätigen"
+    "Set Ack": "Bestätigen",
+    "Use custom user agent": "Benutzerdefinierter User-Agent",
+    "User agent HTTP header": "User-Agent HTTP-Header"
 }

package/admin/i18n/en/translations.json

@@ -30,5 +30,7 @@
     "user": "Username",
     "Options": "Options",
     "Set ID": "Set ID",
-    "Set Ack": "Set Ack"
+    "Set Ack": "Set Ack",
+    "Use custom user agent": "Use custom user agent",
+    "User agent HTTP header": "User agent HTTP header"
 }

package/admin/i18n/es/translations.json

@@ -30,5 +30,7 @@
     "user": "Nombre de usuario",
     "Options": "Opciones",
     "Set ID": "Pon la identificacion",
-    "Set Ack": "Establecer acuse de recibo"
+    "Set Ack": "Establecer acuse de recibo",
+    "Use custom user agent": "Utilice un agente de usuario personalizado",
+    "User agent HTTP header": "Encabezado HTTP del agente de usuario"
 }

package/admin/i18n/fr/translations.json

@@ -30,5 +30,7 @@
     "user": "Nom d'utilisateur",
     "Options": "Choix",
     "Set ID": "Définir l'identifiant",
-    "Set Ack": "Confirmer"
+    "Set Ack": "Confirmer",
+    "Use custom user agent": "Utiliser un agent utilisateur personnalisé",
+    "User agent HTTP header": "En-tête HTTP de l'agent utilisateur"
 }

package/admin/i18n/it/translations.json

@@ -30,5 +30,7 @@
     "user": "Nome utente",
     "Options": "Opzioni",
     "Set ID": "Imposta l'ID",
-    "Set Ack": "Imposta Rispondi"
+    "Set Ack": "Imposta Rispondi",
+    "Use custom user agent": "Utilizza l'agente utente personalizzato",
+    "User agent HTTP header": "Intestazione HTTP dell'agente utente"
 }

package/admin/i18n/nl/translations.json

@@ -30,5 +30,7 @@
     "user": "Gebruikersnaam",
     "Options": "Opties",
     "Set ID": "ID instellen",
-    "Set Ack": "Set Ack"
+    "Set Ack": "Set Ack",
+    "Use custom user agent": "Gebruik een aangepaste user-agent",
+    "User agent HTTP header": "HTTP-header van gebruikersagent"
 }

package/admin/i18n/pl/translations.json

@@ -30,5 +30,7 @@
     "user": "Nazwa Użytkownika",
     "Options": "Opcje",
     "Set ID": "Ustaw ID",
-    "Set Ack": "Ustaw Potwierdź"
+    "Set Ack": "Ustaw Potwierdź",
+    "Use custom user agent": "Użyj niestandardowego klienta użytkownika",
+    "User agent HTTP header": "Nagłówek HTTP agenta użytkownika"
 }

package/admin/i18n/pt/translations.json

@@ -30,5 +30,7 @@
     "user": "Nome de usuário",
     "Options": "Opções",
     "Set ID": "Definir ID",
-    "Set Ack": "Definir confirmação"
+    "Set Ack": "Definir confirmação",
+    "Use custom user agent": "Use agente de usuário personalizado",
+    "User agent HTTP header": "Cabeçalho HTTP do agente do usuário"
 }

package/admin/i18n/ru/translations.json

@@ -30,5 +30,7 @@
     "user": "Имя пользователя",
     "Options": "Опции",
     "Set ID": "Установить идентификатор",
-    "Set Ack": "Установить подтверждение"
+    "Set Ack": "Установить подтверждение",
+    "Use custom user agent": "Использовать собственный пользовательский агент",
+    "User agent HTTP header": "HTTP-заголовок пользовательского агента"
 }

package/admin/i18n/uk/translations.json

@@ -30,5 +30,7 @@
     "user": "Ім'я користувача",
     "Options": "Опції",
     "Set ID": "Встановити ID",
-    "Set Ack": "Установити Ack"
+    "Set Ack": "Установити Ack",
+    "Use custom user agent": "Використовуйте спеціальний агент користувача",
+    "User agent HTTP header": "HTTP-заголовок агента користувача"
 }

package/admin/i18n/zh-cn/translations.json

@@ -30,5 +30,7 @@
     "user": "用户名",
     "Options": "选项",
     "Set ID": "设置名称",
-    "Set Ack": "设置确认"
+    "Set Ack": "设置确认",
+    "Use custom user agent": "使用自定义用户代理",
+    "User agent HTTP header": "用户代理 HTTP 标头"
 }

package/admin/jsonConfig.json

@@ -340,6 +340,22 @@
                             "default": false
                         }
                     ]
+                },
+                "customUserAgentEnabled": {
+                    "type": "checkbox",
+                    "newLine": true,
+                    "sm": 12,
+                    "md": 4,
+                    "lg": 4,
+                    "label": "Use custom user agent"
+                },
+                "customUserAgent": {
+                    "hidden": "!data.customUserAgentEnabled",
+                    "type": "text",
+                    "sm": 12,
+                    "md": 8,
+                    "lg": 8,
+                    "label": "User agent HTTP header"
                 }
             }
         },

package/admin/words.js

@@ -40,4 +40,6 @@ systemDictionary = {
     "Options": {                                      "en": "Options",                                          "de": "Optionen",                                         "ru": "Опции",                                            "pt": "Opções",                                           "nl": "Opties",                                           "fr": "Choix",                                            "it": "Opzioni",                                          "es": "Opciones",                                         "pl": "Opcje",                                            "uk": "Опції",                                            "zh-cn": "选项"},
     "Set ID": {                                       "en": "Set ID",                                           "de": "ID festlegen",                                     "ru": "Установить идентификатор",                         "pt": "Definir ID",                                       "nl": "ID instellen",                                     "fr": "Définir l'identifiant",                            "it": "Imposta l'ID",                                     "es": "Pon la identificacion",                            "pl": "Ustaw ID",                                         "uk": "Встановити ID",                                    "zh-cn": "设置名称"},
     "Set Ack": {                                      "en": "Set Ack",                                          "de": "Bestätigen",                                       "ru": "Установить подтверждение",                         "pt": "Definir confirmação",                              "nl": "Set Ack",                                          "fr": "Confirmer",                                        "it": "Imposta Rispondi",                                 "es": "Establecer acuse de recibo",                       "pl": "Ustaw Potwierdź",                                  "uk": "Установити Ack",                                   "zh-cn": "设置确认"},
+    "Use custom user agent": {                        "en": "Use custom user agent",                            "de": "Benutzerdefinierter User-Agent",                   "ru": "Использовать собственный пользовательский агент",  "pt": "Use agente de usuário personalizado",              "nl": "Gebruik een aangepaste user-agent",                "fr": "Utiliser un agent utilisateur personnalisé",       "it": "Utilizza l'agente utente personalizzato",          "es": "Utilice un agente de usuario personalizado",       "pl": "Użyj niestandardowego klienta użytkownika",        "uk": "Використовуйте спеціальний агент користувача",     "zh-cn": "使用自定义用户代理"},
+    "User agent HTTP header": {                       "en": "User agent HTTP header",                           "de": "User-Agent HTTP-Header",                           "ru": "HTTP-заголовок пользовательского агента",          "pt": "Cabeçalho HTTP do agente do usuário",              "nl": "HTTP-header van gebruikersagent",                  "fr": "En-tête HTTP de l'agent utilisateur",              "it": "Intestazione HTTP dell'agente utente",             "es": "Encabezado HTTP del agente de usuario",            "pl": "Nagłówek HTTP agenta użytkownika",                 "uk": "HTTP-заголовок агента користувача",                "zh-cn": "用户代理 HTTP 标头"},
 };

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "ical",
-    "version": "1.13.6",
+    "version": "1.14.0",
     "news": {
+      "1.14.0": {
+        "en": "Allow to set custom http user agent\nAdded option to use files tab for calendar files",
+        "de": "Erlauben Sie, benutzerdefinierte http-Benutzer-Agent\nOption hinzugefügt, um Dateien Tab für Kalenderdateien zu verwenden",
+        "ru": "Разрешить настроить пользовательский\nДобавлена возможность использования вкладки файлов для календарных файлов",
+        "pt": "Permitir definir agente de usuário http personalizado\nOpção adicionada para usar a guia de arquivos para arquivos de calendário",
+        "nl": "Aangepaste http-gebruikeragent instellen\nToegevoegd optie om bestanden te gebruiken tabblad voor agendabestanden",
+        "fr": "Permettre de définir un agent utilisateur http personnalisé\nAjout d'une option pour utiliser l'onglet fichiers pour les fichiers calendrier",
+        "it": "Consentire di impostare personalizzato http user agent\nAggiunta opzione per utilizzare scheda file per i file del calendario",
+        "es": "Permitir establecer un agente de usuario http personalizado\nOpción adicional para usar la pestaña de archivos para archivos de calendario",
+        "pl": "Zezwalaj na ustawianie niestandardowych użytkowników http\nDodano opcję użycia zakładki plików do plików kalendarza",
+        "uk": "Дозвольте встановити користувальницький агент\nДодана можливість використовувати вкладку файлів для календарних файлів",
+        "zh-cn": "允许设置自定义 http 用户代理\n为日历文件使用文件标签添加了选项"
+      },
       "1.13.6": {
         "en": "Incorrect jsonConfig has been fixed [#602]\nDependencies have been updated",
         "de": "Fehler in jsonConfig wurde behoben [#602]\nAbhängigkeiten wurden aktualisiert",
@@ -80,19 +93,6 @@
         "pl": "Zmiennikowa biblioteka",
         "uk": "Змінена бібліотека запитів",
         "zh-cn": "更改要求图书馆"
-      },
-      "1.13.0": {
-        "en": "Added Admin 5 UI\nTranslated all object names",
-        "de": "Admin 5 UI\nAlle Objektnamen übersetzt",
-        "ru": "Добавлено Admin 5 UI\nПереведено все названия объектов",
-        "pt": "Adicionado administrador 5 UI\nTraduzido todos os nomes de objetos",
-        "nl": "Admin 5 UI\nVertaald alle objectnamen",
-        "fr": "Ajout d'Admin 5 UI\nTranslated all object names",
-        "it": "Aggiunto 5 UI\nTradotto tutti i nomi degli oggetti",
-        "es": "Admin 5 UI\nTraducir todos los nombres de objetos",
-        "pl": "Admin 5\nPrzetłumaczył wszystkie nazwy obiektowe",
-        "uk": "Додано інтерфейс адміністратора 5\nПерекладено всі назви об'єктів",
-        "zh-cn": "增删5 UI\n所有物体的名称"
       }
     },
     "title": "iCal Calendar",
@@ -163,7 +163,7 @@
     },
     "dependencies": [
       {
-        "js-controller": ">=2.0.0"
+        "js-controller": ">=3.3.22"
       }
     ],
     "globalDependencies": [
@@ -195,10 +195,12 @@
         "pass": "",
         "sslignore": false,
         "color": "#FF0000",
-        "filter": "ignored events",
+        "filter": "",
         "filterregex": false
       }
     ],
+    "customUserAgentEnabled": false,
+    "customUserAgent": "Mozilla/5.0 (X11; Linux i686; rv:109.0) Gecko/20100101 Firefox/121.0",
     "events": [
       {
         "name": "Vacation",
@@ -212,6 +214,27 @@
     ]
   },
   "instanceObjects": [
+    {
+      "_id": "",
+      "type": "meta",
+      "common": {
+        "name": {
+          "en": "Meta storage for user files",
+          "de": "Meta-Speicher für Benutzerdateien",
+          "ru": "Meta Storage для файлов пользователей",
+          "pt": "Meta de armazenamento para arquivos de usuário",
+          "nl": "Meta opslag voor gebruikersbestanden",
+          "fr": "Stockage Meta pour les fichiers utilisateur",
+          "it": "Meta storage per i file utente",
+          "es": "Meta almacenamiento para archivos de usuario",
+          "pl": "Meta storage for user files",
+          "uk": "Зберігання мета для файлів користувачів",
+          "zh-cn": "用户档案的储存"
+        },
+        "type": "meta.user"
+      },
+      "native": {}
+    },
     {
       "_id": "events",
       "type": "channel",

package/main.js

@@ -157,10 +157,18 @@ Date.prototype.compare = function(b) {
     );
 };
 
-function getICal(urlOrFile, user, pass, sslignore, calName, cb) {
+async function getICal(urlOrFile, user, pass, sslignore, calName, cb) {
     // Is it file or URL
     if (!urlOrFile.match(/^https?:\/\//)) {
-        if (!fs.existsSync(urlOrFile)) {
+        const ioFileExists = await adapter.fileExistsAsync(adapter.namespace, urlOrFile);
+        if (ioFileExists) {
+            try {
+                const ioFile = await adapter.readFileAsync(adapter.namespace, urlOrFile);
+                cb(null, ioFile.file.toString());
+            } catch (e) {
+                cb && cb(`Cannot read ioBroker file "${urlOrFile}": ${e}`);
+            }
+        } else if (!fs.existsSync(urlOrFile)) {
             cb && cb(`File does not exist: "${urlOrFile}"`);
         } else {
             try {
@@ -178,6 +186,12 @@ function getICal(urlOrFile, user, pass, sslignore, calName, cb) {
             url: urlOrFile
         };
 
+        if (adapter.config.customUserAgentEnabled && adapter.config.customUserAgent) {
+            options.headers = {
+                'User-Agent': adapter.config.customUserAgent
+            };
+        }
+
         if (sslignore === 'ignore' || sslignore === 'true' || sslignore === true) {
             options.httpsAgent = new https.Agent({
                 rejectUnauthorized: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.ical",
-  "version": "1.13.6",
+  "version": "1.14.0",
   "description": "Allows read information from google calender and from iCal.",
   "author": {
     "name": "bluefox",
@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "@iobroker/adapter-core": "^3.0.4",
-    "axios": "1.6.2",
+    "axios": "1.6.5",
     "cloneextend": "^0.0.3",
     "json-schema": "^0.4.0",
     "node-ical": "^0.17.1",
@@ -53,10 +53,10 @@
     "@alcalzone/release-script-plugin-manual-review": "^3.7.0",
     "@iobroker/adapter-dev": "^1.2.0",
     "@iobroker/testing": "^4.1.0",
-    "@types/chai": "^4.3.6",
-    "@types/chai-as-promised": "^7.1.5",
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^20.10.5",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.10.6",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^17.0.2",
     "@types/sinon-chai": "^3.2.12",
@@ -65,7 +65,7 @@
     "chai-string": "^1.5.0",
     "eslint": "^8.56.0",
     "luxon": "^3.4.4",
-    "mocha": "^10.1.0",
+    "mocha": "^10.2.0",
     "proxyquire": "^2.1.3",
     "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",