Include status in title.
[guacamole.git] / src / main / webapp / scripts / interface.js
index e18f524..960c8d3 100644 (file)
@@ -2,11 +2,13 @@
 // UI Definition
 var GuacamoleUI = {
 
+    "viewport"    : document.getElementById("viewportClone"),
     "display"     : document.getElementById("display"),
     "menu"        : document.getElementById("menu"),
     "menuControl" : document.getElementById("menuControl"),
+    "touchMenu"   : document.getElementById("touchMenu"),
     "logo"        : document.getElementById("status-logo"),
-    "state"       : document.getElementById("state"),
+    "eventTarget" : document.getElementById("eventTarget"),
 
     "buttons": {
 
@@ -19,12 +21,12 @@ var GuacamoleUI = {
     },
 
     "containers": {
-        "error"    : document.getElementById("errorDialog"),
+        "state"    : document.getElementById("statusDialog"),
         "clipboard": document.getElementById("clipboardDiv"),
         "keyboard" : document.getElementById("keyboardContainer")
     },
     
-    "error"     : document.getElementById("errorText"),
+    "state"     : document.getElementById("statusText"),
     "clipboard" : document.getElementById("clipboard")
 
 };
@@ -41,15 +43,73 @@ var GuacamoleUI = {
     var guacErrorImage = new Image();
     guacErrorImage.src = "images/noguacamole-logo-24.png";
 
-    GuacamoleUI.showError = function(error) {
+    // Function for adding a class to an element
+    var addClass;
+
+    // Function for removing a class from an element
+    var removeClass;
+
+    // If Node.classList is supported, implement addClass/removeClass using that
+    if (Node.classList) {
+
+        addClass = function(element, classname) {
+            element.classList.add(classname);
+        };
+        
+        removeClass = function(element, classname) {
+            element.classList.remove(classname);
+        };
+        
+    }
+
+    // Otherwise, implement own
+    else {
+
+        addClass = function(element, classname) {
+
+            // Simply add new class
+            element.className += " " + classname;
 
-        GuacamoleUI.menu.className = "error";
-        GuacamoleUI.display.className += " guac-error";
+        };
+        
+        removeClass = function(element, classname) {
 
-        GuacamoleUI.logo.src = guacErrorImage.src;
-        GuacamoleUI.error.textContent = error;
-        GuacamoleUI.containers.error.style.visibility = "visible";
+            // Filter out classes with given name
+            element.className = element.className.replace(/([^ ]+)[ ]*/g,
+                function(match, testClassname, spaces, offset, string) {
 
+                    // If same class, remove
+                    if (testClassname == classname)
+                        return "";
+
+                    // Otherwise, allow
+                    return match;
+                    
+                }
+            );
+
+        };
+        
+    }
+
+
+    GuacamoleUI.hideStatus = function() {
+        removeClass(document.body, "guac-error");
+        GuacamoleUI.containers.state.style.visibility = "hidden";
+        GuacamoleUI.display.style.opacity = "1";
+    };
+    
+    GuacamoleUI.showStatus = function(text) {
+        removeClass(document.body, "guac-error");
+        GuacamoleUI.containers.state.style.visibility = "visible";
+        GuacamoleUI.state.textContent = text;
+        GuacamoleUI.display.style.opacity = "1";
+    };
+    
+    GuacamoleUI.showError = function(error) {
+        addClass(document.body, "guac-error");
+        GuacamoleUI.state.textContent = error;
+        GuacamoleUI.display.style.opacity = "0.1";
     };
 
     GuacamoleUI.shadeMenu = function() {
@@ -118,12 +178,54 @@ 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;
+
     // Show/Hide keyboard
     var keyboardResizeInterval = null;
     GuacamoleUI.buttons.showKeyboard.onclick = function() {
 
+        // If Guac OSK shown, hide it.
         var displayed = GuacamoleUI.containers.keyboard.style.display;
-        if (displayed != "block") {
+        if (displayed == "block") {
+            GuacamoleUI.containers.keyboard.style.display = "none";
+            GuacamoleUI.buttons.showKeyboard.textContent = "Show Keyboard";
+
+            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;
+
+            }
+
+            // Ensure event target is NOT focused if we are using the Guac OSK.
+            GuacamoleUI.eventTarget.blur();
+
             GuacamoleUI.containers.keyboard.style.display = "block";
             GuacamoleUI.buttons.showKeyboard.textContent = "Hide Keyboard";
 
@@ -133,13 +235,7 @@ var GuacamoleUI = {
 
             updateKeyboardSize();
         }
-        else {
-            GuacamoleUI.containers.keyboard.style.display = "none";
-            GuacamoleUI.buttons.showKeyboard.textContent = "Show Keyboard";
-
-            window.onresize = null;
-            window.clearInterval(keyboardResizeInterval);
-        }
+        
 
     };
 
@@ -153,7 +249,7 @@ var GuacamoleUI = {
     var detectMenuCloseTimeout = null;
 
     // Clear detection timeouts
-    function resetMenuDetect() {
+    GuacamoleUI.resetMenuDetect = function() {
 
         if (detectMenuOpenTimeout != null) {
             window.clearTimeout(detectMenuOpenTimeout);
@@ -165,79 +261,98 @@ var GuacamoleUI = {
             detectMenuCloseTimeout = null;
         }
 
-    }
+    };
 
     // Initiate detection of menu open action. If not canceled through some
     // user event, menu will open.
-    function startMenuOpenDetect() {
+    GuacamoleUI.startMenuOpenDetect = function() {
 
-        // Clear detection state
-        resetMenuDetect();
+        if (!detectMenuOpenTimeout) {
 
-        // Wait and then show menu
-        detectMenuOpenTimeout = window.setTimeout(function() {
-            GuacamoleUI.showMenu();
-            detectMenuOpenTimeout = null;
-        }, 325);
+            // Clear detection state
+            GuacamoleUI.resetMenuDetect();
 
-    }
+            // Wait and then show menu
+            detectMenuOpenTimeout = window.setTimeout(function() {
+
+                // If menu opened via mouse, do not show native OSK
+                GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
+
+                GuacamoleUI.showMenu();
+                detectMenuOpenTimeout = null;
+            }, 325);
+
+        }
+
+    };
 
     // Initiate detection of menu close action. If not canceled through some
-    // user event, menu will close.
-    function startMenuCloseDetect() {
+    // user mouse event, menu will close.
+    GuacamoleUI.startMenuCloseDetect = function() {
 
-        // Clear detection state
-        resetMenuDetect();
+        if (!detectMenuCloseTimeout) {
 
-        // Wait and then shade menu
-        detectMenuCloseTimeout = window.setTimeout(function() {
-            GuacamoleUI.shadeMenu();
-            detectMenuCloseTimeout = null;
-        }, 500);
+            // Clear detection state
+            GuacamoleUI.resetMenuDetect();
 
-    }
+            // Wait and then shade menu
+            detectMenuCloseTimeout = window.setTimeout(function() {
+                GuacamoleUI.shadeMenu();
+                detectMenuCloseTimeout = null;
+            }, 500);
+
+        }
+
+    };
 
     // Show menu if mouseover any part of menu
     GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.showMenu, true);
 
     // Stop detecting menu state change intents if mouse is over menu
-    GuacamoleUI.menu.addEventListener('mouseover', resetMenuDetect, true);
+    GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.resetMenuDetect, true);
 
     // When mouse hovers over top of screen, start detection of intent to open menu
-    GuacamoleUI.menuControl.addEventListener('mousemove', startMenuOpenDetect, true);
+    GuacamoleUI.menuControl.addEventListener('mousemove', GuacamoleUI.startMenuOpenDetect, true);
 
-    // When mouse enters display, start detection of intent to close menu
-    GuacamoleUI.display.addEventListener('mouseover', startMenuCloseDetect, true);
+    var menuShowLongPressTimeout = null;
+
+    GuacamoleUI.startLongPressDetect = function() {
+
+        if (!menuShowLongPressTimeout) {
+
+            menuShowLongPressTimeout = window.setTimeout(function() {
+                
+                menuShowLongPressTimeout = null;
+
+                // Assume native OSK if menu shown via long-press
+                GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_NATIVE;
+                GuacamoleUI.showMenu();
+
+            }, 800);
 
-    // Show menu if mouse leaves document
-    document.addEventListener('mouseout', function(e) {
-        
-        // Get parent of the element the mouse pointer is leaving
-               if (!e) e = window.event;
-        var target = e.relatedTarget || e.toElement;
-        
-        // Ensure target is not document nor child of document
-        var targetParent = target;
-        while (targetParent != null) {
-            if (targetParent == document) return;
-            targetParent = targetParent.parentNode;
         }
+    };
+
+    GuacamoleUI.stopLongPressDetect = function() {
+        window.clearTimeout(menuShowLongPressTimeout);
+        menuShowLongPressTimeout = null;
+    };
 
-        // Start detection of intent to open menu
-        startMenuOpenDetect();
-    }, true);
+    // 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', GuacamoleUI.startLongPressDetect, true);
 
     // Reconnect button
     GuacamoleUI.buttons.reconnect.onclick = function() {
         window.location.reload();
     };
 
-    GuacamoleUI.display.onclick = function(e) {
-        e.preventDefault();
-        return false;
-    };
-
     // On-screen keyboard
     GuacamoleUI.keyboard = new Guacamole.OnScreenKeyboard("layouts/en-us-qwerty-mobile.xml");
     GuacamoleUI.containers.keyboard.appendChild(GuacamoleUI.keyboard.getElement());
@@ -257,11 +372,82 @@ var GuacamoleUI = {
 // Tie UI events / behavior to a specific Guacamole client
 GuacamoleUI.attach = function(guac) {
 
+    var title_prefix = null;
+    var connection_name = null 
+    
+    var guac_display = guac.getDisplay();
+
+    // Set document title appropriately, based on prefix and connection name
+    function updateTitle() {
+
+        // Use title prefix if present
+        if (title_prefix) {
+            
+            document.title = title_prefix;
+
+            // Include connection name, if present
+            if (connection_name)
+                document.title += " " + connection_name;
+
+        }
+
+        // Otherwise, just set to connection name
+        else if (connection_name)
+            document.title = connection_name;
+
+    }
+
+    // When mouse enters display, start detection of intent to close menu
+    guac_display.addEventListener('mouseover', GuacamoleUI.startMenuCloseDetect, true);
+
+    guac_display.onclick = function(e) {
+        e.preventDefault();
+        return false;
+    };
+
     // Mouse
-    var mouse = new Guacamole.Mouse(GuacamoleUI.display);
+    var mouse = new Guacamole.Mouse(guac_display);
     mouse.onmousedown = mouse.onmouseup = mouse.onmousemove =
         function(mouseState) {
+       
+            // Determine mouse position within view
+            var mouse_view_x = mouseState.x + guac_display.offsetLeft - window.pageXOffset;
+            var mouse_view_y = mouseState.y + guac_display.offsetTop  - window.pageYOffset;
+
+            // Determine viewport dimensioins
+            var view_width  = GuacamoleUI.viewport.offsetWidth;
+            var view_height = GuacamoleUI.viewport.offsetHeight;
+
+            // Determine scroll amounts based on mouse position relative to document
+
+            var scroll_amount_x;
+            if (mouse_view_x > view_width)
+                scroll_amount_x = mouse_view_x - view_width;
+            else if (mouse_view_x < 0)
+                scroll_amount_x = mouse_view_x;
+            else
+                scroll_amount_x = 0;
+
+            var scroll_amount_y;
+            if (mouse_view_y > view_height)
+                scroll_amount_y = mouse_view_y - view_height;
+            else if (mouse_view_y < 0)
+                scroll_amount_y = mouse_view_y;
+            else
+                scroll_amount_y = 0;
+
+            // Scroll (if necessary) to keep mouse on screen.
+            window.scrollBy(scroll_amount_x, scroll_amount_y);
+       
+            // Hide menu on movement
+            GuacamoleUI.startMenuCloseDetect();
+
+            // Stop detecting long presses if mouse is being used
+            GuacamoleUI.stopLongPressDetect();
+
+            // Send mouse event
             guac.sendMouseState(mouseState);
+            
         };
 
     // Keyboard
@@ -275,6 +461,12 @@ GuacamoleUI.attach = function(guac) {
     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);
             };
 
@@ -289,54 +481,65 @@ GuacamoleUI.attach = function(guac) {
 
     // Handle client state change
     guac.onstatechange = function(clientState) {
+
         switch (clientState) {
 
             // Idle
             case 0:
-                GuacamoleUI.state.textContent = "Idle."
+                GuacamoleUI.showStatus("Idle.");
+                title_prefix = "[Idle]";
                 break;
 
             // Connecting
             case 1:
-                GuacamoleUI.state.textContent = "Connecting...";
+                GuacamoleUI.shadeMenu();
+                GuacamoleUI.showStatus("Connecting...");
+                title_prefix = "[Connecting...]";
                 break;
 
             // Connected + waiting
             case 2:
-                GuacamoleUI.state.textContent = "Connected, waiting for first update...";
+                GuacamoleUI.showStatus("Connected, waiting for first update...");
+                title_prefix = "[Waiting...]";
                 break;
 
             // Connected
             case 3:
                 
+                GuacamoleUI.hideStatus();
                 GuacamoleUI.display.className =
                     GuacamoleUI.display.className.replace(/guac-loading/, '');
 
                 GuacamoleUI.menu.className = "connected";
-                GuacamoleUI.state.textContent = "Connected.";
-                GuacamoleUI.shadeMenu();
+
+                title_prefix = null;
                 break;
 
             // Disconnecting
             case 4:
-                GuacamoleUI.state.textContent = "Disconnecting...";
+                GuacamoleUI.showStatus("Disconnecting...");
+                title_prefix = "[Disconnecting...]";
                 break;
 
             // Disconnected
             case 5:
-                GuacamoleUI.state.textContent = "Disconnected.";
+                GuacamoleUI.showStatus("Disconnected.");
+                title_prefix = "[Disconnected]";
                 break;
 
             // Unknown status code
             default:
-                GuacamoleUI.state.textContent = "Unknown";
+                GuacamoleUI.showStatus("[UNKNOWN STATUS]");
 
         }
+
+        updateTitle();
     };
 
     // Name instruction handler
     guac.onname = function(name) {
-        document.title = name;
+        connection_name = name;
+        updateTitle();
     };
 
     // Error handler
@@ -347,32 +550,6 @@ GuacamoleUI.attach = function(guac) {
 
         // Display error message
         GuacamoleUI.showError(error);
-
-        // Show error by desaturating display
-        var layers = guac.getLayers();
-        for (var i=0; i<layers.length; i++) {
-            layers[i].filter(desaturateFilter);
-        }
-
-        // Filter for desaturation
-        function desaturateFilter(data, width, height) {
-
-            for (var i=0; i<data.length; i+=4) {
-
-                // Get RGB values
-                var r = data[i];
-                var g = data[i+1];
-                var b = data[i+2];
-
-                // Desaturate
-                var v = Math.max(r, g, b) / 2;
-                data[i]   = v;
-                data[i+1] = v;
-                data[i+2] = v;
-
-            }
-
-        }
         
     };
 
@@ -404,11 +581,11 @@ GuacamoleUI.attach = function(guac) {
         GuacamoleUI.clipboard.value = data;
     };
 
-    GuacamoleUI.keyboard.onkeypress = function(keysym) {
+    GuacamoleUI.keyboard.onkeydown = function(keysym) {
         guac.sendKeyEvent(1, keysym);
     };
 
-    GuacamoleUI.keyboard.onkeyrelease = function(keysym) {
+    GuacamoleUI.keyboard.onkeyup = function(keysym) {
         guac.sendKeyEvent(0, keysym);
     };