From 78ba57d55d99bbbe78fc80127f0cd19647a47925 Mon Sep 17 00:00:00 2001
From: Jermolene <jeremy@osmosoft.com>
Date: Sat, 3 May 2014 17:49:20 +0100
Subject: [PATCH] Remove support for browser-startup modules

Instead support startup modules that stipulate which platform they
require.

Also include docs updates and fixes to fullscreen plugin
---
 boot/boot.js                                  | 13 +++++-
 core/language/en-GB/Docs/ModuleTypes.multids  |  1 -
 core/modules/startup.js                       |  6 ---
 .../tiddlers/mechanisms/StartupMechanism.tid  |  1 +
 languages/de-DE/Docs/ModuleTypes.multids      |  1 -
 languages/fr-FR/Docs/ModuleTypes.multids      |  1 -
 languages/it-IT/Docs/ModuleTypes.multids      |  1 -
 languages/ja-JP/Docs/ModuleTypes.multids      |  1 -
 languages/zh-Hans/Docs/ModuleTypes.multids    |  1 -
 languages/zh-Hant/Docs/ModuleTypes.multids    |  1 -
 plugins/tiddlywiki/fullscreen/init.js         | 41 ++++++++++---------
 11 files changed, 34 insertions(+), 34 deletions(-)

diff --git a/boot/boot.js b/boot/boot.js
index 96616ae95..14b9b4615 100644
--- a/boot/boot.js
+++ b/boot/boot.js
@@ -1773,9 +1773,20 @@ $tw.boot.executeNextStartupTask = function() {
 };
 
 $tw.boot.isStartupTaskEligible = function(taskModule) {
+	var t;
+	// Check that the platform is correct
+	var platforms = taskModule.platforms;
+	if(platforms) {
+		for(t=0; t<platforms.length; t++) {
+			if((platforms[t] === "browser" && !$tw.browser) || (platforms[t] === "node" && !$tw.node)) {
+				return false;
+			}
+		}
+	}
+	// Check that all of the tasks that we must be performed after has been done
 	var after = taskModule.after;
 	if(after) {
-		for(var t=0; t<after.length; t++) {
+		for(t=0; t<after.length; t++) {
 			if(!$tw.boot.executedStartupModules[after[t]]) {
 				return false;
 			}
diff --git a/core/language/en-GB/Docs/ModuleTypes.multids b/core/language/en-GB/Docs/ModuleTypes.multids
index c94056db5..6f7f08d30 100644
--- a/core/language/en-GB/Docs/ModuleTypes.multids
+++ b/core/language/en-GB/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: Animations that may be used with the RevealWidget.
-browser-startup: Startup functions that are only executed in the browser.
 command: Commands that can be executed under Node.js.
 config: Data to be inserted into `$tw.config`.
 filteroperator: Individual filter operator methods.
diff --git a/core/modules/startup.js b/core/modules/startup.js
index a849ee86f..6943fe904 100755
--- a/core/modules/startup.js
+++ b/core/modules/startup.js
@@ -220,12 +220,6 @@ exports.startup = function() {
 				param: "$:/language/Modals/SaveInstructions"
 			});
 		}
-		// Call browser startup modules
-		$tw.modules.forEachModuleOfType("browser-startup",function(title,module) {
-			if(module.startup) {
-				module.startup();
-			}
-		});
 	} else {
 		// On the server, start a commander with the command line arguments
 		commander = new $tw.Commander(
diff --git a/editions/tw5.com/tiddlers/mechanisms/StartupMechanism.tid b/editions/tw5.com/tiddlers/mechanisms/StartupMechanism.tid
index de545fbd1..9838f6203 100644
--- a/editions/tw5.com/tiddlers/mechanisms/StartupMechanism.tid
+++ b/editions/tw5.com/tiddlers/mechanisms/StartupMechanism.tid
@@ -14,6 +14,7 @@ Modules with their ''module-type'' field set to `startup`:
 ** For synchronous startup modules the startup function is called as `startup()`, asynchronous modules are passed a callback they must invoke on completion: `startup(callback)`
 * May expose a `name` property that is used to identify the task
 * May expose a `after` property containing an array of names of dependent tasks that must be run before this one
+* May expose a `platforms` property containing an array of names of platforms that are required in order for the startup module to be executed. The defined platforms are ''node'' and ''browser''
 
 ! Startup Processing
 
diff --git a/languages/de-DE/Docs/ModuleTypes.multids b/languages/de-DE/Docs/ModuleTypes.multids
index 175a27447..955011253 100644
--- a/languages/de-DE/Docs/ModuleTypes.multids
+++ b/languages/de-DE/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: Animationen, die vom RevealWidget verwendet werden. 
-browser-startup: Funktionen, die einmalig beim Browser start ausgeführt werden.
 command: Kommandozeilen Parameter, die mit node.js ausgeführt werden können.
 config: Daten, die in `$tw.config` eingefügt werden.
 filteroperator: Individuelle Filter Operator Funktionen.
diff --git a/languages/fr-FR/Docs/ModuleTypes.multids b/languages/fr-FR/Docs/ModuleTypes.multids
index 545d8756c..69bf6177d 100644
--- a/languages/fr-FR/Docs/ModuleTypes.multids
+++ b/languages/fr-FR/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: Animations pouvant être utilisées par le RevealWidget.
-browser-startup: Fonctions de démarrage exécutées dans le navigateur uniquement.
 command: Commandes qui peuvent être exécutées en mode Node.js.
 config: Données à inclure dans `$tw.config`.
 filteroperator: Méthodes d'opérateurs pour les filtres.
diff --git a/languages/it-IT/Docs/ModuleTypes.multids b/languages/it-IT/Docs/ModuleTypes.multids
index 5f4d5868b..53b39331a 100644
--- a/languages/it-IT/Docs/ModuleTypes.multids
+++ b/languages/it-IT/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: Animazioni che possono essere utilizzate con RevealWidget.
-browser-startup: Funzioni di avvio che vengono eseguite solo nel browser.
 command: Comandi che possono essere eseguiti sotto Node.js.
 config: Data da inserire nel `$tw.config`.
 filteroperator: I singoli metodi degli operatori di filtro.
diff --git a/languages/ja-JP/Docs/ModuleTypes.multids b/languages/ja-JP/Docs/ModuleTypes.multids
index eed885ea5..0aca2b089 100644
--- a/languages/ja-JP/Docs/ModuleTypes.multids
+++ b/languages/ja-JP/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: アニメーション。通常は RevealWidget で使用されるモジュール。
-browser-startup: ブラウザから開いたときにのみ、初回に実行されるファンクションモジュール。
 command: Node.js で実行できるコマンド。
 config: `$tw.config` に格納されるデータ。
 filteroperator: 個々のフィルタ操作用メソッドモジュール。
diff --git a/languages/zh-Hans/Docs/ModuleTypes.multids b/languages/zh-Hans/Docs/ModuleTypes.multids
index 29155c05a..015d5c652 100644
--- a/languages/zh-Hans/Docs/ModuleTypes.multids
+++ b/languages/zh-Hans/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: 动画模块包含可用于 RevealWidget 的动画。
-browser-startup: 仅可于浏览器中执行的启动功能函数。
 command: 可于 Node.js 执行的指令。
 config: 加入 `$tw.config` 的数据。
 filteroperator: 个别筛选器算子方法。
diff --git a/languages/zh-Hant/Docs/ModuleTypes.multids b/languages/zh-Hant/Docs/ModuleTypes.multids
index 2bba8dd6c..0111f41e2 100644
--- a/languages/zh-Hant/Docs/ModuleTypes.multids
+++ b/languages/zh-Hant/Docs/ModuleTypes.multids
@@ -1,7 +1,6 @@
 title: $:/language/Docs/ModuleTypes/
 
 animation: 動畫模組包含可用於 RevealWidget 的動畫。
-browser-startup: 僅可於瀏覽器中執行的啟動功能函數。
 command: 可於 Node.js 執行的指令。
 config: 加入 `$tw.config` 的資料。
 filteroperator: 個別篩選器運算元方法。
diff --git a/plugins/tiddlywiki/fullscreen/init.js b/plugins/tiddlywiki/fullscreen/init.js
index 58de69854..768876231 100644
--- a/plugins/tiddlywiki/fullscreen/init.js
+++ b/plugins/tiddlywiki/fullscreen/init.js
@@ -1,7 +1,7 @@
 /*\
 title: $:/plugins/tiddlywiki/fullscreen/init.js
 type: application/javascript
-module-type: browser-startup
+module-type: startup
 
 Message handler for full screen mode
 
@@ -12,34 +12,35 @@ Message handler for full screen mode
 /*global $tw: false, Element: false */
 "use strict";
 
-var d = document,
-	db = d.body,
-	_requestFullscreen = db.webkitRequestFullscreen !== undefined ? "webkitRequestFullscreen" :
-						db.mozRequestFullScreen !== undefined ? "mozRequestFullScreen" :
-						db.msRequestFullscreen !== undefined ? "msRequestFullscreen" :
-						db.requestFullscreen !== undefined ? "requestFullscreen" : "",
-	_exitFullscreen = d.webkitExitFullscreen !== undefined ? "webkitExitFullscreen" :
+// Export name and synchronous status
+exports.name = "full-screen-startup";
+exports.platforms = ["browser"];
+exports.after = ["startup"];
+exports.synchronous = true;
+
+exports.startup = function() {
+	var d = document,
+		db = d.body,
+		_requestFullscreen = db.webkitRequestFullscreen !== undefined ? "webkitRequestFullscreen" :
+							db.mozRequestFullScreen !== undefined ? "mozRequestFullScreen" :
+							db.msRequestFullscreen !== undefined ? "msRequestFullscreen" :
+							db.requestFullscreen !== undefined ? "requestFullscreen" : "",
+		_exitFullscreen = d.webkitExitFullscreen !== undefined ? "webkitExitFullscreen" :
 							d.mozCancelFullScreen !== undefined ? "mozCancelFullScreen" :
 							d.msExitFullscreen !== undefined ? "msExitFullscreen" :
 							d.exitFullscreen !== undefined ? "exitFullscreen" : "",
-	_fullscreenElement = d.webkitFullscreenElement !== undefined ? "webkitFullscreenElement" :
+		_fullscreenElement = d.webkitFullscreenElement !== undefined ? "webkitFullscreenElement" :
 							d.mozFullScreenElement !== undefined ? "mozFullScreenElement" :
 							d.msFullscreenElement !== undefined ? "msFullscreenElement" :
 							d.fullscreenElement !== undefined ? "fullscreenElement" : "";
-
-var toggleFullscreen = function() {
-	if(document[_fullscreenElement]) {
-		document[_exitFullscreen]();
-	} else {
-		document.documentElement[_requestFullscreen](Element.ALLOW_KEYBOARD_INPUT);
-	}
-};
-
-exports.startup = function() {
 	// Install the full screen handler
 	if(_requestFullscreen) {
 		$tw.rootWidget.addEventListener("tw-full-screen",function(event) {
-			toggleFullscreen();
+			if(document[_fullscreenElement]) {
+				document[_exitFullscreen]();
+			} else {
+				document.documentElement[_requestFullscreen](Element.ALLOW_KEYBOARD_INPUT);
+			}
 		});
 	}
 };