Extend permalink/permaview to optionally copy URL to the clipboard

Fixes #3255

core/language/en-GB/ControlPanel.multids

@@ -126,6 +126,10 @@ Settings/NavigationHistory/Caption: Navigation History
 Settings/NavigationHistory/Hint: Update browser history when navigating to a tiddler:
 Settings/NavigationHistory/No/Description: Do not update history
 Settings/NavigationHistory/Yes/Description: Update history
+Settings/NavigationPermalinkviewMode/Caption: Permalink/permaview Mode
+Settings/NavigationPermalinkviewMode/Hint: Choose how permalink/permaview is handled:
+Settings/NavigationPermalinkviewMode/CopyToClipboard/Description: Copy permalink/permaview URL to clipboard
+Settings/NavigationPermalinkviewMode/UpdateAddressBar/Description: Update address bar with permalink/permaview URL
 Settings/PerformanceInstrumentation/Caption: Performance Instrumentation
 Settings/PerformanceInstrumentation/Hint: Displays performance statistics in the browser developer console. Requires reload to take effect
 Settings/PerformanceInstrumentation/Description: Enable performance instrumentation

core/modules/startup/story.js

@@ -27,6 +27,9 @@ var DEFAULT_TIDDLERS_TITLE = "$:/DefaultTiddlers";
 // Config
 var CONFIG_UPDATE_ADDRESS_BAR = "$:/config/Navigation/UpdateAddressBar"; // Can be "no", "permalink", "permaview"
 var CONFIG_UPDATE_HISTORY = "$:/config/Navigation/UpdateHistory"; // Can be "yes" or "no"
+var CONFIG_PERMALINKVIEW_COPY_TO_CLIPBOARD = "$:/config/Navigation/Permalinkview/CopyToClipboard"; // Can be "yes" (default) or "no"
+var CONFIG_PERMALINKVIEW_UPDATE_ADDRESS_BAR = "$:/config/Navigation/Permalinkview/UpdateAddressBar"; // Can be "yes" (default) or "no"
+
 
 exports.startup = function() {
 	// Open startup tiddlers
@@ -72,17 +75,19 @@ exports.startup = function() {
 		// Listen for the tm-permalink message
 		$tw.rootWidget.addEventListener("tm-permalink",function(event) {
 			updateLocationHash({
-				updateAddressBar: "permalink",
+				updateAddressBar: $tw.wiki.getTiddlerText(CONFIG_PERMALINKVIEW_UPDATE_ADDRESS_BAR,"yes").trim() === "yes" ? "permalink" : "none",
 				updateHistory: $tw.wiki.getTiddlerText(CONFIG_UPDATE_HISTORY,"no").trim(),
-				targetTiddler: event.param || event.tiddlerTitle
+				targetTiddler: event.param || event.tiddlerTitle,
+				copyToClipboard: $tw.wiki.getTiddlerText(CONFIG_PERMALINKVIEW_COPY_TO_CLIPBOARD,"yes").trim() === "yes" ? "permalink" : "none"
 			});
 		});
 		// Listen for the tm-permaview message
 		$tw.rootWidget.addEventListener("tm-permaview",function(event) {
 			updateLocationHash({
-				updateAddressBar: "permaview",
+				updateAddressBar: $tw.wiki.getTiddlerText(CONFIG_PERMALINKVIEW_UPDATE_ADDRESS_BAR,"yes").trim() === "yes" ? "permaview" : "none",
 				updateHistory: $tw.wiki.getTiddlerText(CONFIG_UPDATE_HISTORY,"no").trim(),
-				targetTiddler: event.param || event.tiddlerTitle
+				targetTiddler: event.param || event.tiddlerTitle,
+				copyToClipboard: $tw.wiki.getTiddlerText(CONFIG_PERMALINKVIEW_COPY_TO_CLIPBOARD,"yes").trim() === "yes" ? "permaview" : "none"
 			});				
 		});
 	}
@@ -146,41 +151,52 @@ function openStartupTiddlers(options) {
 options: See below
 options.updateAddressBar: "permalink", "permaview" or "no" (defaults to "permaview")
 options.updateHistory: "yes" or "no" (defaults to "no")
+options.copyToClipboard: "permalink", "permaview" or "no" (defaults to "no")
 options.targetTiddler: optional title of target tiddler for permalink
 */
 function updateLocationHash(options) {
-	if(options.updateAddressBar !== "no") {
+	// Get the story and the history stack
-		// Get the story and the history stack
+	var storyList = $tw.wiki.getTiddlerList(DEFAULT_STORY_TITLE),
-		var storyList = $tw.wiki.getTiddlerList(DEFAULT_STORY_TITLE),
+		historyList = $tw.wiki.getTiddlerData(DEFAULT_HISTORY_TITLE,[]),
-			historyList = $tw.wiki.getTiddlerData(DEFAULT_HISTORY_TITLE,[]),
+		targetTiddler = "";
+	if(options.targetTiddler) {
+		targetTiddler = options.targetTiddler;
+	} else {
+		// The target tiddler is the one at the top of the stack
+		if(historyList.length > 0) {
+			targetTiddler = historyList[historyList.length-1].title;
+		}
+		// Blank the target tiddler if it isn't present in the story
+		if(storyList.indexOf(targetTiddler) === -1) {
 			targetTiddler = "";
-		if(options.targetTiddler) {
-			targetTiddler = options.targetTiddler;
-		} else {
-			// The target tiddler is the one at the top of the stack
-			if(historyList.length > 0) {
-				targetTiddler = historyList[historyList.length-1].title;
-			}
-			// Blank the target tiddler if it isn't present in the story
-			if(storyList.indexOf(targetTiddler) === -1) {
-				targetTiddler = "";
-			}
 		}
-		// Assemble the location hash
+	}
-		if(options.updateAddressBar === "permalink") {
+	// Assemble the location hash
+	switch(options.updateAddressBar) {
+		case "permalink":
 			$tw.locationHash = "#" + encodeURIComponent(targetTiddler);
-		} else {
+			break;
+		case "permaview":
 			$tw.locationHash = "#" + encodeURIComponent(targetTiddler) + ":" + encodeURIComponent($tw.utils.stringifyList(storyList));
-		}
+			break;
-		// Only change the location hash if we must, thus avoiding unnecessary onhashchange events
+	}
-		if($tw.utils.getLocationHash() !== $tw.locationHash) {
+	// Copy URL to the clipboard
-			if(options.updateHistory === "yes") {
+	switch(options.copyToClipboard) {
-				// Assign the location hash so that history is updated
+		case "permalink":
-				window.location.hash = $tw.locationHash;
+			$tw.utils.copyToClipboard($tw.utils.getLocationPath() + "#" + encodeURIComponent(targetTiddler));
-			} else {
+			break;
-				// We use replace so that browser history isn't affected
+		case "permaview":
-				window.location.replace(window.location.toString().split("#")[0] + $tw.locationHash);
+			$tw.utils.copyToClipboard($tw.utils.getLocationPath() + "#" + encodeURIComponent(targetTiddler) + ":" + encodeURIComponent($tw.utils.stringifyList(storyList)));
-			}
+			break;
+	}
+	// Only change the location hash if we must, thus avoiding unnecessary onhashchange events
+	if($tw.utils.getLocationHash() !== $tw.locationHash) {
+		if(options.updateHistory === "yes") {
+			// Assign the location hash so that history is updated
+			window.location.hash = $tw.locationHash;
+		} else {
+			// We use replace so that browser history isn't affected
+			window.location.replace(window.location.toString().split("#")[0] + $tw.locationHash);
 		}
 	}
 }

core/modules/utils/dom/dom.js

@@ -263,4 +263,9 @@ exports.copyToClipboard = function(text,options) {
 	document.body.removeChild(textArea);
 };
 
+exports.getLocationPath = function() {
+	return window.location.toString().split("#")[0];
+};
+
+
 })();

core/ui/ControlPanel/Settings/NavigationPermalinkviewMode.tid

@@ -0,0 +1,10 @@
+title: $:/core/ui/ControlPanel/Settings/NavigationPermalinkviewMode
+tags: $:/tags/ControlPanel/Settings
+caption: {{$:/language/ControlPanel/Settings/NavigationPermalinkviewMode/Caption}}
+
+\define lingo-base() $:/language/ControlPanel/Settings/NavigationPermalinkviewMode/
+<<lingo Hint>>
+
+<$checkbox tiddler="$:/config/Navigation/Permalinkview/CopyToClipboard" field="text" checked="yes" unchecked="no" default="yes"> <$link to="$:/config/Navigation/Permalinkview/CopyToClipboard"><<lingo CopyToClipboard/Description>></$link> </$checkbox>
+
+<$checkbox tiddler="$:/config/Navigation/Permalinkview/UpdateAddressBar" field="text" checked="yes" unchecked="no" default="yes"> <$link to="$:/config/Navigation/Permalinkview/UpdateAddressBar"><<lingo UpdateAddressBar/Description>></$link> </$checkbox>