From 734bdd37462eff9d5569de0452385cc338be677b Mon Sep 17 00:00:00 2001
From: Pierre Ossman <ossman@cendio.se>
Date: Fri, 23 Aug 2019 13:58:40 +0200
Subject: [PATCH] Deprecate showDotCursor option for RFB constructor

It is not relevant for the connection stage so it should not have
been a constructor argument to begin with. Ship with a warning for
a release before we remove it.
---
 kasmweb/app/ui.js   | 2 +-
 kasmweb/core/rfb.js | 7 ++++++-
 kasmweb/docs/API.md | 5 -----
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/kasmweb/app/ui.js b/kasmweb/app/ui.js
index 966aa6d..443de1e 100644
--- a/kasmweb/app/ui.js
+++ b/kasmweb/app/ui.js
@@ -1270,7 +1270,6 @@ const UI = {
 
         UI.rfb = new RFB(document.getElementById('noVNC_container'), url,
                          { shared: UI.getSetting('shared'),
-                           showDotCursor: UI.getSetting('show_dot'),
                            repeaterID: UI.getSetting('repeaterID'),
                            credentials: { password: password } });
         UI.rfb.addEventListener("connect", UI.connectFinished);
@@ -1294,6 +1293,7 @@ const UI = {
         UI.rfb.clipViewport = UI.getSetting('view_clip');
         UI.rfb.scaleViewport = UI.getSetting('resize') === 'scale';
         UI.rfb.resizeSession = UI.getSetting('resize') === 'remote';
+        UI.rfb.showDotCursor = UI.getSetting('show_dot');
         UI.rfb.idleDisconnect = UI.getSetting('idle_disconnect');
         UI.rfb.videoQuality = UI.getSetting('video_quality');
         UI.rfb.clipboardUp = UI.getSetting('clipboard_up');
diff --git a/kasmweb/core/rfb.js b/kasmweb/core/rfb.js
index 58e1ac8..9fd5909 100644
--- a/kasmweb/core/rfb.js
+++ b/kasmweb/core/rfb.js
@@ -56,7 +56,6 @@ export default class RFB extends EventTargetMixin {
         this._rfb_credentials = options.credentials || {};
         this._shared = 'shared' in options ? !!options.shared : true;
         this._repeaterID = options.repeaterID || '';
-        this._showDotCursor = options.showDotCursor || false;
         this._wsProtocols = options.wsProtocols || [];
 
         // Internal state
@@ -269,6 +268,12 @@ export default class RFB extends EventTargetMixin {
         this._clipViewport = false;
         this._scaleViewport = false;
         this._resizeSession = false;
+
+        this._showDotCursor = false;
+        if (options.showDotCursor !== undefined) {
+            Log.Warn("Specifying showDotCursor as a RFB constructor argument is deprecated");
+            this._showDotCursor = options.showDotCursor;
+        }
     }
 
     // ===== PROPERTIES =====
diff --git a/kasmweb/docs/API.md b/kasmweb/docs/API.md
index 05c6122..aa6337f 100644
--- a/kasmweb/docs/API.md
+++ b/kasmweb/docs/API.md
@@ -187,11 +187,6 @@ connection to a specified VNC server.
       - A `DOMString` specifying the ID to provide to any VNC repeater
         encountered.
 
-    `showDotCursor`
-      - A `boolean` indicating whether a dot cursor should be shown
-        instead of a zero-sized or fully-transparent cursor if the
-        server sets such invisible cursor. Disabled by default.
-
     `wsProtocols`
       - An `Array` of `DOMString`s specifying the sub-protocols to use
         in the WebSocket connection. Empty by default.