mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-08-23 05:20:03 +00:00
Add server (web/socket), create socket system, better helper loader.
- The Magic Mirror is now hosted via a express server, allowing you to load it from an external client (for debugging.) - It now includes a socket system to communicate between the node_helper and the client module. - node_helpers are now only loaded if the module is configured in the config.
This commit is contained in:
Michael Teeuw
@@ -8,6 +8,7 @@
|
||||
*/
|
||||
|
||||
var defaults = {
|
||||
port: 80,
|
||||
|
||||
language: 'en',
|
||||
timeFormat: 24,
|
||||
@@ -50,4 +51,8 @@ var defaults = {
|
||||
modules: 'modules',
|
||||
vendor: 'vendor'
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
/*************** DO NOT EDIT THE LINE BELOW ***************/
|
||||
if (typeof module !== 'undefined') {module.exports = defaults;}
|
||||
153
js/electron.js
153
js/electron.js
@@ -1,10 +1,15 @@
|
||||
'use strict';
|
||||
|
||||
//for searching modules
|
||||
//load modules
|
||||
const walk = require('walk');
|
||||
const fs = require('fs');
|
||||
const Server = require(__dirname + '/server.js');
|
||||
const spawn = require('child_process').spawn;
|
||||
|
||||
const electron = require('electron');
|
||||
|
||||
|
||||
// Config
|
||||
var config = {};
|
||||
// Module to control application life.
|
||||
const app = electron.app;
|
||||
// Module to create native browser window.
|
||||
@@ -15,79 +20,115 @@ const BrowserWindow = electron.BrowserWindow;
|
||||
let mainWindow;
|
||||
|
||||
function createWindow () {
|
||||
// Create the browser window.
|
||||
mainWindow = new BrowserWindow({width: 800, height: 600, fullscreen: true, "auto-hide-menu-bar": true, "node-integration": false});
|
||||
// Create the browser window.
|
||||
mainWindow = new BrowserWindow({width: 800, height: 600, fullscreen: true, "auto-hide-menu-bar": true, "node-integration": false});
|
||||
|
||||
// and load the index.html of the app.
|
||||
mainWindow.loadURL('file://' + __dirname + '../../index.html');
|
||||
// and load the index.html of the app.
|
||||
//mainWindow.loadURL('file://' + __dirname + '../../index.html');
|
||||
mainWindow.loadURL('http://localhost:' + config.port);
|
||||
|
||||
// Open the DevTools.
|
||||
//mainWindow.webContents.openDevTools();
|
||||
// Open the DevTools.
|
||||
//mainWindow.webContents.openDevTools();
|
||||
|
||||
// Emitted when the window is closed.
|
||||
mainWindow.on('closed', function() {
|
||||
// Dereference the window object, usually you would store windows
|
||||
// in an array if your app supports multi windows, this is the time
|
||||
// when you should delete the corresponding element.
|
||||
mainWindow = null;
|
||||
});
|
||||
// Emitted when the window is closed.
|
||||
mainWindow.on('closed', function() {
|
||||
// Dereference the window object, usually you would store windows
|
||||
// in an array if your app supports multi windows, this is the time
|
||||
// when you should delete the corresponding element.
|
||||
mainWindow = null;
|
||||
});
|
||||
}
|
||||
|
||||
//Walk module folder and get file names
|
||||
var module_loader = walk.walk(__dirname + '/../modules', { followLinks: false });
|
||||
function loadConfig (callback) {
|
||||
console.log("Loading config ...");
|
||||
var defaults = require(__dirname + '/defaults.js');
|
||||
var configFilename = __dirname + '/../config/config.js';
|
||||
|
||||
//for each file in modules
|
||||
module_loader.on('file', function(root, stat, next) {
|
||||
//if file is called node_helper.js load it
|
||||
if (stat.name == "node_helper.js"){
|
||||
var module = (root + '/' + stat.name).split("/");
|
||||
var moduleName = module[module.length-2];
|
||||
try {
|
||||
fs.accessSync(configFilename, fs.R_OK);
|
||||
var c = require(configFilename);
|
||||
var config = Object.assign(defaults, c);
|
||||
callback(config);
|
||||
} catch (e) {
|
||||
callback(defaults);
|
||||
}
|
||||
}
|
||||
|
||||
//start module as child
|
||||
var child = spawn('node', [root + '/' + stat.name])
|
||||
function loadModule(moduleName) {
|
||||
var helperPath = __dirname + '/../modules/' + moduleName + '/node_helper.js';
|
||||
|
||||
// Make sure the output is logged.
|
||||
child.stdout.on('data', function(data) {
|
||||
process.stdout.write(moduleName + ': ' + data);
|
||||
});
|
||||
try {
|
||||
fs.accessSync(helperPath, fs.R_OK);
|
||||
|
||||
child.stderr.on('data', function(data) {
|
||||
process.stdout.write(moduleName + ': ' + data);
|
||||
});
|
||||
|
||||
child.on('close', function(code) {
|
||||
console.log(moduleName + ' closing code: ' + code);
|
||||
});
|
||||
var child = spawn('node', [helperPath]);
|
||||
|
||||
// Make sure the output is logged.
|
||||
child.stdout.on('data', function(data) {
|
||||
process.stdout.write('[' + moduleName + '] ' + data);
|
||||
});
|
||||
|
||||
//Log module name
|
||||
|
||||
console.log("Started helper script for module " + moduleName + ".");
|
||||
}
|
||||
next();
|
||||
child.stderr.on('data', function(data) {
|
||||
process.stdout.write('[' + moduleName + '] ' + data);
|
||||
});
|
||||
|
||||
child.on('close', function(code) {
|
||||
console.log(moduleName + ' closing code: ' + code);
|
||||
});
|
||||
|
||||
//Log module name
|
||||
console.log("Started helper script for module: " + moduleName + ".");
|
||||
|
||||
} catch (e) {
|
||||
console.log("No helper found for module: " + moduleName + ".");
|
||||
}
|
||||
}
|
||||
|
||||
function loadModules(modules) {
|
||||
console.log("Loading module helpers ...");
|
||||
|
||||
for (var m in modules) {
|
||||
loadModule(modules[m]);
|
||||
}
|
||||
|
||||
console.log("All module helpers loaded.");
|
||||
}
|
||||
|
||||
loadConfig(function(c) {
|
||||
config = c;
|
||||
|
||||
var modules = [];
|
||||
|
||||
for (var m in config.modules) {
|
||||
var module = config.modules[m];
|
||||
if (modules.indexOf(module.module) === -1) {
|
||||
modules.push(module.module);
|
||||
}
|
||||
}
|
||||
|
||||
loadModules(modules);
|
||||
});
|
||||
|
||||
module_loader.on('end', function() {
|
||||
console.log("All helpers started.");
|
||||
});
|
||||
|
||||
// This method will be called when Electron has finished
|
||||
// initialization and is ready to create browser windows.
|
||||
app.on('ready', createWindow);
|
||||
app.on('ready', function() {
|
||||
var server = new Server(config, function() {
|
||||
createWindow();
|
||||
});
|
||||
});
|
||||
|
||||
// Quit when all windows are closed.
|
||||
app.on('window-all-closed', function () {
|
||||
// On OS X it is common for applications and their menu bar
|
||||
// to stay active until the user quits explicitly with Cmd + Q
|
||||
if (process.platform !== 'darwin') {
|
||||
app.quit();
|
||||
}
|
||||
// On OS X it is common for applications and their menu bar
|
||||
// to stay active until the user quits explicitly with Cmd + Q
|
||||
if (process.platform !== 'darwin') {
|
||||
app.quit();
|
||||
}
|
||||
});
|
||||
|
||||
app.on('activate', function () {
|
||||
// On OS X it's common to re-create a window in the app when the
|
||||
// dock icon is clicked and there are no other windows open.
|
||||
if (mainWindow === null) {
|
||||
createWindow();
|
||||
}
|
||||
// On OS X it's common to re-create a window in the app when the
|
||||
// dock icon is clicked and there are no other windows open.
|
||||
if (mainWindow === null) {
|
||||
createWindow();
|
||||
}
|
||||
});
|
||||
|
||||
37
js/module.js
37
js/module.js
@@ -88,7 +88,15 @@ var Module = Class.extend({
|
||||
}
|
||||
},
|
||||
|
||||
|
||||
/* socketNotificationReceived(notification, payload)
|
||||
* This method is called when a socket notification arrives.
|
||||
*
|
||||
* argument notification string - The identifier of the noitication.
|
||||
* argument payload mixed - The payload of the notification.
|
||||
*/
|
||||
socketNotificationReceived: function(notification, payload) {
|
||||
Log.log(this.name + ' received a socket notification: ' + notification + ' - Payload: ' + payload);
|
||||
},
|
||||
|
||||
|
||||
|
||||
@@ -118,6 +126,23 @@ var Module = Class.extend({
|
||||
this.config = Object.assign(this.defaults, config);
|
||||
},
|
||||
|
||||
/* socket()
|
||||
* Returns a socket object. If it doesn't exsist, it's created.
|
||||
* It also registers the notification callback.
|
||||
*/
|
||||
socket: function() {
|
||||
if (typeof this._socket === 'undefined') {
|
||||
this._socket = this._socket = new MMSocket(this.name);
|
||||
}
|
||||
|
||||
var self = this;
|
||||
this._socket.setNotificationCallback(function(notification, payload) {
|
||||
self.socketNotificationReceived(notification, payload);
|
||||
});
|
||||
|
||||
return this._socket;
|
||||
},
|
||||
|
||||
/* file(file)
|
||||
* Retrieve the path to a module fike.
|
||||
*
|
||||
@@ -170,6 +195,16 @@ var Module = Class.extend({
|
||||
*/
|
||||
sendNotification: function(notification, payload) {
|
||||
MM.sendNotification(notification, payload, this);
|
||||
},
|
||||
|
||||
/* sendSocketNotification(notification, payload)
|
||||
* Send a socket notification to the node helper.
|
||||
*
|
||||
* argument notification string - The identifier of the noitication.
|
||||
* argument payload mixed - The payload of the notification.
|
||||
*/
|
||||
sendSocketNotification: function(notification, payload) {
|
||||
this.socket().sendNotification(notification, payload);
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
83
js/server.js
Normal file
83
js/server.js
Normal file
@@ -0,0 +1,83 @@
|
||||
/* Magic Mirror
|
||||
* Server
|
||||
*
|
||||
* By Michael Teeuw http://michaelteeuw.nl
|
||||
* MIT Licensed.
|
||||
*/
|
||||
|
||||
var express = require('express');
|
||||
var app = require('express')();
|
||||
var server = require('http').Server(app);
|
||||
var io = require('socket.io')(server);
|
||||
var path = require('path');
|
||||
|
||||
var Server = function(config, callback) {
|
||||
|
||||
/* createNamespace(namespace)
|
||||
* Creates a namespace with a wildcard event.
|
||||
*
|
||||
* argument namespace string - The name of the namespace.
|
||||
*/
|
||||
var createNamespace = function(namespace) {
|
||||
console.log('Creating socket namespace: ' + namespace);
|
||||
|
||||
io.of(namespace).on('connection', function (socket) {
|
||||
console.log("New socket connection on namespace: " + namespace);
|
||||
|
||||
// add a catch all event.
|
||||
var onevent = socket.onevent;
|
||||
socket.onevent = function (packet) {
|
||||
var args = packet.data || [];
|
||||
onevent.call (this, packet); // original call
|
||||
packet.data = ["*"].concat(args);
|
||||
onevent.call(this, packet); // additional call to catch-all
|
||||
};
|
||||
|
||||
// register catch all.
|
||||
socket.on('*', function (event, data) {
|
||||
io.of(namespace).emit(event, data);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
/* createNamespaces()
|
||||
* Creates a namespace for all modules in the config.
|
||||
*/
|
||||
var createNamespaces = function() {
|
||||
var modules = [];
|
||||
var m;
|
||||
|
||||
for (m in config.modules) {
|
||||
var module = config.modules[m];
|
||||
if (modules.indexOf(module.module) === -1) {
|
||||
modules.push(module.module);
|
||||
}
|
||||
}
|
||||
|
||||
for (m in modules) {
|
||||
createNamespace(modules[m]);
|
||||
}
|
||||
};
|
||||
|
||||
console.log("Starting server op port " + config.port + " ... ");
|
||||
|
||||
server.listen(config.port);
|
||||
app.use('/js', express.static(__dirname));
|
||||
app.use('/config', express.static(path.resolve(__dirname + '/../config')));
|
||||
app.use('/css', express.static(path.resolve(__dirname + '/../css')));
|
||||
app.use('/fonts', express.static(path.resolve(__dirname + '/../fonts')));
|
||||
app.use('/modules', express.static(path.resolve(__dirname + '/../modules')));
|
||||
app.use('/vendor', express.static(path.resolve(__dirname + '/../vendor')));
|
||||
|
||||
app.get('/', function (req, res) {
|
||||
res.sendFile(path.resolve(__dirname + '/../index.html'));
|
||||
});
|
||||
|
||||
createNamespaces();
|
||||
|
||||
if (typeof callback === 'function') {
|
||||
callback();
|
||||
}
|
||||
};
|
||||
|
||||
module.exports = Server;
|
||||
40
js/socket.js
Normal file
40
js/socket.js
Normal file
@@ -0,0 +1,40 @@
|
||||
/* exported Log */
|
||||
|
||||
/* Magic Mirror
|
||||
* Socket Connection
|
||||
*
|
||||
* By Michael Teeuw http://michaelteeuw.nl
|
||||
* MIT Licensed.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
var MMSocket = function(moduleName) {
|
||||
|
||||
var self = this;
|
||||
|
||||
if (typeof moduleName !== 'string') {
|
||||
throw new Error('Please set the module name for the MMSocket.');
|
||||
}
|
||||
|
||||
self.moduleName = moduleName;
|
||||
|
||||
|
||||
self.socket = io('http://localhost:8080');
|
||||
self.socket.on('notification', function (data) {
|
||||
MM.sendNotification(data.notification, data.payload, Socket);
|
||||
});
|
||||
|
||||
return {
|
||||
sendMessage: function(notification, payload, sender) {
|
||||
Log.log('Send socket message: ' + notification);
|
||||
self.socket.emit('notification', {
|
||||
notification: notification,
|
||||
sender: sender,
|
||||
payload: payload
|
||||
});
|
||||
}
|
||||
};
|
||||
};
|
||||
|
||||
|
||||
83
js/socketclient.js
Normal file
83
js/socketclient.js
Normal file
@@ -0,0 +1,83 @@
|
||||
if (typeof window === 'undefined') {
|
||||
// Only perfom this part if is isn't running in the browser.
|
||||
|
||||
// Load socket client
|
||||
var io = require('socket.io-client');
|
||||
|
||||
// Load config
|
||||
var fs = require('fs');
|
||||
|
||||
var config = {};
|
||||
|
||||
var defaults = require(__dirname + '/defaults.js');
|
||||
var configFilename = __dirname + '/../config/config.js';
|
||||
|
||||
try {
|
||||
fs.accessSync(configFilename, fs.R_OK);
|
||||
var c = require(configFilename);
|
||||
config = Object.assign(defaults, c);
|
||||
} catch (e) {
|
||||
config = defaults;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
var MMSocket = function(moduleName) {
|
||||
|
||||
var self = this;
|
||||
|
||||
if (typeof moduleName !== 'string') {
|
||||
throw new Error('Please set the module name for the MMSocket.');
|
||||
}
|
||||
|
||||
self.moduleName = moduleName;
|
||||
|
||||
// Private Methods
|
||||
var socketBase = (typeof window === 'undefined') ? 'http://localhost:'+config.port : '';
|
||||
socket = io(socketBase + '/' + self.moduleName);
|
||||
|
||||
var notificationCallback = function() {};
|
||||
|
||||
socket.on('connect', function(s) {
|
||||
|
||||
// add a catch all event.
|
||||
var onevent = socket.onevent;
|
||||
socket.onevent = function (packet) {
|
||||
var args = packet.data || [];
|
||||
onevent.call (this, packet); // original call
|
||||
packet.data = ["*"].concat(args);
|
||||
onevent.call(this, packet); // additional call to catch-all
|
||||
};
|
||||
|
||||
// register catch all.
|
||||
socket.on('*', function (notification, payload) {
|
||||
if (notification !== '*') {
|
||||
//console.log('Received notification: ' + notification +', payload: ' + payload);
|
||||
notificationCallback(notification, payload);
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
});
|
||||
|
||||
var sendNotification = function(notification, payload) {
|
||||
//console.log('Send notification: ' + notification +', payload: ' + payload);
|
||||
socket.emit(notification, payload);
|
||||
};
|
||||
|
||||
// Public Methods
|
||||
this.setNotificationCallback = function(callback) {
|
||||
notificationCallback = callback;
|
||||
};
|
||||
|
||||
this.sendNotification = function(notification, payload) {
|
||||
if (typeof payload === 'undefined') {
|
||||
payload = {};
|
||||
}
|
||||
sendNotification(notification, payload);
|
||||
};
|
||||
};
|
||||
|
||||
if (typeof module !== 'undefined') {
|
||||
module.exports = MMSocket;
|
||||
}
|
||||
Reference in New Issue
Block a user