5 /* Detection Constants */
7 "LONG_PRESS_DETECT_TIMEOUT" : 800, /* milliseconds */
8 "LONG_PRESS_MOVEMENT_THRESHOLD" : 10, /* pixels */
9 "MENU_CLOSE_DETECT_TIMEOUT" : 500, /* milliseconds */
10 "MENU_OPEN_DETECT_TIMEOUT" : 325, /* milliseconds */
11 "KEYBOARD_AUTO_RESIZE_INTERVAL" : 30, /* milliseconds */
13 /* Animation Constants */
15 "MENU_SHADE_STEPS" : 10, /* frames */
16 "MENU_SHADE_INTERVAL" : 30, /* milliseconds */
17 "MENU_SHOW_STEPS" : 5, /* frames */
18 "MENU_SHOW_INTERVAL" : 30, /* milliseconds */
20 /* OSK Mode Constants */
21 "OSK_MODE_NATIVE" : 1, /* "Show Keyboard" will show the platform's native OSK */
22 "OSK_MODE_GUAC" : 2, /* "Show Keyboard" will show Guac's built-in OSK */
26 "viewport" : document.getElementById("viewportClone"),
27 "display" : document.getElementById("display"),
28 "menu" : document.getElementById("menu"),
29 "menuControl" : document.getElementById("menuControl"),
30 "touchMenu" : document.getElementById("touchMenu"),
31 "logo" : document.getElementById("status-logo"),
32 "eventTarget" : document.getElementById("eventTarget"),
36 "showClipboard": document.getElementById("showClipboard"),
37 "showKeyboard" : document.getElementById("showKeyboard"),
38 "ctrlAltDelete": document.getElementById("ctrlAltDelete"),
39 "reconnect" : document.getElementById("reconnect"),
40 "logout" : document.getElementById("logout"),
42 "touchShowClipboard" : document.getElementById("touchShowClipboard"),
43 "touchShowKeyboard" : document.getElementById("touchShowKeyboard"),
44 "touchLogout" : document.getElementById("touchLogout")
49 "state" : document.getElementById("statusDialog"),
50 "clipboard": document.getElementById("clipboardDiv"),
51 "keyboard" : document.getElementById("keyboardContainer")
54 "state" : document.getElementById("statusText"),
55 "clipboard" : document.getElementById("clipboard")
59 // Constant UI initialization and behavior
62 var menu_shaded = false;
64 var shade_interval = null;
65 var show_interval = null;
67 // Cache error image (might not be available when error occurs)
68 var guacErrorImage = new Image();
69 guacErrorImage.src = "images/noguacamole-logo-24.png";
71 // Function for adding a class to an element
74 // Function for removing a class from an element
77 // If Node.classList is supported, implement addClass/removeClass using that
80 addClass = function(element, classname) {
81 element.classList.add(classname);
84 removeClass = function(element, classname) {
85 element.classList.remove(classname);
90 // Otherwise, implement own
93 addClass = function(element, classname) {
95 // Simply add new class
96 element.className += " " + classname;
100 removeClass = function(element, classname) {
102 // Filter out classes with given name
103 element.className = element.className.replace(/([^ ]+)[ ]*/g,
104 function(match, testClassname, spaces, offset, string) {
106 // If same class, remove
107 if (testClassname == classname)
121 GuacamoleUI.hideStatus = function() {
122 removeClass(document.body, "guac-error");
123 GuacamoleUI.containers.state.style.visibility = "hidden";
124 GuacamoleUI.display.style.opacity = "1";
127 GuacamoleUI.showStatus = function(text) {
128 removeClass(document.body, "guac-error");
129 GuacamoleUI.containers.state.style.visibility = "visible";
130 GuacamoleUI.state.textContent = text;
131 GuacamoleUI.display.style.opacity = "1";
134 GuacamoleUI.showError = function(error) {
135 addClass(document.body, "guac-error");
136 GuacamoleUI.state.textContent = error;
137 GuacamoleUI.display.style.opacity = "0.1";
140 GuacamoleUI.hideTouchMenu = function() {
141 GuacamoleUI.touchMenu.style.visibility = "hidden";
144 GuacamoleUI.showTouchMenu = function() {
146 GuacamoleUI.touchMenu.style.left =
147 ((GuacamoleUI.viewport.offsetWidth - GuacamoleUI.touchMenu.offsetWidth) / 2
148 + window.pageXOffset)
151 GuacamoleUI.touchMenu.style.top =
152 ((GuacamoleUI.viewport.offsetHeight - GuacamoleUI.touchMenu.offsetHeight) / 2
153 + window.pageYOffset)
156 GuacamoleUI.touchMenu.style.visibility = "visible";
160 GuacamoleUI.shadeMenu = function() {
164 var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHADE_STEPS) + 1;
168 window.clearInterval(show_interval);
169 shade_interval = window.setInterval(function() {
173 GuacamoleUI.menu.style.transform =
174 GuacamoleUI.menu.style.WebkitTransform =
175 GuacamoleUI.menu.style.MozTransform =
176 GuacamoleUI.menu.style.OTransform =
177 GuacamoleUI.menu.style.msTransform =
179 "translateY(" + offset + "px)";
181 if (offset <= -GuacamoleUI.menu.offsetHeight) {
182 window.clearInterval(shade_interval);
183 GuacamoleUI.menu.style.visiblity = "hidden";
186 }, GuacamoleUI.MENU_SHADE_INTERVAL);
191 GuacamoleUI.showMenu = function() {
195 var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHOW_STEPS) + 1;
196 var offset = -GuacamoleUI.menu.offsetHeight;
198 GuacamoleUI.menu.style.visiblity = "";
200 window.clearInterval(shade_interval);
201 show_interval = window.setInterval(function() {
207 window.clearInterval(show_interval);
210 GuacamoleUI.menu.style.transform =
211 GuacamoleUI.menu.style.WebkitTransform =
212 GuacamoleUI.menu.style.MozTransform =
213 GuacamoleUI.menu.style.OTransform =
214 GuacamoleUI.menu.style.msTransform =
216 "translateY(" + offset + "px)";
218 }, GuacamoleUI.MENU_SHOW_INTERVAL);
223 // Show/Hide clipboard
224 GuacamoleUI.buttons.showClipboard.onclick = function() {
226 var displayed = GuacamoleUI.containers.clipboard.style.display;
227 if (displayed != "block") {
228 GuacamoleUI.containers.clipboard.style.display = "block";
229 GuacamoleUI.buttons.showClipboard.innerHTML = "Hide Clipboard";
232 GuacamoleUI.containers.clipboard.style.display = "none";
233 GuacamoleUI.buttons.showClipboard.innerHTML = "Show Clipboard";
234 GuacamoleUI.clipboard.onchange();
239 GuacamoleUI.buttons.touchShowClipboard.onclick = function() {
241 alert("Not yet implemented... Sorry.");
244 // Show/Hide keyboard
245 var keyboardResizeInterval = null;
246 GuacamoleUI.buttons.showKeyboard.onclick = function() {
248 // If Guac OSK shown, hide it.
249 var displayed = GuacamoleUI.containers.keyboard.style.display;
250 if (displayed == "block") {
251 GuacamoleUI.containers.keyboard.style.display = "none";
252 GuacamoleUI.buttons.showKeyboard.textContent = "Show Keyboard";
254 window.onresize = null;
255 window.clearInterval(keyboardResizeInterval);
258 // Otherwise, show it
261 // Ensure event target is NOT focused if we are using the Guac OSK.
262 GuacamoleUI.eventTarget.blur();
264 GuacamoleUI.containers.keyboard.style.display = "block";
265 GuacamoleUI.buttons.showKeyboard.textContent = "Hide Keyboard";
267 // Automatically update size
268 window.onresize = updateKeyboardSize;
269 keyboardResizeInterval = window.setInterval(updateKeyboardSize,
270 GuacamoleUI.KEYBOARD_AUTO_RESIZE_INTERVAL);
272 updateKeyboardSize();
278 // Touch-specific keyboard show
279 GuacamoleUI.buttons.touchShowKeyboard.onclick =
282 // Center event target in case browser automatically centers
283 // input fields on focus.
284 GuacamoleUI.eventTarget.style.left =
285 (window.pageXOffset + GuacamoleUI.viewport.offsetWidth / 2) + "px";
287 GuacamoleUI.eventTarget.style.top =
288 (window.pageYOffset + GuacamoleUI.viewport.offsetHeight / 2) + "px";
290 GuacamoleUI.eventTarget.focus();
291 GuacamoleUI.hideTouchMenu();
296 GuacamoleUI.buttons.logout.onclick =
297 GuacamoleUI.buttons.touchLogout.onclick =
299 window.location.href = "logout";
300 GuacamoleUI.hideTouchMenu();
303 // Timeouts for detecting if users wants menu to open or close
304 var detectMenuOpenTimeout = null;
305 var detectMenuCloseTimeout = null;
307 // Clear detection timeouts
308 GuacamoleUI.resetMenuDetect = function() {
310 if (detectMenuOpenTimeout != null) {
311 window.clearTimeout(detectMenuOpenTimeout);
312 detectMenuOpenTimeout = null;
315 if (detectMenuCloseTimeout != null) {
316 window.clearTimeout(detectMenuCloseTimeout);
317 detectMenuCloseTimeout = null;
322 // Initiate detection of menu open action. If not canceled through some
323 // user event, menu will open.
324 GuacamoleUI.startMenuOpenDetect = function() {
326 if (!detectMenuOpenTimeout) {
328 // Clear detection state
329 GuacamoleUI.resetMenuDetect();
331 // Wait and then show menu
332 detectMenuOpenTimeout = window.setTimeout(function() {
334 // If menu opened via mouse, do not show native OSK
335 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
337 GuacamoleUI.showMenu();
338 detectMenuOpenTimeout = null;
339 }, GuacamoleUI.MENU_OPEN_DETECT_TIMEOUT);
345 // Initiate detection of menu close action. If not canceled through some
346 // user mouse event, menu will close.
347 GuacamoleUI.startMenuCloseDetect = function() {
349 if (!detectMenuCloseTimeout) {
351 // Clear detection state
352 GuacamoleUI.resetMenuDetect();
354 // Wait and then shade menu
355 detectMenuCloseTimeout = window.setTimeout(function() {
356 GuacamoleUI.shadeMenu();
357 detectMenuCloseTimeout = null;
358 }, GuacamoleUI.MENU_CLOSE_DETECT_TIMEOUT);
364 // Show menu if mouseover any part of menu
365 GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.showMenu, true);
367 // Stop detecting menu state change intents if mouse is over menu
368 GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.resetMenuDetect, true);
370 // When mouse hovers over top of screen, start detection of intent to open menu
371 GuacamoleUI.menuControl.addEventListener('mousemove', GuacamoleUI.startMenuOpenDetect, true);
373 var long_press_start_x = 0;
374 var long_press_start_y = 0;
375 var menuShowLongPressTimeout = null;
377 GuacamoleUI.startLongPressDetect = function() {
379 if (!menuShowLongPressTimeout) {
381 menuShowLongPressTimeout = window.setTimeout(function() {
383 menuShowLongPressTimeout = null;
385 // Assume native OSK if menu shown via long-press
386 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_NATIVE;
387 GuacamoleUI.showTouchMenu();
389 }, GuacamoleUI.LONG_PRESS_DETECT_TIMEOUT);
394 GuacamoleUI.stopLongPressDetect = function() {
395 window.clearTimeout(menuShowLongPressTimeout);
396 menuShowLongPressTimeout = null;
399 // Detect long-press at bottom of screen
400 GuacamoleUI.display.addEventListener('touchstart', function(e) {
402 // Close menu if shown
403 GuacamoleUI.shadeMenu();
404 GuacamoleUI.hideTouchMenu();
406 // Record touch location
407 if (e.touches.length == 1) {
408 var touch = e.touches[0];
409 long_press_start_x = touch.screenX;
410 long_press_start_y = touch.screenY;
414 GuacamoleUI.startLongPressDetect();
418 // Stop detection if touch moves significantly
419 GuacamoleUI.display.addEventListener('touchmove', function(e) {
421 // If touch distance from start exceeds threshold, cancel long press
422 var touch = e.touches[0];
423 if (Math.abs(touch.screenX - long_press_start_x) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD
424 || Math.abs(touch.screenY - long_press_start_y) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD)
425 GuacamoleUI.stopLongPressDetect();
429 // Stop detection if press stops
430 GuacamoleUI.display.addEventListener('touchend', GuacamoleUI.stopLongPressDetect, true);
432 // Close menu on mouse movement
433 GuacamoleUI.display.addEventListener('mousemove', GuacamoleUI.startMenuCloseDetect, true);
434 GuacamoleUI.display.addEventListener('mousedown', GuacamoleUI.startMenuCloseDetect, true);
437 GuacamoleUI.buttons.reconnect.onclick = function() {
438 window.location.reload();
441 // On-screen keyboard
442 GuacamoleUI.keyboard = new Guacamole.OnScreenKeyboard("layouts/en-us-qwerty-mobile.xml");
443 GuacamoleUI.containers.keyboard.appendChild(GuacamoleUI.keyboard.getElement());
445 // Function for automatically updating keyboard size
446 var lastKeyboardWidth;
447 function updateKeyboardSize() {
448 var currentSize = GuacamoleUI.keyboard.getElement().offsetWidth;
449 if (lastKeyboardWidth != currentSize) {
450 GuacamoleUI.keyboard.resize(currentSize);
451 lastKeyboardWidth = currentSize;
455 // Turn off autocorrect and autocapitalization on eventTarget
456 GuacamoleUI.eventTarget.setAttribute("autocorrect", "off");
457 GuacamoleUI.eventTarget.setAttribute("autocapitalize", "off");
459 // Automatically reposition event target on scroll
460 window.addEventListener("scroll", function() {
461 GuacamoleUI.eventTarget.style.left = window.pageXOffset + "px";
462 GuacamoleUI.eventTarget.style.top = window.pageYOffset + "px";
467 // Tie UI events / behavior to a specific Guacamole client
468 GuacamoleUI.attach = function(guac) {
470 var title_prefix = null;
471 var connection_name = "Guacamole";
473 var guac_display = guac.getDisplay();
475 // Set document title appropriately, based on prefix and connection name
476 function updateTitle() {
478 // Use title prefix if present
481 document.title = title_prefix;
483 // Include connection name, if present
485 document.title += " " + connection_name;
489 // Otherwise, just set to connection name
490 else if (connection_name)
491 document.title = connection_name;
495 // When mouse enters display, start detection of intent to close menu
496 guac_display.addEventListener('mouseover', GuacamoleUI.startMenuCloseDetect, true);
498 guac_display.onclick = function(e) {
504 var mouse = new Guacamole.Mouse(guac_display);
505 mouse.onmousedown = mouse.onmouseup = mouse.onmousemove =
506 function(mouseState) {
508 // Determine mouse position within view
509 var mouse_view_x = mouseState.x + guac_display.offsetLeft - window.pageXOffset;
510 var mouse_view_y = mouseState.y + guac_display.offsetTop - window.pageYOffset;
512 // Determine viewport dimensioins
513 var view_width = GuacamoleUI.viewport.offsetWidth;
514 var view_height = GuacamoleUI.viewport.offsetHeight;
516 // Determine scroll amounts based on mouse position relative to document
519 if (mouse_view_x > view_width)
520 scroll_amount_x = mouse_view_x - view_width;
521 else if (mouse_view_x < 0)
522 scroll_amount_x = mouse_view_x;
527 if (mouse_view_y > view_height)
528 scroll_amount_y = mouse_view_y - view_height;
529 else if (mouse_view_y < 0)
530 scroll_amount_y = mouse_view_y;
534 // Scroll (if necessary) to keep mouse on screen.
535 window.scrollBy(scroll_amount_x, scroll_amount_y);
538 guac.sendMouseState(mouseState);
543 var keyboard = new Guacamole.Keyboard(document);
545 // Monitor whether the event target is focused
546 var eventTargetFocused = false;
548 // Save length for calculation of changed value
549 var currentLength = GuacamoleUI.eventTarget.value.length;
551 GuacamoleUI.eventTarget.onfocus = function() {
552 eventTargetFocused = true;
553 GuacamoleUI.eventTarget.value = "";
557 GuacamoleUI.eventTarget.onblur = function() {
558 eventTargetFocused = false;
561 // If text is input directly into event target without typing (as with
562 // voice input, for example), type automatically.
563 GuacamoleUI.eventTarget.oninput = function(e) {
565 // Calculate current length and change in length
566 var oldLength = currentLength;
567 currentLength = GuacamoleUI.eventTarget.value.length;
569 // If deleted or replaced text, ignore
570 if (currentLength <= oldLength)
574 var text = GuacamoleUI.eventTarget.value.substring(oldLength);
576 // Send each character
577 for (var i=0; i<text.length; i++) {
580 var charCode = text.charCodeAt(i);
583 var keysym = 0x003F; // Default to a question mark
584 if (charCode >= 0x0000 && charCode <= 0x00FF)
586 else if (charCode >= 0x0100 && charCode <= 0x10FFFF)
587 keysym = 0x01000000 | charCode;
589 // Send keysym only if not already pressed
590 if (!keyboard.pressed[keysym]) {
592 // Press and release key
593 guac.sendKeyEvent(1, keysym);
594 guac.sendKeyEvent(0, keysym);
602 function isTypableCharacter(keysym) {
603 return (keysym & 0xFFFF00) != 0xFF00;
606 function disableKeyboard() {
607 keyboard.onkeydown = null;
608 keyboard.onkeyup = null;
611 function enableKeyboard() {
613 keyboard.onkeydown = function (keysym) {
614 guac.sendKeyEvent(1, keysym);
615 return eventTargetFocused && isTypableCharacter(keysym);
618 keyboard.onkeyup = function (keysym) {
619 guac.sendKeyEvent(0, keysym);
620 return eventTargetFocused && isTypableCharacter(keysym);
625 // Enable keyboard by default
628 // Handle client state change
629 guac.onstatechange = function(clientState) {
631 switch (clientState) {
635 GuacamoleUI.showStatus("Idle.");
636 title_prefix = "[Idle]";
641 GuacamoleUI.shadeMenu();
642 GuacamoleUI.showStatus("Connecting...");
643 title_prefix = "[Connecting...]";
646 // Connected + waiting
648 GuacamoleUI.showStatus("Connected, waiting for first update...");
649 title_prefix = "[Waiting...]";
654 GuacamoleUI.hideStatus();
660 GuacamoleUI.showStatus("Disconnecting...");
661 title_prefix = "[Disconnecting...]";
666 GuacamoleUI.showStatus("Disconnected.");
667 title_prefix = "[Disconnected]";
670 // Unknown status code
672 GuacamoleUI.showStatus("[UNKNOWN STATUS]");
679 // Name instruction handler
680 guac.onname = function(name) {
681 connection_name = name;
686 guac.onerror = function(error) {
688 // Disconnect, if connected
691 // Display error message
692 GuacamoleUI.showError(error);
696 // Disconnect on close
697 window.onunload = function() {
701 // Handle clipboard events
702 GuacamoleUI.clipboard.onchange = function() {
704 var text = GuacamoleUI.clipboard.value;
705 guac.setClipboard(text);
709 // Ignore keypresses when clipboard is focused
710 GuacamoleUI.clipboard.onfocus = function() {
714 // Capture keypresses when clipboard is not focused
715 GuacamoleUI.clipboard.onblur = function() {
719 // Server copy handler
720 guac.onclipboard = function(data) {
721 GuacamoleUI.clipboard.value = data;
724 GuacamoleUI.keyboard.onkeydown = function(keysym) {
725 guac.sendKeyEvent(1, keysym);
728 GuacamoleUI.keyboard.onkeyup = function(keysym) {
729 guac.sendKeyEvent(0, keysym);
732 // Send Ctrl-Alt-Delete
733 GuacamoleUI.buttons.ctrlAltDelete.onclick = function() {
735 var KEYSYM_CTRL = 0xFFE3;
736 var KEYSYM_ALT = 0xFFE9;
737 var KEYSYM_DELETE = 0xFFFF;
739 guac.sendKeyEvent(1, KEYSYM_CTRL);
740 guac.sendKeyEvent(1, KEYSYM_ALT);
741 guac.sendKeyEvent(1, KEYSYM_DELETE);
742 guac.sendKeyEvent(0, KEYSYM_DELETE);
743 guac.sendKeyEvent(0, KEYSYM_ALT);
744 guac.sendKeyEvent(0, KEYSYM_CTRL);