TiddlyWiki5/core/modules/startup/startup.js

/*\
title: $:/core/modules/startup.js
type: application/javascript
module-type: startup

Miscellaneous startup logic for both the client and server.

\*/
(function(){

/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";

// Export name and synchronous status
exports.name = "startup";
exports.after = ["load-modules"];
exports.synchronous = true;

// Set to `true` to enable performance instrumentation
var PERFORMANCE_INSTRUMENTATION_CONFIG_TITLE = "$:/config/Performance/Instrumentation";

var widget = require("$:/core/modules/widgets/widget.js");

exports.startup = function() {
	// Minimal browser detection
	if($tw.browser) {
		$tw.browser.isIE = (/msie|trident/i.test(navigator.userAgent));
		$tw.browser.isFirefox = !!document.mozFullScreenEnabled;
		// 2023-07-21 Edge returns UA below. So we use "isChromeLike"
		//'mozilla/5.0 (windows nt 10.0; win64; x64) applewebkit/537.36 (khtml, like gecko) chrome/114.0.0.0 safari/537.36 edg/114.0.1823.82'
		$tw.browser.isChromeLike = navigator.userAgent.toLowerCase().indexOf("chrome") > -1;
		$tw.browser.hasTouch = !!window.matchMedia && window.matchMedia("(pointer: coarse)").matches;
		$tw.browser.isMobileChrome = $tw.browser.isChromeLike && $tw.browser.hasTouch;
	}
	// Platform detection
	$tw.platform = {};
	if($tw.browser) {
		$tw.platform.isMac = /Mac/.test(navigator.platform);
		$tw.platform.isWindows = /win/i.test(navigator.platform);
		$tw.platform.isLinux = /Linux/i.test(navigator.platform);
	} else {
		switch(require("os").platform()) {
			case "darwin":
				$tw.platform.isMac = true;
				break;
			case "win32":
				$tw.platform.isWindows = true;
				break;
			case "freebsd":
				$tw.platform.isLinux = true;
				break;
			case "linux":
				$tw.platform.isLinux = true;
				break;
		}
	}
	// Initialise version
	$tw.version = $tw.utils.extractVersionInfo();
	// Set up the performance framework
	$tw.perf = new $tw.Performance($tw.wiki.getTiddlerText(PERFORMANCE_INSTRUMENTATION_CONFIG_TITLE,"no") === "yes");
	// Create a root widget for attaching event handlers. By using it as the parentWidget for another widget tree, one can reuse the event handlers
	$tw.rootWidget = new widget.widget({
		type: "widget",
		children: []
	},{
		wiki: $tw.wiki,
		document: $tw.browser ? document : $tw.fakeDocument
	});
	// Execute any startup actions
	$tw.rootWidget.invokeActionsByTag("$:/tags/StartupAction");
	if($tw.browser) {
		$tw.rootWidget.invokeActionsByTag("$:/tags/StartupAction/Browser");
	}
	if($tw.node) {
		$tw.rootWidget.invokeActionsByTag("$:/tags/StartupAction/Node");
	}
	// Kick off the language manager and switcher
	$tw.language = new $tw.Language();
	$tw.languageSwitcher = new $tw.PluginSwitcher({
		wiki: $tw.wiki,
		pluginType: "language",
		controllerTitle: "$:/language",
		defaultPlugins: [
			"$:/languages/en-GB"
		],
		onSwitch: function(plugins) {
			if($tw.browser) {
				var pluginTiddler = $tw.wiki.getTiddler(plugins[0]);
				if(pluginTiddler) {
					document.documentElement.setAttribute("dir",pluginTiddler.getFieldString("text-direction") || "auto");
				} else {
					document.documentElement.removeAttribute("dir");
				}
			}
		}
	});
	// Kick off the theme manager
	$tw.themeManager = new $tw.PluginSwitcher({
		wiki: $tw.wiki,
		pluginType: "theme",
		controllerTitle: "$:/theme",
		defaultPlugins: [
			"$:/themes/tiddlywiki/snowwhite",
			"$:/themes/tiddlywiki/vanilla"
		]
	});
	// Kick off the keyboard manager
	$tw.keyboardManager = new $tw.KeyboardManager();
	// Listen for shortcuts
	if($tw.browser) {
		$tw.utils.addEventListeners(document,[{
			name: "keydown",
			handlerObject: $tw.keyboardManager,
			handlerMethod: "handleKeydownEvent"
		}]);
	}
	// Clear outstanding tiddler store change events to avoid an unnecessary refresh cycle at startup
	$tw.wiki.clearTiddlerEventQueue();
	// Find a working syncadaptor
	$tw.syncadaptor = undefined;
	$tw.modules.forEachModuleOfType("syncadaptor",function(title,module) {
		if(!$tw.syncadaptor && module.adaptorClass) {
			$tw.syncadaptor = new module.adaptorClass({wiki: $tw.wiki});
		}
	});
	// Set up the syncer object if we've got a syncadaptor
	if($tw.syncadaptor) {
		$tw.syncer = new $tw.Syncer({
			wiki: $tw.wiki,
			syncadaptor: $tw.syncadaptor,
			logging: $tw.wiki.getTiddlerText('$:/config/SyncLogging', "yes") === "yes"
		});
	}
	// Setup the saver handler
	$tw.saverHandler = new $tw.SaverHandler({
		wiki: $tw.wiki,
		dirtyTracking: !$tw.syncadaptor,
		preloadDirty: $tw.boot.preloadDirty || []
	});
	// Host-specific startup
	if($tw.browser) {
		// Install the popup manager
		$tw.popup = new $tw.utils.Popup();
		// Install the animator
		$tw.anim = new $tw.utils.Animator();
	}
};

})();