Clipboard which can be activated/used from within the touch menu.
[guacamole.git] / src / main / webapp / scripts / interface.js
index 88bfff5..e12f4df 100644 (file)
@@ -2,6 +2,30 @@
 // UI Definition
 var GuacamoleUI = {
 
+    "LOGOUT_PROMPT" :   "Logging out will disconnect all of your active "
+                      + "Guacamole sessions. Are you sure you wish to log out?",
+
+    /* Detection Constants */
+    
+    "LONG_PRESS_DETECT_TIMEOUT"     : 800, /* milliseconds */
+    "LONG_PRESS_MOVEMENT_THRESHOLD" : 10,  /* pixels */
+    "MENU_CLOSE_DETECT_TIMEOUT"     : 500, /* milliseconds */
+    "MENU_OPEN_DETECT_TIMEOUT"      : 325, /* milliseconds */
+    "KEYBOARD_AUTO_RESIZE_INTERVAL" : 30,  /* milliseconds */
+
+    /* Animation Constants */
+
+    "MENU_SHADE_STEPS"    : 10, /* frames */
+    "MENU_SHADE_INTERVAL" : 30, /* milliseconds */
+    "MENU_SHOW_STEPS"     : 5,  /* frames */
+    "MENU_SHOW_INTERVAL"  : 30, /* milliseconds */
+
+    /* OSK Mode Constants */
+    "OSK_MODE_NATIVE" : 1, /* "Show Keyboard" will show the platform's native OSK */
+    "OSK_MODE_GUAC"   : 2, /* "Show Keyboard" will show Guac's built-in OSK */
+
+    /* UI Elements */
+
     "viewport"    : document.getElementById("viewportClone"),
     "display"     : document.getElementById("display"),
     "menu"        : document.getElementById("menu"),
@@ -16,18 +40,24 @@ var GuacamoleUI = {
         "showKeyboard" : document.getElementById("showKeyboard"),
         "ctrlAltDelete": document.getElementById("ctrlAltDelete"),
         "reconnect"    : document.getElementById("reconnect"),
-        "logout"       : document.getElementById("logout")
+        "logout"       : document.getElementById("logout"),
+
+        "touchShowClipboard" : document.getElementById("touchShowClipboard"),
+        "touchShowKeyboard"  : document.getElementById("touchShowKeyboard"),
+        "touchLogout"        : document.getElementById("touchLogout")
 
     },
 
     "containers": {
-        "state"    : document.getElementById("statusDialog"),
-        "clipboard": document.getElementById("clipboardDiv"),
-        "keyboard" : document.getElementById("keyboardContainer")
+        "state"         : document.getElementById("statusDialog"),
+        "clipboard"     : document.getElementById("clipboardDiv"),
+        "touchClipboard": document.getElementById("touchClipboardDiv"),
+        "keyboard"      : document.getElementById("keyboardContainer")
     },
     
-    "state"     : document.getElementById("statusText"),
-    "clipboard" : document.getElementById("clipboard")
+    "state"          : document.getElementById("statusText"),
+    "clipboard"      : document.getElementById("clipboard"),
+    "touchClipboard" : document.getElementById("touchClipboard")
 
 };
 
@@ -112,11 +142,41 @@ var GuacamoleUI = {
         GuacamoleUI.display.style.opacity = "0.1";
     };
 
+    GuacamoleUI.hideTouchMenu = function() {
+        GuacamoleUI.touchMenu.style.visibility = "hidden";
+    };
+
+    function positionCentered(element) {
+        element.style.left =
+            ((GuacamoleUI.viewport.offsetWidth - element.offsetWidth) / 2
+            + window.pageXOffset)
+            + "px";
+
+        element.style.top =
+            ((GuacamoleUI.viewport.offsetHeight - element.offsetHeight) / 2
+            + window.pageYOffset)
+            + "px";
+    }
+
+    GuacamoleUI.showTouchMenu = function() {
+        positionCentered(GuacamoleUI.touchMenu);
+        GuacamoleUI.touchMenu.style.visibility = "visible";
+    };
+
+    GuacamoleUI.hideTouchClipboard = function() {
+        GuacamoleUI.containers.touchClipboard.style.visibility = "hidden";
+    };
+
+    GuacamoleUI.showTouchClipboard = function() {
+        positionCentered(GuacamoleUI.containers.touchClipboard);
+        GuacamoleUI.containers.touchClipboard.style.visibility = "visible";
+    };
+
     GuacamoleUI.shadeMenu = function() {
 
         if (!menu_shaded) {
 
-            var step = Math.floor(GuacamoleUI.menu.offsetHeight / 10) + 1;
+            var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHADE_STEPS) + 1;
             var offset = 0;
             menu_shaded = true;
 
@@ -124,14 +184,21 @@ var GuacamoleUI = {
             shade_interval = window.setInterval(function() {
 
                 offset -= step;
-                GuacamoleUI.menu.style.top = offset + "px";
+
+                GuacamoleUI.menu.style.transform =
+                GuacamoleUI.menu.style.WebkitTransform =
+                GuacamoleUI.menu.style.MozTransform =
+                GuacamoleUI.menu.style.OTransform =
+                GuacamoleUI.menu.style.msTransform =
+
+                    "translateY(" + offset + "px)";
 
                 if (offset <= -GuacamoleUI.menu.offsetHeight) {
                     window.clearInterval(shade_interval);
                     GuacamoleUI.menu.style.visiblity = "hidden";
                 }
 
-            }, 30);
+            }, GuacamoleUI.MENU_SHADE_INTERVAL);
         }
 
     };
@@ -140,7 +207,7 @@ var GuacamoleUI = {
 
         if (menu_shaded) {
 
-            var step = Math.floor(GuacamoleUI.menu.offsetHeight / 5) + 1;
+            var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHOW_STEPS) + 1;
             var offset = -GuacamoleUI.menu.offsetHeight;
             menu_shaded = false;
             GuacamoleUI.menu.style.visiblity = "";
@@ -155,9 +222,15 @@ var GuacamoleUI = {
                     window.clearInterval(show_interval);
                 }
 
-                GuacamoleUI.menu.style.top = offset + "px";
+                GuacamoleUI.menu.style.transform =
+                GuacamoleUI.menu.style.WebkitTransform =
+                GuacamoleUI.menu.style.MozTransform =
+                GuacamoleUI.menu.style.OTransform =
+                GuacamoleUI.menu.style.msTransform =
 
-            }, 30);
+                    "translateY(" + offset + "px)";
+
+            }, GuacamoleUI.MENU_SHOW_INTERVAL);
         }
 
     };
@@ -178,20 +251,10 @@ var GuacamoleUI = {
 
     };
 
-    /**
-     * When GuacamoleUI.oskMode == OSK_MODE_NATIVE, "Show Keyboard" tries
-     * to use the native OSK instead of the Guacamole OSK.
-     */
-    GuacamoleUI.OSK_MODE_NATIVE = 1;
-
-    /**
-     * When GuacamoleUI.oskMode == OSK_MODE_GUAC, "Show Keyboard" uses the 
-     * Guacamole OSK, regardless of whether a native OSK is available.
-     */
-    GuacamoleUI.OSK_MODE_GUAC   = 2;
-
-    // Assume no native OSK by default
-    GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
+    GuacamoleUI.buttons.touchShowClipboard.onclick = function() {
+        GuacamoleUI.hideTouchMenu();
+        GuacamoleUI.showTouchClipboard();
+    };
 
     // Show/Hide keyboard
     var keyboardResizeInterval = null;
@@ -206,22 +269,9 @@ var GuacamoleUI = {
             window.onresize = null;
             window.clearInterval(keyboardResizeInterval);
         }
-        
-        // If not shown ... action depends on OSK mode.
-        else {
-
-            // If we think the platform has a native OSK, use the event target to
-            // cause it to display.
-            if (GuacamoleUI.oskMode == GuacamoleUI.OSK_MODE_NATIVE) {
-
-                // ...but use the Guac OSK if clicked again
-                GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
 
-                // Try to show native OSK by focusing eventTarget.
-                GuacamoleUI.eventTarget.focus();
-                return;
-
-            }
+        // Otherwise, show it
+        else {
 
             // Ensure event target is NOT focused if we are using the Guac OSK.
             GuacamoleUI.eventTarget.blur();
@@ -231,18 +281,44 @@ var GuacamoleUI = {
 
             // Automatically update size
             window.onresize = updateKeyboardSize;
-            keyboardResizeInterval = window.setInterval(updateKeyboardSize, 30);
+            keyboardResizeInterval = window.setInterval(updateKeyboardSize,
+                GuacamoleUI.KEYBOARD_AUTO_RESIZE_INTERVAL);
 
             updateKeyboardSize();
+
         }
-        
 
     };
 
+    // Touch-specific keyboard show
+    GuacamoleUI.buttons.touchShowKeyboard.onclick = 
+        function(e) {
+
+            // Center event target in case browser automatically centers
+            // input fields on focus.
+            GuacamoleUI.eventTarget.style.left =
+                (window.pageXOffset + GuacamoleUI.viewport.offsetWidth / 2) + "px";
+
+            GuacamoleUI.eventTarget.style.top =
+                (window.pageYOffset + GuacamoleUI.viewport.offsetHeight / 2) + "px";
+
+            GuacamoleUI.eventTarget.focus();
+            GuacamoleUI.hideTouchMenu();
+
+        };
+
     // Logout
-    GuacamoleUI.buttons.logout.onclick = function() {
-        window.location.href = "logout";
-    };
+    GuacamoleUI.buttons.logout.onclick =
+    GuacamoleUI.buttons.touchLogout.onclick =
+        function() {
+
+            // Logout after warning user about session disconnect
+            if (confirm(GuacamoleUI.LOGOUT_PROMPT)) {
+                window.location.href = "logout";
+                GuacamoleUI.hideTouchMenu();
+            }
+            
+        };
 
     // Timeouts for detecting if users wants menu to open or close
     var detectMenuOpenTimeout = null;
@@ -280,7 +356,7 @@ var GuacamoleUI = {
 
                 GuacamoleUI.showMenu();
                 detectMenuOpenTimeout = null;
-            }, 325);
+            }, GuacamoleUI.MENU_OPEN_DETECT_TIMEOUT);
 
         }
 
@@ -299,7 +375,7 @@ var GuacamoleUI = {
             detectMenuCloseTimeout = window.setTimeout(function() {
                 GuacamoleUI.shadeMenu();
                 detectMenuCloseTimeout = null;
-            }, 500);
+            }, GuacamoleUI.MENU_CLOSE_DETECT_TIMEOUT);
 
         }
 
@@ -328,9 +404,9 @@ var GuacamoleUI = {
 
                 // Assume native OSK if menu shown via long-press
                 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_NATIVE;
-                GuacamoleUI.showMenu();
+                GuacamoleUI.showTouchMenu();
 
-            }, 800);
+            }, GuacamoleUI.LONG_PRESS_DETECT_TIMEOUT);
 
         }
     };
@@ -340,24 +416,19 @@ var GuacamoleUI = {
         menuShowLongPressTimeout = null;
     };
 
-    // Reset event target (add content, reposition cursor in middle.
-    GuacamoleUI.resetEventTarget = function() {
-        GuacamoleUI.eventTarget.value = "GUAC";
-        GuacamoleUI.eventTarget.selectionStart =
-        GuacamoleUI.eventTarget.selectionEnd   = 2;
-    };
-
     // Detect long-press at bottom of screen
     GuacamoleUI.display.addEventListener('touchstart', function(e) {
         
         // Close menu if shown
         GuacamoleUI.shadeMenu();
+        GuacamoleUI.hideTouchMenu();
+        GuacamoleUI.hideTouchClipboard();
         
         // Record touch location
         if (e.touches.length == 1) {
             var touch = e.touches[0];
-            long_press_start_x = touch.pageX;
-            long_press_start_y = touch.pageY;
+            long_press_start_x = touch.screenX;
+            long_press_start_y = touch.screenY;
         }
         
         // Start detection
@@ -368,15 +439,11 @@ var GuacamoleUI = {
     // Stop detection if touch moves significantly
     GuacamoleUI.display.addEventListener('touchmove', function(e) {
         
-        if (e.touches.length == 1) {
-
-            // If touch distance from start exceeds threshold, cancel long press
-            var touch = e.touches[0];
-            if (Math.abs(touch.pageX - long_press_start_x) >= 10
-                || Math.abs(touch.pageY - long_press_start_y) >= 10)
-                GuacamoleUI.stopLongPressDetect();
-
-        }
+        // If touch distance from start exceeds threshold, cancel long press
+        var touch = e.touches[0];
+        if (Math.abs(touch.screenX - long_press_start_x) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD
+            || Math.abs(touch.screenY - long_press_start_y) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD)
+            GuacamoleUI.stopLongPressDetect();
         
     }, true);
 
@@ -406,13 +473,23 @@ var GuacamoleUI = {
         }
     };
 
+    // Turn off autocorrect and autocapitalization on eventTarget
+    GuacamoleUI.eventTarget.setAttribute("autocorrect", "off");
+    GuacamoleUI.eventTarget.setAttribute("autocapitalize", "off");
+
+    // Automatically reposition event target on scroll
+    window.addEventListener("scroll", function() {
+        GuacamoleUI.eventTarget.style.left = window.pageXOffset + "px";
+        GuacamoleUI.eventTarget.style.top = window.pageYOffset + "px";
+    });
+
 })();
 
 // Tie UI events / behavior to a specific Guacamole client
 GuacamoleUI.attach = function(guac) {
 
     var title_prefix = null;
-    var connection_name = null 
+    var connection_name = "Guacamole"; 
     
     var guac_display = guac.getDisplay();
 
@@ -486,27 +563,84 @@ GuacamoleUI.attach = function(guac) {
     // Keyboard
     var keyboard = new Guacamole.Keyboard(document);
 
+    // Monitor whether the event target is focused
+    var eventTargetFocused = false;
+
+    // Save length for calculation of changed value
+    var currentLength = GuacamoleUI.eventTarget.value.length;
+
+    GuacamoleUI.eventTarget.onfocus = function() {
+        eventTargetFocused = true;
+        GuacamoleUI.eventTarget.value = "";
+        currentLength = 0;
+    };
+
+    GuacamoleUI.eventTarget.onblur = function() {
+        eventTargetFocused = false;
+    };
+
+    // If text is input directly into event target without typing (as with
+    // voice input, for example), type automatically.
+    GuacamoleUI.eventTarget.oninput = function(e) {
+
+        // Calculate current length and change in length
+        var oldLength = currentLength;
+        currentLength = GuacamoleUI.eventTarget.value.length;
+        
+        // If deleted or replaced text, ignore
+        if (currentLength <= oldLength)
+            return;
+
+        // Get changed text
+        var text = GuacamoleUI.eventTarget.value.substring(oldLength);
+
+        // Send each character
+        for (var i=0; i<text.length; i++) {
+
+            // Get char code
+            var charCode = text.charCodeAt(i);
+
+            // Convert to keysym
+            var keysym = 0x003F; // Default to a question mark
+            if (charCode >= 0x0000 && charCode <= 0x00FF)
+                keysym = charCode;
+            else if (charCode >= 0x0100 && charCode <= 0x10FFFF)
+                keysym = 0x01000000 | charCode;
+
+            // Send keysym only if not already pressed
+            if (!keyboard.pressed[keysym]) {
+
+                // Press and release key
+                guac.sendKeyEvent(1, keysym);
+                guac.sendKeyEvent(0, keysym);
+
+            }
+
+        }
+
+    }
+
+    function isTypableCharacter(keysym) {
+        return (keysym & 0xFFFF00) != 0xFF00;
+    }
+
     function disableKeyboard() {
         keyboard.onkeydown = null;
         keyboard.onkeyup = null;
     }
 
     function enableKeyboard() {
-        keyboard.onkeydown = 
-            function (keysym) {
-          
-                // If we're using native OSK, ensure event target is reset
-                // on each key event.
-                if (GuacamoleUI.oskMode == GuacamoleUI.OSK_MODE_NATIVE)
-                    GuacamoleUI.resetEventTarget();
-                
-                guac.sendKeyEvent(1, keysym);
-            };
 
-        keyboard.onkeyup = 
-            function (keysym) {
-                guac.sendKeyEvent(0, keysym);
-            };
+        keyboard.onkeydown = function (keysym) {
+            guac.sendKeyEvent(1, keysym);
+            return eventTargetFocused && isTypableCharacter(keysym);
+        };
+
+        keyboard.onkeyup = function (keysym) {
+            guac.sendKeyEvent(0, keysym);
+            return eventTargetFocused && isTypableCharacter(keysym);
+        };
+
     }
 
     // Enable keyboard by default
@@ -538,13 +672,7 @@ GuacamoleUI.attach = function(guac) {
 
             // Connected
             case 3:
-                
                 GuacamoleUI.hideStatus();
-                GuacamoleUI.display.className =
-                    GuacamoleUI.display.className.replace(/guac-loading/, '');
-
-                GuacamoleUI.menu.className = "connected";
-
                 title_prefix = null;
                 break;
 
@@ -595,23 +723,35 @@ GuacamoleUI.attach = function(guac) {
     GuacamoleUI.clipboard.onchange = function() {
 
         var text = GuacamoleUI.clipboard.value;
+        GuacamoleUI.touchClipboard.value = text;
+        guac.setClipboard(text);
+
+    };
+
+    GuacamoleUI.touchClipboard.onchange = function() {
+
+        var text = GuacamoleUI.touchClipboard.value;
+        GuacamoleUI.clipboard.value = text;
         guac.setClipboard(text);
 
     };
 
     // Ignore keypresses when clipboard is focused
-    GuacamoleUI.clipboard.onfocus = function() {
+    GuacamoleUI.clipboard.onfocus =
+    GuacamoleUI.touchClipboard.onfocus = function() {
         disableKeyboard();
     };
 
     // Capture keypresses when clipboard is not focused
-    GuacamoleUI.clipboard.onblur = function() {
+    GuacamoleUI.clipboard.onblur =
+    GuacamoleUI.touchClipboard.onblur = function() {
         enableKeyboard();
     };
 
     // Server copy handler
     guac.onclipboard = function(data) {
         GuacamoleUI.clipboard.value = data;
+        GuacamoleUI.touchClipboard.value = data;
     };
 
     GuacamoleUI.keyboard.onkeydown = function(keysym) {
@@ -637,4 +777,4 @@ GuacamoleUI.attach = function(guac) {
         guac.sendKeyEvent(0, KEYSYM_CTRL);
     };
 
-};
\ No newline at end of file
+};