node_helper.js

/* Magic Mirror
 * Module: Remote Control
 *
 * By Joseph Bethge
 * MIT Licensed.
 */
/* jshint node: true, esversion: 6 */

const NodeHelper = require("node_helper");
const path = require("path");
const url = require("url");
const fs = require("fs");
const util = require("util");
const exec = require("child_process").exec;
const os = require("os");
const simpleGit = require("simple-git");
const bodyParser = require("body-parser");
const express = require("express");

var defaultModules = require(path.resolve(__dirname + "/../default/defaultmodules.js"));

Module = {
    configDefaults: {},
    notificationHandler: {},
    register: function(name, moduleDefinition) {
        Module.configDefaults[name] = moduleDefinition.defaults;
        /* API EXTENSION - Added v2.0.0 */
        Module.notificationHandler[name] = ("notificationReceived" in moduleDefinition) ?
            moduleDefinition.notificationReceived.toString() : "";
    }
};

module.exports = NodeHelper.create(Object.assign({
        // Subclass start method.
        start: function() {
            var self = this;

            this.initialized = false;
            console.log("Starting node helper for: " + self.name);

            // load fall back translation
            self.loadTranslation("en");

            this.configOnHd = {};
            this.configData = {};

            this.waiting = [];

            this.template = "";
            this.modulesAvailable = [];
            this.modulesInstalled = [];

            this.delayedQueryTimers = {};

            fs.readFile(path.resolve(__dirname + "/remote.html"), function(err, data) {
                self.template = data.toString();
            });

            this.combineConfig();
            this.updateModuleList();
            this.createRoutes();

            /* API EXTENSION - Added v2.0.0 */
            this.externalApiRoutes = {};
            this.moduleApiMenu = {};
        },

        stop: function() {
            // Clear all timeouts for clean shutdown
            Object.keys(this.delayedQueryTimers).forEach(t => {
                clearTimeout(this.delayedQueryTimers[t]);
            });
        },

        onModulesLoaded: function() {
            /* CALLED AFTER MODULES AND CONFIG DATA ARE LOADED */
            /* API EXTENSION - Added v2.0.0 */
            this.createApiRoutes();
        },

        combineConfig: function() {
            // function copied from MichMich (MIT)
            var defaults = require(__dirname + "/../../js/defaults.js");
            var configFilename = path.resolve(__dirname + "/../../config/config.js");
            if (typeof(global.configuration_file) !== "undefined") {
                configFilename = global.configuration_file;
            }

            this.thisConfig = {};
            try {
                fs.accessSync(configFilename, fs.F_OK);
                var c = require(configFilename);
                var config = Object.assign({}, defaults, c);
                this.configOnHd = config;
                // Get the configuration for this module.
                if ("modules" in this.configOnHd) {
                    let thisModule = this.configOnHd.modules.find(m => m.module === 'MMM-Remote-Control');
                    if (thisModule && "config" in thisModule) {
                        this.thisConfig = thisModule.config;
                    }
                }
            } catch (e) {
                if (e.code == "ENOENT") {
                    console.error("MMM-Remote-Control WARNING! Could not find config file. Please create one. Starting with default configuration.");
                    this.configOnHd = defaults;
                } else if (e instanceof ReferenceError || e instanceof SyntaxError) {
                    console.error("MMM-Remote-Control WARNING! Could not validate config file. Please correct syntax errors. Starting with default configuration.");
                    this.configOnHd = defaults;
                } else {
                    console.error("MMM-Remote-Control WARNING! Could not load config file. Starting with default configuration. Error found: " + e);
                    this.configOnHd = defaults;
                }
            }

            this.loadTranslation(this.configOnHd.language);
        },

        createRoutes: function() {
            var self = this;

            this.expressApp.get("/remote.html", function(req, res) {
                if (self.template === "") {
                    res.send(503);
                } else {
                    res.contentType("text/html");
                    var transformedData = self.fillTemplates(self.template);
                    res.send(transformedData);
                }
            });

            this.expressApp.get("/get", function(req, res) {
                var query = url.parse(req.url, true).query;

                self.answerGet(query, res);
            });
            this.expressApp.post("/post", function(req, res) {
                var query = url.parse(req.url, true).query;

                self.answerPost(query, req, res);
            });

            this.expressApp.get("/config-help.html", function(req, res) {
                var query = url.parse(req.url, true).query;

                self.answerConfigHelp(query, res);
            });

            this.expressApp.get("/remote", function(req, res) {
                var query = url.parse(req.url, true).query;

                if (query.action) {
                    var result = self.executeQuery(query, res);
                    if (result === true) {
                        return;
                    }
                }
                res.send({ "status": "error", "reason": "unknown_command", "info": "original input: " + JSON.stringify(query) });
            });
        },

        capitalizeFirst: function(string) {
            return string.charAt(0).toUpperCase() + string.slice(1);
        },

        formatName: function(string) {
            string = string.replace(/MMM-/g, '').replace(/([a-z])([A-Z])/g, "$1 $2").replace(/(^|[-_])(\w)/g, function($0, $1, $2) {
                return ($1 && ' ') + $2.toUpperCase();
            });
            return string;
        },

        updateModuleList: function(force) {
            var self = this;
            var downloadModules = require('./scripts/download_modules');
            downloadModules({
                force: force,
                callback: (result) => {
                    if (result && result.startsWith("ERROR")) { console.error(result); }
                    this.readModuleData();
                }
            });
        },

        readModuleData: function() {
            var self = this;

            fs.readFile(path.resolve(__dirname + "/modules.json"), (err, data) => {
                self.modulesAvailable = JSON.parse(data.toString());

                for (let i = 0; i < self.modulesAvailable.length; i++) {
                    self.modulesAvailable[i].name = self.formatName(self.modulesAvailable[i].longname);
                    self.modulesAvailable[i].isDefaultModule = false;
                }

                for (let i = 0; i < defaultModules.length; i++) {
                    self.modulesAvailable.push({
                        longname: defaultModules[i],
                        name: self.capitalizeFirst(defaultModules[i]),
                        isDefaultModule: true,
                        installed: true,
                        author: "MichMich",
                        desc: "",
                        id: "MichMich/MagicMirror",
                        url: "https://github.com/MichMich/MagicMirror/wiki/MagicMirror%C2%B2-Modules#default-modules"
                    });
                    var module = self.modulesAvailable[self.modulesAvailable.length - 1];
                    var modulePath = self.configOnHd.paths.modules + "/default/" + defaultModules[i];
                    self.loadModuleDefaultConfig(module, modulePath);
                }

                // now check for installed modules
                fs.readdir(path.resolve(__dirname + "/.."), function(err, files) {
                    let installedModules = files.filter(f => ['node_modules', 'default', 'README.md'].indexOf(f) === -1);
                    installedModules.forEach((dir, i, a) => {
                        self.addModule(dir, (i === installedModules.length - 1));
                    });
                });
            });
        },

        addModule: function(folderName, lastOne) {
            var self = this;

            var modulePath = this.configOnHd.paths.modules + "/" + folderName;
            fs.stat(modulePath, (err, stats) => {
                if (stats.isDirectory()) {
                    var isInList = false;
                    var currentModule;
                    self.modulesInstalled.push(folderName);
                    for (var i = 0; i < self.modulesAvailable.length; i++) {
                        if (self.modulesAvailable[i].longname === folderName) {
                            isInList = true;
                            self.modulesAvailable[i].installed = true;
                            currentModule = self.modulesAvailable[i];
                        }
                    }
                    if (!isInList) {
                        var newModule = {
                            longname: folderName,
                            name: self.formatName(folderName),
                            isDefaultModule: false,
                            installed: true,
                            author: "unknown",
                            desc: "",
                            id: "local/" + folderName,
                            url: ""
                        };
                        self.modulesAvailable.push(newModule);
                        currentModule = newModule;
                    }
                    self.loadModuleDefaultConfig(currentModule, modulePath, lastOne);

                    // check for available updates
                    var stat;
                    try {
                        stat = fs.statSync(path.join(modulePath, '.git'));
                    } catch (err) {
                        // Error when directory .git doesn't exist
                        // This module is not managed with git, skip
                        return;
                    }

                    var sg = simpleGit(modulePath);
                    sg.fetch().status(function(err, data) {
                        if (!err) {
                            if (data.behind > 0) {
                                currentModule.updateAvailable = true;
                            }
                        }
                    });
                    if (!isInList) {
                        sg.getRemotes(true, function(error, result) {
                            if (error) {
                                console.log(error);
                            }
                            try {
                                var baseUrl = result[0].refs.fetch;
                                // replacements
                                baseUrl = baseUrl.replace(".git", "").replace("github.com:", "github.com/");
                                // if cloned with ssh
                                currentModule.url = baseUrl.replace("git@", "https://");
                            } catch (e) {
                                // Something happened. Skip it.
                                return;
                            }
                        });
                    }
                }
            });
        },

        loadModuleDefaultConfig: function(module, modulePath, lastOne) {
            // function copied from MichMich (MIT)
            var filename = path.resolve(modulePath + "/" + module.longname + ".js");
            try {
                fs.accessSync(filename, fs.F_OK);
                var jsfile = require(filename);
                /* Defaults are stored when Module.register is called during require(filename); */
            } catch (e) {
                if (e.code == "ENOENT") {
                    console.error("ERROR! Could not find main module js file for " + module.longname);
                } else if (e instanceof ReferenceError || e instanceof SyntaxError) {
                    console.error("ERROR! Could not validate main module js file.");
                    console.error(e);
                } else {
                    console.error("ERROR! Could not load main module js file. Error found: " + e);
                }
            }
            if (lastOne) { this.onModulesLoaded(); }
        },

        answerConfigHelp: function(query, res) {
            if (defaultModules.indexOf(query.module) !== -1) {
                // default module
                var dir = path.resolve(__dirname + "/..");
                let git = simpleGit(dir);
                git.revparse(["HEAD"], function(error, result) {
                    if (error) {
                        console.log(error);
                    }
                    res.writeHead(302, { 'Location': "https://github.com/MichMich/MagicMirror/tree/" + result.trim() + "/modules/default/" + query.module });
                    res.end();
                });
                return;
            }
            var modulePath = this.configOnHd.paths.modules + "/" + query.module;
            let git = simpleGit(modulePath);
            git.getRemotes(true, function(error, result) {
                if (error) {
                    console.log(error);
                }
                var baseUrl = result[0].refs.fetch;
                // replacements
                baseUrl = baseUrl.replace(".git", "").replace("github.com:", "github.com/");
                // if cloned with ssh
                baseUrl = baseUrl.replace("git@", "https://");
                git.revparse(["HEAD"], function(error, result) {
                    if (error) {
                        console.log(error);
                    }
                    res.writeHead(302, { 'Location': baseUrl + "/tree/" + result.trim() });
                    res.end();
                });
            });
        },

        getConfig: function() {
            var config = this.configOnHd;
            for (let i = 0; i < config.modules.length; i++) {
                var current = config.modules[i];
                var def = Module.configDefaults[current.module];
                if (!("config" in current)) {
                    current.config = {};
                }
                if (!def) {
                    def = {};
                }
                for (var key in def) {
                    if (!(key in current.config)) {
                        current.config[key] = def[key];
                    }
                }
            }
            return config;
        },

        removeDefaultValues: function(config) {
            // remove cached version
            delete require.cache[require.resolve(__dirname + "/../../js/defaults.js")];
            // then reload default config
            var defaultConfig = require(__dirname + "/../../js/defaults.js");

            for (let key in defaultConfig) {
                if (defaultConfig.hasOwnProperty(key) && config && config.hasOwnProperty(key) && defaultConfig[key] === config[key]) {
                    delete config[key];
                }
            }

            for (let i = 0; i < config.modules.length; i++) {
                var current = config.modules[i];
                var def = Module.configDefaults[current.module];
                if (!def) {
                    def = {};
                }
                for (let key in def) {
                    if (def.hasOwnProperty(key) && current.config.hasOwnProperty(key) && def[key] === current.config[key]) {
                        delete current.config[key];
                    }
                }
                // console.log(current.config);
                if (current.config === {}) {
                    delete current[config];
                    continue;
                }
                // console.log(current);
            }

            return config;
        },

        answerPost: function(query, req, res) {
            var self = this;

            if (query.data === "config") {
                var backupHistorySize = 5;
                var configPath = path.resolve("config/config.js");

                var best = -1;
                var bestTime = null;
                for (var i = backupHistorySize - 1; i > 0; i--) {
                    let backupPath = path.resolve("config/config.js.backup" + i);
                    try {
                        var stats = fs.statSync(backupPath);
                        if (best === -1 || stats.mtime < bestTime) {
                            best = i;
                            bestTime = stats.mtime;
                        }
                    } catch (e) {
                        if (e.code === "ENOENT") {
                            // does not exist yet
                            best = i;
                            bestTime = "0000-00-00T00:00:00Z";
                        }
                    }
                }
                if (best === -1) {
                    // can not backup, panic!
                    console.error("MMM-Remote-Control Error! Backing up config failed, not saving!");
                    self.sendResponse(res, new Error("Backing up config failed, not saving!"), { query: query });
                    return;
                }
                let backupPath = path.resolve("config/config.js.backup" + best);

                var source = fs.createReadStream(configPath);
                var destination = fs.createWriteStream(backupPath);

                // back up last config
                source.pipe(destination, { end: false });
                source.on("end", () => {
                    self.configOnHd = self.removeDefaultValues(req.body);

                    var header = "/*************** AUTO GENERATED BY REMOTE CONTROL MODULE ***************/\n\nvar config = \n";
                    var footer = "\n\n/*************** DO NOT EDIT THE LINE BELOW ***************/\nif (typeof module !== 'undefined') {module.exports = config;}\n";

                    fs.writeFile(configPath, header + util.inspect(self.configOnHd, {
                            showHidden: false,
                            depth: null,
                            maxArrayLength: null,
                            compact: false
                        }) + footer,
                        (error) => {
                            query.data = "config_update";
                            if (error) {
                                self.sendResponse(res, error, { query: query, backup: backupPath, config: self.configOnHd });
                            }
                            console.info("MMM-Remote-Control saved new config!");
                            console.info("Used backup: " + backupPath);
                            self.sendResponse(res, undefined, { query: query, backup: backupPath, config: self.configOnHd });
                        }
                    );
                });
            }
        },

        answerGet: function(query, res) {
            var self = this;

            if (query.data === "modulesAvailable") {
                this.modulesAvailable.sort(function(a, b) { return a.name.localeCompare(b.name); });
                this.sendResponse(res, undefined, { query: query, data: this.modulesAvailable });
                return;
            }
            if (query.data === "modulesInstalled") {
                var filterInstalled = function(value) {
                    return value.installed && !value.isDefaultModule;
                };
                var installed = self.modulesAvailable.filter(filterInstalled);
                installed.sort(function(a, b) {
                    return a.name.localeCompare(b.name);
                });
                this.sendResponse(res, undefined, { query: query, data: installed });
                return;
            }
            if (query.data === "translations") {
                this.sendResponse(res, undefined, { query: query, data: this.translation });
                return;
            }
            if (query.data === "mmUpdateAvailable") {
                var sg = simpleGit(__dirname + "/..");
                sg.fetch().status((err, data) => {
                    if (!err) {
                        if (data.behind > 0) {
                            this.sendResponse(res, undefined, { query: query, result: true });
                            return;
                        }
                    }
                    this.sendResponse(res, undefined, { query: query, result: false });
                });
                return;
            }
            if (query.data === "config") {
                this.sendResponse(res, undefined, { query: query, data: this.getConfig() });
                return;
            }
            if (query.data === "defaultConfig") {
                if (!(query.module in Module.configDefaults)) {
                    this.sendResponse(res, undefined, { query: query, data: {} });
                } else {
                    this.sendResponse(res, undefined, { query: query, data: Module.configDefaults[query.module] });
                }
                return;
            }
            if (query.data === "modules") {
                if (!this.checkInititialized(res)) { return; }
                this.callAfterUpdate(() => {
                    this.sendResponse(res, undefined, { query: query, data: self.configData.moduleData });
                });
                return;
            }
            if (query.data === "brightness") {
                if (!this.checkInititialized(res)) { return; }
                this.callAfterUpdate(() => {
                    this.sendResponse(res, undefined, { query: query, result: self.configData.brightness });
                });
                return;
            }
            if (query.data === "userPresence") {
                this.sendResponse(res, undefined, { query: query, result: this.userPresence });
                return;
            }
            // Unknown Command, Return Error
            this.sendResponse(res, "Unknown or Bad Command.", query);
        },

        callAfterUpdate: function(callback, timeout) {
            if (timeout === undefined) {
                timeout = 3000;
            }

            var waitObject = {
                finished: false,
                run: function() {
                    if (this.finished) {
                        return;
                    }
                    this.finished = true;
                    this.callback();
                },
                callback: callback
            };

            this.waiting.push(waitObject);
            this.sendSocketNotification("UPDATE");
            setTimeout(function() {
                waitObject.run();
            }, timeout);
        },

        delayedQuery: function(query, res) {
            if (query.did in this.delayedQueryTimers) {
                clearTimeout(this.delayedQueryTimers[query.did]);
                delete this.delayedQueryTimers[query.did];
            }
            if (!query.abort) {
                this.delayedQueryTimers[query.did] = setTimeout(() => {
                    this.executeQuery(query.query);
                    delete this.delayedQueryTimers[query.did];
                }, (("timeout" in query) ? query.timeout : 10) * 1000);
            }
            this.sendResponse(res, undefined, query);
        },


        sendResponse: function(res, error, data) {
            let response = { success: true };
            let status = 200;
            let result = true;
            if (error) {
                console.log(error);
                response = { success: false, status: "error", reason: "unknown", info: error };
                status = 400;
                result = false;
            }
            if (data) {
                response = Object.assign({}, response, data);
            }
            if (res) {
                if ("isSocket" in res && res.isSocket) {
                    this.sendSocketNotification("REMOTE_ACTION_RESULT", response);
                } else {
                    res.status(status).json(response);
                }
            }
            return result;
        },

        monitorControl: function(action, opts, res) {
            let status = "unknown";
            let monitorOnCommand = (this.initialized && "monitorOnCommand" in this.thisConfig.customCommand) ?
                this.thisConfig.customCommand.monitorOnCommand :
                "echo 1 > /sys/class/amhdmitx/amhdmitx0/phy";
            let monitorOffCommand = (this.initialized && "monitorOffCommand" in this.thisConfig.customCommand) ?
                this.thisConfig.customCommand.monitorOffCommand :
                "echo 0 > /sys/class/amhdmitx/amhdmitx0/phy";
            let monitorStatusCommand = (this.initialized && "monitorStatusCommand" in this.thisConfig.customCommand) ?
                this.thisConfig.customCommand.monitorStatusCommand :
                "cat /sys/class/amhdmitx/amhdmitx0/phy";
            if (["MONITORTOGGLE", "MONITORSTATUS"].indexOf(action) !== -1) {
                screenStatus = exec(monitorStatusCommand, opts, (error, stdout, stderr) => {
                    if (stdout.indexOf("TV is off") !== -1 || stdout.indexOf("false") !== -1) {
                        // Screen is OFF, turn it ON
                        status = "off";
                        if (action === "MONITORTOGGLE" || action === "MONITORON") {
                            exec(monitorOnCommand, opts, (error, stdout, stderr) => {
                                this.checkForExecError(error, stdout, stderr, res, { monitor: "on" });
                            });
                            this.sendSocketNotification("USER_PRESENCE", true);
                            return;
                        }
                    } else if (stdout.indexOf("HDMI") !== -1 || stdout.indexOf("true") !== -1) {
                        // Screen is ON, turn it OFF
                        status = "on";
                        if (action === "MONITORTOGGLE") {
                            this.monitorControl("MONITOROFF", opts, res);
                            return;
                        }
                    }
                    this.checkForExecError(error, stdout, stderr, res, { monitor: status });
                    return;
                });
            }
            if (action === "MONITORON") {
                exec(monitorOnCommand, (error, stdout, stderr) => {
                    this.checkForExecError(error, stdout, stderr, res, { monitor: "off" });
                });
                this.sendSocketNotification("USER_PRESENCE", false);
                return;
            }

            if (action === "MONITOROFF") {
                exec(monitorOffCommand, (error, stdout, stderr) => {
                    this.checkForExecError(error, stdout, stderr, res, { monitor: "off" });
                });
                this.sendSocketNotification("USER_PRESENCE", false);
                return;
            }
        },

        executeQuery: function(query, res) {
            var self = this;
            var opts = { timeout: 15000 };

            if (query.action === "SHUTDOWN") {
                exec("sudo shutdown -h now", opts, (error, stdout, stderr) => { self.checkForExecError(error, stdout, stderr, res); });
                return true;
            }
            if (query.action === "REBOOT") {
                exec("sudo shutdown -r now", opts, (error, stdout, stderr) => { self.checkForExecError(error, stdout, stderr, res); });
                return true;
            }
            if (query.action === "RESTART" || query.action === "STOP") {
                this.controlPm2(res, query);
                return true;
            }
            if (query.action === "USER_PRESENCE") {
                this.sendSocketNotification("USER_PRESENCE", query.value);
                this.userPresence = query.value;
                this.sendResponse(res, undefined, query);
                return true;
            }
            if (["MONITORON", "MONITOROFF", "MONITORTOGGLE", "MONITORSTATUS"].indexOf(query.action) !== -1) {
                this.monitorControl(query.action, opts, res);
                return true;
            }
            if (query.action === "HIDE" || query.action === "SHOW" || query.action === "TOGGLE") {
                self.sendSocketNotification(query.action, query);
                self.sendResponse(res);
                return true;
            }
            if (query.action === "BRIGHTNESS") {
                self.sendResponse(res);
                self.sendSocketNotification(query.action, query.value);
                return true;
            }
            if (query.action === "SAVE") {
                self.sendResponse(res);
                self.callAfterUpdate(function() { self.saveDefaultSettings(); });
                return true;
            }
            if (query.action === "MODULE_DATA") {
                self.callAfterUpdate(function() {
                    self.sendResponse(res, undefined, self.configData);
                });
                return true;
            }
            if (query.action === "INSTALL") {
                self.installModule(query.url, res, query);
                return true;
            }
            if (query.action === "REFRESH") {
                self.sendResponse(res);
                self.sendSocketNotification(query.action);
                return true;
            }
            if (query.action === "HIDE_ALERT") {
                self.sendResponse(res);
                self.sendSocketNotification(query.action);
                return true;
            }
            if (query.action === "SHOW_ALERT") {
                self.sendResponse(res);

                var type = query.type ? query.type : "alert";
                var title = query.title ? query.title : "Note";
                var message = query.message ? query.message : "Attention!";
                var timer = query.timer ? query.timer : 4;

                self.sendSocketNotification(query.action, {
                    type: type,
                    title: title,
                    message: message,
                    timer: timer * 1000
                });
                return true;
            }
            if (query.action === "UPDATE") {
                self.updateModule(decodeURI(query.module), res);
                return true;
            }
            if (query.action === 'NOTIFICATION') {
                try {
                    var payload = {}; // Assume empty JSON-object if no payload is provided
                    if (typeof query.payload === 'undefined') {
                        payload = query.payload;
                    } else if (typeof query.payload === 'object') {
                        payload = query.payload;
                    } else if (typeof query.payload === 'string') {
                        if (query.payload.startsWith("{")) {
                            payload = JSON.parse(query.payload);
                        } else {
                            payload = query.payload;
                        }
                    }
                    this.sendSocketNotification(query.action, { 'notification': query.notification, 'payload': payload });
                    this.sendResponse(res);
                    return true;
                } catch (err) {
                    console.log("ERROR: ", err);
                    this.sendResponse(res, err, { reason: err.message });
                    return true;
                }
            }
            if (["MINIMIZE", "TOGGLEFULLSCREEN", "DEVTOOLS"].indexOf(query.action) !== -1) {
                try {
                    let electron = require("electron").BrowserWindow;
                    if (!electron) { throw "Could not get Electron window instance."; }
                    let win = electron.getFocusedWindow();
                    switch (query.action) {
                        case "MINIMIZE":
                            win.minimize();
                            break;
                        case "TOGGLEFULLSCREEN":
                            win.setFullScreen(!win.isFullScreen());
                            break;
                        case "DEVTOOLS":
                            win.webContents.openDevTools();
                            break;
                        default:
                    }
                    this.sendResponse(res);
                } catch (err) {
                    this.sendResponse(res, err);
                }
                return;
            }
            if (query.action === "DELAYED") {
                /* Expects a nested query object 
                 *   {
                 *       action: "DELAYED",
                 *       did: "SOME_UNIQUE_ID",
                 *       timeout: 10000,  // Optional; Default 10000ms
                 *       abort: false, // Optional; send to cancel
                 *       query: {
                 *           action: "SHOW_ALERT",
                 *           title: "Delayed Alert!",
                 *           message: "This is a delayed alert test."
                 *       }
                 *   }
                 * Resending with same ID resets delay, unless abort:true
                 */
                this.delayedQuery(query, res);
                return;
            }
            self.sendResponse(res, new Error(`Invalid Option: ${ query.action }`));
            return false;
        },

        installModule: function(url, res, data) {
            var self = this;

            simpleGit(path.resolve(__dirname + "/..")).clone(url, path.basename(url), function(error, result) {
                if (error) {
                    console.log(error);
                    self.sendResponse(res, error);
                } else {
                    var workDir = path.resolve(__dirname + "/../" + path.basename(url));
                    exec("npm install", { cwd: workDir, timeout: 120000 }, (error, stdout, stderr) => {
                        if (error) {
                            console.log(error);
                            self.sendResponse(res, error, Object.assign({ stdout: stdout, stderr: stderr }, data));
                        } else {
                            // success part
                            self.readModuleData();
                            self.sendResponse(res, undefined, Object.assign({ stdout: stdout }, data));
                        }
                    });
                }
            });
        },

        updateModule: function(module, res) {
            console.log("UPDATE " + (module || "MagicMirror"));

            var self = this;

            var path = __dirname + "/../../";
            var name = "MM";

            if (typeof module !== 'undefined' && module !== 'undefined') {
                if (self.modulesAvailable) {
                    var modData = self.modulesAvailable.find(m => m.longname === module);
                    if (modData === undefined) {
                        this.sendResponse(res, new Error("Unknown Module"), { info: modules });
                        return;
                    }

                    path = __dirname + "/../" + modData.longname;
                    name = modData.name;
                }
            }

            console.log("path: " + path + " name: " + name);

            var git = simpleGit(path);
            git.pull((error, result) => {
                if (error) {
                    console.log(error);
                    self.sendResponse(res, error);
                    return;
                }
                if (result.summary.changes) {
                    exec("npm install", { cwd: path, timeout: 120000 }, (error, stdout, stderr) => {
                        if (error) {
                            console.log(error);
                            self.sendResponse(res, error, { stdout: stdout, stderr: stderr });
                        } else {
                            // success part
                            self.readModuleData();
                            self.sendResponse(res, undefined, { code: "restart", info: name + " updated." });
                        }
                    });
                } else {
                    self.sendResponse(res, undefined, { code: "up-to-date", info: name + " already up to date." });
                }
            });
        },

        checkForExecError: function(error, stdout, stderr, res, data) {
            console.log(stdout);
            console.log(stderr);
            this.sendResponse(res, error, data);
        },

        controlPm2: function(res, query) {
            var pm2 = require('pm2');
            let processName = query.processName || this.thisConfig.pm2ProcessName || "mm";

            pm2.connect((err) => {
                if (err) {
                    this.sendResponse(res, err);
                    return;
                }
                console.log(`PM2 process: ${query.action.toLowerCase()} ${processName}`);

                pm2.stop(processName, (err, apps) => {
                    this.sendResponse(res, undefined, { action: action, processName: processName });
                    pm2.disconnect();
                    if (err) { this.sendResponse(res, err); }
                });
            });
        },

        translate: function(data) {
            Object.keys(this.translation).forEach(t => {
                let pattern = "%%TRANSLATE:" + t + "%%";
                let re = new RegExp(pattern, "g");
                data = data.replace(re, this.translation[t]);
            });
            return data;
        },

        saveDefaultSettings: function() {
            var moduleData = this.configData.moduleData;
            var simpleModuleData = [];
            for (var k = 0; k < moduleData.length; k++) {
                simpleModuleData.push({});
                simpleModuleData[k].identifier = moduleData[k].identifier;
                simpleModuleData[k].hidden = moduleData[k].hidden;
                simpleModuleData[k].lockStrings = moduleData[k].lockStrings;
            }

            var text = JSON.stringify({
                moduleData: simpleModuleData,
                brightness: this.configData.brightness,
                settingsVersion: this.configData.settingsVersion
            });

            fs.writeFile(path.resolve(__dirname + "/settings.json"), text, function(err) {
                if (err) {
                    throw err;
                }
            });
        },

        in: function(pattern, string) {
            return string.indexOf(pattern) !== -1;
        },

        loadDefaultSettings: function() {
            var self = this;

            fs.readFile(path.resolve(__dirname + "/settings.json"), function(err, data) {
                if (err) {
                    if (self.in("no such file or directory", err.message)) {
                        return;
                    }
                    console.log(err);
                } else {
                    data = JSON.parse(data.toString());
                    self.sendSocketNotification("DEFAULT_SETTINGS", data);
                }
            });
        },

        fillTemplates: function(data) {
            return this.translate(data);
        },

        loadTranslation: function(language) {
            var self = this;

            fs.readFile(path.resolve(__dirname + "/translations/" + language + ".json"), function(err, data) {
                if (err) {
                    return;
                } else {
                    self.translation = Object.assign({}, self.translation, JSON.parse(data.toString()));
                }
            });
        },

        loadCustomMenus: function() {
            if ("customMenu" in this.thisConfig) {
                let menuPath = path.resolve(__dirname + "/../../config/" + this.thisConfig.customMenu);
                if (!fs.existsSync(menuPath)) {
                    console.log(`MMM-Remote-Control customMenu Requested, but file:${menuPath} was not found`);
                    return;
                }
                fs.readFile(menuPath, (err, data) => {
                    if (err) {
                        return;
                    } else {
                        this.customMenu = Object.assign({}, this.customMenu, JSON.parse(this.translate(data.toString())));
                        this.sendSocketNotification("REMOTE_CLIENT_CUSTOM_MENU", this.customMenu);
                    }
                });
            }
        },

        getIpAddresses: function() {
            // module started, answer with current IP address
            var interfaces = os.networkInterfaces();
            var addresses = [];
            for (var k in interfaces) {
                for (var k2 in interfaces[k]) {
                    var address = interfaces[k][k2];
                    if (address.family === "IPv4" && !address.internal) {
                        addresses.push(address.address);
                    }
                }
            }
            return addresses;
        },

        socketNotificationReceived: function(notification, payload) {
            var self = this;

            if (notification === "CURRENT_STATUS") {
                this.configData = payload;
                this.thisConfig = payload.remoteConfig;
                if (!this.initialized) {
                    // Do anything else required to initialize
                    this.initialized = true;
                } else {
                    this.waiting.forEach(o => { o.run(); });
                    this.waiting = [];
                }
            }
            if (notification === "REQUEST_DEFAULT_SETTINGS") {
                // module started, answer with current ip addresses
                self.sendSocketNotification("IP_ADDRESSES", self.getIpAddresses());

                // check if we have got saved default settings
                self.loadDefaultSettings();
            }
            if (notification === "REMOTE_ACTION") {
                if ("action" in payload) {
                    this.executeQuery(payload, { isSocket: true });
                } else if ("data" in payload) {
                    this.answerGet(payload, { isSocket: true });
                }
            }
            if (notification === "NEW_CONFIG") {
                this.answerPost({ data: "config" }, { body: payload }, { isSocket: true });
            }
            if (notification === "REMOTE_CLIENT_CONNECTED") {
                this.sendSocketNotification("REMOTE_CLIENT_CONNECTED");
                this.loadCustomMenus();
                if ("id" in this.moduleApiMenu) {
                    this.sendSocketNotification("REMOTE_CLIENT_MODULEAPI_MENU", this.moduleApiMenu);
                }
            }
            if (notification === "REMOTE_NOTIFICATION_ECHO_IN") {
                this.sendSocketNotification("REMOTE_NOTIFICATION_ECHO_OUT", payload);
            }
            if (notification === "USER_PRESENCE") {
                this.userPresence = payload;
            }
            /* API EXTENSION -- added v2.0.0 */
            if (notification === "REGISTER_API") {
                if ("module" in payload) {
                    if ("actions" in payload && payload.actions !== {}) {
                        this.externalApiRoutes[payload.path] = payload;
                    } else {
                        // Blank actions means the module has requested to be removed from API
                        delete this.externalApiRoutes[payload.path];
                    }
                    this.updateModuleApiMenu();
                }
            }
        }
    },
    require('./API/api.js')));