iobroker.gotify-ws 0.1.0

package/main.js

@@ -0,0 +1,411 @@
+/* eslint-disable prefer-const */
+'use strict';
+
+const WebSocket = require('ws');
+const utils = require('@iobroker/adapter-core');
+const adapterName = require('./package.json').name.split('.').pop();
+
+let systemLang = 'de'; // system language
+let ws = null;
+let timer = null;
+let stop = false;
+
+class GotifyWs extends utils.Adapter {
+	/**
+	 * @param {Partial<utils.AdapterOptions>} [options={}]
+	 */
+	constructor(options) {
+		super({
+			...options,
+			// @ts-ignore
+			name: adapterName,
+		});
+		this.on('ready', this.onReady.bind(this));
+		this.on('message', this.onMessage.bind(this));
+		this.on('unload', this.onUnload.bind(this));
+	}
+
+	async onReady() {
+		const sysLang = await this.getForeignObjectAsync('system.config');
+
+		if (sysLang && sysLang.common && sysLang.common.language) {
+			systemLang = sysLang.common.language;
+		}
+
+		this.setState('info.connection', false, true);
+		this.connectWebSocket();
+	}
+
+	/**
+	 * @param {() => void} callback
+	 */
+	onUnload(callback) {
+		this.setState('info.connection', false, true);
+
+		try {
+			if (ws) {
+				stop = true;
+				ws.close();
+				ws.terminate();
+				clearTimeout(timer);
+				timer = null;
+			}
+			callback();
+		} catch (e) {
+			callback();
+		}
+	}
+
+	/**
+	 * @param {{ command: string; from: string; callback: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo | undefined; }} obj
+	 */
+	async onMessage(obj) {
+		switch (obj.command) {
+			case 'sendToInstance':
+				// @ts-ignore
+				if (obj && obj.command === 'sendToInstance' && obj.message && obj.message.type) {
+					// eslint-disable-next-line prefer-const
+					let resultInstances = [];
+
+					// @ts-ignore
+					const instances = await this.getObjectViewAsync('system', 'instance', {
+						// @ts-ignore
+						startkey: `system.adapter.${obj.message.type}.`,
+						// @ts-ignore
+						endkey: `system.adapter.${obj.message.type}.\u9999`,
+					}).catch((err) => this.log.error(err));
+
+					if (instances && instances.rows && instances.rows.length != 0) {
+						instances.rows.forEach(async (row) => {
+							resultInstances.push({
+								label: row.id.replace('system.adapter.', ''),
+								value: row.id.replace('system.adapter.', ''),
+							});
+						});
+					} else {
+						resultInstances.push({
+							label: this._('none', systemLang),
+							value: 'none',
+						});
+					}
+					this.log.debug(`sendToInstance - ${JSON.stringify(obj)}`);
+					this.sendTo(obj.from, obj.command, resultInstances, obj.callback);
+				}
+				break;
+
+			case 'sendToTelegramUser':
+				// eslint-disable-next-line no-case-declarations
+				let useUsername = false;
+
+				// @ts-ignore
+				if (obj && obj.command === 'sendToTelegramUser' && obj.message && obj.message.instance) {
+					// @ts-ignore
+					const inst = obj.message.instance ? obj.message.instance : this.config.telegramInstance;
+					const userList = await this.getForeignStateAsync(`${inst}.communicate.users`);
+					const configTelegram = await this.getForeignObjectAsync(`system.adapter.${inst}`);
+
+					if (configTelegram && configTelegram.native) {
+						const native = configTelegram.native;
+						useUsername = native.useUsername;
+					}
+
+					// eslint-disable-next-line prefer-const
+					let resultUser = [{ label: this._('All Receiver', systemLang), value: 'allTelegramUsers' }];
+
+					if (userList && userList.val) {
+						// @ts-ignore
+						const users = JSON.parse(userList.val);
+
+						for (const i in users) {
+							resultUser.push({
+								label: useUsername === true ? users[i].userName : users[i].firstName,
+								value: useUsername === true ? users[i].userName : users[i].firstName,
+							});
+						}
+
+						try {
+							this.sendTo(obj.from, obj.command, resultUser, obj.callback);
+						} catch (err) {
+							this.log.error(`Cannot parse stored user IDs from Telegram: ${err}`);
+						}
+					}
+				}
+				break;
+			case 'sendToDiscordTarget':
+				// @ts-ignore
+				if (obj && obj.command === 'sendToDiscordTarget' && obj.message && obj.message.instance) {
+					let resultTarget = [{ label: this._('none', systemLang), value: 'none' }];
+					// @ts-ignore
+					const targetList = await this.sendToAsync(obj.message.instance, 'getNotificationTargets', {});
+
+					if (Array.isArray(targetList)) {
+						for (const i in targetList) {
+							resultTarget.push({
+								label: targetList[i].value,
+								value: targetList[i].value,
+							});
+						}
+					}
+
+					try {
+						this.sendTo(obj.from, obj.command, resultTarget, obj.callback);
+					} catch (err) {
+						this.log.error(`Cannot parse stored user IDs from Discord: ${err}`);
+					}
+				} else if (obj && obj.command === 'sendToDiscordTarget') {
+					let resultTarget = [{ label: this._('none', systemLang), value: 'none' }];
+
+					try {
+						this.sendTo(obj.from, obj.command, resultTarget, obj.callback);
+					} catch (err) {
+						this.log.error(`Cannot parse stored user IDs from Discord: ${err}`);
+					}
+				}
+				break;
+		}
+	}
+
+	async connectWebSocket() {
+		if (this.config.ip && this.config.port) {
+			const uri = `ws://${this.config.ip}:${this.config.port}/stream`;
+
+			ws = new WebSocket(uri, {
+				headers: {
+					'X-Gotify-Key': this.config.token,
+				},
+			});
+
+			ws.on('open', () => {
+				this.setState('info.connection', true, true);
+				this.log.info('WebSocket connected');
+			});
+
+			ws.on('message', async (data) => {
+				const line = JSON.parse(data);
+				this.pushMessage(line);
+			});
+
+			ws.on('close', () => {
+				this.setState('info.connection', false, true);
+				this.log.info('WebSocket closed');
+				if (stop === false) {
+					timer = setTimeout(this.connectWebSocket, 5000);
+				}
+			});
+
+			ws.on('error', (err) => {
+				this.setState('info.connection', false, true);
+				// @ts-ignore
+				this.log.error('WebSocket error:', err);
+			});
+		} else {
+			this.log.error('WebSocket error: Please check your Configuration');
+		}
+	}
+
+	async pushMessage(line) {
+		if (this.config.notificationType) {
+			switch (this.config.notificationType) {
+				case 'telegram':
+					if (
+						this.config.telegramUser &&
+						this.config.telegramUser === 'allTelegramUsers' &&
+						this.config.telegramInstance
+					) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title =
+							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
+
+						try {
+							this.sendTo(this.config.telegramInstance, 'send', {
+								parse_mode: 'HTML',
+								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Telegram message: ${err}`);
+						}
+					} else if (
+						this.config.telegramUser &&
+						this.config.telegramUser != 'allTelegramUsers' &&
+						this.config.telegramInstance
+					) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title =
+							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
+
+						try {
+							this.sendTo(this.config.telegramInstance, 'send', {
+								user: this.config.telegramUser,
+								parse_mode: 'HTML',
+								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Telegram message: ${err}`);
+						}
+					}
+					break;
+				case 'email':
+					if (this.config.emailInstance && this.config.emailReceiver && this.config.emailSender) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title = line.title != '' ? line.title.replace(/[`]/g, '') : 'Gotifi WS Message';
+
+						try {
+							this.sendTo(this.config.emailInstance, 'send', {
+								text: formatMessage,
+								to: this.config.emailReceiver,
+								subject: title,
+								from: this.config.emailSender,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending E-Mail message: ${err}`);
+						}
+					}
+					break;
+				case 'pushover':
+					if (
+						this.config.pushoverSilentNotice === true &&
+						this.config.pushoverInstance &&
+						this.config.pushoverDeviceID
+					) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title =
+							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
+
+						try {
+							this.sendTo(this.config.pushoverInstance, 'send', {
+								message: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+								sound: '',
+								priority: -1,
+								title: title,
+								device: this.config.pushoverDeviceID,
+								html: 1,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Pushover message: ${err}`);
+						}
+					} else if (this.config.pushoverInstance && this.config.pushoverDeviceID) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title =
+							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
+
+						try {
+							this.sendTo(this.config.pushoverInstance, 'send', {
+								message: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+								sound: '',
+								title: title,
+								device: this.config.pushoverDeviceID,
+								html: 1,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Pushover message: ${err}`);
+						}
+					}
+					break;
+				case 'whatsapp-cmb':
+					if (this.config.whatsappInstance) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title = line.title != '' ? `*${line.title.replace(/[`]/g, '')}*` : '*Gotifi WS Message*';
+
+						try {
+							this.sendTo(this.config.whatsappInstance, 'send', {
+								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending WhatsApp message: ${err}`);
+						}
+					}
+					break;
+				case 'signal-cmb':
+					if (this.config.signalInstance) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title = line.title != '' ? line.title.replace(/[`]/g, '') : 'Gotifi WS Message';
+
+						try {
+							this.sendTo(this.config.signalInstance, 'send', {
+								text: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Signal message: ${err}`);
+						}
+					}
+					break;
+				case 'matrix':
+					if (this.config.matrixInstance) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title =
+							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : '<b>Gotifi WS Message</b>';
+
+						try {
+							this.sendTo(this.config.matrixInstance, {
+								html: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+							});
+						} catch (err) {
+							this.log.warn(`Error sending Matrix message: ${err}`);
+						}
+					}
+					break;
+				case 'discord':
+					if (this.config.discordInstance && this.config.discordTarget) {
+						const message = line.message.replace(/[`]/g, '');
+						const formatMessage = message.replace(/[']/g, '"');
+						const title =
+							line.title != '' ? `<b>${line.title.replace(/[`]/g, '')}</b>` : 'Gotifi WS Message';
+
+						if (this.config.discordTarget.match(/^\d+$/)) {
+							// send to a single user
+							try {
+								this.sendTo(this.config.discordInstance, 'sendMessage', {
+									userId: this.config.discordTarget,
+									content: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+								});
+							} catch (err) {
+								this.log.warn(`Error sending Discord message: ${err}`);
+							}
+						} else if (this.config.discordTarget.match(/^\d+\/\d+$/)) {
+							// send to a server channel
+							const [serverId, channelId] = this.config.discordTarget.split('/');
+							try {
+								this.sendTo(this.config.discordInstance, 'sendMessage', {
+									serverId,
+									channelId,
+									content: `${title != '' ? `${title}\n` : ''}${formatMessage}`,
+								});
+							} catch (err) {
+								this.log.warn(`Error sending Discord message: ${err}`);
+							}
+						}
+					}
+					break;
+			}
+		} else {
+			this.log.error('Push-Message error: Please check your Configuration');
+		}
+	}
+	_(word, systemLang) {
+		const translations = require(`./admin/i18n/${systemLang ? systemLang : 'en'}/translations.json`);
+
+		if (translations[word]) {
+			return translations[word];
+		} else {
+			this.log.debug('Please translate in translations.json: ' + word);
+			return word;
+		}
+	}
+}
+
+if (require.main !== module) {
+	/**
+	 * @param {Partial<utils.AdapterOptions>} [options={}]
+	 */
+	module.exports = (options) => new GotifyWs(options);
+} else {
+	new GotifyWs();
+}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "iobroker.gotify-ws",
+  "version": "0.1.0",
+  "description": "Gotify web socket for connection to various notification systems",
+  "author": {
+    "name": "simatec",
+    "email": "simatec@simateccloud.de"
+  },
+  "homepage": "https://github.com/simatec/ioBroker.gotify-ws",
+  "license": "MIT",
+  "keywords": [
+    "Gotify",
+    "Websocket",
+    "Telegram",
+    "Whatsapp",
+    "Discord",
+    "Mail",
+    "Pushover"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/simatec/ioBroker.gotify-ws.git"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "dependencies": {
+    "@iobroker/adapter-core": "^3.1.6",
+    "ws": "^8.17.1",
+    "axios": "^1.7.2"
+  },
+  "devDependencies": {
+    "@alcalzone/release-script": "^3.7.0",
+    "@alcalzone/release-script-plugin-iobroker": "^3.7.1",
+    "@alcalzone/release-script-plugin-license": "^3.7.0",
+    "@alcalzone/release-script-plugin-manual-review": "^3.7.0",
+    "@iobroker/adapter-dev": "^1.3.0",
+    "@iobroker/testing": "^4.1.3",
+    "@tsconfig/node20": "^20.1.4",
+    "@types/chai": "^4.3.16",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.14.5",
+    "@types/proxyquire": "^1.3.31",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^3.2.12",
+    "chai": "^4.3.10",
+    "chai-as-promised": "^7.1.2",
+    "eslint": "^9.5.0",
+    "mocha": "^10.4.0",
+    "proxyquire": "^2.1.3",
+    "sinon": "^18.0.0",
+    "sinon-chai": "^3.7.0",
+    "typescript": "~5.4.5"
+  },
+  "main": "main.js",
+  "files": [
+    "admin{,/!(src)/**}/!(tsconfig|tsconfig.*|.eslintrc).json",
+    "admin{,/!(src)/**}/*.{html,css,png,svg,jpg,js}",
+    "lib/",
+    "www/",
+    "io-package.json",
+    "LICENSE",
+    "main.js"
+  ],
+  "scripts": {
+    "test": "npm run test:package && npm run test:unit",
+    "test:package": "mocha test/package --exit",
+    "test:unit": "mocha test/unit --exit",
+    "test:integration": "mocha test/integration --exit",
+    "release": "release-script",
+    "release-patch": "release-script patch --yes",
+    "release-minor": "release-script minor --yes",
+    "release-major": "release-script major --yes",
+    "translate": "translate-adapter"
+  },
+  "bugs": {
+    "url": "https://github.com/simatec/ioBroker.gotify-ws/issues"
+  },
+  "readmeFilename": "README.md"
+}