Fix crash possibility if module: <name> is not defined and on mista…

…ke `position: <position>` (#3445)

Fix #3442

CHANGELOG.md

@@ -23,6 +23,7 @@ _This release is scheduled to be released on 2024-07-01._
 
 ### Fixed
 
+- Fix crash possibility if `module: <name>` is not defined and on `postion: <positon>` misktake.
 - [weather] Fixed precipitationProbability in forecast for provider openmeteo (#3446)
 - [weather] Fixed type=daily for provider openmeteo having no data when running after 23:00 (#3449)
 - [weather] Fixed type=daily for provider openmeteo showing nightly icons in forecast when current time is "nightly" (#3458)

js/app.js

@@ -253,8 +253,15 @@ function App () {
 
 		let modules = [];
 		for (const module of config.modules) {
-			if (!modules.includes(module.module) && !module.disabled) {
-				modules.push(module.module);
+			if (module.disabled) continue;
+			if (module.module) {
+				if (Utils.moduleHasValidPosition(module.position) || typeof (module.position) === "undefined") {
+					modules.push(module.module);
+				} else {
+					Log.warn("Invalid module position found for this configuration:", module);
+				}
+			} else {
+				Log.warn("No module name found for this configuration:", module);
 			}
 		}
 

js/check_config.js

@@ -5,6 +5,10 @@ const { Linter } = require("eslint");
 
 const linter = new Linter();
 
+const Ajv = require("ajv");
+
+const ajv = new Ajv();
+
 const rootPath = path.resolve(`${__dirname}/../`);
 const Log = require(`${rootPath}/js/logger.js`);
 
@@ -59,6 +63,68 @@ function checkConfigFile () {
 		for (const error of errors) {
 			Log.error(`Line ${error.line} column ${error.column}: ${error.message}`);
 		}
+		return;
+	}
+
+	Log.info("Checking modules structure configuration... ");
+
+	// Make Ajv schema confguration of modules config
+	// only scan "module" and "position"
+	const schema = {
+		type: "object",
+		properties: {
+			modules: {
+				type: "array",
+				items: {
+					type: "object",
+					properties: {
+						module: {
+							type: "string"
+						},
+						position: {
+							type: "string",
+							enum: [
+								"top_bar",
+								"top_left",
+								"top_center",
+								"top_right",
+								"upper_third",
+								"middle_center",
+								"lower_third",
+								"bottom_left",
+								"bottom_center",
+								"bottom_right",
+								"bottom_bar",
+								"fullscreen_above",
+								"fullscreen_below"
+							]
+						}
+					},
+					required: ["module"]
+				}
+			}
+		}
+	};
+
+	// scan all modules
+	const validate = ajv.compile(schema);
+	const data = require(configFileName);
+
+	const valid = validate(data);
+	if (!valid) {
+		let module = validate.errors[0].instancePath.split("/")[2];
+		let position = validate.errors[0].instancePath.split("/")[3];
+
+		Log.error(colors.red("This module configuration contains errors:"));
+		Log.error(data.modules[module]);
+		if (position) {
+			Log.error(colors.red(`${position}: ${validate.errors[0].message}`));
+			Log.error(validate.errors[0].params.allowedValues);
+		} else {
+			Log.error(colors.red(validate.errors[0].message));
+		}
+	} else {
+		Log.info(colors.green("Your modules structure configuration doesn't contain errors :)"));
 	}
 }
 

js/loader.js

@@ -50,7 +50,8 @@ const Loader = (function () {
 	 * @returns {object[]} module data as configured in config
 	 */
 	const getAllModules = function () {
-		return config.modules;
+		const AllModules = config.modules.filter((module) => (module.module !== undefined) && (MM.getAvailableModulePositions.indexOf(module.position) > -1 || typeof (module.position) === "undefined"));
+		return AllModules;
 	};
 
 	/**

js/main.js

@@ -450,10 +450,10 @@ const MM = (function () {
 	 * an ugly top margin. By using this function, the top bar will be hidden if the
 	 * update notification is not visible.
 	 */
-	const updateWrapperStates = function () {
-		const positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
+	const modulePositions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
 
-		positions.forEach(function (position) {
+	const updateWrapperStates = function () {
+		modulePositions.forEach(function (position) {
 			const wrapper = selectWrapper(position);
 			const moduleWrappers = wrapper.getElementsByClassName("module");
 
@@ -701,7 +701,10 @@ const MM = (function () {
 		showModule (module, speed, callback, options) {
 			// do not change module.hidden yet, only if we really show it later
 			showModule(module, speed, callback, options);
-		}
+		},
+
+		// return all available module postions.
+		getAvailableModulePositions: modulePositions
 	};
 }());
 

js/utils.js

@@ -25,5 +25,16 @@ module.exports = {
 		} catch (e) {
 			Log.error(e);
 		}
+	},
+
+	// return all available module positions
+	getAvailableModulePositions () {
+		return ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
+	},
+
+	// return if postion is on modulePositions Array (true/false)
+	moduleHasValidPosition (position) {
+		if (this.getAvailableModulePositions().indexOf(position) === -1) return false;
+		return true;
 	}
 };

package.json

@@ -54,6 +54,7 @@
 		"*.css": "stylelint --fix"
 	},
 	"dependencies": {
+		"ajv": "^8.16.0",
 		"ansis": "^3.2.0",
 		"console-stamp": "^3.1.2",
 		"envsub": "^4.1.0",