4f897b8ef3cd27a2a866268d7743a56ce37f95da
[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.onclick = 
280         function(e) {
281
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";
286
287             GuacamoleUI.eventTarget.style.top =
288                 (window.pageYOffset + GuacamoleUI.viewport.offsetHeight / 2) + "px";
289
290             GuacamoleUI.eventTarget.focus();
291             GuacamoleUI.hideTouchMenu();
292
293         };
294
295     // Logout
296     GuacamoleUI.buttons.logout.onclick =
297     GuacamoleUI.buttons.touchLogout.onclick =
298         function() {
299             window.location.href = "logout";
300         };
301
302     // Timeouts for detecting if users wants menu to open or close
303     var detectMenuOpenTimeout = null;
304     var detectMenuCloseTimeout = null;
305
306     // Clear detection timeouts
307     GuacamoleUI.resetMenuDetect = function() {
308
309         if (detectMenuOpenTimeout != null) {
310             window.clearTimeout(detectMenuOpenTimeout);
311             detectMenuOpenTimeout = null;
312         }
313
314         if (detectMenuCloseTimeout != null) {
315             window.clearTimeout(detectMenuCloseTimeout);
316             detectMenuCloseTimeout = null;
317         }
318
319     };
320
321     // Initiate detection of menu open action. If not canceled through some
322     // user event, menu will open.
323     GuacamoleUI.startMenuOpenDetect = function() {
324
325         if (!detectMenuOpenTimeout) {
326
327             // Clear detection state
328             GuacamoleUI.resetMenuDetect();
329
330             // Wait and then show menu
331             detectMenuOpenTimeout = window.setTimeout(function() {
332
333                 // If menu opened via mouse, do not show native OSK
334                 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_GUAC;
335
336                 GuacamoleUI.showMenu();
337                 detectMenuOpenTimeout = null;
338             }, GuacamoleUI.MENU_OPEN_DETECT_TIMEOUT);
339
340         }
341
342     };
343
344     // Initiate detection of menu close action. If not canceled through some
345     // user mouse event, menu will close.
346     GuacamoleUI.startMenuCloseDetect = function() {
347
348         if (!detectMenuCloseTimeout) {
349
350             // Clear detection state
351             GuacamoleUI.resetMenuDetect();
352
353             // Wait and then shade menu
354             detectMenuCloseTimeout = window.setTimeout(function() {
355                 GuacamoleUI.shadeMenu();
356                 detectMenuCloseTimeout = null;
357             }, GuacamoleUI.MENU_CLOSE_DETECT_TIMEOUT);
358
359         }
360
361     };
362
363     // Show menu if mouseover any part of menu
364     GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.showMenu, true);
365
366     // Stop detecting menu state change intents if mouse is over menu
367     GuacamoleUI.menu.addEventListener('mouseover', GuacamoleUI.resetMenuDetect, true);
368
369     // When mouse hovers over top of screen, start detection of intent to open menu
370     GuacamoleUI.menuControl.addEventListener('mousemove', GuacamoleUI.startMenuOpenDetect, true);
371
372     var long_press_start_x = 0;
373     var long_press_start_y = 0;
374     var menuShowLongPressTimeout = null;
375
376     GuacamoleUI.startLongPressDetect = function() {
377
378         if (!menuShowLongPressTimeout) {
379
380             menuShowLongPressTimeout = window.setTimeout(function() {
381                 
382                 menuShowLongPressTimeout = null;
383
384                 // Assume native OSK if menu shown via long-press
385                 GuacamoleUI.oskMode = GuacamoleUI.OSK_MODE_NATIVE;
386                 GuacamoleUI.showTouchMenu();
387
388             }, GuacamoleUI.LONG_PRESS_DETECT_TIMEOUT);
389
390         }
391     };
392
393     GuacamoleUI.stopLongPressDetect = function() {
394         window.clearTimeout(menuShowLongPressTimeout);
395         menuShowLongPressTimeout = null;
396     };
397
398     // Detect long-press at bottom of screen
399     GuacamoleUI.display.addEventListener('touchstart', function(e) {
400         
401         // Close menu if shown
402         GuacamoleUI.shadeMenu();
403         GuacamoleUI.hideTouchMenu();
404         
405         // Record touch location
406         if (e.touches.length == 1) {
407             var touch = e.touches[0];
408             long_press_start_x = touch.screenX;
409             long_press_start_y = touch.screenY;
410         }
411         
412         // Start detection
413         GuacamoleUI.startLongPressDetect();
414         
415     }, true);
416
417     // Stop detection if touch moves significantly
418     GuacamoleUI.display.addEventListener('touchmove', function(e) {
419         
420         // If touch distance from start exceeds threshold, cancel long press
421         var touch = e.touches[0];
422         if (Math.abs(touch.screenX - long_press_start_x) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD
423             || Math.abs(touch.screenY - long_press_start_y) >= GuacamoleUI.LONG_PRESS_MOVEMENT_THRESHOLD)
424             GuacamoleUI.stopLongPressDetect();
425         
426     }, true);
427
428     // Stop detection if press stops
429     GuacamoleUI.display.addEventListener('touchend', GuacamoleUI.stopLongPressDetect, true);
430
431     // Close menu on mouse movement
432     GuacamoleUI.display.addEventListener('mousemove', GuacamoleUI.startMenuCloseDetect, true);
433     GuacamoleUI.display.addEventListener('mousedown', GuacamoleUI.startMenuCloseDetect, true);
434
435     // Reconnect button
436     GuacamoleUI.buttons.reconnect.onclick = function() {
437         window.location.reload();
438     };
439
440     // On-screen keyboard
441     GuacamoleUI.keyboard = new Guacamole.OnScreenKeyboard("layouts/en-us-qwerty-mobile.xml");
442     GuacamoleUI.containers.keyboard.appendChild(GuacamoleUI.keyboard.getElement());
443
444     // Function for automatically updating keyboard size
445     var lastKeyboardWidth;
446     function updateKeyboardSize() {
447         var currentSize = GuacamoleUI.keyboard.getElement().offsetWidth;
448         if (lastKeyboardWidth != currentSize) {
449             GuacamoleUI.keyboard.resize(currentSize);
450             lastKeyboardWidth = currentSize;
451         }
452     };
453
454     // Turn off autocorrect and autocapitalization on eventTarget
455     GuacamoleUI.eventTarget.setAttribute("autocorrect", "off");
456     GuacamoleUI.eventTarget.setAttribute("autocapitalize", "off");
457
458     // Automatically reposition event target on scroll
459     window.addEventListener("scroll", function() {
460         GuacamoleUI.eventTarget.style.left = window.pageXOffset + "px";
461         GuacamoleUI.eventTarget.style.top = window.pageYOffset + "px";
462     });
463
464 })();
465
466 // Tie UI events / behavior to a specific Guacamole client
467 GuacamoleUI.attach = function(guac) {
468
469     var title_prefix = null;
470     var connection_name = "Guacamole"; 
471     
472     var guac_display = guac.getDisplay();
473
474     // Set document title appropriately, based on prefix and connection name
475     function updateTitle() {
476
477         // Use title prefix if present
478         if (title_prefix) {
479             
480             document.title = title_prefix;
481
482             // Include connection name, if present
483             if (connection_name)
484                 document.title += " " + connection_name;
485
486         }
487
488         // Otherwise, just set to connection name
489         else if (connection_name)
490             document.title = connection_name;
491
492     }
493
494     // When mouse enters display, start detection of intent to close menu
495     guac_display.addEventListener('mouseover', GuacamoleUI.startMenuCloseDetect, true);
496
497     guac_display.onclick = function(e) {
498         e.preventDefault();
499         return false;
500     };
501
502     // Mouse
503     var mouse = new Guacamole.Mouse(guac_display);
504     mouse.onmousedown = mouse.onmouseup = mouse.onmousemove =
505         function(mouseState) {
506        
507             // Determine mouse position within view
508             var mouse_view_x = mouseState.x + guac_display.offsetLeft - window.pageXOffset;
509             var mouse_view_y = mouseState.y + guac_display.offsetTop  - window.pageYOffset;
510
511             // Determine viewport dimensioins
512             var view_width  = GuacamoleUI.viewport.offsetWidth;
513             var view_height = GuacamoleUI.viewport.offsetHeight;
514
515             // Determine scroll amounts based on mouse position relative to document
516
517             var scroll_amount_x;
518             if (mouse_view_x > view_width)
519                 scroll_amount_x = mouse_view_x - view_width;
520             else if (mouse_view_x < 0)
521                 scroll_amount_x = mouse_view_x;
522             else
523                 scroll_amount_x = 0;
524
525             var scroll_amount_y;
526             if (mouse_view_y > view_height)
527                 scroll_amount_y = mouse_view_y - view_height;
528             else if (mouse_view_y < 0)
529                 scroll_amount_y = mouse_view_y;
530             else
531                 scroll_amount_y = 0;
532
533             // Scroll (if necessary) to keep mouse on screen.
534             window.scrollBy(scroll_amount_x, scroll_amount_y);
535        
536             // Send mouse event
537             guac.sendMouseState(mouseState);
538             
539         };
540
541     // Keyboard
542     var keyboard = new Guacamole.Keyboard(document);
543
544     // Monitor whether the event target is focused
545     var eventTargetFocused = false;
546
547     // Save length for calculation of changed value
548     var currentLength = GuacamoleUI.eventTarget.value.length;
549
550     GuacamoleUI.eventTarget.onfocus = function() {
551         eventTargetFocused = true;
552         GuacamoleUI.eventTarget.value = "";
553         currentLength = 0;
554     };
555
556     GuacamoleUI.eventTarget.onblur = function() {
557         eventTargetFocused = false;
558     };
559
560     // If text is input directly into event target without typing (as with
561     // voice input, for example), type automatically.
562     GuacamoleUI.eventTarget.oninput = function(e) {
563
564         // Calculate current length and change in length
565         var oldLength = currentLength;
566         currentLength = GuacamoleUI.eventTarget.value.length;
567         
568         // If deleted or replaced text, ignore
569         if (currentLength <= oldLength)
570             return;
571
572         // Get changed text
573         var text = GuacamoleUI.eventTarget.value.substring(oldLength);
574
575         // Send each character
576         for (var i=0; i<text.length; i++) {
577
578             // Get char code
579             var charCode = text.charCodeAt(i);
580
581             // Convert to keysym
582             var keysym = 0x003F; // Default to a question mark
583             if (charCode >= 0x0000 && charCode <= 0x00FF)
584                 keysym = charCode;
585             else if (charCode >= 0x0100 && charCode <= 0x10FFFF)
586                 keysym = 0x01000000 | charCode;
587
588             // Send keysym only if not already pressed
589             if (!keyboard.pressed[keysym]) {
590
591                 // Press and release key
592                 guac.sendKeyEvent(1, keysym);
593                 guac.sendKeyEvent(0, keysym);
594
595             }
596
597         }
598
599     }
600
601     function isTypableCharacter(keysym) {
602         return (keysym & 0xFFFF00) != 0xFF00;
603     }
604
605     function disableKeyboard() {
606         keyboard.onkeydown = null;
607         keyboard.onkeyup = null;
608     }
609
610     function enableKeyboard() {
611
612         keyboard.onkeydown = function (keysym) {
613             guac.sendKeyEvent(1, keysym);
614             return eventTargetFocused && isTypableCharacter(keysym);
615         };
616
617         keyboard.onkeyup = function (keysym) {
618             guac.sendKeyEvent(0, keysym);
619             return eventTargetFocused && isTypableCharacter(keysym);
620         };
621
622     }
623
624     // Enable keyboard by default
625     enableKeyboard();
626
627     // Handle client state change
628     guac.onstatechange = function(clientState) {
629
630         switch (clientState) {
631
632             // Idle
633             case 0:
634                 GuacamoleUI.showStatus("Idle.");
635                 title_prefix = "[Idle]";
636                 break;
637
638             // Connecting
639             case 1:
640                 GuacamoleUI.shadeMenu();
641                 GuacamoleUI.showStatus("Connecting...");
642                 title_prefix = "[Connecting...]";
643                 break;
644
645             // Connected + waiting
646             case 2:
647                 GuacamoleUI.showStatus("Connected, waiting for first update...");
648                 title_prefix = "[Waiting...]";
649                 break;
650
651             // Connected
652             case 3:
653                 GuacamoleUI.hideStatus();
654                 title_prefix = null;
655                 break;
656
657             // Disconnecting
658             case 4:
659                 GuacamoleUI.showStatus("Disconnecting...");
660                 title_prefix = "[Disconnecting...]";
661                 break;
662
663             // Disconnected
664             case 5:
665                 GuacamoleUI.showStatus("Disconnected.");
666                 title_prefix = "[Disconnected]";
667                 break;
668
669             // Unknown status code
670             default:
671                 GuacamoleUI.showStatus("[UNKNOWN STATUS]");
672
673         }
674
675         updateTitle();
676     };
677
678     // Name instruction handler
679     guac.onname = function(name) {
680         connection_name = name;
681         updateTitle();
682     };
683
684     // Error handler
685     guac.onerror = function(error) {
686
687         // Disconnect, if connected
688         guac.disconnect();
689
690         // Display error message
691         GuacamoleUI.showError(error);
692         
693     };
694
695     // Disconnect on close
696     window.onunload = function() {
697         guac.disconnect();
698     };
699
700     // Handle clipboard events
701     GuacamoleUI.clipboard.onchange = function() {
702
703         var text = GuacamoleUI.clipboard.value;
704         guac.setClipboard(text);
705
706     };
707
708     // Ignore keypresses when clipboard is focused
709     GuacamoleUI.clipboard.onfocus = function() {
710         disableKeyboard();
711     };
712
713     // Capture keypresses when clipboard is not focused
714     GuacamoleUI.clipboard.onblur = function() {
715         enableKeyboard();
716     };
717
718     // Server copy handler
719     guac.onclipboard = function(data) {
720         GuacamoleUI.clipboard.value = data;
721     };
722
723     GuacamoleUI.keyboard.onkeydown = function(keysym) {
724         guac.sendKeyEvent(1, keysym);
725     };
726
727     GuacamoleUI.keyboard.onkeyup = function(keysym) {
728         guac.sendKeyEvent(0, keysym);
729     };
730
731     // Send Ctrl-Alt-Delete
732     GuacamoleUI.buttons.ctrlAltDelete.onclick = function() {
733
734         var KEYSYM_CTRL   = 0xFFE3;
735         var KEYSYM_ALT    = 0xFFE9;
736         var KEYSYM_DELETE = 0xFFFF;
737
738         guac.sendKeyEvent(1, KEYSYM_CTRL);
739         guac.sendKeyEvent(1, KEYSYM_ALT);
740         guac.sendKeyEvent(1, KEYSYM_DELETE);
741         guac.sendKeyEvent(0, KEYSYM_DELETE);
742         guac.sendKeyEvent(0, KEYSYM_ALT);
743         guac.sendKeyEvent(0, KEYSYM_CTRL);
744     };
745
746 };