3ad73fbda063999ca2b187c8ca3a0a3908d8e637
[guacamole.git] / src / main / webapp / scripts / interface.js
1
2 // UI Definition
3 var GuacamoleUI = {
4
5     /* Detection Constants */
6     
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 */
12
13     /* Animation Constants */
14
15     "MENU_SHADE_STEPS"    : 10, /* frames */
16     "MENU_SHADE_INTERVAL" : 30, /* milliseconds */
17     "MENU_SHOW_STEPS"     : 5,  /* frames */
18     "MENU_SHOW_INTERVAL"  : 30, /* milliseconds */
19
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 */
23
24     /* UI Elements */
25
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"),
33
34     "buttons": {
35
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"),
41
42         "touchShowClipboard" : document.getElementById("touchShowClipboard"),
43         "touchShowKeyboard"  : document.getElementById("touchShowKeyboard"),
44         "touchLogout"        : document.getElementById("touchLogout")
45
46     },
47
48     "containers": {
49         "state"    : document.getElementById("statusDialog"),
50         "clipboard": document.getElementById("clipboardDiv"),
51         "keyboard" : document.getElementById("keyboardContainer")
52     },
53     
54     "state"     : document.getElementById("statusText"),
55     "clipboard" : document.getElementById("clipboard")
56
57 };
58
59 // Constant UI initialization and behavior
60 (function() {
61
62     var menu_shaded = false;
63
64     var shade_interval = null;
65     var show_interval = null;
66
67     // Cache error image (might not be available when error occurs)
68     var guacErrorImage = new Image();
69     guacErrorImage.src = "images/noguacamole-logo-24.png";
70
71     // Function for adding a class to an element
72     var addClass;
73
74     // Function for removing a class from an element
75     var removeClass;
76
77     // If Node.classList is supported, implement addClass/removeClass using that
78     if (Node.classList) {
79
80         addClass = function(element, classname) {
81             element.classList.add(classname);
82         };
83         
84         removeClass = function(element, classname) {
85             element.classList.remove(classname);
86         };
87         
88     }
89
90     // Otherwise, implement own
91     else {
92
93         addClass = function(element, classname) {
94
95             // Simply add new class
96             element.className += " " + classname;
97
98         };
99         
100         removeClass = function(element, classname) {
101
102             // Filter out classes with given name
103             element.className = element.className.replace(/([^ ]+)[ ]*/g,
104                 function(match, testClassname, spaces, offset, string) {
105
106                     // If same class, remove
107                     if (testClassname == classname)
108                         return "";
109
110                     // Otherwise, allow
111                     return match;
112                     
113                 }
114             );
115
116         };
117         
118     }
119
120
121     GuacamoleUI.hideStatus = function() {
122         removeClass(document.body, "guac-error");
123         GuacamoleUI.containers.state.style.visibility = "hidden";
124         GuacamoleUI.display.style.opacity = "1";
125     };
126     
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";
132     };
133     
134     GuacamoleUI.showError = function(error) {
135         addClass(document.body, "guac-error");
136         GuacamoleUI.state.textContent = error;
137         GuacamoleUI.display.style.opacity = "0.1";
138     };
139
140     GuacamoleUI.hideTouchMenu = function() {
141         GuacamoleUI.touchMenu.style.visibility = "hidden";
142     };
143     
144     GuacamoleUI.showTouchMenu = function() {
145         
146         GuacamoleUI.touchMenu.style.left =
147             ((GuacamoleUI.viewport.offsetWidth - GuacamoleUI.touchMenu.offsetWidth) / 2
148             + window.pageXOffset)
149             + "px";
150
151         GuacamoleUI.touchMenu.style.top =
152             ((GuacamoleUI.viewport.offsetHeight - GuacamoleUI.touchMenu.offsetHeight) / 2
153             + window.pageYOffset)
154             + "px";
155
156         GuacamoleUI.touchMenu.style.visibility = "visible";
157         
158     };
159
160     GuacamoleUI.shadeMenu = function() {
161
162         if (!menu_shaded) {
163
164             var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHADE_STEPS) + 1;
165             var offset = 0;
166             menu_shaded = true;
167
168             window.clearInterval(show_interval);
169             shade_interval = window.setInterval(function() {
170
171                 offset -= step;
172
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 =
178
179                     "translateY(" + offset + "px)";
180
181                 if (offset <= -GuacamoleUI.menu.offsetHeight) {
182                     window.clearInterval(shade_interval);
183                     GuacamoleUI.menu.style.visiblity = "hidden";
184                 }
185
186             }, GuacamoleUI.MENU_SHADE_INTERVAL);
187         }
188
189     };
190
191     GuacamoleUI.showMenu = function() {
192
193         if (menu_shaded) {
194
195             var step = Math.floor(GuacamoleUI.menu.offsetHeight / GuacamoleUI.MENU_SHOW_STEPS) + 1;
196             var offset = -GuacamoleUI.menu.offsetHeight;
197             menu_shaded = false;
198             GuacamoleUI.menu.style.visiblity = "";
199
200             window.clearInterval(shade_interval);
201             show_interval = window.setInterval(function() {
202
203                 offset += step;
204
205                 if (offset >= 0) {
206                     offset = 0;
207                     window.clearInterval(show_interval);
208                 }
209
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 =
215
216                     "translateY(" + offset + "px)";
217
218             }, GuacamoleUI.MENU_SHOW_INTERVAL);
219         }
220
221     };
222
223     // Show/Hide clipboard
224     GuacamoleUI.buttons.showClipboard.onclick = function() {
225
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";
230         }
231         else {
232             GuacamoleUI.containers.clipboard.style.display = "none";
233             GuacamoleUI.buttons.showClipboard.innerHTML = "Show Clipboard";
234             GuacamoleUI.clipboard.onchange();
235         }
236
237     };
238
239     GuacamoleUI.buttons.touchShowClipboard.onclick = function() {
240         // FIXME: Implement
241         alert("Not yet implemented... Sorry.");
242     };
243
244     // Show/Hide keyboard
245     var keyboardResizeInterval = null;
246     GuacamoleUI.buttons.showKeyboard.onclick = function() {
247
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";
253
254             window.onresize = null;
255             window.clearInterval(keyboardResizeInterval);
256         }
257
258         // Otherwise, show it
259         else {
260
261             // Ensure event target is NOT focused if we are using the Guac OSK.
262             GuacamoleUI.eventTarget.blur();
263
264             GuacamoleUI.containers.keyboard.style.display = "block";
265             GuacamoleUI.buttons.showKeyboard.textContent = "Hide Keyboard";
266
267             // Automatically update size
268             window.onresize = updateKeyboardSize;
269             keyboardResizeInterval = window.setInterval(updateKeyboardSize,
270                 GuacamoleUI.KEYBOARD_AUTO_RESIZE_INTERVAL);
271
272             updateKeyboardSize();
273
274         }
275
276     };
277
278     // Touch-specific keyboard show
279     GuacamoleUI.buttons.touchShowKeyboard.ontouchstart = 
280     GuacamoleUI.buttons.touchShowKeyboard.onclick = 
281         function(e) {
282             GuacamoleUI.eventTarget.focus();
283             GuacamoleUI.hideTouchMenu();
284             e.preventDefault();
285         };
286
287     // Logout
288     GuacamoleUI.buttons.logout.onclick =
289     GuacamoleUI.buttons.touchLogout.onclick =
290         function() {
291             window.location.href = "logout";
292         };
293
294     // Timeouts for detecting if users wants menu to open or close
295     var detectMenuOpenTimeout = null;
296     var detectMenuCloseTimeout = null;
297
298     // Clear detection timeouts
299     GuacamoleUI.resetMenuDetect = function() {
300
301         if (detectMenuOpenTimeout != null) {
302             window.clearTimeout(detectMenuOpenTimeout);
303             detectMenuOpenTimeout = null;
304         }
305
306         if (detectMenuCloseTimeout != null) {
307             window.clearTimeout(detectMenuCloseTimeout);
308             detectMenuCloseTimeout = null;
309         }
310
311     };
312
313     // Initiate detection of menu open action. If not canceled through some
314     // user event, menu will open.
315     GuacamoleUI.startMenuOpenDetect = function() {
316
317         if (!detectMenuOpenTimeout) {
318
319             // Clear detection state
320             GuacamoleUI.resetMenuDetect();
321
322             // Wait and then show menu
323             detectMenuOpenTimeout = window.setTimeout(function() {
324
325                 // If menu opened via mouse, do not show native OSK
326                 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
327
328                 GuacamoleUI.showMenu();
329                 detectMenuOpenTimeout = null;
330             }, GuacamoleUI.MENU_OPEN_DETECT_TIMEOUT);
331
332         }
333
334     };
335
336     // Initiate detection of menu close action. If not canceled through some
337     // user mouse event, menu will close.
338     GuacamoleUI.startMenuCloseDetect = function() {
339
340         if (!detectMenuCloseTimeout) {
341
342             // Clear detection state
343             GuacamoleUI.resetMenuDetect();
344
345             // Wait and then shade menu
346             detectMenuCloseTimeout = window.setTimeout(function() {
347                 GuacamoleUI.shadeMenu();
348                 detectMenuCloseTimeout = null;
349             }, GuacamoleUI.MENU_CLOSE_DETECT_TIMEOUT);
350
351         }
352
353     };
354
355     // Show menu if mouseover any part of menu
356     GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.showMenu, true);
357
358     // Stop detecting menu state change intents if mouse is over menu
359     GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.resetMenuDetect, true);
360
361     // When mouse hovers over top of screen, start detection of intent to open menu
362     GuacamoleUI.menuControl.addEventListener('mousemove', GuacamoleUI.startMenuOpenDetect, true);
363
364     var long_press_start_x = 0;
365     var long_press_start_y = 0;
366     var menuShowLongPressTimeout = null;
367
368     GuacamoleUI.startLongPressDetect = function() {
369
370         if (!menuShowLongPressTimeout) {
371
372             menuShowLongPressTimeout = window.setTimeout(function() {
373                 
374                 menuShowLongPressTimeout = null;
375
376                 // Assume native OSK if menu shown via long-press
377                 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_NATIVE;
378                 GuacamoleUI.showTouchMenu();
379
380             }, GuacamoleUI.LONG_PRESS_DETECT_TIMEOUT);
381
382         }
383     };
384
385     GuacamoleUI.stopLongPressDetect = function() {
386         window.clearTimeout(menuShowLongPressTimeout);
387         menuShowLongPressTimeout = null;
388     };
389
390     // Detect long-press at bottom of screen
391     GuacamoleUI.display.addEventListener('touchstart', function(e) {
392         
393         // Close menu if shown
394         GuacamoleUI.shadeMenu();
395         GuacamoleUI.hideTouchMenu();
396         
397         // Record touch location
398         if (e.touches.length == 1) {
399             var touch = e.touches[0];
400             long_press_start_x = touch.screenX;
401             long_press_start_y = touch.screenY;
402         }
403         
404         // Start detection
405         GuacamoleUI.startLongPressDetect();
406         
407     }, true);
408
409     // Stop detection if touch moves significantly
410     GuacamoleUI.display.addEventListener('touchmove', function(e) {
411         
412         // If touch distance from start exceeds threshold, cancel long press
413         var touch = e.touches[0];
414         if (Math.abs(touch.screenX - long_press_start_x) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD
415             || Math.abs(touch.screenY - long_press_start_y) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD)
416             GuacamoleUI.stopLongPressDetect();
417         
418     }, true);
419
420     // Stop detection if press stops
421     GuacamoleUI.display.addEventListener('touchend', GuacamoleUI.stopLongPressDetect, true);
422
423     // Close menu on mouse movement
424     GuacamoleUI.display.addEventListener('mousemove', GuacamoleUI.startMenuCloseDetect, true);
425     GuacamoleUI.display.addEventListener('mousedown', GuacamoleUI.startMenuCloseDetect, true);
426
427     // Reconnect button
428     GuacamoleUI.buttons.reconnect.onclick = function() {
429         window.location.reload();
430     };
431
432     // On-screen keyboard
433     GuacamoleUI.keyboard = new Guacamole.OnScreenKeyboard("layouts/en-us-qwerty-mobile.xml");
434     GuacamoleUI.containers.keyboard.appendChild(GuacamoleUI.keyboard.getElement());
435
436     // Function for automatically updating keyboard size
437     var lastKeyboardWidth;
438     function updateKeyboardSize() {
439         var currentSize = GuacamoleUI.keyboard.getElement().offsetWidth;
440         if (lastKeyboardWidth != currentSize) {
441             GuacamoleUI.keyboard.resize(currentSize);
442             lastKeyboardWidth = currentSize;
443         }
444     };
445
446     // Turn off autocorrect and autocapitalization on eventTarget
447     GuacamoleUI.eventTarget.setAttribute("autocorrect", "off");
448     GuacamoleUI.eventTarget.setAttribute("autocapitalize", "off");
449
450     // Automatically reposition event target on scroll
451     window.addEventListener("scroll", function() {
452         GuacamoleUI.eventTarget.style.left = window.pageXOffset + "px";
453         GuacamoleUI.eventTarget.style.top = window.pageYOffset + "px";
454     });
455
456 })();
457
458 // Tie UI events / behavior to a specific Guacamole client
459 GuacamoleUI.attach = function(guac) {
460
461     var title_prefix = null;
462     var connection_name = "Guacamole"; 
463     
464     var guac_display = guac.getDisplay();
465
466     // Set document title appropriately, based on prefix and connection name
467     function updateTitle() {
468
469         // Use title prefix if present
470         if (title_prefix) {
471             
472             document.title = title_prefix;
473
474             // Include connection name, if present
475             if (connection_name)
476                 document.title += " " + connection_name;
477
478         }
479
480         // Otherwise, just set to connection name
481         else if (connection_name)
482             document.title = connection_name;
483
484     }
485
486     // When mouse enters display, start detection of intent to close menu
487     guac_display.addEventListener('mouseover', GuacamoleUI.startMenuCloseDetect, true);
488
489     guac_display.onclick = function(e) {
490         e.preventDefault();
491         return false;
492     };
493
494     // Mouse
495     var mouse = new Guacamole.Mouse(guac_display);
496     mouse.onmousedown = mouse.onmouseup = mouse.onmousemove =
497         function(mouseState) {
498        
499             // Determine mouse position within view
500             var mouse_view_x = mouseState.x + guac_display.offsetLeft - window.pageXOffset;
501             var mouse_view_y = mouseState.y + guac_display.offsetTop  - window.pageYOffset;
502
503             // Determine viewport dimensioins
504             var view_width  = GuacamoleUI.viewport.offsetWidth;
505             var view_height = GuacamoleUI.viewport.offsetHeight;
506
507             // Determine scroll amounts based on mouse position relative to document
508
509             var scroll_amount_x;
510             if (mouse_view_x > view_width)
511                 scroll_amount_x = mouse_view_x - view_width;
512             else if (mouse_view_x < 0)
513                 scroll_amount_x = mouse_view_x;
514             else
515                 scroll_amount_x = 0;
516
517             var scroll_amount_y;
518             if (mouse_view_y > view_height)
519                 scroll_amount_y = mouse_view_y - view_height;
520             else if (mouse_view_y < 0)
521                 scroll_amount_y = mouse_view_y;
522             else
523                 scroll_amount_y = 0;
524
525             // Scroll (if necessary) to keep mouse on screen.
526             window.scrollBy(scroll_amount_x, scroll_amount_y);
527        
528             // Send mouse event
529             guac.sendMouseState(mouseState);
530             
531         };
532
533     // Keyboard
534     var keyboard = new Guacamole.Keyboard(document);
535
536     // Monitor whether the event target is focused
537     var eventTargetFocused = false;
538
539     // Save length for calculation of changed value
540     var currentLength = GuacamoleUI.eventTarget.value.length;
541
542     GuacamoleUI.eventTarget.onfocus = function() {
543         eventTargetFocused = true;
544         GuacamoleUI.eventTarget.value = "";
545         currentLength = 0;
546     };
547
548     GuacamoleUI.eventTarget.onblur = function() {
549         eventTargetFocused = false;
550     };
551
552     // If text is input directly into event target without typing (as with
553     // voice input, for example), type automatically.
554     GuacamoleUI.eventTarget.oninput = function(e) {
555
556         // Calculate current length and change in length
557         var oldLength = currentLength;
558         currentLength = GuacamoleUI.eventTarget.value.length;
559         
560         // If deleted or replaced text, ignore
561         if (currentLength <= oldLength)
562             return;
563
564         // Get changed text
565         var text = GuacamoleUI.eventTarget.value.substring(oldLength);
566
567         // Send each character
568         for (var i=0; i<text.length; i++) {
569
570             // Get char code
571             var charCode = text.charCodeAt(i);
572
573             // Convert to keysym
574             var keysym = 0x003F; // Default to a question mark
575             if (charCode >= 0x0000 && charCode <= 0x00FF)
576                 keysym = charCode;
577             else if (charCode >= 0x0100 && charCode <= 0x10FFFF)
578                 keysym = 0x01000000 | charCode;
579
580             // Send keysym only if not already pressed
581             if (!keyboard.pressed[keysym]) {
582
583                 // Press and release key
584                 guac.sendKeyEvent(1, keysym);
585                 guac.sendKeyEvent(0, keysym);
586
587             }
588
589         }
590
591     }
592
593     function isTypableCharacter(keysym) {
594         return (keysym & 0xFFFF00) != 0xFF00;
595     }
596
597     function disableKeyboard() {
598         keyboard.onkeydown = null;
599         keyboard.onkeyup = null;
600     }
601
602     function enableKeyboard() {
603
604         keyboard.onkeydown = function (keysym) {
605             guac.sendKeyEvent(1, keysym);
606             return eventTargetFocused && isTypableCharacter(keysym);
607         };
608
609         keyboard.onkeyup = function (keysym) {
610             guac.sendKeyEvent(0, keysym);
611             return eventTargetFocused && isTypableCharacter(keysym);
612         };
613
614     }
615
616     // Enable keyboard by default
617     enableKeyboard();
618
619     // Handle client state change
620     guac.onstatechange = function(clientState) {
621
622         switch (clientState) {
623
624             // Idle
625             case 0:
626                 GuacamoleUI.showStatus("Idle.");
627                 title_prefix = "[Idle]";
628                 break;
629
630             // Connecting
631             case 1:
632                 GuacamoleUI.shadeMenu();
633                 GuacamoleUI.showStatus("Connecting...");
634                 title_prefix = "[Connecting...]";
635                 break;
636
637             // Connected + waiting
638             case 2:
639                 GuacamoleUI.showStatus("Connected, waiting for first update...");
640                 title_prefix = "[Waiting...]";
641                 break;
642
643             // Connected
644             case 3:
645                 GuacamoleUI.hideStatus();
646                 title_prefix = null;
647                 break;
648
649             // Disconnecting
650             case 4:
651                 GuacamoleUI.showStatus("Disconnecting...");
652                 title_prefix = "[Disconnecting...]";
653                 break;
654
655             // Disconnected
656             case 5:
657                 GuacamoleUI.showStatus("Disconnected.");
658                 title_prefix = "[Disconnected]";
659                 break;
660
661             // Unknown status code
662             default:
663                 GuacamoleUI.showStatus("[UNKNOWN STATUS]");
664
665         }
666
667         updateTitle();
668     };
669
670     // Name instruction handler
671     guac.onname = function(name) {
672         connection_name = name;
673         updateTitle();
674     };
675
676     // Error handler
677     guac.onerror = function(error) {
678
679         // Disconnect, if connected
680         guac.disconnect();
681
682         // Display error message
683         GuacamoleUI.showError(error);
684         
685     };
686
687     // Disconnect on close
688     window.onunload = function() {
689         guac.disconnect();
690     };
691
692     // Handle clipboard events
693     GuacamoleUI.clipboard.onchange = function() {
694
695         var text = GuacamoleUI.clipboard.value;
696         guac.setClipboard(text);
697
698     };
699
700     // Ignore keypresses when clipboard is focused
701     GuacamoleUI.clipboard.onfocus = function() {
702         disableKeyboard();
703     };
704
705     // Capture keypresses when clipboard is not focused
706     GuacamoleUI.clipboard.onblur = function() {
707         enableKeyboard();
708     };
709
710     // Server copy handler
711     guac.onclipboard = function(data) {
712         GuacamoleUI.clipboard.value = data;
713     };
714
715     GuacamoleUI.keyboard.onkeydown = function(keysym) {
716         guac.sendKeyEvent(1, keysym);
717     };
718
719     GuacamoleUI.keyboard.onkeyup = function(keysym) {
720         guac.sendKeyEvent(0, keysym);
721     };
722
723     // Send Ctrl-Alt-Delete
724     GuacamoleUI.buttons.ctrlAltDelete.onclick = function() {
725
726         var KEYSYM_CTRL   = 0xFFE3;
727         var KEYSYM_ALT    = 0xFFE9;
728         var KEYSYM_DELETE = 0xFFFF;
729
730         guac.sendKeyEvent(1, KEYSYM_CTRL);
731         guac.sendKeyEvent(1, KEYSYM_ALT);
732         guac.sendKeyEvent(1, KEYSYM_DELETE);
733         guac.sendKeyEvent(0, KEYSYM_DELETE);
734         guac.sendKeyEvent(0, KEYSYM_ALT);
735         guac.sendKeyEvent(0, KEYSYM_CTRL);
736     };
737
738 };