From 4382de1604c2121985ea99bfdc789407bf7735f9 Mon Sep 17 00:00:00 2001
From: Matthew Petroff <matthew@mpetroff.net>
Date: Thu, 22 Oct 2020 10:29:31 -0400
Subject: [PATCH] Make opening of links in new tabs configurable.

Default to not doing so except for in standalone viewer.
---
 doc/json-config-parameters.md |  8 ++++++++
 src/js/pannellum.js           | 33 +++++++++++++++++++++++++--------
 src/standalone/standalone.js  |  1 +
 utils/build/build.py          |  2 +-
 4 files changed, 35 insertions(+), 9 deletions(-)

diff --git a/doc/json-config-parameters.md b/doc/json-config-parameters.md
index b4d3ab9..05bf3b7 100644
--- a/doc/json-config-parameters.md
+++ b/doc/json-config-parameters.md
@@ -234,6 +234,14 @@ the configuration is provided via the URL; it defaults to `false` but can be
 set to `true` when using the API.
 
 
+### `targetBlank` (boolean)
+
+When `true`, `target="_blank"` is set on most hyperlinks to open them in new
+tabs. This is always `true` when using the standalone viewer since said viewer
+is often used in an `<iframe>`, where it doesn't make sense to open the link in
+the same place. Defaults to `false`.
+
+
 ### `crossOrigin` (string)
 
 This specifies the type of CORS request used and can be set to either
diff --git a/src/js/pannellum.js b/src/js/pannellum.js
index 4d9b02c..97f8282 100644
--- a/src/js/pannellum.js
+++ b/src/js/pannellum.js
@@ -110,6 +110,7 @@ var defaultConfig = {
     draggable: true,
     disableKeyboardCtrl: false,
     crossOrigin: 'anonymous',
+    targetBlank: false,
     touchPanSpeedCoeffFactor: 1,
     capturedKeyNumbers: [16, 17, 27, 37, 38, 39, 40, 61, 65, 68, 83, 87, 107, 109, 173, 187, 189],
     friction: 0.15
@@ -160,7 +161,13 @@ uiContainer.appendChild(dragFix);
 // Display about information on right click
 var aboutMsg = document.createElement('span');
 aboutMsg.className = 'pnlm-about-msg';
-aboutMsg.innerHTML = '<a href="https://pannellum.org/" target="_blank" rel="noopener">Pannellum</a>';
+var aboutMsgLink = document.createElement('a');
+aboutMsgLink.href = 'https://pannellum.org/';
+aboutMsgLink.textContent = 'Pannellum';
+aboutMsg.appendChild(aboutMsgLink);
+var aboutMsgVersion = document.createElement('span');
+// VERSION PLACEHOLDER FOR BUILD
+aboutMsg.appendChild(aboutMsgVersion);
 uiContainer.appendChild(aboutMsg);
 dragFix.addEventListener('contextmenu', aboutMessage);
 
@@ -1789,8 +1796,10 @@ function createHotSpot(hs) {
             imgp = config.basePath + imgp;
         a = document.createElement('a');
         a.href = sanitizeURL(hs.URL ? hs.URL : imgp, true);
-        a.target = '_blank';
-        a.rel = 'noopener';
+        if (config.targetBlank) {
+            a.target = '_blank';
+            a.rel = 'noopener';
+        }
         span.appendChild(a);
         var image = document.createElement('img');
         image.src = sanitizeURL(imgp);
@@ -1806,7 +1815,7 @@ function createHotSpot(hs) {
             for (var key in hs.attributes) {
                 a.setAttribute(key, hs.attributes[key]);
             }
-        } else {
+        } else if (config.targetBlank) {
             a.target = '_blank';
             a.rel = 'noopener';
         }
@@ -2109,6 +2118,10 @@ function processOptions(isPreview) {
         infoDisplay.author.innerHTML = '';
     if (!config.hasOwnProperty('title') && !config.hasOwnProperty('author'))
         infoDisplay.container.style.display = 'none';
+    if (config.targetBlank) {
+        aboutMsgLink.rel = 'noopener';
+        aboutMsgLink.target = '_blank';
+    }
 
     // Fill in load button label and loading box text
     controls.load.innerHTML = '<div><p>' + config.strings.loadButtonLabel + '</p></div>';
@@ -2128,8 +2141,10 @@ function processOptions(isPreview) {
                 if (config.authorURL) {
                     var authorLink = document.createElement('a');
                     authorLink.href = sanitizeURL(config['authorURL'], true);
-                    authorLink.target = '_blank';
-                    authorLink.rel = 'noopener';
+                    if (config.targetBlank) {
+                        authorLink.target = '_blank';
+                        authorLink.rel = 'noopener';
+                    }
                     authorLink.innerHTML = escapeHTML(config[key]);
                     authorText = authorLink.outerHTML;
                 }
@@ -2140,8 +2155,10 @@ function processOptions(isPreview) {
             case 'fallback':
                 var link = document.createElement('a');
                 link.href = sanitizeURL(config[key], true);
-                link.target = '_blank';
-                link.rel = 'noopener';
+                if (config.targetBlank) {
+                    link.target = '_blank';
+                    link.rel = 'noopener';
+                }
                 link.textContent = 'Click here to view this panorama in an alternative viewer.';
                 var message = document.createElement('p');
                 message.textContent = 'Your browser does not support WebGL.';
diff --git a/src/standalone/standalone.js b/src/standalone/standalone.js
index 9188b4c..5187259 100644
--- a/src/standalone/standalone.js
+++ b/src/standalone/standalone.js
@@ -96,6 +96,7 @@ function parseURLParameters() {
 
     // Create viewer
     configFromURL.escapeHTML = true;
+    configFromURL.targetBlank = true;
     viewer = pannellum.viewer('container', configFromURL);
 }
 
diff --git a/utils/build/build.py b/utils/build/build.py
index 8012a90..2a6bb41 100755
--- a/utils/build/build.py
+++ b/utils/build/build.py
@@ -104,7 +104,7 @@ def build(files, css, html, filename, release=False):
         else:
             print('No .git folder detected, setting version to testing')
             version = "testing"
-    js = js.replace('"_blank">Pannellum</a>','"_blank">Pannellum</a> ' + version)
+    js = js.replace('// VERSION PLACEHOLDER FOR BUILD', 'aboutMsgVersion.textContent = " ' + version + '";')
     with open('../../src/standalone/standalone.js', 'r') as f:
         standalone_js = f.read()
     standalone_js = JScompress(js + standalone_js)