Merge pull request #586 from MichMich/develop

Release 2.1.0

.eslintrc.json

@@ -4,11 +4,13 @@
 		"quotes": ["error", "double"],
 		"max-len": ["error", 250],
 		"curly": "error",
-		"camelcase": ["error", {"properties": "never"}]
+		"camelcase": ["error", {"properties": "never"}],
+		"no-trailing-spaces": ["error"],
+		"no-irregular-whitespace": ["error"]
 	},
 	"env": {
 		"browser": true,
 		"node": true,
 		"es6": true
 	}
-}
+}

.github/CONTRIBUTING.md

@@ -23,7 +23,7 @@ To run StyleLint, use `grunt stylelint`.
 
 ### Submitting Issues
 
-Please only submit reproducible issues. 
+Please only submit reproducible issues.
 
 If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
 Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-> Please send your pull requests the develop branch. 
+> Please send your pull requests the develop branch.
 > Don't forget to add the change to CHANGELOG.md.
 
 * Does the pull request solve a **related** issue?

CHANGELOG.md

@@ -2,13 +2,65 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2016-12-31
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Added
+- Finnish translation.
+- Danish translation.
+- Turkish translation.
+- Option to limit access to certain IP addresses based on the value of `ipWhitelist` in the `config.js`, default is access from localhost only (Issue [#456](https://github.com/MichMich/MagicMirror/issues/456)).
+- Added ability to change the point of time when calendar events get relative.
+- Add Splash screen on boot.
+- Add option to show humidity in currentWeather module.
+- Add VSCode IntelliSense support.
+- Module API: Add Visibility locking to module system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#visibility-locking) for more information.
+- Module API: Method to overwrite the module's header. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#getheader) for more information.
+- Module API: Option to define the minimum MagicMirror version to run a module. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#requiresversion) for more information.
+- Calendar module now broadcasts the event list to all other modules using the notification system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/calendar) for more information.
+- Possibility to use the the calendar feed as the source for the weather (currentweather & weatherforecast) location data. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/weatherforecast) for more information.
+- Added option to show rain amount in the weatherforecast default module
+- Add module `updatenotification` to get an update whenever a new version is availabe. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/updatenotification) for more information.
+- Add the abilty to set timezone on the date display in the Clock Module
+- Ability to set date format in calendar module
+- Possibility to use currentweather for the compliments
+- Added option `disabled` for modules.
+- Added option `address` to set bind address.
+- Added option `onlyTemp` for currentweather module to show show only current temperature and weather icon.
+- Added option `remoteFile` to compliments module to load compliment array from filesystem.
+- Added option `zoom` to scale the whole mirror display with a given factor.
+- Added option `roundTemp` for currentweather and weatherforecast modules to display temperatures rounded to nearest integer.
+- Added abilty set the classes option to compliments module for style and text size of compliments.
+- Added ability to configure electronOptions
+- Calendar module: option to hide private events
+- Add root_path for global vars
+
+### Updated
+- Modified translations for Frysk.
+- Modified core English translations.
+- Updated package.json as a result of Snyk security update.
+- Improve object instantiation to prevent reference errors.
+- Improve logger. `Log.log()` now accepts multiple arguments.
+- Remove extensive logging in newsfeed node helper.
+- Calendar times are now uniformly capitalized.
+- Modules are now secure, and Helmet is now used to prevent abuse of the Mirror's API.
+
+### Fixed
+- Solve an issue where module margins would appear when the first module of a section was hidden.
+- Solved visual display errors on chrome, if all modules in one of the right sections are hidden.
+- Global and Module default config values are no longer modified when setting config values.
+- Hide a region if all modules in a region are hidden. Prevention unwanted margins.
+- Replaced `electron-prebuilt` package with `electron` in order to fix issues that would happen after 2017.
+- Documentation of alert module
+
 ## [2.0.5] - 2016-09-20
 
 ### Added
 - Added ability to remove tags from the beginning or end of newsfeed items in 'newsfeed.js'.
 - Added ability to define "the day after tomorrow" for calendar events (Definition for German and Dutch already included).
 - Added CII Badge (we are compliant with the CII Best Practices)
-- Add support for doing http basic auth when loading calendars 
+- Add support for doing http basic auth when loading calendars
 - Add the abilty to turn off and on the date display in the Clock Module
 
 ### Fixed

Gruntfile.js

@@ -6,7 +6,10 @@ module.exports = function(grunt) {
 			options: {
 				configFile: ".eslintrc.json"
 			},
-			target: ["js/*.js", "modules/default/*.js", "serveronly/*.js", "*.js"]
+			target: ["js/*.js", "modules/default/*.js", "modules/default/*/*.js",
+				"serveronly/*.js", "*.js", "!modules/default/alert/notificationFx.js",
+				"!modules/default/alert/modernizr.custom.js", "!modules/default/alert/classie.js"
+			]
 		},
 		stylelint: {
 			simple: {
@@ -47,7 +50,6 @@ module.exports = function(grunt) {
 						"MD018": false,
 						"MD012": false,
 						"MD026": false,
-						"MD036": false,
 						"MD038": false
 					}
 				},
@@ -64,4 +66,4 @@ module.exports = function(grunt) {
 	grunt.loadNpmTasks("grunt-yamllint");
 	grunt.loadNpmTasks("grunt-markdownlint");
 	grunt.registerTask("default", ["eslint", "stylelint", "jsonlint", "markdownlint", "yamllint"]);
-};
+};

README.md

@@ -60,7 +60,7 @@ The following wiki links are helpful in the configuration of your MagicMirror²
 If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
 
 ```bash
-git pull
+git pull && npm install
 ```
 
 If you changed nothing more than the config or the modules, this should work without any problems.
@@ -73,15 +73,18 @@ Type `git status` to see your changes, if there are any, you can reset them with
 
 The following properties can be configured:
 
-
 | **Option** | **Description** |
 | --- | --- |
 | `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. |
-| `kioskmode` | This allows MagicMirror² to run in Kiosk Mode. It protects from other programs popping on top of your screen. The default value is `false`|
+| `address` | The ip address the accept connections. The  default open bind `::` is IPv6 is available or `0.0.0.0` IPv4 run on.  Example config: `192.168.10.100`. |
+| `ipWhitelist` | The list of IPs from which you are allowed to access the MagicMirror². The default value is `["127.0.0.1", "::ffff:127.0.0.1", "::1"]`. It is possible to specify IPs with subnet masks (`["127.0.0.1", "127.0.0.1/24"]`) or define ip ranges (`["127.0.0.1", ["192.168.0.1", "192.168.0.100"]]`).|
+| `zoom` | This allows to scale the mirror contents with a given zoom factor. The default value is `1.0`|
 | `language` | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. |
 | `timeFormat` | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. |
 | `units` | The units that will be used in the default weather modules. Possible values are `metric` or `imperial`. The default is `metric`. |
 | `modules` | An array of active modules. **The array must contain objects. See the next table below for more information.** |
+| `electronOptions` | An optional array of Electron (browser) options. This allows configuration of e.g. the browser screen size and position (defaults `.width = 800` & `.height = 600`). Kiosk mode can be enabled by setting `.kiosk = true`, `.autoHideMenuBar = false`, `.fullscreen = false`. More options can be found [here](https://github.com/electron/electron/blob/master/docs/api/browser-window.md). |
+
 
 Module configuration:
 
@@ -91,6 +94,7 @@ Module configuration:
 | `position` | The location of the module in which the module will be loaded. Possible values are `top_ bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
 | `classes` | Additional classes which are passed to the module. The field is optional. |
 | `header` | To display a header text above the module, add the header property. This field is optional. |
+| `disabled` | Set disabled to `true` to skip creating the module. This field is optional. |
 | `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
 
 ## Modules
@@ -129,3 +133,8 @@ Please keep the following in mind:
 - **New Features**: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.
 
 Thanks for your help in making MagicMirror² better!
+
+<p align="center">
+<br>
+	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
+</p>

config/config.js.sample

@@ -6,6 +6,7 @@
 
 var config = {
 	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
 
 	language: 'en',
 	timeFormat: 24,
@@ -15,6 +16,10 @@ var config = {
 		{
 			module: 'alert',
 		},
+		{
+			module: "updatenotification",
+			position: "top_bar"
+		},
 		{
 			module: 'clock',
 			position: 'top_left'
@@ -50,9 +55,9 @@ var config = {
 			position: 'top_right',
 			header: 'Weather Forecast',
 			config: {
-	            location: 'New York',
+				location: 'New York',
 				locationID: '5128581',  //ID from http://www.openweathermap.org
-	            appid: 'YOUR_OPENWEATHER_API_KEY'
+				appid: 'YOUR_OPENWEATHER_API_KEY'
 			}
 		},
 		{

css/main.css

@@ -113,11 +113,12 @@ sup {
  */
 
 .module {
-  margin-top: 30px;
+  margin-bottom: 30px;
 }
 
-.module:first-child {
-  margin-top: 0;
+.region.bottom .module {
+  margin-top: 30px;
+  margin-bottom: 0;
 }
 
 /**

index.html

@@ -8,6 +8,10 @@
 	<link rel="stylesheet" type="text/css" href="css/main.css">
 	<link rel="stylesheet" type="text/css" href="fonts/roboto.css">
 	<!-- custom.css is loaded by the loader.js to make sure it's loaded after the module css files. -->
+
+	<script type="text/javascript">
+		var version = "#VERSION#";
+	</script>
 </head>
 <body>
 	<div class="region fullscreen below"><div class="container"></div></div>

installers/raspberry.sh

@@ -18,7 +18,7 @@ echo '                       \$$$$$$  |'
 echo '                        \______/'
 echo -e "\e[0m"
 
-# Define the tested version of Node.js. 
+# Define the tested version of Node.js.
 NODE_TESTED="v5.1.0"
 
 #Determine which Pi is running.
@@ -49,19 +49,19 @@ if command_exists node; then
 	echo -e "\e[0mMinimum Node version: \e[1m$NODE_TESTED\e[0m"
 	echo -e "\e[0mInstalled Node version: \e[1m$NODE_CURRENT\e[0m"
 	if version_gt $NODE_TESTED $NODE_CURRENT; then
-    	echo -e "\e[96mNode should be upgraded.\e[0m"
-    	NODE_INSTALL=true
-
-    	#Check if a node process is currenlty running.
-    	#If so abort installation.
-    	if pgrep "node" > /dev/null; then
-		    echo -e "\e[91mA Node process is currently running. Can't upgrade."
-		    echo "Please quit all Node processes and restart the installer."
-		    exit;
+		echo -e "\e[96mNode should be upgraded.\e[0m"
+		NODE_INSTALL=true
+
+		#Check if a node process is currenlty running.
+		#If so abort installation.
+		if pgrep "node" > /dev/null; then
+			echo -e "\e[91mA Node process is currently running. Can't upgrade."
+			echo "Please quit all Node processes and restart the installer."
+			exit;
 		fi
 
-    else
-    	echo -e "\e[92mNo Node.js upgrade nessecery.\e[0m"
+	else
+		echo -e "\e[92mNo Node.js upgrade nessecery.\e[0m"
 	fi
 
 else
@@ -113,6 +113,34 @@ else
 	exit;
 fi
 
+# Check if plymouth is installed (default with PIXEL desktop environment), then install custom splashscreen.
+echo -e "\e[96mCheck plymouth installation ...\e[0m"
+if command_exists plymouth; then
+	THEME_DIR="/usr/share/plymouth/themes"
+	echo -e "\e[90mSplashscreen: Checking themes directory.\e[0m"
+	if [ -d $THEME_DIR ]; then
+		echo -e "\e[90mSplashscreen: Create theme directory if not exists.\e[0m"
+		if [ ! -d $THEME_DIR/MagicMirror ]; then
+			sudo mkdir $THEME_DIR/MagicMirror
+		fi
+
+		if sudo cp ~/MagicMirror/splashscreen/splash.png $THEME_DIR/MagicMirror/splash.png && sudo cp ~/MagicMirror/splashscreen/MagicMirror.plymouth $THEME_DIR/MagicMirror/MagicMirror.plymouth && sudo cp ~/MagicMirror/splashscreen/MagicMirror.script $THEME_DIR/MagicMirror/MagicMirror.script; then
+			echo -e "\e[90mSplashscreen: Theme copied successfully.\e[0m"
+			if sudo plymouth-set-default-theme -R MagicMirror; then
+				echo -e "\e[92mSplashscreen: Changed theme to MagicMirror successfully.\e[0m"
+			else
+				echo -e "\e[91mSplashscreen: Couldn't change theme to MagicMirror!\e[0m"
+			fi
+		else
+			echo -e "\e[91mSplashscreen: Copying theme failed!\e[0m"
+		fi
+	else
+		echo -e "\e[91mSplashscreen: Themes folder doesn't exist!\e[0m"
+	fi
+else
+	echo -e "\e[93mplymouth is not installed.\e[0m";
+fi
+
 echo " "
 echo -e "\e[92mWe're ready! Run \e[1m\e[97mDISPLAY=:0 npm start\e[0m\e[92m from the ~/MagicMirror directory to start your MagicMirror.\e[0m"
 echo " "

js/app.js

@@ -10,6 +10,13 @@ var Server = require(__dirname + "/server.js");
 var defaultModules = require(__dirname + "/../modules/default/defaultmodules.js");
 var path = require("path");
 
+// Get version number.
+global.version = JSON.parse(fs.readFileSync("package.json", "utf8")).version;
+console.log("Starting MagicMirror: v" + global.version);
+
+// global absolute root path
+global.root_path = path.resolve(__dirname + "/../");
+
 // The next part is here to prevent a major exception when there
 // is no internet connection. This could probable be solved better.
 process.on("uncaughtException", function (err) {
@@ -34,7 +41,7 @@ var App = function() {
 	var loadConfig = function(callback) {
 		console.log("Loading config ...");
 		var defaults = require(__dirname + "/defaults.js");
-		var configFilename = path.resolve(__dirname + "/../config/config.js");
+		var configFilename = path.resolve(global.root_path + "/config/config.js");
 		try {
 			fs.accessSync(configFilename, fs.F_OK);
 			var c = require(configFilename);
@@ -82,6 +89,17 @@ var App = function() {
 		if (loadModule) {
 			var Module = require(helperPath);
 			var m = new Module();
+
+			if (m.requiresVersion) {
+				console.log("Check MagicMirror version for node helper '" + moduleName + "' - Minimum version:  " + m.requiresVersion + " - Current version: " + global.version);
+				if (cmpVersions(global.version, m.requiresVersion) >= 0) {
+					console.log("Version is ok!");
+				} else {
+					console.log("Version is incorrect. Skip module: '" + moduleName + "'");
+					return;
+				}
+			}
+
 			m.setName(moduleName);
 			m.setPath(path.resolve(moduleFolder));
 			nodeHelpers.push(m);
@@ -103,6 +121,28 @@ var App = function() {
 		console.log("All module helpers loaded.");
 	};
 
+	/* cmpVersions(a,b)
+	 * Compare two symantic version numbers and return the difference.
+	 *
+	 * argument a string - Version number a.
+	 * argument a string - Version number b.
+	 */
+	function cmpVersions(a, b) {
+		var i, diff;
+		var regExStrip0 = /(\.0+)+$/;
+		var segmentsA = a.replace(regExStrip0, "").split(".");
+		var segmentsB = b.replace(regExStrip0, "").split(".");
+		var l = Math.min(segmentsA.length, segmentsB.length);
+
+		for (i = 0; i < l; i++) {
+			diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+			if (diff) {
+				return diff;
+			}
+		}
+		return segmentsA.length - segmentsB.length;
+	}
+
 	/* start(callback)
 	 * This methods starts the core app.
 	 * It loads the config, then it loads all modules.
@@ -119,7 +159,7 @@ var App = function() {
 
 			for (var m in config.modules) {
 				var module = config.modules[m];
-				if (modules.indexOf(module.module) === -1) {
+				if (modules.indexOf(module.module) === -1 && !module.disabled) {
 					modules.push(module.module);
 				}
 			}
@@ -147,4 +187,4 @@ var App = function() {
 	};
 };
 
-module.exports = new App();
+module.exports = new App();