tiddlywiki 5.1.21 → 5.2.1

package/core/modules/utils/fakedom.js

@@ -21,14 +21,32 @@ var bumpSequenceNumber = function(object) {
 	}
 };
 
+var TW_Node = function (){
+	throw TypeError("Illegal constructor");
+};
+
+Object.defineProperty(TW_Node.prototype, 'ELEMENT_NODE', {
+	get: function() {
+		return 1;
+	}
+});
+
+Object.defineProperty(TW_Node.prototype, 'TEXT_NODE', {
+	get: function() {
+		return 3;
+	}
+});
+
 var TW_TextNode = function(text) {
 	bumpSequenceNumber(this);
 	this.textContent = text + "";
 };
 
+TW_TextNode.prototype = Object.create(TW_Node.prototype);
+
 Object.defineProperty(TW_TextNode.prototype, "nodeType", {
 	get: function() {
-		return 3;
+		return this.TEXT_NODE;
 	}
 });
 
@@ -49,6 +67,8 @@ var TW_Element = function(tag,namespace) {
 	this.namespaceURI = namespace || "http://www.w3.org/1999/xhtml";
 };
 
+TW_Element.prototype = Object.create(TW_Node.prototype);
+
 Object.defineProperty(TW_Element.prototype, "style", {
 	get: function() {
 		return this._style;
@@ -69,7 +89,7 @@ Object.defineProperty(TW_Element.prototype, "style", {
 
 Object.defineProperty(TW_Element.prototype, "nodeType", {
 	get: function() {
-		return 1;
+		return this.ELEMENT_NODE;
 	}
 });
 
@@ -215,7 +235,7 @@ Object.defineProperty(TW_Element.prototype, "innerHTML", {
 				if(node instanceof TW_Element) {
 					b.push(node.outerHTML);
 				} else if(node instanceof TW_TextNode) {
-					b.push($tw.utils.htmlEncode(node.textContent));
+					b.push($tw.utils.htmlTextEncode(node.textContent));
 				}
 			});
 			return b.join("");

package/core/modules/utils/filesystem.js

@@ -15,13 +15,33 @@ File system utilities
 var fs = require("fs"),
 	path = require("path");
 
+/*
+Return the subdirectories of a path
+*/
+exports.getSubdirectories = function(dirPath) {
+	if(!$tw.utils.isDirectory(dirPath)) {
+		return null;
+	}
+	var subdirs = [];
+	$tw.utils.each(fs.readdirSync(dirPath),function(item) {
+		if($tw.utils.isDirectory(path.resolve(dirPath,item))) {
+			subdirs.push(item);
+		}
+	});
+	return subdirs;
+}
+
 /*
 Recursively (and synchronously) copy a directory and all its content
 */
 exports.copyDirectory = function(srcPath,dstPath) {
 	// Remove any trailing path separators
-	srcPath = $tw.utils.removeTrailingSeparator(srcPath);
-	dstPath = $tw.utils.removeTrailingSeparator(dstPath);
+	srcPath = path.resolve($tw.utils.removeTrailingSeparator(srcPath));
+	dstPath = path.resolve($tw.utils.removeTrailingSeparator(dstPath));
+	// Check that neither director is within the other
+	if(srcPath.substring(0,dstPath.length) === dstPath || dstPath.substring(0,srcPath.length) === srcPath) {
+		return "Cannot copy nested directories";
+	}
 	// Create the destination directory
 	var err = $tw.utils.createDirectory(dstPath);
 	if(err) {
@@ -184,15 +204,23 @@ exports.deleteEmptyDirs = function(dirpath,callback) {
 /*
 Create a fileInfo object for saving a tiddler:
 	filepath: the absolute path to the file containing the tiddler
-	type: the type of the tiddler file (NOT the type of the tiddler)
+	type: the type of the tiddler file on disk (NOT the type of the tiddler)
 	hasMetaFile: true if the file also has a companion .meta file
+	isEditableFile: true if the tiddler was loaded via non-standard options & marked editable
 Options include:
 	directory: absolute path of root directory to which we are saving
 	pathFilters: optional array of filters to be used to generate the base path
-	wiki: optional wiki for evaluating the pathFilters
+	extFilters: optional array of filters to be used to generate the base path
+	wiki: optional wiki for evaluating the pathFilters,
+	fileInfo: an existing fileInfo to check against
 */
 exports.generateTiddlerFileInfo = function(tiddler,options) {
-	var fileInfo = {};
+	var fileInfo = {}, metaExt;
+	// Propagate the isEditableFile flag
+	if(options.fileInfo && !!options.fileInfo.isEditableFile) {
+		fileInfo.isEditableFile = true;
+		fileInfo.originalpath = options.fileInfo.originalpath;
+	}
 	// Check if the tiddler has any unsafe fields that can't be expressed in a .tid or .meta file: containing control characters, or leading/trailing whitespace
 	var hasUnsafeFields = false;
 	$tw.utils.each(tiddler.getFieldStrings(),function(value,fieldName) {
@@ -200,6 +228,7 @@ exports.generateTiddlerFileInfo = function(tiddler,options) {
 			hasUnsafeFields = hasUnsafeFields || /[\x00-\x1F]/mg.test(value);
 			hasUnsafeFields = hasUnsafeFields || ($tw.utils.trim(value) !== value);
 		}
+		hasUnsafeFields = hasUnsafeFields || /:/mg.test(fieldName);
 	});
 	// Check for field values 
 	if(hasUnsafeFields) {
@@ -218,19 +247,67 @@ exports.generateTiddlerFileInfo = function(tiddler,options) {
 			fileInfo.type = tiddlerType;
 			fileInfo.hasMetaFile = true;
 		}
+		if(options.extFilters) {
+			// Check for extension overrides
+			metaExt = $tw.utils.generateTiddlerExtension(tiddler.fields.title,{
+				extFilters: options.extFilters,
+				wiki: options.wiki
+			});
+			if(metaExt) {
+				if(metaExt === ".tid") {
+					// Overriding to the .tid extension needs special handling
+					fileInfo.type = "application/x-tiddler";
+					fileInfo.hasMetaFile = false;
+				} else if (metaExt === ".json") {
+					// Overriding to the .json extension needs special handling
+					fileInfo.type = "application/json";
+					fileInfo.hasMetaFile = false;
+				} else {
+					//If the new type matches a known extention, use that MIME type's encoding
+					var extInfo = $tw.utils.getFileExtensionInfo(metaExt);
+					fileInfo.type = extInfo ? extInfo.type : null;
+					fileInfo.encoding = $tw.utils.getTypeEncoding(metaExt);
+					fileInfo.hasMetaFile = true;
+				}
+			}
+		}
 	}
-	// Take the file extension from the tiddler content type
+	// Take the file extension from the tiddler content type or metaExt
 	var contentTypeInfo = $tw.config.contentTypeInfo[fileInfo.type] || {extension: ""};
 	// Generate the filepath
 	fileInfo.filepath = $tw.utils.generateTiddlerFilepath(tiddler.fields.title,{
-		extension: contentTypeInfo.extension,
+		extension: metaExt || contentTypeInfo.extension,
 		directory: options.directory,
 		pathFilters: options.pathFilters,
-		wiki: options.wiki
+		wiki: options.wiki,
+		fileInfo: options.fileInfo
 	});
 	return fileInfo;
 };
 
+/*
+Generate the file extension for saving a tiddler
+Options include:
+	extFilters: optional array of filters to be used to generate the extention
+	wiki: optional wiki for evaluating the extFilters
+*/
+exports.generateTiddlerExtension = function(title,options) {
+	var extension;
+	// Check if any of the extFilters applies
+	if(options.extFilters && options.wiki) { 
+		$tw.utils.each(options.extFilters,function(filter) {
+			if(!extension) {
+				var source = options.wiki.makeTiddlerIterator([title]),
+					result = options.wiki.filterTiddlers(filter,null,source);
+				if(result.length > 0) {
+					extension = result[0];
+				}
+			}
+		});
+	}
+	return extension;
+};
+
 /*
 Generate the filepath for saving a tiddler
 Options include:
@@ -238,11 +315,12 @@ Options include:
 	directory: absolute path of root directory to which we are saving
 	pathFilters: optional array of filters to be used to generate the base path
 	wiki: optional wiki for evaluating the pathFilters
+	fileInfo: an existing fileInfo object to check against
 */
 exports.generateTiddlerFilepath = function(title,options) {
-	var self = this,
-		directory = options.directory || "",
+	var directory = options.directory || "",
 		extension = options.extension || "",
+		originalpath = (options.fileInfo && options.fileInfo.originalpath) ? options.fileInfo.originalpath : "",
 		filepath;
 	// Check if any of the pathFilters applies
 	if(options.pathFilters && options.wiki) {
@@ -256,28 +334,46 @@ exports.generateTiddlerFilepath = function(title,options) {
 			}
 		});
 	}
-	// If not, generate a base pathname
-	if(!filepath) {
+	if(!filepath && !!originalpath) {
+		//Use the originalpath without the extension
+		var ext = path.extname(originalpath);
+		filepath = originalpath.substring(0,originalpath.length - ext.length);
+	} else if(!filepath) {
 		filepath = title;
-		// If the filepath already ends in the extension then remove it
-		if(filepath.substring(filepath.length - extension.length) === extension) {
-			filepath = filepath.substring(0,filepath.length - extension.length);
-		}
 		// Remove any forward or backward slashes so we don't create directories
 		filepath = filepath.replace(/\/|\\/g,"_");
 	}
-	// Don't let the filename start with a dot because such files are invisible on *nix
-	filepath = filepath.replace(/^\./g,"_");
-	// Remove any characters that can't be used in cross-platform filenames
-	filepath = $tw.utils.transliterate(filepath.replace(/<|>|\:|\"|\||\?|\*|\^/g,"_"));
+	// Replace any Windows control codes
+	filepath = filepath.replace(/^(con|prn|aux|nul|com[0-9]|lpt[0-9])$/i,"_$1_");
+	// Replace any leading spaces with the same number of underscores
+	filepath = filepath.replace(/^ +/,function (u) { return u.replace(/ /g, "_")});
+	//If the path does not start with "." or ".." && a path seperator, then
+	if(!/^\.{1,2}[/\\]/g.test(filepath)) {
+		// Don't let the filename start with any dots because such files are invisible on *nix
+		filepath = filepath.replace(/^\.+/g,function (u) { return u.replace(/\./g, "_")});
+	}
+	// Replace any Unicode control codes
+	filepath = filepath.replace(/[\x00-\x1f\x80-\x9f]/g,"_");
+	// Replace any characters that can't be used in cross-platform filenames
+	filepath = $tw.utils.transliterate(filepath.replace(/<|>|~|\:|\"|\||\?|\*|\^/g,"_"));
+	// Replace any dots or spaces at the end of the extension with the same number of underscores
+	extension = extension.replace(/[\. ]+$/, function (u) { return u.replace(/[\. ]/g, "_")});
+	// Truncate the extension if it is too long
+	if(extension.length > 32) {
+		extension = extension.substr(0,32);
+	}
+	// If the filepath already ends in the extension then remove it
+	if(filepath.substring(filepath.length - extension.length) === extension) {
+		filepath = filepath.substring(0,filepath.length - extension.length);
+	}
 	// Truncate the filename if it is too long
 	if(filepath.length > 200) {
 		filepath = filepath.substr(0,200);
 	}
-	// If the resulting filename is blank (eg because the title is just punctuation characters)
-	if(!filepath) {
+	// If the resulting filename is blank (eg because the title is just punctuation)
+	if(!filepath || /^_+$/g.test(filepath)) {
 		// ...then just use the character codes of the title
-		filepath = "";	
+		filepath = "";
 		$tw.utils.each(title.split(""),function(char) {
 			if(filepath) {
 				filepath += "-";
@@ -286,14 +382,31 @@ exports.generateTiddlerFilepath = function(title,options) {
 		});
 	}
 	// Add a uniquifier if the file already exists
-	var fullPath,
+	var fullPath, oldPath = (options.fileInfo) ? options.fileInfo.filepath : undefined,
 		count = 0;
 	do {
 		fullPath = path.resolve(directory,filepath + (count ? "_" + count : "") + extension);
+		if(oldPath && oldPath == fullPath) {
+			break;
+		}
 		count++;
 	} while(fs.existsSync(fullPath));
+	// If the last write failed with an error, or if path does not start with:
+	//	the resolved options.directory, the resolved wikiPath directory, the wikiTiddlersPath directory, 
+	//	or the 'originalpath' directory, then encodeURIComponent() and resolve to tiddler directory.
+	var writePath = $tw.hooks.invokeHook("th-make-tiddler-path",fullPath,fullPath),
+		encode = (options.fileInfo || {writeError: false}).writeError == true;
+	if(!encode) {
+		encode = !(writePath.indexOf($tw.boot.wikiTiddlersPath) == 0 ||
+			writePath.indexOf(path.resolve(directory)) == 0 ||
+			writePath.indexOf(path.resolve($tw.boot.wikiPath)) == 0 ||
+			writePath.indexOf(path.resolve($tw.boot.wikiTiddlersPath,originalpath)) == 0 );
+		}
+	if(encode) {
+		writePath = path.resolve(directory,encodeURIComponent(fullPath));
+	}
 	// Return the full path to the file
-	return fullPath;
+	return writePath;
 };
 
 /*
@@ -307,18 +420,33 @@ exports.saveTiddlerToFile = function(tiddler,fileInfo,callback) {
 	if(fileInfo.hasMetaFile) {
 		// Save the tiddler as a separate body and meta file
 		var typeInfo = $tw.config.contentTypeInfo[tiddler.fields.type || "text/plain"] || {encoding: "utf8"};
-		fs.writeFile(fileInfo.filepath,tiddler.fields.text,typeInfo.encoding,function(err) {
+		fs.writeFile(fileInfo.filepath,tiddler.fields.text || "",typeInfo.encoding,function(err) {
 			if(err) {
 				return callback(err);
 			}
-			fs.writeFile(fileInfo.filepath + ".meta",tiddler.getFieldStringBlock({exclude: ["text","bag"]}),"utf8",callback);
+			fs.writeFile(fileInfo.filepath + ".meta",tiddler.getFieldStringBlock({exclude: ["text","bag"]}),"utf8",function(err) {
+				if(err) {
+					return callback(err);
+				}
+				return callback(null,fileInfo);
+			});
 		});
 	} else {
 		// Save the tiddler as a self contained templated file
 		if(fileInfo.type === "application/x-tiddler") {
-			fs.writeFile(fileInfo.filepath,tiddler.getFieldStringBlock({exclude: ["text","bag"]}) + (!!tiddler.fields.text ? "\n\n" + tiddler.fields.text : ""),"utf8",callback);
+			fs.writeFile(fileInfo.filepath,tiddler.getFieldStringBlock({exclude: ["text","bag"]}) + (!!tiddler.fields.text ? "\n\n" + tiddler.fields.text : ""),"utf8",function(err) {
+				if(err) {
+					return callback(err);
+				}
+				return callback(null,fileInfo);
+			});
 		} else {
-			fs.writeFile(fileInfo.filepath,JSON.stringify([tiddler.getFieldStrings({exclude: ["bag"]})],null,$tw.config.preferences.jsonSpaces),"utf8",callback);
+			fs.writeFile(fileInfo.filepath,JSON.stringify([tiddler.getFieldStrings({exclude: ["bag"]})],null,$tw.config.preferences.jsonSpaces),"utf8",function(err) {
+				if(err) {
+					return callback(err);
+				}
+				return callback(null,fileInfo);
+			});
 		}
 	}
 };
@@ -334,7 +462,7 @@ exports.saveTiddlerToFileSync = function(tiddler,fileInfo) {
 	if(fileInfo.hasMetaFile) {
 		// Save the tiddler as a separate body and meta file
 		var typeInfo = $tw.config.contentTypeInfo[tiddler.fields.type || "text/plain"] || {encoding: "utf8"};
-		fs.writeFileSync(fileInfo.filepath,tiddler.fields.text,typeInfo.encoding);
+		fs.writeFileSync(fileInfo.filepath,tiddler.fields.text || "",typeInfo.encoding);
 		fs.writeFileSync(fileInfo.filepath + ".meta",tiddler.getFieldStringBlock({exclude: ["text","bag"]}),"utf8");
 	} else {
 		// Save the tiddler as a self contained templated file
@@ -344,6 +472,73 @@ exports.saveTiddlerToFileSync = function(tiddler,fileInfo) {
 			fs.writeFileSync(fileInfo.filepath,JSON.stringify([tiddler.getFieldStrings({exclude: ["bag"]})],null,$tw.config.preferences.jsonSpaces),"utf8");
 		}
 	}
+	return fileInfo;
+};
+
+/*
+Delete a file described by the fileInfo if it exits
+*/
+exports.deleteTiddlerFile = function(fileInfo,callback) {
+	//Only attempt to delete files that exist on disk
+	if(!fileInfo.filepath || !fs.existsSync(fileInfo.filepath)) {
+		//For some reason, the tiddler is only in memory or we can't modify the file at this path
+		$tw.syncer.displayError("Server deleteTiddlerFile task failed for filepath: "+fileInfo.filepath);
+		return callback(null,fileInfo);
+	}
+	// Delete the file
+	fs.unlink(fileInfo.filepath,function(err) {
+		if(err) {
+			return callback(err);
+		}
+		// Delete the metafile if present
+		if(fileInfo.hasMetaFile && fs.existsSync(fileInfo.filepath + ".meta")) {
+			fs.unlink(fileInfo.filepath + ".meta",function(err) {
+				if(err) {
+					return callback(err);
+				}
+				return $tw.utils.deleteEmptyDirs(path.dirname(fileInfo.filepath),function(err) {
+					if(err) {
+						return callback(err);
+					}
+					return callback(null,fileInfo);
+				});
+			});
+		} else {
+			return $tw.utils.deleteEmptyDirs(path.dirname(fileInfo.filepath),function(err) {
+				if(err) {
+					return callback(err);
+				}
+				return callback(null,fileInfo);
+			});
+		}
+	});
+};
+
+/*
+Cleanup old files on disk, by comparing the options values:
+	adaptorInfo from $tw.syncer.tiddlerInfo
+	bootInfo from $tw.boot.files
+*/
+exports.cleanupTiddlerFiles = function(options,callback) {
+	var adaptorInfo = options.adaptorInfo || {},
+	bootInfo = options.bootInfo || {},
+	title = options.title || "undefined";
+	if(adaptorInfo.filepath && bootInfo.filepath && adaptorInfo.filepath !== bootInfo.filepath) {
+		$tw.utils.deleteTiddlerFile(adaptorInfo,function(err) {
+			if(err) {
+				if ((err.code == "EPERM" || err.code == "EACCES") && err.syscall == "unlink") {
+					// Error deleting the previous file on disk, should fail gracefully
+					$tw.syncer.displayError("Server desynchronized. Error cleaning up previous file for tiddler: \""+title+"\"",err);
+					return callback(null,bootInfo);
+				} else {
+					return callback(err);
+				}
+			}
+			return callback(null,bootInfo);
+		});
+	} else {
+		return callback(null,bootInfo);
+	}
 };
 
 })();

package/core/modules/utils/linked-list.js

@@ -0,0 +1,204 @@
+/*\
+module-type: utils
+title: $:/core/modules/utils/linkedlist.js
+type: application/javascript
+
+This is a doubly-linked indexed list intended for manipulation, particularly
+pushTop, which it does with significantly better performance than an array.
+
+\*/
+(function(){
+
+function LinkedList() {
+	this.clear();
+};
+
+LinkedList.prototype.clear = function() {
+	// LinkedList performs the duty of both the head and tail node
+	this.next = Object.create(null);
+	this.prev = Object.create(null);
+	this.first = undefined;
+	this.last = undefined;
+	this.length = 0;
+};
+
+LinkedList.prototype.remove = function(value) {
+	if($tw.utils.isArray(value)) {
+		for(var t=0; t<value.length; t++) {
+			_assertString(value[t]);
+		}
+		for(var t=0; t<value.length; t++) {
+			_removeOne(this,value[t]);
+		}
+	} else {
+		_assertString(value);
+		_removeOne(this,value);
+	}
+};
+
+/*
+Push behaves like array.push and accepts multiple string arguments. But it also
+accepts a single array argument too, to be consistent with its other methods.
+*/
+LinkedList.prototype.push = function(/* values */) {
+	var values = arguments;
+	if($tw.utils.isArray(values[0])) {
+		values = values[0];
+	}
+	for(var i = 0; i < values.length; i++) {
+		_assertString(values[i]);
+	}
+	for(var i = 0; i < values.length; i++) {
+		_linkToEnd(this,values[i]);
+	}
+	return this.length;
+};
+
+LinkedList.prototype.pushTop = function(value) {
+	if($tw.utils.isArray(value)) {
+		for (var t=0; t<value.length; t++) {
+			_assertString(value[t]);
+		}
+		for(var t=0; t<value.length; t++) {
+			_removeOne(this,value[t]);
+		}
+		for(var t=0; t<value.length; t++) {
+			_linkToEnd(this,value[t]);
+		}
+	} else {
+		_assertString(value);
+		_removeOne(this,value);
+		_linkToEnd(this,value);
+	}
+};
+
+LinkedList.prototype.each = function(callback) {
+	var visits = Object.create(null),
+		value = this.first;
+	while(value !== undefined) {
+		callback(value);
+		var next = this.next[value];
+		if(typeof next === "object") {
+			var i = visits[value] || 0;
+			visits[value] = i+1;
+			value = next[i];
+		} else {
+			value = next;
+		}
+	}
+};
+
+LinkedList.prototype.toArray = function() {
+	var output = new Array(this.length),
+		index = 0;
+	this.each(function(value) { output[index++] = value; });
+	return output;
+};
+
+LinkedList.prototype.makeTiddlerIterator = function(wiki) {
+	var self = this;
+	return function(callback) {
+		self.each(function(title) {
+			callback(wiki.getTiddler(title),title);
+		});
+	};
+};
+
+function _removeOne(list,value) {
+	var prevEntry = list.prev[value],
+		nextEntry = list.next[value],
+		prev = prevEntry,
+		next = nextEntry;
+	if(typeof nextEntry === "object") {
+		next = nextEntry[0];
+		prev = prevEntry[0];
+	}
+	// Relink preceding element.
+	if(list.first === value) {
+		list.first = next
+	} else if(prev !== undefined) {
+		if(typeof list.next[prev] === "object") {
+			if(next === undefined) {
+				// Must have been last, and 'i' would be last element.
+				list.next[prev].pop();
+			} else {
+				var i = list.next[prev].indexOf(value);
+				list.next[prev][i] = next;
+			}
+		} else {
+			list.next[prev] = next;
+		}
+	} else {
+		return;
+	}
+	// Now relink following element
+	// Check "next !== undefined" rather than "list.last === value" because
+	// we need to know if the FIRST value is the last in the list, not the last.
+	if(next !== undefined) {
+		if(typeof list.prev[next] === "object") {
+			if(prev === undefined) {
+				// Must have been first, and 'i' would be 0.
+				list.prev[next].shift();
+			} else {
+				var i = list.prev[next].indexOf(value);
+				list.prev[next][i] = prev;
+			}
+		} else {
+			list.prev[next] = prev;
+		}
+	} else {
+		list.last = prev;
+	}
+	// Delink actual value. If it uses arrays, just remove first entries.
+	if(typeof nextEntry === "object") {
+		nextEntry.shift();
+		prevEntry.shift();
+	} else {
+		list.next[value] = undefined;
+		list.prev[value] = undefined;
+	}
+	list.length -= 1;
+};
+
+// Sticks the given node onto the end of the list.
+function _linkToEnd(list,value) {
+	if(list.first === undefined) {
+		list.first = value;
+	} else {
+		// Does it already exists?
+		if(list.first === value || list.prev[value] !== undefined) {
+			if(typeof list.next[value] === "string") {
+				list.next[value] = [list.next[value]];
+				list.prev[value] = [list.prev[value]];
+			} else if(typeof list.next[value] === "undefined") {
+				// list.next[value] must be undefined.
+				// Special case. List already has 1 value. It's at the end.
+				list.next[value] = [];
+				list.prev[value] = [list.prev[value]];
+			}
+			list.prev[value].push(list.last);
+			// We do NOT append a new value onto "next" list. Iteration will
+			// figure out it must point to End-of-List on its own.
+		} else {
+			list.prev[value] = list.last;
+		}
+		// Make the old last point to this new one.
+		if(typeof list.next[list.last] === "object") {
+			list.next[list.last].push(value);
+		} else {
+			list.next[list.last] = value;
+		}
+	}
+	list.last = value;
+	list.length += 1;
+};
+
+function _assertString(value) {
+	if(typeof value !== "string") {
+		throw "Linked List only accepts string values, not " + value;
+	}
+};
+
+exports.LinkedList = LinkedList;
+
+})();