/*\ title: $:/core/boot.js type: application/javascript The main boot kernel for TiddlyWiki. This single file creates a barebones TW environment that is just sufficient to bootstrap the plugins containing the main logic of the applicaiton. On the server this file is executed directly to boot TiddlyWiki. In the browser, this file is packed into a single HTML file along with other elements: # bootprefix.js # # boot.js The module definitions on the browser look like this: $tw.defineModule("MyModule","moduletype",function(module,exports,require) { // Module code inserted here return exports; }); In practice, each module is wrapped in a separate script block. \*/ (function() { /*jslint node: true, browser: true */ /*global modules: false, $tw: false */ "use strict"; /////////////////////////// Setting up $tw // Set up $tw global for the server if(typeof(window) === "undefined" && !global.$tw) { global.$tw = {}; // No ``browser`` member for the server exports.$tw = $tw; } // Boot information $tw.boot = {}; // Server initialisation var fs, path, vm; if(!$tw.browser) { // Standard node libraries fs = require("fs"); path = require("path"); vm = require("vm"); // System paths and filenames $tw.boot.bootFile = path.basename(module.filename); $tw.boot.bootPath = path.dirname(module.filename); $tw.boot.wikiPath = process.cwd(); // Read package info $tw.packageInfo = JSON.parse(fs.readFileSync($tw.boot.bootPath + "/../package.json")); // Check node version number var targetVersion = $tw.packageInfo.engine.node.substr(2).split("."), currVersion = process.version.substr(1).split("."); if(targetVersion[0] > currVersion[0] || targetVersion[1] > currVersion[1] || targetVersion[2] > currVersion[2]) { throw "TiddlyWiki5 requires node.js version " + $tw.packageInfo.engine.node; } } // Modules store registers all the modules the system has seen $tw.modules = $tw.modules || {}; $tw.modules.titles = $tw.modules.titles || {}; // hashmap by module title of {fn:, exports:, moduleType:} // Plugins store organises module exports by module type $tw.plugins = $tw.plugins || {}; $tw.plugins.moduleTypes = $tw.plugins.moduleTypes || {}; // hashmap by module type of array of exports // Config object $tw.config = $tw.config || {}; // Constants $tw.config.root = $tw.config.root || "$:"; // Root for module titles (eg, "$:/core/boot.js") $tw.config.bootModuleSubDir = $tw.config.bootModuleSubDir || "./modules"; $tw.config.wikiPluginsSubDir = $tw.config.wikiPluginsSubDir || "./plugins"; $tw.config.wikiShadowsSubDir = $tw.config.wikiShadowsSubDir || "./wiki"; $tw.config.wikiTiddlersSubDir = $tw.config.wikiTiddlersSubDir || "./tiddlers"; // File extension mappings $tw.config.fileExtensionInfo = { ".tid": {type: "application/x-tiddler"}, ".tiddler": {type: "application/x-tiddler-html-div"}, ".recipe": {type: "application/x-tiddlywiki-recipe"}, ".txt": {type: "text/plain"}, ".css": {type: "text/css"}, ".html": {type: "text/html"}, ".js": {type: "application/javascript"}, ".json": {type: "application/json"}, ".jpg": {type: "image/jpeg"}, ".jpeg": {type: "image/jpeg"}, ".png": {type: "image/png"}, ".gif": {type: "image/gif"}, ".svg": {type: "image/svg+xml"} }; // Content type mappings $tw.config.contentTypeInfo = { "application/x-tiddler": {encoding: "utf8"}, "application/x-tiddler-html-div": {encoding: "utf8"}, "application/x-tiddlywiki-recipe": {encoding: "utf8"}, "text/plain": {encoding: "utf8"}, "text/css": {encoding: "utf8"}, "text/html": {encoding: "utf8"}, "application/javascript": {encoding: "utf8"}, "application/json": {encoding: "utf8"}, "image/jpeg": {encoding: "base64"}, "image/png": {encoding: "base64"}, "image/gif": {encoding: "base64"}, "image/svg+xml": {encoding: "utf8"} }; /////////////////////////// Utility functions $tw.utils = $tw.utils || {}; /* Determine if a value is an array */ $tw.utils.isArray = function(value) { return Object.prototype.toString.call(value) == "[object Array]"; }; // Convert "&" to &, "<" to <, ">" to > and """ to " $tw.utils.htmlDecode = function(s) { return s.toString().replace(/</mg,"<").replace(/>/mg,">").replace(/"/mg,"\"").replace(/&/mg,"&"); }; /* Pad a string to a given length with "0"s. Length defaults to 2 */ $tw.utils.pad = function(value,length) { length = length || 2; var s = value.toString(); if(s.length < length) { s = "000000000000000000000000000".substr(0,length - s.length) + s; } return s; }; // Convert a date into YYYYMMDDHHMM format $tw.utils.stringifyDate = function(value) { return value.getUTCFullYear() + $tw.utils.pad(value.getUTCMonth() + 1) + $tw.utils.pad(value.getUTCDate()) + $tw.utils.pad(value.getUTCHours()) + $tw.utils.pad(value.getUTCMinutes()); }; // Parse a date from a YYYYMMDDHHMMSSMMM format string $tw.utils.parseDate = function(value) { if(typeof value === "string") { return new Date(Date.UTC(parseInt(value.substr(0,4),10), parseInt(value.substr(4,2),10)-1, parseInt(value.substr(6,2),10), parseInt(value.substr(8,2)||"00",10), parseInt(value.substr(10,2)||"00",10), parseInt(value.substr(12,2)||"00",10), parseInt(value.substr(14,3)||"000",10))); } else if (value instanceof Date) { return value; } else { return null; } }; // Parse a string array from a bracketted list $tw.utils.parseStringArray = function(value) { if(typeof value === "string") { var memberRegExp = /(?:\[\[([^\]]+)\]\])|([^\s]+)/mg, results = [], match; do { match = memberRegExp.exec(value); if(match) { results.push(match[1] || match[2]); } } while(match); return results; } else if ($tw.utils.isArray(value)) { return value; } else { return null; } }; // Parse a block of name:value fields. The `fields` object is used as the basis for the return value $tw.utils.parseFields = function(text,fields) { text.split(/\r?\n/mg).forEach(function(line) { var p = line.indexOf(":"); if(p !== -1) { var field = line.substr(0, p).trim(), value = line.substr(p+1).trim(); fields[field] = value; } }); return fields; }; /* Resolves a source filepath delimited with `/` relative to a specified absolute root filepath. In relative paths, the special folder name `..` refers to immediate parent directory, and the name `.` refers to the current directory */ $tw.utils.resolvePath = function(sourcepath,rootpath) { // If the source path starts with ./ or ../ then it is relative to the root if(sourcepath.substr(0,2) === "./" || sourcepath.substr(0,3) === "../" ) { var src = sourcepath.split("/"), root = rootpath.split("/"); // Remove the filename part of the root root.splice(root.length-1,1); // Process the source path bit by bit onto the end of the root path while(src.length > 0) { var c = src.shift(); if(c === "..") { // Slice off the last root entry for a double dot if(root.length > 0) { root.splice(root.length-1,1); } } else if(c !== ".") { // Ignore dots root.push(c); // Copy other elements across } } return root.join("/"); } else { // If it isn't relative, just return the path return sourcepath; } }; /////////////////////////// Plugin mechanism /* Register a single plugin module in the $tw.plugins.moduleTypes hashmap */ $tw.plugins.registerPlugin = function(name,moduleType,moduleExports) { if(!(moduleType in $tw.plugins.moduleTypes)) { $tw.plugins.moduleTypes[moduleType] = []; } $tw.plugins.moduleTypes[moduleType].push(moduleExports); }; /* Register all plugin module tiddlers */ $tw.plugins.registerPluginModules = function() { for(var title in $tw.wiki.tiddlers) { var tiddler = $tw.wiki.getTiddler(title); if(tiddler.fields.type === "application/javascript" && tiddler.fields["module-type"] !== undefined) { $tw.plugins.registerPlugin(title,tiddler.fields["module-type"],$tw.modules.execute(title)); } } }; /* Get all the plugins of a particular type in a hashmap by their `name` field */ $tw.plugins.getPluginsByTypeAsHashmap = function(moduleType,nameField) { nameField = nameField || "name"; var plugins = $tw.plugins.moduleTypes[moduleType], results = {}; if(plugins) { for(var t=0; t 1) { fields = $tw.utils.parseFields(split[0],fields); fields.text = split.slice(1).join("\n\n"); } else { fields.text = text; } return [fields]; } }); $tw.plugins.registerPlugin($tw.config.root + "/kernel/tiddlerdeserializer/txt","tiddlerdeserializer",{ "text/plain": function(text,fields) { fields.text = text; fields.type = "text/plain"; return [fields]; } }); $tw.plugins.registerPlugin($tw.config.root + "/kernel/tiddlerdeserializer/html","tiddlerdeserializer",{ "text/html": function(text,fields) { fields.text = text; fields.type = "text/html"; return [fields]; } }); // Install the tiddler deserializer plugins so they are immediately available $tw.plugins.applyMethods("tiddlerdeserializer",$tw.Wiki.tiddlerDeserializerPlugins); /////////////////////////// Intermediate initialisation /* Create the wiki store for the app */ $tw.wiki = new $tw.Wiki(); /////////////////////////// Browser definitions if($tw.browser) { /* Execute the module named 'moduleName'. The name can optionally be relative to the module named 'moduleRoot' */ $tw.modules.execute = function(moduleName,moduleRoot) { var name = moduleRoot ? $tw.utils.resolvePath(moduleName,moduleRoot) : moduleName, require = function(modRequire) { return $tw.modules.execute(modRequire,name); }, exports = {}, module = $tw.modules.titles[name]; if(!module) { throw new Error("Cannot find module named '" + moduleName + "' required by module '" + moduleRoot + "', resolved to " + name); } if(module.exports) { return module.exports; } else { module.exports = {}; module.fn(module,module.exports,require); return module.exports; } }; /* Register a deserializer that can extract tiddlers from the DOM */ $tw.plugins.registerPlugin($tw.config.root + "/kernel/tiddlerdeserializer/dom","tiddlerdeserializer",{ "(DOM)": function(node) { var extractTextTiddler = function(node) { var e = node.firstChild; while(e && e.nodeName.toLowerCase() !== "pre") { e = e.nextSibling; } var title = node.getAttribute ? node.getAttribute("title") : null; if(e && title) { var attrs = node.attributes, tiddler = { text: $tw.utils.htmlDecode(e.innerHTML) }; for(var i=attrs.length-1; i >= 0; i--) { if(attrs[i].specified) { tiddler[attrs[i].name] = attrs[i].value; } } return tiddler; } else { return null; } }, extractModuleTiddler = function(node) { if(node.hasAttribute && node.hasAttribute("data-tiddler-title")) { var text = node.innerHTML, s = text.indexOf("{"), e = text.lastIndexOf("}"); if(node.hasAttribute("data-module") && s !== -1 && e !== -1) { text = text.substring(s+1,e); } var fields = {text: text}, attributes = node.attributes; for(var a=0; a