MagicMirror/modules/default/updatenotification/updatenotification.js

/* 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: 1000
	},

	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);
	}
});