tiddlywiki 5.3.8 → 5.4.1

package/plugins/tiddlywiki/browser-storage/util.js

@@ -10,98 +10,96 @@ Utility methods for browser-storage plugin
 "use strict";
 
 function BrowserStorageUtil(wiki,options) {
-    this.options = options || {};
-    this.wiki = wiki;
-    this.cachedTiddlers = [];
-    this.QUOTA_EXCEEDED_ALERT_TITLE = "$:/config/BrowserStorage/QuotaExceededAlert";
-    this.DEFAULT_QUOTA_EXCEEDED_ALERT_PREFIX = "Quota exceeded attempting to store `";
-    this.DEFAULT_QUOTA_EXCEEDED_ALERT_SUFFIX = "` in browser local storage";
+	this.options = options || {};
+	this.wiki = wiki;
+	this.cachedTiddlers = [];
+	this.QUOTA_EXCEEDED_ALERT_TITLE = "$:/config/BrowserStorage/QuotaExceededAlert";
+	this.DEFAULT_QUOTA_EXCEEDED_ALERT_PREFIX = "Quota exceeded attempting to store `";
+	this.DEFAULT_QUOTA_EXCEEDED_ALERT_SUFFIX = "` in browser local storage";
 }
 
 BrowserStorageUtil.prototype.isEnabled = function() {
-    return $tw.wiki.getTiddlerText(this.options.enabledTitle) === "yes";
+	return $tw.wiki.getTiddlerText(this.options.enabledTitle) === "yes";
 };
 
 BrowserStorageUtil.prototype.cachePreloadTiddlers = function() {
-    var self = this;
-    $tw.utils.each($tw.boot.preloadDirty, function(item){
-        var tiddler = $tw.wiki.getTiddler(item);
-        self.cachedTiddlers.push(tiddler);
-    });
+	var self = this;
+	$tw.utils.each($tw.boot.preloadDirty, function(item){
+		var tiddler = $tw.wiki.getTiddler(item);
+		self.cachedTiddlers.push(tiddler);
+	});
 };
 
 BrowserStorageUtil.prototype.addCachedTiddlers = function() {
-    var self = this;
-    if(this.cachedTiddlers.length > 0) {
-        $tw.utils.each(this.cachedTiddlers, function(item){
-            $tw.wiki.addTiddler(item);
-        });
-        this.cachedTiddlers.length = 0;
-    }
+	if(this.cachedTiddlers.length > 0) {
+		$tw.utils.each(this.cachedTiddlers, function(item){
+			$tw.wiki.addTiddler(item);
+		});
+		this.cachedTiddlers.length = 0;
+	}
 };
 
 BrowserStorageUtil.prototype.removeTiddlerFromLocalStorage = function(title) {
-    console.log("browser-storage: Removing", title);
-    window.localStorage.removeItem(this.options.prefix + title);
+	console.log("browser-storage: Removing", title);
+	window.localStorage.removeItem(this.options.prefix + title);
 };
 
 BrowserStorageUtil.prototype.saveTiddlerToLocalStorage = function(title) {
-    // Get the tiddler
-    var tiddler = $tw.wiki.getTiddler(title);
-    if(tiddler) {
-        if(this.wiki.tiddlerExists(title)) {
-            // This is not a shadow tiddler
-            console.log("browser-storage: Saving",title);
-            // Get the JSON of the tiddler
-            var json = JSON.stringify(tiddler.getFieldStrings());
-            // Try to save it to local storage
-            try {
-                window.localStorage.setItem(this.options.prefix + title,json);
-            } catch(e) {
-                if(e.name === "QuotaExceededError") {
-                    // Complain if we failed
-                    var msg = $tw.wiki.getTiddlerText(this.QUOTA_EXCEEDED_ALERT_TITLE,this.DEFAULT_QUOTA_EXCEEDED_ALERT_PREFIX + title + this.DEFAULT_QUOTA_EXCEEDED_ALERT_SUFFIX);
-                    if(this.options.logger) {
-                        this.options.logger.alert(msg);
-                    }
-                    // No point in keeping old values around for this tiddler
-                    window.localStorage.removeItem(this.options.prefix + title);
-                } else {
-                    console.log("Browser-storage error:",e);
-                }
-            }
-        } else {
-            // Shadow tiddler which is no longer overwritten (or never was)
-            // Ensure it is not in local storage
-            this.removeTiddlerFromLocalStorage(title);
-        }
-    } else {
-        // In local storage, use the special value of empty string to mark the tiddler as deleted
-        // On future page loads, if the tiddler is already gone from startup then the blank entry
-        // will be removed from localstorage. Otherwise, the tiddler will be deleted.
-        console.log("browser-storage: Blanking",title); 
-        try {
-            window.localStorage.setItem(this.options.prefix + title, "");
-        } catch(e) {
-            console.log("Browser-storage error:",e);
-        }
-    }
+	// Get the tiddler
+	var tiddler = $tw.wiki.getTiddler(title);
+	if(tiddler) {
+		if(this.wiki.tiddlerExists(title)) {
+			// This is not a shadow tiddler
+			console.log("browser-storage: Saving",title);
+			// Get the JSON of the tiddler
+			var json = JSON.stringify(tiddler.getFieldStrings());
+			// Try to save it to local storage
+			try {
+				window.localStorage.setItem(this.options.prefix + title,json);
+			} catch(e) {
+				if(e.name === "QuotaExceededError") {
+					// Complain if we failed
+					var msg = $tw.wiki.getTiddlerText(this.QUOTA_EXCEEDED_ALERT_TITLE,this.DEFAULT_QUOTA_EXCEEDED_ALERT_PREFIX + title + this.DEFAULT_QUOTA_EXCEEDED_ALERT_SUFFIX);
+					if(this.options.logger) {
+						this.options.logger.alert(msg);
+					}
+					// No point in keeping old values around for this tiddler
+					window.localStorage.removeItem(this.options.prefix + title);
+				} else {
+					console.log("Browser-storage error:",e);
+				}
+			}
+		} else {
+			// Shadow tiddler which is no longer overwritten (or never was)
+			// Ensure it is not in local storage
+			this.removeTiddlerFromLocalStorage(title);
+		}
+	} else {
+		// In local storage, use the special value of empty string to mark the tiddler as deleted
+		// On future page loads, if the tiddler is already gone from startup then the blank entry
+		// will be removed from localstorage. Otherwise, the tiddler will be deleted.
+		console.log("browser-storage: Blanking",title); 
+		try {
+			window.localStorage.setItem(this.options.prefix + title, "");
+		} catch(e) {
+			console.log("Browser-storage error:",e);
+		}
+	}
 };
 
 BrowserStorageUtil.prototype.clearLocalStorage = function() {
-    var url = window.location.pathname,
-        log = [];
-    // Step through each browser storage item
-    if(window.localStorage) {
-        for(var index=window.localStorage.length - 1; index>=0; index--) {
-            var key = window.localStorage.key(index),
-                parts = key.split("#");
-            // Delete it if it is ours
-            if(parts[0] === "tw5" && parts[1] === url) {
-                window.localStorage.removeItem(key);
-            }
-        }
-    }
+	var url = window.location.pathname;
+	// Step through each browser storage item
+	if(window.localStorage) {
+		for(var index=window.localStorage.length - 1; index>=0; index--) {
+			var key = window.localStorage.key(index),
+				parts = key.split("#");
+			// Delete it if it is ours
+			if(parts[0] === "tw5" && parts[1] === url) {
+				window.localStorage.removeItem(key);
+			}
+		}
+	}
 };
 
 exports.BrowserStorageUtil = BrowserStorageUtil;

package/plugins/tiddlywiki/codemirror/engine.js

@@ -9,9 +9,8 @@ Text editor engine based on a CodeMirror instance
 
 "use strict";
 
-var CODEMIRROR_OPTIONS = "$:/config/CodeMirror",
-HEIGHT_VALUE_TITLE = "$:/config/TextEditor/EditorHeight/Height",
-CONFIG_FILTER = "[all[shadows+tiddlers]prefix[$:/config/codemirror/]]"
+var HEIGHT_VALUE_TITLE = "$:/config/TextEditor/EditorHeight/Height",
+	CONFIG_FILTER = "[all[shadows+tiddlers]prefix[$:/config/codemirror/]]";
 	
 // Install CodeMirror
 if($tw.browser && !window.CodeMirror) {
@@ -42,36 +41,36 @@ function getCmConfig() {
 		config = {},
 		configTiddlers = $tw.wiki.filterTiddlers(CONFIG_FILTER);
 
-	if ($tw.utils.isArray(configTiddlers)) {
-		for (var i=0; i<configTiddlers.length; i++) {
+	if($tw.utils.isArray(configTiddlers)) {
+		for(var i=0; i<configTiddlers.length; i++) {
 			tiddler = $tw.wiki.getTiddler(configTiddlers[i]);
-				if (tiddler) {
+			if(tiddler) {
 				element = configTiddlers[i].replace(/\$:\/config\/codemirror\//ig,"");
-					type = (tiddler.fields.type) ? tiddler.fields.type.trim().toLocaleLowerCase() : "string";
-				switch (type) {
+				type = (tiddler.fields.type) ? tiddler.fields.type.trim().toLocaleLowerCase() : "string";
+				switch(type) {
 					case "bool":
-					test = tiddler.fields.text.trim().toLowerCase();
-					value = (test === "true") ? true : false;
-					config[element] = value;
-					break;
+						test = tiddler.fields.text.trim().toLowerCase();
+						value = (test === "true") ? true : false;
+						config[element] = value;
+						break;
 					case "string":
-					value = tiddler.fields.text.trim();
-					config[element] = value;
-					break;
+						value = tiddler.fields.text.trim();
+						config[element] = value;
+						break;
 					case "integer":
-					value = parseInt(tiddler.fields.text.trim(), 10);
-					config[element] = value;
-					break;
+						value = parseInt(tiddler.fields.text.trim(), 10);
+						config[element] = value;
+						break;
 					case "json":
-					value = JSON.parse(tiddler.fields.text.trim());
+						value = JSON.parse(tiddler.fields.text.trim());
 						extend = (tiddler.fields.extend) ? tiddler.fields.extend : element;
 
-					if (config[extend]) {
-						$tw.utils.extend(config[extend], value);
-					} else {
-						config[extend] = value;
-					}
-					break;
+						if(config[extend]) {
+							$tw.utils.extend(config[extend], value);
+						} else {
+							config[extend] = value;
+						}
+						break;
 				}
 			}
 		}
@@ -122,7 +121,7 @@ function CodeMirrorEngine(options) {
 			self.widget.invokeActionString(self.widget.editInputActions,this,event,{actionValue: this.getText()});
 		}
 	});
-	
+
 	this.cm.on("drop",function(cm,event) {
 		if(!self.widget.isFileDropEnabled) {
 			event.stopPropagation(); // Otherwise TW's dropzone widget sees the drop event
@@ -135,19 +134,19 @@ function CodeMirrorEngine(options) {
 
 			// from https://github.com/codemirror/CodeMirror/blob/master/src/measurement/position_measurement.js#L673
 			function posFromMouse(cm, e, liberal, forRect) {
-				let display = cm.display
-				if (!liberal && e_target(e).getAttribute("cm-not-content") == "true") return null
+				let display = cm.display;
+				if(!liberal && e_target(e).getAttribute("cm-not-content") == "true") return null;
 
-				let x, y, space = display.lineSpace.getBoundingClientRect()
+				let x, y, space = display.lineSpace.getBoundingClientRect();
 				// Fails unpredictably on IE[67] when mouse is dragged around quickly.
-				try { x = e.clientX - space.left; y = e.clientY - space.top }
-				catch (e) { return null }
-				let coords = cm.coordsChar(cm, x, y), line
-				if (forRect && coords.xRel > 0 && (line = cm.getLine(cm.doc, coords.line).text).length == coords.ch) {
-					let colDiff = window.CodeMirror.countColumn(line, line.length, cm.options.tabSize) - line.length
-					coords = window.CodeMirror.Pos(coords.line, Math.max(0, Math.round((x - paddingH(cm.display).left) / charWidth(cm.display)) - colDiff))
+				try { x = e.clientX - space.left; y = e.clientY - space.top; }
+				catch (e) { return null; }
+				let coords = cm.coordsChar(cm, x, y), line;
+				if(forRect && coords.xRel > 0 && (line = cm.getLine(cm.doc, coords.line).text).length == coords.ch) {
+					let colDiff = window.CodeMirror.countColumn(line, line.length, cm.options.tabSize) - line.length;
+					coords = window.CodeMirror.Pos(coords.line, Math.max(0, Math.round((x - paddingH(cm.display).left) / charWidth(cm.display)) - colDiff));
 				}
-				return coords
+				return coords;
 			}
 
 			var pos = posFromMouse(cm,event,true);
@@ -155,7 +154,7 @@ function CodeMirrorEngine(options) {
 				return;
 			}
 			// Don't do a replace if the drop happened inside of the selected text.
-			if (cm.state.draggingText && cm.doc.sel.contains(pos) > -1) {
+			if(cm.state.draggingText && cm.doc.sel.contains(pos) > -1) {
 				cm.state.draggingText(event);
 				// Ensure the editor is re-focused
 				setTimeout(function() {cm.display.input.focus();}, 20); 
@@ -163,14 +162,14 @@ function CodeMirrorEngine(options) {
 			}
 			try {
 				var text = event.dataTransfer.getData("Text");
-				if (text) {
+				if(text) {
 					var selected;
-					if (cm.state.draggingText && !cm.state.draggingText.copy) {
+					if(cm.state.draggingText && !cm.state.draggingText.copy) {
 						selected = cm.listSelections();
 					}
 					cm.setCursor(cm.coordsChar({left:event.pageX,top:event.pageY}));
-					if (selected) {
-						for (var i = 0; i < selected.length; ++i) {
+					if(selected) {
+						for(var i = 0; i < selected.length; ++i) {
 							replaceRange(cm.doc, "", selected[i].anchor, selected[i].head, "drag");
 						}
 					}
@@ -183,7 +182,7 @@ function CodeMirrorEngine(options) {
 		return false;
 	});
 	this.cm.on("keydown",function(cm,event) {
-		if ($tw.keyboardManager.handleKeydownEvent(event, {onlyPriority: true})) {
+		if($tw.keyboardManager.handleKeydownEvent(event, {onlyPriority: true})) {
 			return true;
 		}
 	
@@ -225,7 +224,7 @@ function CodeMirrorEngine(options) {
 			event["twEditor"] = true;
 		});
 	}
-;
+	;
 }
 
 /*
@@ -260,6 +259,8 @@ CodeMirrorEngine.prototype.fixHeight = function() {
 	if(this.widget.editAutoHeight) {
 		// Resize to fit
 		this.cm.setSize(null,null);
+	} else if(this.widget.editRows) {
+		this.cm.setSize(null,this.widget.editRows + "em");
 	} else {
 		var fixedHeight = parseInt(this.widget.wiki.getTiddlerText(HEIGHT_VALUE_TITLE,"400px"),10);
 		fixedHeight = Math.max(fixedHeight,20);
@@ -272,7 +273,7 @@ Focus the engine node
 */
 CodeMirrorEngine.prototype.focus  = function() {
 	this.cm.focus();
-}
+};
 
 /*
 Create a blank structure representing a text operation
@@ -281,7 +282,7 @@ CodeMirrorEngine.prototype.createTextOperation = function() {
 	var selections = this.cm.listSelections();
 	if(selections.length > 0) {
 		var anchorPos = this.cm.indexFromPos(selections[0].anchor),
-		headPos = this.cm.indexFromPos(selections[0].head);
+			headPos = this.cm.indexFromPos(selections[0].head);
 	}
 	var operation = {
 		text: this.cm.getValue(),

package/plugins/tiddlywiki/confetti/confetti-widget.js

@@ -10,8 +10,6 @@ Confetti widget
 
 var Widget = require("$:/core/modules/widgets/widget.js").widget;
 
-var confetti = require("$:/plugins/tiddlywiki/confetti/confetti.js");
-
 var ConfettiWidget = function(parseTreeNode,options) {
 	this.initialise(parseTreeNode,options);
 };

package/plugins/tiddlywiki/dom-to-image/docs.tid

@@ -0,0 +1,66 @@
+title: $:/plugins/tiddlywiki/dom-to-image/docs
+caption: tm-save-dom-to-image message
+
+!! `tm-save-dom-to-image` message
+
+The `tm-save-dom-to-image` message uses a [[third-party library|https://github.com/1904labs/dom-to-image-more]] to save a DOM node as an image. The image can be saved to a file or to a tiddler.
+
+Note that there are some limitations to saving content loaded from external domains due to the same-origin policy. See the documentation for more details.
+
+The following parameters are supported:
+
+|!Parameters |!Description |
+|''selector'' |CSS selector identifying the DOM node to be saved as an image (defaults to `body`). If multiple DOM nodes are returned by the selector then the first one is used |
+|''format'' |Save format: ''png'', ''jpeg'' or ''svg'' (defaults to ''png'') |
+|''quality'' |Optional quality 0 to 1 for JPEG images (note that the default quality is 1, and this default is applied even if the quality is explicitly specified as `0`. To force a low quality JPEG image it is therefore necessary to specify a small non-zero value such as `0.001`) |
+|''scale'' |Optional scale factor for the image (defaults to 1) |
+|''width'' |Optional width of the image in pixels |
+|''height'' |Optional height of the image in pixels |
+|''save-file'' |Optional filename to save the image to |
+|''save-title'' |Optional title of tiddler to save the image to |
+|''oncompletion'' |Optional action string to be invoked when the save operation has completed |
+|''var-*'' |Variables to be passed to the completion handler (without the "var-" prefix) |
+
+!! Examples
+
+<$button>
+<$action-sendmessage
+	$message="tm-save-dom-to-image"
+	selector="body.tc-body"
+	scale="2"
+	save-file="screenshot.png"
+/>
+Save the screen as an image file in PNG format
+</$button>
+
+<$button>
+<$action-sendmessage
+	$message="tm-save-dom-to-image"
+	selector="body.tc-body"
+	scale="2"
+	save-title="$:/temp/screenshot.png"
+/>
+Save the screen as an image tiddler in PNG format
+</$button> [[$:/temp/screenshot.png]]
+
+<$button>
+<$action-sendmessage
+	$message="tm-save-dom-to-image"
+	selector="body.tc-body"
+	format="jpeg"
+	scale="1"
+	quality="0.01"
+	save-title="$:/temp/screenshot.jpeg"
+/>
+Save the screen as an image tiddler in low quality JPEG format
+</$button> [[$:/temp/screenshot.jpeg]]
+
+<$button>
+<$action-sendmessage
+	$message="tm-save-dom-to-image"
+	selector="body.tc-body"
+	format="svg"
+	save-title="$:/temp/screenshot.svg"
+/>
+Save the screen as an image tiddler in SVG format
+</$button> [[$:/temp/screenshot.svg]]