iobroker.motioneye 0.1.2 → 0.2.1

package/lib/cameraDiscovery.test.js

@@ -0,0 +1,76 @@
+'use strict';
+
+const { expect } = require('chai');
+const {
+	extractMediaFolderFromMotionEyeConfig,
+	mapMotionEyeCamera,
+	mergeMotionEyeCameras,
+	parseLoadCamerasMessage,
+} = require('./cameraDiscovery');
+
+describe('cameraDiscovery', () => {
+	it('extractMediaFolderFromMotionEyeConfig should read custom folder names', () => {
+		expect(
+			extractMediaFolderFromMotionEyeConfig({
+				root_directory: '/var/lib/motioneye/Bambu',
+			}),
+		).to.equal('Bambu');
+		expect(
+			extractMediaFolderFromMotionEyeConfig({
+				root_directory: '/var/lib/motioneye/Camera8',
+			}),
+		).to.equal('');
+	});
+
+	it('mapMotionEyeCamera should build admin row defaults', () => {
+		expect(
+			mapMotionEyeCamera(
+				{
+					id: 3,
+					name: 'Auffahrt',
+					root_directory: '/var/lib/motioneye/Auffahrt',
+				},
+				'still',
+			),
+		).to.deep.equal({
+			name: 'Auffahrt',
+			motionEyeId: 3,
+			id: '',
+			mediaFolder: 'Auffahrt',
+			defaultMode: 'still',
+			enabled: true,
+		});
+	});
+
+	it('parseLoadCamerasMessage should decode camerasPayload from admin jsonData', () => {
+		const cameras = [{ name: 'A', motionEyeId: 1 }];
+		const payload = parseLoadCamerasMessage({
+			motionHost: '192.168.1.1',
+			camerasPayload: encodeURIComponent(JSON.stringify(cameras)),
+		});
+
+		expect(payload.motionHost).to.equal('192.168.1.1');
+		expect(payload.cameras).to.deep.equal(cameras);
+	});
+
+	it('mergeMotionEyeCameras should keep existing rows and append missing ids', () => {
+		const result = mergeMotionEyeCameras(
+			[{ name: 'Carport', motionEyeId: 1, enabled: true, defaultMode: 'off' }],
+			[
+				{ id: 1, name: 'Carport ME' },
+				{ id: 2, name: 'Garten' },
+			],
+			'sharp',
+		);
+
+		expect(result.added).to.equal(1);
+		expect(result.cameras).to.have.length(2);
+		expect(result.cameras[0].name).to.equal('Carport');
+		expect(result.cameras[1]).to.deep.include({
+			name: 'Garten',
+			motionEyeId: 2,
+			defaultMode: 'sharp',
+			enabled: true,
+		});
+	});
+});

package/lib/cameraRegistry.js

@@ -31,6 +31,7 @@ function slugifyId(value) {
  * @property {number} motionEyeId
  * @property {boolean} [enabled]
  * @property {string} [defaultMode]
+ * @property {string} [mediaFolder] Folder name under /var/lib/motioneye
  */
 
 /**
@@ -41,6 +42,7 @@ function slugifyId(value) {
  * @property {number} motionEyeId
  * @property {boolean} enabled
  * @property {string} defaultMode
+ * @property {string} mediaFolder Sanitized folder name or empty
  */
 
 /**
@@ -98,6 +100,7 @@ function resolveCameras(cameras, fallbackDefaultMode = 'off') {
 			motionEyeId: Number(entry.motionEyeId),
 			enabled: entry.enabled !== false,
 			defaultMode: entry.defaultMode || fallbackDefaultMode,
+			mediaFolder: String(entry.mediaFolder || '').trim(),
 		});
 	}
 

package/lib/mediaStorage.js

@@ -0,0 +1,62 @@
+'use strict';
+
+/** Default MotionEye media base path (see motioneye.conf media_path). */
+const MOTIONEYE_MEDIA_BASE = '/var/lib/motioneye';
+
+/**
+ * Sanitize a single folder name segment (no path separators).
+ * @param {unknown} value
+ * @returns {string}
+ */
+function sanitizeMediaFolderName(value) {
+	const trimmed = String(value == null ? '' : value).trim();
+	if (!trimmed) {
+		return '';
+	}
+
+	if (/[/\\]/.test(trimmed) || trimmed.includes('..')) {
+		return '';
+	}
+
+	return trimmed
+		.replace(/[^\wäöüÄÖÜß .-]/g, '_')
+		.replace(/\s+/g, ' ')
+		.trim();
+}
+
+/**
+ * @param {unknown} folderName
+ * @returns {string} Full root_directory path or empty when invalid/unset
+ */
+function buildMediaRootDirectory(folderName) {
+	const folder = sanitizeMediaFolderName(folderName);
+	if (!folder) {
+		return '';
+	}
+
+	return `${MOTIONEYE_MEDIA_BASE}/${folder}`;
+}
+
+/**
+ * MotionEye config patch for custom file storage path.
+ * @param {unknown} folderName
+ * @returns {Record<string, unknown>}
+ */
+function buildStoragePatch(folderName) {
+	const rootDirectory = buildMediaRootDirectory(folderName);
+	if (!rootDirectory) {
+		return {};
+	}
+
+	return {
+		storage_device: 'custom-path',
+		root_directory: rootDirectory,
+	};
+}
+
+module.exports = {
+	MOTIONEYE_MEDIA_BASE,
+	sanitizeMediaFolderName,
+	buildMediaRootDirectory,
+	buildStoragePatch,
+};

package/lib/mediaStorage.test.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const { expect } = require('chai');
+const {
+	MOTIONEYE_MEDIA_BASE,
+	sanitizeMediaFolderName,
+	buildMediaRootDirectory,
+	buildStoragePatch,
+} = require('./mediaStorage');
+
+describe('mediaStorage', () => {
+	it('sanitizeMediaFolderName should reject path separators', () => {
+		expect(sanitizeMediaFolderName('Bambu')).to.equal('Bambu');
+		expect(sanitizeMediaFolderName('Innenhof I')).to.equal('Innenhof I');
+		expect(sanitizeMediaFolderName('/var/lib/foo')).to.equal('');
+		expect(sanitizeMediaFolderName('..')).to.equal('');
+	});
+
+	it('buildMediaRootDirectory should prepend MotionEye base path', () => {
+		expect(buildMediaRootDirectory('Bambu')).to.equal(`${MOTIONEYE_MEDIA_BASE}/Bambu`);
+		expect(buildMediaRootDirectory('')).to.equal('');
+	});
+
+	it('buildStoragePatch should return custom-path config', () => {
+		expect(buildStoragePatch('Carport')).to.deep.equal({
+			storage_device: 'custom-path',
+			root_directory: `${MOTIONEYE_MEDIA_BASE}/Carport`,
+		});
+		expect(buildStoragePatch('')).to.deep.equal({});
+	});
+});

package/lib/motionEyeApi.js

@@ -9,7 +9,7 @@ const SIGNATURE_REGEX = new RegExp('[^a-zA-Z0-9/?_.=&{}\\[\\]":, -]', 'g');
 const LIST_CACHE_MS = 15000;
 
 /**
- * @param {string|undefined} serverHeader
+ * @param {string | string[] | undefined} serverHeader
  * @returns {string}
  */
 function parseMotionEyeServerHeader(serverHeader) {
@@ -17,7 +17,8 @@ function parseMotionEyeServerHeader(serverHeader) {
 		return '';
 	}
 
-	const match = String(serverHeader).match(/^motionEye\/(.+)$/i);
+	const header = Array.isArray(serverHeader) ? serverHeader[0] : serverHeader;
+	const match = String(header).match(/^motionEye\/(.+)$/i);
 	return match ? match[1].trim() : '';
 }
 
@@ -152,6 +153,7 @@ function buildAuthPath(path, method, body, username, signKey) {
  * @property {number} status
  * @property {unknown} data
  * @property {string} body
+ * @property {import('node:http').IncomingHttpHeaders} [headers]
  */
 
 /**
@@ -174,7 +176,7 @@ function createMotionEyeApi(options) {
 	 * @param {string} path
 	 * @param {string} [method]
 	 * @param {string|null} [body]
-	 * @returns {Promise<{ status: number, body: string }>}
+	 * @returns {Promise<{ status: number, body: string, headers: import('node:http').IncomingHttpHeaders }>}
 	 */
 	function httpRequest(path, method = 'GET', body = null) {
 		return new Promise((resolve, reject) => {

package/lib/streamManager.js

@@ -84,10 +84,6 @@ function checkStreamPort(motionHost, port) {
 	});
 }
 
-function sleep(ms) {
-	return new Promise(resolve => setTimeout(resolve, ms));
-}
-
 /**
  * @typedef {object} StreamManagerDeps
  * @property {string} motionHost
@@ -104,6 +100,7 @@ function sleep(ms) {
  * @property {(level: string, message: string) => void} log
  * @property {(fn: () => void, ms: number) => unknown} setTimeoutFn
  * @property {(id: unknown) => void} clearTimeoutFn
+ * @property {(ms: number) => Promise<void>} delayFn
  * @property {() => Map<string, import('./cameraRegistry').ResolvedCamera>} getCamerasByChannel
  * @property {() => boolean} isUnloading
  */
@@ -209,7 +206,7 @@ function createStreamManager(deps) {
 	 */
 	async function publishStreamHtmlWhenReady(camera) {
 		const started = Date.now();
-		await sleep(deps.streamStartDelayMs);
+		await deps.delayFn(deps.streamStartDelayMs);
 
 		while (Date.now() - started < deps.streamReadyTimeoutMs) {
 			if (deps.isUnloading() || !(await isStreamEnabled(camera))) {
@@ -221,7 +218,7 @@ function createStreamManager(deps) {
 				uiConfig = await getStreamUiConfig(camera);
 			} catch (error) {
 				deps.log('debug', `Stream port query ${camera.name}: ${error.message}`);
-				await sleep(deps.streamRetryMs);
+				await deps.delayFn(deps.streamRetryMs);
 				continue;
 			}
 
@@ -234,7 +231,7 @@ function createStreamManager(deps) {
 			}
 
 			await setStreamLoadingHtml(camera);
-			await sleep(deps.streamRetryMs);
+			await deps.delayFn(deps.streamRetryMs);
 		}
 
 		if (await isStreamEnabled(camera)) {
@@ -289,7 +286,7 @@ function createStreamManager(deps) {
 		/** @type {Record<string, boolean>} */
 		const relinked = {};
 
-		await sleep(deps.streamStartDelayMs);
+		await deps.delayFn(deps.streamStartDelayMs);
 
 		while (Date.now() - started < deps.streamSiblingRelinkTimeoutMs) {
 			if (deps.isUnloading() || relinkRunIds[runKey] !== runId) {
@@ -328,7 +325,7 @@ function createStreamManager(deps) {
 				return;
 			}
 
-			await sleep(deps.streamRetryMs);
+			await deps.delayFn(deps.streamRetryMs);
 		}
 	}
 

package/main.js

@@ -7,7 +7,9 @@
 const utils = require('@iobroker/adapter-core');
 const { createMotionEyeApi } = require('./lib/motionEyeApi');
 const { createMotionApi } = require('./lib/motionApi');
+const { buildStoragePatch } = require('./lib/mediaStorage');
 const { INFO_STATE_LABELS } = require('./lib/infoLabels');
+const { mergeMotionEyeCameras, parseLoadCamerasMessage } = require('./lib/cameraDiscovery');
 const { resolveCameras, buildWebhookUrl } = require('./lib/cameraRegistry');
 const {
 	normalizeMode,
@@ -35,6 +37,12 @@ class Motioneye extends utils.Adapter {
 		});
 		this.on('ready', this.onReady.bind(this));
 		this.on('stateChange', this.onStateChange.bind(this));
+		this.on('message', obj => {
+			this.onMessage(obj).catch(error => {
+				this.log.error(`onMessage failed: ${error.stack || error.message || error}`);
+				this.replyToMessage(obj, { error: String(error.message || error) });
+			});
+		});
 		this.on('unload', this.onUnload.bind(this));
 
 		this.motionEyeApi = undefined;
@@ -93,6 +101,7 @@ class Motioneye extends utils.Adapter {
 			setState: (id, val, ack) => this.setStateAsync(id, val, ack),
 			log: (level, message) => this.log[level](message),
 			setTimeoutFn: (fn, ms) => this.setTimeout(fn, ms),
+			delayFn: ms => this.delay(ms),
 			clearTimeoutFn: id => {
 				// @ts-expect-error adapter-core branded Timeout id from setTimeout
 				this.clearTimeout(id);
@@ -209,7 +218,7 @@ class Motioneye extends utils.Adapter {
 	}
 
 	async ensureInfoStates() {
-		for (const [stateId, name] of Object.entries(INFO_STATE_LABELS)) {
+		for (const [stateId, labels] of Object.entries(INFO_STATE_LABELS)) {
 			const type = stateId === 'camerasOnline' ? 'number' : 'string';
 			const role =
 				stateId === 'connection' ? 'indicator.connected' : stateId === 'camerasOnline' ? 'value' : 'text';
@@ -217,7 +226,7 @@ class Motioneye extends utils.Adapter {
 			await this.setObjectNotExistsAsync(`${INFO_PREFIX}.${stateId}`, {
 				type: 'state',
 				common: {
-					name,
+					name: /** @type {ioBroker.StringOrTranslated} */ (labels),
 					type: stateId === 'connection' ? 'boolean' : type,
 					role,
 					read: true,
@@ -411,7 +420,7 @@ class Motioneye extends utils.Adapter {
 			{
 				id: 'streamUrl',
 				common: {
-					name: `${camera.name} stream HTML (inventwo)`,
+					name: `${camera.name} stream HTML`,
 					type: 'string',
 					role: 'text',
 					read: true,
@@ -462,6 +471,16 @@ class Motioneye extends utils.Adapter {
 			});
 		}
 
+		const streamUrlId = `${channelId}.streamUrl`;
+		const streamUrlName = `${camera.name} stream HTML`;
+		const streamUrlObject = await this.getObjectAsync(streamUrlId);
+		const currentStreamUrlName = streamUrlObject?.common?.name ? String(streamUrlObject.common.name) : '';
+		if (currentStreamUrlName && /\(inventwo\)|inventwo HTML/i.test(currentStreamUrlName)) {
+			await this.extendObjectAsync(streamUrlId, {
+				common: { name: streamUrlName },
+			});
+		}
+
 		const webhookUrl = this.getWebhookUrl(camera);
 		await this.setStateAsync(`${channelId}.webhookUrl`, webhookUrl, true);
 		await this.setStateAsync(`${channelId}.motionEyeId`, camera.motionEyeId, true);
@@ -534,6 +553,15 @@ class Motioneye extends utils.Adapter {
 			patch.video_streaming = false;
 		}
 
+		const storagePatch = buildStoragePatch(camera.mediaFolder);
+		if (camera.mediaFolder && !storagePatch.root_directory) {
+			this.log.warn(
+				`Invalid media folder for ${camera.name}: "${camera.mediaFolder}" — skipped (use a single folder name without slashes)`,
+			);
+		} else {
+			Object.assign(patch, storagePatch);
+		}
+
 		const result = await this.motionEyeApi.saveCameraConfig(camera.motionEyeId, patch);
 		await this.setStateAsync(`${channelId}.mode`, mode, true);
 		await this.setStateAsync(`${channelId}.status`, `Mode=${MODE_LABELS[mode]}`, true);
@@ -754,6 +782,74 @@ class Motioneye extends utils.Adapter {
 		}
 	}
 
+	/**
+	 * @param {ioBroker.Message} obj
+	 * @param {Record<string, unknown>} response
+	 */
+	replyToMessage(obj, response) {
+		if (!obj?.callback || !obj.from || !obj.command) {
+			return;
+		}
+
+		this.sendTo(obj.from, obj.command, response, obj.callback);
+	}
+
+	/**
+	 * @param {ioBroker.Message} obj
+	 */
+	async onMessage(obj) {
+		if (!obj || typeof obj.command !== 'string') {
+			return;
+		}
+
+		if (obj.command === 'loadCameras') {
+			await this.handleLoadCameras(obj);
+		}
+	}
+
+	/**
+	 * @param {ioBroker.Message} obj
+	 */
+	async handleLoadCameras(obj) {
+		const payload = parseLoadCamerasMessage(obj.message);
+
+		const motionHost = String(payload.motionHost || this.config.motionHost || '').trim();
+		const motionEyePort = Number(payload.motionEyePort ?? this.config.motionEyePort) || 8765;
+		const motionEyeUser = String(payload.motionEyeUser ?? this.config.motionEyeUser ?? 'admin');
+		const motionEyePassword = String(this.config.motionEyePassword ?? '');
+		const requestTimeoutMs = Number(payload.requestTimeoutMs ?? this.config.requestTimeoutMs) || 45000;
+		const defaultMode = String(payload.defaultMode || this.config.defaultMode || 'off');
+		const existingCameras = Array.isArray(payload.cameras) ? payload.cameras : this.config.cameras || [];
+
+		try {
+			if (!motionHost) {
+				throw new Error('MotionEye host is required');
+			}
+
+			const api = createMotionEyeApi({
+				host: motionHost,
+				motionEyePort,
+				username: motionEyeUser,
+				password: motionEyePassword,
+				requestTimeoutMs,
+				listCacheMs: 0,
+			});
+
+			const motionEyeList = await api.getCameraList();
+			const { cameras, added } = mergeMotionEyeCameras(existingCameras, motionEyeList, defaultMode);
+
+			this.log.info(`Loaded ${motionEyeList.length} camera(s) from MotionEye, added ${added} new row(s)`);
+
+			this.replyToMessage(obj, {
+				native: { cameras },
+				result: added > 0 ? 'added' : 'none',
+			});
+		} catch (error) {
+			this.log.error(`loadCameras failed: ${error.message}`);
+			this.replyToMessage(obj, { error: error.message });
+		}
+	}
+
 	/**
 	 * @param {() => void} callback
 	 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.motioneye",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Connect MotionEye cameras to ioBroker for motion detection, snapshots, and live streams",
   "author": {
     "name": "skvarel",
@@ -29,7 +29,7 @@
     "node": ">= 22"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^3.3.2"
+    "@iobroker/adapter-core": "^3.4.1"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^5.2.1",
@@ -74,6 +74,6 @@
   },
   "readmeFilename": "README.md",
   "overrides": {
-    "@iobroker/adapter-core": "^3.3.2"
+    "@iobroker/adapter-core": "^3.4.1"
   }
 }