import type {Zigbee2MQTTAPI, Zigbee2MQTTResponse} from 'lib/types/api'; import fs from 'node:fs'; import path from 'node:path'; import {Context, runInNewContext} from 'node:vm'; import bind from 'bind-decorator'; import stringify from 'json-stable-stringify-without-jsonify'; import data from '../util/data'; import logger from '../util/logger'; import * as settings from '../util/settings'; import utils from '../util/utils'; import Extension from './extension'; const SUPPORTED_OPERATIONS = ['save', 'remove']; export default abstract class ExternalJSExtension extends Extension { protected mqttTopic: string; protected requestRegex: RegExp; protected basePath: string; constructor( zigbee: Zigbee, mqtt: MQTT, state: State, publishEntityState: PublishEntityState, eventBus: EventBus, enableDisableExtension: (enable: boolean, name: string) => Promise, restartCallback: () => Promise, addExtension: (extension: Extension) => Promise, mqttTopic: string, folderName: string, ) { super(zigbee, mqtt, state, publishEntityState, eventBus, enableDisableExtension, restartCallback, addExtension); this.mqttTopic = mqttTopic; this.requestRegex = new RegExp(`${settings.get().mqtt.base_topic}/bridge/request/${mqttTopic}/(save|remove)`); this.basePath = data.joinPath(folderName); } override async start(): Promise { await super.start(); this.eventBus.onMQTTMessage(this, this.onMQTTMessage); await this.loadFiles(); await this.publishExternalJS(); } private getFilePath(name: string, mkBasePath: boolean = false): string { if (mkBasePath && !fs.existsSync(this.basePath)) { fs.mkdirSync(this.basePath, {recursive: true}); } return path.join(this.basePath, name); } protected getFileCode(name: string): string { return fs.readFileSync(path.join(this.basePath, name), 'utf8'); } protected *getFiles(): Generator<{name: string; code: string}> { if (!fs.existsSync(this.basePath)) { return; } for (const fileName of fs.readdirSync(this.basePath)) { if (fileName.endsWith('.js')) { yield {name: fileName, code: this.getFileCode(fileName)}; } } } @bind async onMQTTMessage(data: eventdata.MQTTMessage): Promise { const match = data.topic.match(this.requestRegex); if (match && SUPPORTED_OPERATIONS.includes(match[1].toLowerCase())) { const message = utils.parseJSON(data.message, data.message); try { let response; if (match[1].toLowerCase() === 'save') { response = await this.save( message as Zigbee2MQTTAPI['bridge/request/converter/save'] | Zigbee2MQTTAPI['bridge/request/extension/save'], ); } else { response = await this.remove( message as Zigbee2MQTTAPI['bridge/request/converter/remove'] | Zigbee2MQTTAPI['bridge/request/extension/remove'], ); } await this.mqtt.publish(`bridge/response/${this.mqttTopic}/${match[1]}`, stringify(response)); } catch (error) { logger.error(`Request '${data.topic}' failed with error: '${(error as Error).message}'`); const response = utils.getResponse(message, {}, `${(error as Error).message}`); await this.mqtt.publish(`bridge/response/${this.mqttTopic}/${match[1]}`, stringify(response)); } } } protected abstract removeJS(name: string, module: M): Promise; protected abstract loadJS(name: string, module: M): Promise; @bind private async remove( message: Zigbee2MQTTAPI['bridge/request/converter/remove'] | Zigbee2MQTTAPI['bridge/request/extension/remove'], ): Promise> { if (!message.name) { return utils.getResponse(message, {}, `Invalid payload`); } const {name} = message; const toBeRemoved = this.getFilePath(name); if (fs.existsSync(toBeRemoved)) { await this.removeJS(name, this.loadModuleFromText(this.getFileCode(name), name)); fs.rmSync(toBeRemoved, {force: true}); logger.info(`${name} (${toBeRemoved}) removed.`); await this.publishExternalJS(); return utils.getResponse(message, {}); } else { return utils.getResponse(message, {}, `${name} (${toBeRemoved}) doesn't exists`); } } @bind private async save( message: Zigbee2MQTTAPI['bridge/request/converter/save'] | Zigbee2MQTTAPI['bridge/request/extension/save'], ): Promise> { if (!message.name || !message.code) { return utils.getResponse(message, {}, `Invalid payload`); } const {name, code} = message; try { await this.loadJS(name, this.loadModuleFromText(code, name)); const filePath = this.getFilePath(name, true); fs.writeFileSync(filePath, code, 'utf8'); logger.info(`${name} loaded. Contents written to '${filePath}'.`); await this.publishExternalJS(); return utils.getResponse(message, {}); } catch (error) { return utils.getResponse(message, {}, `${name} contains invalid code: ${(error as Error).message}`); } } private async loadFiles(): Promise { for (const extension of this.getFiles()) { await this.loadJS(extension.name, this.loadModuleFromText(extension.code, extension.name)); } } private async publishExternalJS(): Promise { await this.mqtt.publish( `bridge/${this.mqttTopic}s`, stringify(Array.from(this.getFiles())), { retain: true, qos: 0, }, settings.get().mqtt.base_topic, true, ); } private loadModuleFromText(moduleCode: string, name: string): M { const moduleFakePath = path.join(__dirname, '..', '..', 'data', 'extension', name); const sandbox: Context = { require: require, module: {}, console, setTimeout, clearTimeout, setInterval, clearInterval, setImmediate, clearImmediate, }; runInNewContext(moduleCode, sandbox, moduleFakePath); return sandbox.module.exports; } }