added all files to project

modules/default/updatenotification/README.md

@@ -0,0 +1,6 @@
+# Module: Update Notification
+
+The `updatenotification` module is one of the default modules of the MagicMirror.
+This will display a message whenever a new version of the MagicMirror application is available.
+
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/updatenotification.html).

modules/default/updatenotification/git_helper.js

@@ -0,0 +1,177 @@
+const util = require("util");
+const exec = util.promisify(require("child_process").exec);
+const fs = require("fs");
+const path = require("path");
+const Log = require("logger");
+
+class gitHelper {
+	constructor() {
+		this.gitRepos = [];
+		this.baseDir = path.normalize(__dirname + "/../../../");
+	}
+
+	getRefRegex(branch) {
+		return new RegExp("s*([a-z,0-9]+[.][.][a-z,0-9]+)  " + branch, "g");
+	}
+
+	async execShell(command) {
+		let res = { stdout: "", stderr: "" };
+		const { stdout, stderr } = await exec(command);
+
+		res.stdout = stdout;
+		res.stderr = stderr;
+		return res;
+	}
+
+	async isGitRepo(moduleFolder) {
+		let res = await this.execShell("cd " + moduleFolder + " && git remote -v");
+		if (res.stderr) {
+			Log.error("Failed to fetch git data for " + moduleFolder + ": " + res.stderr);
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+	add(moduleName) {
+		let moduleFolder = this.baseDir;
+		if (moduleName !== "default") {
+			moduleFolder = moduleFolder + "modules/" + moduleName;
+		}
+		try {
+			Log.info("Checking git for module: " + moduleName);
+			// Throws error if file doesn't exist
+			fs.statSync(path.join(moduleFolder, ".git"));
+			// Fetch the git or throw error if no remotes
+			if (this.isGitRepo(moduleFolder)) {
+				// Folder has .git and has at least one git remote, watch this folder
+				this.gitRepos.unshift({ module: moduleName, folder: moduleFolder });
+			}
+		} catch (err) {
+			// Error when directory .git doesn't exist or doesn't have any remotes
+			// This module is not managed with git, skip
+		}
+	}
+
+	async getStatusInfo(repo) {
+		let gitInfo = {
+			module: repo.module,
+			// commits behind:
+			behind: 0,
+			// branch name:
+			current: "",
+			// current hash:
+			hash: "",
+			// remote branch:
+			tracking: "",
+			isBehindInStatus: false
+		};
+		let res;
+		if (repo.module === "default") {
+			// the hash is only needed for the mm repo
+			res = await this.execShell("cd " + repo.folder + " && git rev-parse HEAD");
+			if (res.stderr) {
+				Log.error("Failed to get current commit hash for " + repo.module + ": " + res.stderr);
+			}
+			gitInfo.hash = res.stdout;
+		}
+		if (repo.res) {
+			// mocking
+			res = repo.res;
+		} else {
+			res = await this.execShell("cd " + repo.folder + " && git status -sb");
+		}
+		if (res.stderr) {
+			Log.error("Failed to get git status for " + repo.module + ": " + res.stderr);
+			// exit without git status info
+			return;
+		}
+		// only the first line of stdout is evaluated
+		let status = res.stdout.split("\n")[0];
+		// examples for status:
+		// ## develop...origin/develop
+		// ## master...origin/master [behind 8]
+		status = status.match(/(?![.#])([^.]*)/g);
+		// examples for status:
+		// [ ' develop', 'origin/develop', '' ]
+		// [ ' master', 'origin/master [behind 8]', '' ]
+		gitInfo.current = status[0].trim();
+		status = status[1].split(" ");
+		// examples for status:
+		// [ 'origin/develop' ]
+		// [ 'origin/master', '[behind', '8]' ]
+		gitInfo.tracking = status[0].trim();
+		if (status[2]) {
+			// git fetch was already called before so `git status -sb` delivers already the behind number
+			gitInfo.behind = parseInt(status[2].substring(0, status[2].length - 1));
+			gitInfo.isBehindInStatus = true;
+		}
+		return gitInfo;
+	}
+
+	async getRepoInfo(repo) {
+		let gitInfo;
+		if (repo.gitInfo) {
+			// mocking
+			gitInfo = repo.gitInfo;
+		} else {
+			gitInfo = await this.getStatusInfo(repo);
+		}
+		if (!gitInfo) {
+			return;
+		}
+		if (gitInfo.isBehindInStatus) {
+			return gitInfo;
+		}
+		let res;
+		if (repo.res) {
+			// mocking
+			res = repo.res;
+		} else {
+			res = await this.execShell("cd " + repo.folder + " && git fetch --dry-run");
+		}
+		// example output:
+		// From https://github.com/MichMich/MagicMirror
+		//    e40ddd4..06389e3  develop    -> origin/develop
+		// here the result is in stderr (this is a git default, don't ask why ...)
+		const matches = res.stderr.match(this.getRefRegex(gitInfo.current));
+		if (!matches || !matches[0]) {
+			// no refs found, nothing to do
+			return;
+		}
+		// get behind with refs
+		try {
+			res = await this.execShell("cd " + repo.folder + " && git rev-list --ancestry-path --count " + matches[0]);
+			gitInfo.behind = parseInt(res.stdout);
+			return gitInfo;
+		} catch (err) {
+			Log.error("Failed to get git revisions for " + repo.module + ": " + err);
+		}
+	}
+
+	async getStatus() {
+		const gitResultList = [];
+		for (let repo of this.gitRepos) {
+			const gitInfo = await this.getStatusInfo(repo);
+			if (gitInfo) {
+				gitResultList.unshift(gitInfo);
+			}
+		}
+
+		return gitResultList;
+	}
+
+	async getRepos() {
+		const gitResultList = [];
+		for (let repo of this.gitRepos) {
+			const gitInfo = await this.getRepoInfo(repo);
+			if (gitInfo) {
+				gitResultList.unshift(gitInfo);
+			}
+		}
+
+		return gitResultList;
+	}
+}
+
+module.exports.gitHelper = gitHelper;

modules/default/updatenotification/node_helper.js

@@ -0,0 +1,74 @@
+const GitHelper = require(__dirname + "/git_helper.js");
+const defaultModules = require(__dirname + "/../defaultmodules.js");
+const NodeHelper = require("node_helper");
+
+module.exports = NodeHelper.create({
+	config: {},
+
+	updateTimer: null,
+	updateProcessStarted: false,
+
+	gitHelper: new GitHelper.gitHelper(),
+
+	start: function () {},
+
+	configureModules: async function (modules) {
+		// Push MagicMirror itself , biggest chance it'll show up last in UI and isn't overwritten
+		// others will be added in front
+		// this method returns promises so we can't wait for every one to resolve before continuing
+		this.gitHelper.add("default");
+
+		for (let moduleName in modules) {
+			if (!this.ignoreUpdateChecking(moduleName)) {
+				this.gitHelper.add(moduleName);
+			}
+		}
+	},
+
+	socketNotificationReceived: function (notification, payload) {
+		if (notification === "CONFIG") {
+			this.config = payload;
+		} else if (notification === "MODULES") {
+			// if this is the 1st time thru the update check process
+			if (!this.updateProcessStarted) {
+				this.updateProcessStarted = true;
+				this.configureModules(payload).then(() => this.performFetch());
+			}
+		}
+	},
+
+	performFetch: async function () {
+		for (let gitInfo of await this.gitHelper.getRepos()) {
+			this.sendSocketNotification("STATUS", gitInfo);
+		}
+
+		this.scheduleNextFetch(this.config.updateInterval);
+	},
+
+	scheduleNextFetch: function (delay) {
+		if (delay < 60 * 1000) {
+			delay = 60 * 1000;
+		}
+
+		let self = this;
+		clearTimeout(this.updateTimer);
+		this.updateTimer = setTimeout(function () {
+			self.performFetch();
+		}, delay);
+	},
+
+	ignoreUpdateChecking: function (moduleName) {
+		// Should not check for updates for default modules
+		if (defaultModules.indexOf(moduleName) >= 0) {
+			return true;
+		}
+
+		// Should not check for updates for ignored modules
+		if (this.config.ignoreModules.indexOf(moduleName) >= 0) {
+			return true;
+		}
+
+		// The rest of the modules that passes should check for updates
+		return false;
+	}
+});

modules/default/updatenotification/updatenotification.js

@@ -0,0 +1,120 @@
+/* Magic Mirror
+ * Module: UpdateNotification
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
+ * MIT Licensed.
+ */
+Module.register("updatenotification", {
+	// Define module defaults
+	defaults: {
+		updateInterval: 10 * 60 * 1000, // every 10 minutes
+		refreshInterval: 24 * 60 * 60 * 1000, // one day
+		ignoreModules: [],
+		timeout: 5000
+	},
+
+	suspended: false,
+	moduleList: {},
+
+	// Override start method.
+	start: function () {
+		Log.info("Starting module: " + this.name);
+		setInterval(() => {
+			this.moduleList = {};
+			this.updateDom(2);
+		}, this.config.refreshInterval);
+	},
+
+	notificationReceived: function (notification, payload, sender) {
+		if (notification === "DOM_OBJECTS_CREATED") {
+			this.sendSocketNotification("CONFIG", this.config);
+			this.sendSocketNotification("MODULES", Module.definitions);
+			//this.hide(0, { lockString: this.identifier });
+		}
+	},
+
+	// Override socket notification handler.
+	socketNotificationReceived: function (notification, payload) {
+		if (notification === "STATUS") {
+			this.updateUI(payload);
+		}
+	},
+
+	updateUI: function (payload) {
+		if (payload && payload.behind > 0) {
+			// if we haven't seen info for this module
+			if (this.moduleList[payload.module] === undefined) {
+				// save it
+				this.moduleList[payload.module] = payload;
+				this.updateDom(2);
+			}
+			//self.show(1000, { lockString: self.identifier });
+		} else if (payload && payload.behind === 0) {
+			// if the module WAS in the list, but shouldn't be
+			if (this.moduleList[payload.module] !== undefined) {
+				// remove it
+				delete this.moduleList[payload.module];
+				this.updateDom(2);
+			}
+		}
+	},
+
+	diffLink: function (module, text) {
+		const localRef = module.hash;
+		const remoteRef = module.tracking.replace(/.*\//, "");
+		return '<a href="https://github.com/MichMich/MagicMirror/compare/' + localRef + "..." + remoteRef + '" ' + 'class="xsmall dimmed" ' + 'style="text-decoration: none;" ' + 'target="_blank" >' + text + "</a>";
+	},
+
+	// Override dom generator.
+	getDom: function () {
+		const wrapper = document.createElement("div");
+		if (this.suspended === false) {
+			// process the hash of module info found
+			for (const key of Object.keys(this.moduleList)) {
+				let m = this.moduleList[key];
+
+				const message = document.createElement("div");
+				message.className = "small bright";
+
+				const icon = document.createElement("i");
+				icon.className = "fa fa-exclamation-circle";
+				icon.innerHTML = "&nbsp;";
+				message.appendChild(icon);
+
+				const updateInfoKeyName = m.behind === 1 ? "UPDATE_INFO_SINGLE" : "UPDATE_INFO_MULTIPLE";
+
+				let subtextHtml = this.translate(updateInfoKeyName, {
+					COMMIT_COUNT: m.behind,
+					BRANCH_NAME: m.current
+				});
+
+				const text = document.createElement("span");
+				if (m.module === "default") {
+					text.innerHTML = this.translate("UPDATE_NOTIFICATION");
+					subtextHtml = this.diffLink(m, subtextHtml);
+				} else {
+					text.innerHTML = this.translate("UPDATE_NOTIFICATION_MODULE", {
+						MODULE_NAME: m.module
+					});
+				}
+				message.appendChild(text);
+
+				wrapper.appendChild(message);
+
+				const subtext = document.createElement("div");
+				subtext.innerHTML = subtextHtml;
+				subtext.className = "xsmall dimmed";
+				wrapper.appendChild(subtext);
+			}
+		}
+		return wrapper;
+	},
+
+	suspend: function () {
+		this.suspended = true;
+	},
+	resume: function () {
+		this.suspended = false;
+		this.updateDom(2);
+	}
+});