]> git.proxmox.com Git - mirror_novnc.git/blame - app/ui.js
Properly center status message in vnc_lite
[mirror_novnc.git] / app / ui.js
CommitLineData
15046f00
JM
1/*
2 * noVNC: HTML5 VNC client
d58f8b51 3 * Copyright (C) 2012 Joel Martin
777cb7a0 4 * Copyright (C) 2016 Samuel Mannehed for Cendio AB
6cba147d 5 * Copyright (C) 2016 Pierre Ossman for Cendio AB
1d728ace 6 * Licensed under MPL 2.0 (see LICENSE.txt)
15046f00
JM
7 *
8 * See README.md for usage and integration instructions.
9 */
43cf7bd8 10
bbbf42bb 11/* jslint white: false, browser: true */
ae510306
SR
12/* global window, document.getElementById, Util, WebUtil, RFB, Display */
13
6d6f0db0 14import * as Log from '../core/util/logging.js';
7ca650b7 15import _, { l10n } from '../core/util/localization.js';
6d6f0db0
SR
16import { isTouchDevice, browserSupportsCursorURIs as cursorURIsSupported } from '../core/util/browsers.js';
17import { setCapture, getPointerEvent } from '../core/util/events.js';
3ae0bb09
SR
18import KeyTable from "../core/input/keysym.js";
19import keysyms from "../core/input/keysymdef.js";
867daa98 20import Keyboard from "../core/input/keyboard.js";
3ae0bb09
SR
21import RFB from "../core/rfb.js";
22import Display from "../core/display.js";
6d6f0db0 23import * as WebUtil from "./webutil.js";
bbbf42bb 24
858ea4a7 25var UI = {
6d6f0db0
SR
26
27 connected: false,
28 desktopName: "",
29
30 resizeTimeout: null,
31 statusTimeout: null,
32 hideKeyboardTimeout: null,
33 idleControlbarTimeout: null,
34 closeControlbarTimeout: null,
35
36 controlbarGrabbed: false,
37 controlbarDrag: false,
38 controlbarMouseDownClientY: 0,
39 controlbarMouseDownOffsetY: 0,
40
41 isSafari: false,
6d6f0db0
SR
42 lastKeyboardinput: null,
43 defaultKeyboardinputLen: 100,
44
45 inhibit_reconnect: true,
46 reconnect_callback: null,
47 reconnect_password: null,
48
49 prime: function(callback) {
50 if (document.readyState === "interactive" || document.readyState === "complete") {
51 UI.load(callback);
52 } else {
53 document.addEventListener('DOMContentLoaded', UI.load.bind(UI, callback));
54 }
55 },
529c64e1 56
6d6f0db0
SR
57 // Setup rfb object, load settings from browser storage, then call
58 // UI.init to setup the UI/menus
59 load: function(callback) {
60 WebUtil.initSettings(UI.start, callback);
61 },
529c64e1 62
6d6f0db0
SR
63 // Render default UI and initialize settings menu
64 start: function(callback) {
044d54ed 65
6d6f0db0
SR
66 // Setup global variables first
67 UI.isSafari = (navigator.userAgent.indexOf('Safari') !== -1 &&
68 navigator.userAgent.indexOf('Chrome') === -1);
bbbf42bb 69
6d6f0db0 70 UI.initSettings();
0f6af1e3 71
6d6f0db0
SR
72 // Translate the DOM
73 l10n.translateDOM();
0f6af1e3 74
6d6f0db0
SR
75 // Adapt the interface for touch screen devices
76 if (isTouchDevice) {
77 document.documentElement.classList.add("noVNC_touch");
78 // Remove the address bar
79 setTimeout(function() { window.scrollTo(0, 1); }, 100);
80 }
0f6af1e3 81
6d6f0db0
SR
82 // Restore control bar position
83 if (WebUtil.readSetting('controlbar_pos') === 'right') {
84 UI.toggleControlbarSide();
85 }
edffd9e2 86
6d6f0db0 87 UI.initFullscreen();
0f6af1e3 88
6d6f0db0
SR
89 // Setup event handlers
90 UI.addResizeHandlers();
91 UI.addControlbarHandlers();
92 UI.addTouchSpecificHandlers();
93 UI.addExtraKeysHandlers();
94 UI.addXvpHandlers();
95 UI.addConnectionControlHandlers();
96 UI.addClipboardHandlers();
97 UI.addSettingsHandlers();
98 document.getElementById("noVNC_status")
99 .addEventListener('click', UI.hideStatus);
cf348b78 100
55988e7a
PO
101 // Bootstrap fallback input handler
102 UI.keyboardinputReset();
103
6d6f0db0 104 UI.openControlbar();
b3d91b78 105
6d6f0db0 106 UI.updateViewClip();
0f6af1e3 107
6d6f0db0 108 UI.updateVisualState();
b3c932c3 109
e25f9c40 110 document.documentElement.classList.remove("noVNC_loading");
0f6af1e3 111
6d6f0db0
SR
112 var autoconnect = WebUtil.getConfigVar('autoconnect', false);
113 if (autoconnect === 'true' || autoconnect == '1') {
114 autoconnect = true;
115 UI.connect();
116 } else {
117 autoconnect = false;
067accb8
GK
118 // Show the connect panel on first load unless autoconnecting
119 UI.openConnectPanel();
6d6f0db0 120 }
0f6af1e3 121
6d6f0db0
SR
122 if (typeof callback === "function") {
123 callback(UI.rfb);
124 }
125 },
126
127 initFullscreen: function() {
128 // Only show the button if fullscreen is properly supported
129 // * Safari doesn't support alphanumerical input while in fullscreen
130 if (!UI.isSafari &&
131 (document.documentElement.requestFullscreen ||
132 document.documentElement.mozRequestFullScreen ||
133 document.documentElement.webkitRequestFullscreen ||
134 document.body.msRequestFullscreen)) {
135 document.getElementById('noVNC_fullscreen_button')
136 .classList.remove("noVNC_hidden");
137 UI.addFullscreenHandlers();
138 }
139 },
0f6af1e3 140
6d6f0db0
SR
141 initSettings: function() {
142 var i;
0f6af1e3 143
6d6f0db0
SR
144 // Logging selection dropdown
145 var llevels = ['error', 'warn', 'info', 'debug'];
146 for (i = 0; i < llevels.length; i += 1) {
147 UI.addOption(document.getElementById('noVNC_setting_logging'),llevels[i], llevels[i]);
148 }
b3d91b78 149
6d6f0db0
SR
150 // Settings with immediate effects
151 UI.initSetting('logging', 'warn');
152 UI.updateLogging();
bbbf42bb 153
6d6f0db0
SR
154 // if port == 80 (or 443) then it won't be present and should be
155 // set manually
156 var port = window.location.port;
157 if (!port) {
158 if (window.location.protocol.substring(0,5) == 'https') {
159 port = 443;
bbbf42bb 160 }
6d6f0db0
SR
161 else if (window.location.protocol.substring(0,4) == 'http') {
162 port = 80;
bbbf42bb 163 }
6d6f0db0 164 }
bbbf42bb 165
6d6f0db0
SR
166 /* Populate the controls if defaults are provided in the URL */
167 UI.initSetting('host', window.location.hostname);
168 UI.initSetting('port', port);
169 UI.initSetting('encrypt', (window.location.protocol === "https:"));
6d6f0db0 170 UI.initSetting('cursor', !isTouchDevice);
a49ade5f 171 UI.initSetting('view_clip', false);
6d6f0db0
SR
172 UI.initSetting('resize', 'off');
173 UI.initSetting('shared', true);
174 UI.initSetting('view_only', false);
175 UI.initSetting('path', 'websockify');
176 UI.initSetting('repeaterID', '');
177 UI.initSetting('reconnect', false);
178 UI.initSetting('reconnect_delay', 5000);
179
180 UI.setupSettingLabels();
181 },
182 // Adds a link to the label elements on the corresponding input elements
183 setupSettingLabels: function() {
184 var labels = document.getElementsByTagName('LABEL');
185 for (var i = 0; i < labels.length; i++) {
186 var htmlFor = labels[i].htmlFor;
187 if (htmlFor != '') {
188 var elem = document.getElementById(htmlFor);
189 if (elem) elem.label = labels[i];
190 } else {
191 // If 'for' isn't set, use the first input element child
192 var children = labels[i].children;
193 for (var j = 0; j < children.length; j++) {
194 if (children[j].form !== undefined) {
195 children[j].label = labels[i];
196 break;
24584cca
SM
197 }
198 }
199 }
6d6f0db0
SR
200 }
201 },
59387b34 202
6d6f0db0
SR
203 initRFB: function() {
204 try {
205 UI.rfb = new RFB({'target': document.getElementById('noVNC_canvas'),
206 'onNotification': UI.notification,
207 'onUpdateState': UI.updateState,
208 'onDisconnected': UI.disconnectFinished,
209 'onPasswordRequired': UI.passwordRequired,
210 'onXvpInit': UI.updateXvpButton,
211 'onClipboard': UI.clipboardReceive,
212 'onBell': UI.bell,
213 'onFBUComplete': UI.initialResize,
214 'onFBResize': UI.updateSessionSize,
215 'onDesktopName': UI.updateDesktopName});
216 return true;
217 } catch (exc) {
218 var msg = "Unable to create RFB client -- " + exc;
219 Log.Error(msg);
220 UI.showStatus(msg, 'error');
221 return false;
222 }
223 },
59387b34 224
6d6f0db0
SR
225/* ------^-------
226* /INIT
227* ==============
228* EVENT HANDLERS
229* ------v------*/
230
231 addResizeHandlers: function() {
232 window.addEventListener('resize', UI.applyResizeMode);
233 window.addEventListener('resize', UI.updateViewClip);
234 },
235
236 addControlbarHandlers: function() {
237 document.getElementById("noVNC_control_bar")
238 .addEventListener('mousemove', UI.activateControlbar);
239 document.getElementById("noVNC_control_bar")
240 .addEventListener('mouseup', UI.activateControlbar);
241 document.getElementById("noVNC_control_bar")
242 .addEventListener('mousedown', UI.activateControlbar);
243 document.getElementById("noVNC_control_bar")
06fe4a3e 244 .addEventListener('keydown', UI.activateControlbar);
6d6f0db0
SR
245
246 document.getElementById("noVNC_control_bar")
247 .addEventListener('mousedown', UI.keepControlbar);
248 document.getElementById("noVNC_control_bar")
06fe4a3e 249 .addEventListener('keydown', UI.keepControlbar);
6d6f0db0
SR
250
251 document.getElementById("noVNC_view_drag_button")
252 .addEventListener('click', UI.toggleViewDrag);
253
254 document.getElementById("noVNC_control_bar_handle")
255 .addEventListener('mousedown', UI.controlbarHandleMouseDown);
256 document.getElementById("noVNC_control_bar_handle")
257 .addEventListener('mouseup', UI.controlbarHandleMouseUp);
258 document.getElementById("noVNC_control_bar_handle")
259 .addEventListener('mousemove', UI.dragControlbarHandle);
260 // resize events aren't available for elements
261 window.addEventListener('resize', UI.updateControlbarHandle);
262
263 var exps = document.getElementsByClassName("noVNC_expander");
264 for (var i = 0;i < exps.length;i++) {
265 exps[i].addEventListener('click', UI.toggleExpander);
266 }
267 },
268
269 addTouchSpecificHandlers: function() {
270 document.getElementById("noVNC_mouse_button0")
271 .addEventListener('click', function () { UI.setMouseButton(1); });
272 document.getElementById("noVNC_mouse_button1")
273 .addEventListener('click', function () { UI.setMouseButton(2); });
274 document.getElementById("noVNC_mouse_button2")
275 .addEventListener('click', function () { UI.setMouseButton(4); });
276 document.getElementById("noVNC_mouse_button4")
277 .addEventListener('click', function () { UI.setMouseButton(0); });
278 document.getElementById("noVNC_keyboard_button")
279 .addEventListener('click', UI.toggleVirtualKeyboard);
280
867daa98
PO
281 UI.touchKeyboard = new Keyboard({target: document.getElementById('noVNC_keyboardinput'),
282 onKeyEvent: UI.keyEvent});
283 UI.touchKeyboard.grab();
6d6f0db0
SR
284 document.getElementById("noVNC_keyboardinput")
285 .addEventListener('input', UI.keyInput);
286 document.getElementById("noVNC_keyboardinput")
287 .addEventListener('focus', UI.onfocusVirtualKeyboard);
288 document.getElementById("noVNC_keyboardinput")
289 .addEventListener('blur', UI.onblurVirtualKeyboard);
290 document.getElementById("noVNC_keyboardinput")
291 .addEventListener('submit', function () { return false; });
292
293 document.documentElement
294 .addEventListener('mousedown', UI.keepVirtualKeyboard, true);
2afda544
PO
295 document.documentElement
296 .addEventListener('touchstart', UI.keepVirtualKeyboard, true);
6d6f0db0
SR
297
298 document.getElementById("noVNC_control_bar")
299 .addEventListener('touchstart', UI.activateControlbar);
300 document.getElementById("noVNC_control_bar")
301 .addEventListener('touchmove', UI.activateControlbar);
302 document.getElementById("noVNC_control_bar")
303 .addEventListener('touchend', UI.activateControlbar);
304 document.getElementById("noVNC_control_bar")
305 .addEventListener('input', UI.activateControlbar);
306
307 document.getElementById("noVNC_control_bar")
308 .addEventListener('touchstart', UI.keepControlbar);
309 document.getElementById("noVNC_control_bar")
310 .addEventListener('input', UI.keepControlbar);
311
312 document.getElementById("noVNC_control_bar_handle")
313 .addEventListener('touchstart', UI.controlbarHandleMouseDown);
314 document.getElementById("noVNC_control_bar_handle")
315 .addEventListener('touchend', UI.controlbarHandleMouseUp);
316 document.getElementById("noVNC_control_bar_handle")
317 .addEventListener('touchmove', UI.dragControlbarHandle);
6d6f0db0
SR
318 },
319
320 addExtraKeysHandlers: function() {
321 document.getElementById("noVNC_toggle_extra_keys_button")
322 .addEventListener('click', UI.toggleExtraKeys);
323 document.getElementById("noVNC_toggle_ctrl_button")
324 .addEventListener('click', UI.toggleCtrl);
325 document.getElementById("noVNC_toggle_alt_button")
326 .addEventListener('click', UI.toggleAlt);
327 document.getElementById("noVNC_send_tab_button")
328 .addEventListener('click', UI.sendTab);
329 document.getElementById("noVNC_send_esc_button")
330 .addEventListener('click', UI.sendEsc);
331 document.getElementById("noVNC_send_ctrl_alt_del_button")
332 .addEventListener('click', UI.sendCtrlAltDel);
333 },
334
335 addXvpHandlers: function() {
336 document.getElementById("noVNC_xvp_shutdown_button")
337 .addEventListener('click', function() { UI.rfb.xvpShutdown(); });
338 document.getElementById("noVNC_xvp_reboot_button")
339 .addEventListener('click', function() { UI.rfb.xvpReboot(); });
340 document.getElementById("noVNC_xvp_reset_button")
341 .addEventListener('click', function() { UI.rfb.xvpReset(); });
342 document.getElementById("noVNC_xvp_button")
343 .addEventListener('click', UI.toggleXvpPanel);
344 },
345
346 addConnectionControlHandlers: function() {
347 document.getElementById("noVNC_disconnect_button")
348 .addEventListener('click', UI.disconnect);
349 document.getElementById("noVNC_connect_button")
350 .addEventListener('click', UI.connect);
351 document.getElementById("noVNC_cancel_reconnect_button")
352 .addEventListener('click', UI.cancelReconnect);
353
354 document.getElementById("noVNC_password_button")
355 .addEventListener('click', UI.setPassword);
356 },
357
358 addClipboardHandlers: function() {
359 document.getElementById("noVNC_clipboard_button")
360 .addEventListener('click', UI.toggleClipboardPanel);
6d6f0db0
SR
361 document.getElementById("noVNC_clipboard_text")
362 .addEventListener('change', UI.clipboardSend);
363 document.getElementById("noVNC_clipboard_clear_button")
364 .addEventListener('click', UI.clipboardClear);
365 },
366
367 // Add a call to save settings when the element changes,
368 // unless the optional parameter changeFunc is used instead.
369 addSettingChangeHandler: function(name, changeFunc) {
370 var settingElem = document.getElementById("noVNC_setting_" + name);
371 if (changeFunc === undefined) {
372 changeFunc = function () { UI.saveSetting(name); };
373 }
374 settingElem.addEventListener('change', changeFunc);
375 },
376
377 addSettingsHandlers: function() {
378 document.getElementById("noVNC_settings_button")
379 .addEventListener('click', UI.toggleSettingsPanel);
380
381 UI.addSettingChangeHandler('encrypt');
6d6f0db0
SR
382 UI.addSettingChangeHandler('cursor');
383 UI.addSettingChangeHandler('cursor', UI.updateLocalCursor);
384 UI.addSettingChangeHandler('resize');
385 UI.addSettingChangeHandler('resize', UI.enableDisableViewClip);
386 UI.addSettingChangeHandler('resize', UI.applyResizeMode);
a49ade5f
SM
387 UI.addSettingChangeHandler('view_clip');
388 UI.addSettingChangeHandler('view_clip', UI.updateViewClip);
6d6f0db0
SR
389 UI.addSettingChangeHandler('shared');
390 UI.addSettingChangeHandler('view_only');
391 UI.addSettingChangeHandler('view_only', UI.updateViewOnly);
392 UI.addSettingChangeHandler('host');
393 UI.addSettingChangeHandler('port');
394 UI.addSettingChangeHandler('path');
395 UI.addSettingChangeHandler('repeaterID');
396 UI.addSettingChangeHandler('logging');
397 UI.addSettingChangeHandler('logging', UI.updateLogging);
398 UI.addSettingChangeHandler('reconnect');
399 UI.addSettingChangeHandler('reconnect_delay');
400 },
401
402 addFullscreenHandlers: function() {
403 document.getElementById("noVNC_fullscreen_button")
404 .addEventListener('click', UI.toggleFullscreen);
405
406 window.addEventListener('fullscreenchange', UI.updateFullscreenButton);
407 window.addEventListener('mozfullscreenchange', UI.updateFullscreenButton);
408 window.addEventListener('webkitfullscreenchange', UI.updateFullscreenButton);
409 window.addEventListener('msfullscreenchange', UI.updateFullscreenButton);
410 },
0f6af1e3 411
95dd6001 412/* ------^-------
59387b34 413 * /EVENT HANDLERS
95dd6001 414 * ==============
415 * VISUAL
416 * ------v------*/
58ded70d 417
6d6f0db0
SR
418 updateState: function(rfb, state, oldstate) {
419 var msg;
420
421 document.documentElement.classList.remove("noVNC_connecting");
422 document.documentElement.classList.remove("noVNC_connected");
423 document.documentElement.classList.remove("noVNC_disconnecting");
424 document.documentElement.classList.remove("noVNC_reconnecting");
425
426 switch (state) {
427 case 'connecting':
428 document.getElementById("noVNC_transition_text").textContent = _("Connecting...");
429 document.documentElement.classList.add("noVNC_connecting");
430 break;
431 case 'connected':
432 UI.connected = true;
433 UI.inhibit_reconnect = false;
434 document.documentElement.classList.add("noVNC_connected");
435 if (rfb && rfb.get_encrypt()) {
436 msg = _("Connected (encrypted) to ") + UI.desktopName;
437 } else {
438 msg = _("Connected (unencrypted) to ") + UI.desktopName;
439 }
440 UI.showStatus(msg);
2afda544 441 document.getElementById('noVNC_canvas').focus();
6d6f0db0
SR
442 break;
443 case 'disconnecting':
444 UI.connected = false;
445 document.getElementById("noVNC_transition_text").textContent = _("Disconnecting...");
446 document.documentElement.classList.add("noVNC_disconnecting");
447 break;
448 case 'disconnected':
449 UI.showStatus(_("Disconnected"));
450 break;
451 default:
452 msg = "Invalid UI state";
453 Log.Error(msg);
454 UI.showStatus(msg, 'error');
455 break;
456 }
8d710e8b 457
6d6f0db0
SR
458 UI.updateVisualState();
459 },
8d710e8b 460
6d6f0db0
SR
461 // Disable/enable controls depending on connection state
462 updateVisualState: function() {
463 //Log.Debug(">> updateVisualState");
29475d77 464
6d6f0db0 465 UI.enableDisableViewClip();
fdedbafb 466
6d6f0db0
SR
467 if (cursorURIsSupported() && !isTouchDevice) {
468 UI.enableSetting('cursor');
469 } else {
470 UI.disableSetting('cursor');
471 }
fdedbafb 472
6d6f0db0
SR
473 if (UI.connected) {
474 UI.disableSetting('encrypt');
6d6f0db0
SR
475 UI.disableSetting('shared');
476 UI.disableSetting('host');
477 UI.disableSetting('port');
478 UI.disableSetting('path');
479 UI.disableSetting('repeaterID');
480 UI.updateViewClip();
481 UI.setMouseButton(1);
482
483 // Hide the controlbar after 2 seconds
484 UI.closeControlbarTimeout = setTimeout(UI.closeControlbar, 2000);
485 } else {
486 UI.enableSetting('encrypt');
6d6f0db0
SR
487 UI.enableSetting('shared');
488 UI.enableSetting('host');
489 UI.enableSetting('port');
490 UI.enableSetting('path');
491 UI.enableSetting('repeaterID');
492 UI.updateXvpButton(0);
493 UI.keepControlbar();
494 }
fdedbafb 495
6d6f0db0
SR
496 // Hide input related buttons in view only mode
497 if (UI.rfb && UI.rfb.get_view_only()) {
498 document.getElementById('noVNC_keyboard_button')
499 .classList.add('noVNC_hidden');
500 document.getElementById('noVNC_toggle_extra_keys_button')
501 .classList.add('noVNC_hidden');
502 } else {
503 document.getElementById('noVNC_keyboard_button')
504 .classList.remove('noVNC_hidden');
505 document.getElementById('noVNC_toggle_extra_keys_button')
506 .classList.remove('noVNC_hidden');
507 }
fdedbafb 508
6d6f0db0
SR
509 // State change disables viewport dragging.
510 // It is enabled (toggled) by direct click on the button
511 UI.setViewDrag(false);
fdedbafb 512
6d6f0db0
SR
513 // State change also closes the password dialog
514 document.getElementById('noVNC_password_dlg')
515 .classList.remove('noVNC_open');
eef91bf9 516
6d6f0db0
SR
517 //Log.Debug("<< updateVisualState");
518 },
29475d77 519
6d6f0db0
SR
520 showStatus: function(text, status_type, time) {
521 var statusElem = document.getElementById('noVNC_status');
8a7ec6ea 522
6d6f0db0 523 clearTimeout(UI.statusTimeout);
29475d77 524
6d6f0db0
SR
525 if (typeof status_type === 'undefined') {
526 status_type = 'normal';
527 }
4e471b5b 528
6d6f0db0
SR
529 statusElem.classList.remove("noVNC_status_normal");
530 statusElem.classList.remove("noVNC_status_warn");
531 statusElem.classList.remove("noVNC_status_error");
532
533 switch (status_type) {
534 case 'warning':
535 case 'warn':
536 statusElem.classList.add("noVNC_status_warn");
537 break;
538 case 'error':
539 statusElem.classList.add("noVNC_status_error");
540 break;
541 case 'normal':
542 case 'info':
543 default:
544 statusElem.classList.add("noVNC_status_normal");
545 break;
546 }
8d7708c8 547
6d6f0db0
SR
548 statusElem.textContent = text;
549 statusElem.classList.add("noVNC_open");
8d7708c8 550
6d6f0db0
SR
551 // If no time was specified, show the status for 1.5 seconds
552 if (typeof time === 'undefined') {
553 time = 1500;
554 }
8d7708c8 555
6d6f0db0
SR
556 // Error messages do not timeout
557 if (status_type !== 'error') {
558 UI.statusTimeout = window.setTimeout(UI.hideStatus, time);
559 }
560 },
561
562 hideStatus: function() {
563 clearTimeout(UI.statusTimeout);
564 document.getElementById('noVNC_status').classList.remove("noVNC_open");
565 },
566
567 notification: function (rfb, msg, level, options) {
568 UI.showStatus(msg, level);
569 },
570
571 activateControlbar: function(event) {
572 clearTimeout(UI.idleControlbarTimeout);
573 // We manipulate the anchor instead of the actual control
574 // bar in order to avoid creating new a stacking group
575 document.getElementById('noVNC_control_bar_anchor')
576 .classList.remove("noVNC_idle");
577 UI.idleControlbarTimeout = window.setTimeout(UI.idleControlbar, 2000);
578 },
579
580 idleControlbar: function() {
581 document.getElementById('noVNC_control_bar_anchor')
582 .classList.add("noVNC_idle");
583 },
584
585 keepControlbar: function() {
586 clearTimeout(UI.closeControlbarTimeout);
587 },
588
589 openControlbar: function() {
590 document.getElementById('noVNC_control_bar')
591 .classList.add("noVNC_open");
592 },
593
594 closeControlbar: function() {
595 UI.closeAllPanels();
596 document.getElementById('noVNC_control_bar')
597 .classList.remove("noVNC_open");
598 },
599
600 toggleControlbar: function() {
601 if (document.getElementById('noVNC_control_bar')
602 .classList.contains("noVNC_open")) {
603 UI.closeControlbar();
604 } else {
605 UI.openControlbar();
606 }
607 },
608
609 toggleControlbarSide: function () {
610 // Temporarily disable animation to avoid weird movement
611 var bar = document.getElementById('noVNC_control_bar');
612 bar.style.transitionDuration = '0s';
613 bar.addEventListener('transitionend', function () { this.style.transitionDuration = ""; });
614
615 var anchor = document.getElementById('noVNC_control_bar_anchor');
616 if (anchor.classList.contains("noVNC_right")) {
617 WebUtil.writeSetting('controlbar_pos', 'left');
618 anchor.classList.remove("noVNC_right");
619 } else {
620 WebUtil.writeSetting('controlbar_pos', 'right');
621 anchor.classList.add("noVNC_right");
622 }
ca5c74ad 623
6d6f0db0
SR
624 // Consider this a movement of the handle
625 UI.controlbarDrag = true;
626 },
4e471b5b 627
bbc1648c
SM
628 showControlbarHint: function (show) {
629 var hint = document.getElementById('noVNC_control_bar_hint');
630 if (show) {
631 hint.classList.add("noVNC_active");
632 } else {
633 hint.classList.remove("noVNC_active");
634 }
635 },
636
6d6f0db0
SR
637 dragControlbarHandle: function (e) {
638 if (!UI.controlbarGrabbed) return;
38323d4d 639
6d6f0db0 640 var ptr = getPointerEvent(e);
8ee432f1 641
6d6f0db0
SR
642 var anchor = document.getElementById('noVNC_control_bar_anchor');
643 if (ptr.clientX < (window.innerWidth * 0.1)) {
cf348b78 644 if (anchor.classList.contains("noVNC_right")) {
6d6f0db0 645 UI.toggleControlbarSide();
8ee432f1 646 }
6d6f0db0
SR
647 } else if (ptr.clientX > (window.innerWidth * 0.9)) {
648 if (!anchor.classList.contains("noVNC_right")) {
649 UI.toggleControlbarSide();
04b399e2 650 }
6d6f0db0 651 }
04b399e2 652
6d6f0db0
SR
653 if (!UI.controlbarDrag) {
654 // The goal is to trigger on a certain physical width, the
655 // devicePixelRatio brings us a bit closer but is not optimal.
656 var dragThreshold = 10 * (window.devicePixelRatio || 1);
657 var dragDistance = Math.abs(ptr.clientY - UI.controlbarMouseDownClientY);
04b399e2 658
6d6f0db0 659 if (dragDistance < dragThreshold) return;
04b399e2 660
6d6f0db0
SR
661 UI.controlbarDrag = true;
662 }
f75e4d3c 663
6d6f0db0 664 var eventY = ptr.clientY - UI.controlbarMouseDownOffsetY;
04b399e2 665
6d6f0db0 666 UI.moveControlbarHandle(eventY);
59cd99bc 667
6d6f0db0
SR
668 e.preventDefault();
669 e.stopPropagation();
670 UI.keepControlbar();
671 UI.activateControlbar();
672 },
04b399e2 673
6d6f0db0
SR
674 // Move the handle but don't allow any position outside the bounds
675 moveControlbarHandle: function (viewportRelativeY) {
676 var handle = document.getElementById("noVNC_control_bar_handle");
677 var handleHeight = handle.getBoundingClientRect().height;
678 var controlbarBounds = document.getElementById("noVNC_control_bar")
679 .getBoundingClientRect();
680 var margin = 10;
04b399e2 681
6d6f0db0
SR
682 // These heights need to be non-zero for the below logic to work
683 if (handleHeight === 0 || controlbarBounds.height === 0) {
684 return;
685 }
04b399e2 686
6d6f0db0 687 var newY = viewportRelativeY;
04b399e2 688
6d6f0db0
SR
689 // Check if the coordinates are outside the control bar
690 if (newY < controlbarBounds.top + margin) {
691 // Force coordinates to be below the top of the control bar
692 newY = controlbarBounds.top + margin;
04b399e2 693
6d6f0db0
SR
694 } else if (newY > controlbarBounds.top +
695 controlbarBounds.height - handleHeight - margin) {
696 // Force coordinates to be above the bottom of the control bar
697 newY = controlbarBounds.top +
698 controlbarBounds.height - handleHeight - margin;
699 }
04b399e2 700
6d6f0db0
SR
701 // Corner case: control bar too small for stable position
702 if (controlbarBounds.height < (handleHeight + margin * 2)) {
703 newY = controlbarBounds.top +
704 (controlbarBounds.height - handleHeight) / 2;
705 }
04b399e2 706
6d6f0db0
SR
707 // The transform needs coordinates that are relative to the parent
708 var parentRelativeY = newY - controlbarBounds.top;
709 handle.style.transform = "translateY(" + parentRelativeY + "px)";
710 },
711
712 updateControlbarHandle: function () {
713 // Since the control bar is fixed on the viewport and not the page,
714 // the move function expects coordinates relative the the viewport.
715 var handle = document.getElementById("noVNC_control_bar_handle");
716 var handleBounds = handle.getBoundingClientRect();
717 UI.moveControlbarHandle(handleBounds.top);
718 },
719
720 controlbarHandleMouseUp: function(e) {
721 if ((e.type == "mouseup") && (e.button != 0)) return;
722
723 // mouseup and mousedown on the same place toggles the controlbar
724 if (UI.controlbarGrabbed && !UI.controlbarDrag) {
725 UI.toggleControlbar();
04b399e2
SM
726 e.preventDefault();
727 e.stopPropagation();
de315d62
PO
728 UI.keepControlbar();
729 UI.activateControlbar();
6d6f0db0
SR
730 }
731 UI.controlbarGrabbed = false;
bbc1648c 732 UI.showControlbarHint(false);
6d6f0db0
SR
733 },
734
735 controlbarHandleMouseDown: function(e) {
736 if ((e.type == "mousedown") && (e.button != 0)) return;
737
738 var ptr = getPointerEvent(e);
739
740 var handle = document.getElementById("noVNC_control_bar_handle");
741 var bounds = handle.getBoundingClientRect();
742
333ad45c
SM
743 // Touch events have implicit capture
744 if (e.type === "mousedown") {
745 setCapture(handle);
746 }
747
6d6f0db0
SR
748 UI.controlbarGrabbed = true;
749 UI.controlbarDrag = false;
750
bbc1648c
SM
751 UI.showControlbarHint(true);
752
6d6f0db0
SR
753 UI.controlbarMouseDownClientY = ptr.clientY;
754 UI.controlbarMouseDownOffsetY = ptr.clientY - bounds.top;
755 e.preventDefault();
756 e.stopPropagation();
757 UI.keepControlbar();
758 UI.activateControlbar();
759 },
760
761 toggleExpander: function(e) {
762 if (this.classList.contains("noVNC_open")) {
763 this.classList.remove("noVNC_open");
764 } else {
765 this.classList.add("noVNC_open");
766 }
767 },
575f6983 768
95dd6001 769/* ------^-------
770 * /VISUAL
771 * ==============
772 * SETTINGS
773 * ------v------*/
774
6d6f0db0
SR
775 // Initial page load read/initialization of settings
776 initSetting: function(name, defVal) {
777 // Check Query string followed by cookie
778 var val = WebUtil.getConfigVar(name);
779 if (val === null) {
780 val = WebUtil.readSetting(name, defVal);
781 }
782 UI.updateSetting(name, val);
783 return val;
784 },
bbbf42bb 785
6d6f0db0
SR
786 // Update cookie and form control setting. If value is not set, then
787 // updates from control to current cookie setting.
788 updateSetting: function(name, value) {
bbbf42bb 789
6d6f0db0
SR
790 // Save the cookie for this session
791 if (typeof value !== 'undefined') {
792 WebUtil.writeSetting(name, value);
793 }
bbbf42bb 794
6d6f0db0
SR
795 // Update the settings control
796 value = UI.getSetting(name);
bbbf42bb 797
6d6f0db0
SR
798 var ctrl = document.getElementById('noVNC_setting_' + name);
799 if (ctrl.type === 'checkbox') {
800 ctrl.checked = value;
bbbf42bb 801
6d6f0db0
SR
802 } else if (typeof ctrl.options !== 'undefined') {
803 for (var i = 0; i < ctrl.options.length; i += 1) {
804 if (ctrl.options[i].value === value) {
805 ctrl.selectedIndex = i;
806 break;
bbbf42bb 807 }
bbbf42bb 808 }
6d6f0db0
SR
809 } else {
810 /*Weird IE9 error leads to 'null' appearring
811 in textboxes instead of ''.*/
812 if (value === null) {
813 value = "";
bbbf42bb 814 }
6d6f0db0
SR
815 ctrl.value = value;
816 }
817 },
818
819 // Save control setting to cookie
820 saveSetting: function(name) {
821 var val, ctrl = document.getElementById('noVNC_setting_' + name);
822 if (ctrl.type === 'checkbox') {
823 val = ctrl.checked;
824 } else if (typeof ctrl.options !== 'undefined') {
825 val = ctrl.options[ctrl.selectedIndex].value;
826 } else {
827 val = ctrl.value;
828 }
829 WebUtil.writeSetting(name, val);
830 //Log.Debug("Setting saved '" + name + "=" + val + "'");
831 return val;
832 },
833
834 // Read form control compatible setting from cookie
835 getSetting: function(name) {
836 var ctrl = document.getElementById('noVNC_setting_' + name);
837 var val = WebUtil.readSetting(name);
838 if (typeof val !== 'undefined' && val !== null && ctrl.type === 'checkbox') {
839 if (val.toString().toLowerCase() in {'0':1, 'no':1, 'false':1}) {
840 val = false;
841 } else {
842 val = true;
bbbf42bb 843 }
6d6f0db0
SR
844 }
845 return val;
846 },
847
848 // These helpers compensate for the lack of parent-selectors and
849 // previous-sibling-selectors in CSS which are needed when we want to
850 // disable the labels that belong to disabled input elements.
851 disableSetting: function(name) {
852 var ctrl = document.getElementById('noVNC_setting_' + name);
853 ctrl.disabled = true;
854 ctrl.label.classList.add('noVNC_disabled');
855 },
856
857 enableSetting: function(name) {
858 var ctrl = document.getElementById('noVNC_setting_' + name);
859 ctrl.disabled = false;
860 ctrl.label.classList.remove('noVNC_disabled');
861 },
24584cca 862
ed8cbe4e
PO
863/* ------^-------
864 * /SETTINGS
865 * ==============
866 * PANELS
867 * ------v------*/
868
6d6f0db0
SR
869 closeAllPanels: function() {
870 UI.closeSettingsPanel();
871 UI.closeXvpPanel();
872 UI.closeClipboardPanel();
873 UI.closeExtraKeys();
874 },
ed8cbe4e
PO
875
876/* ------^-------
877 * /PANELS
878 * ==============
879 * SETTINGS (panel)
880 * ------v------*/
881
6d6f0db0
SR
882 openSettingsPanel: function() {
883 UI.closeAllPanels();
884 UI.openControlbar();
885
886 // Refresh UI elements from saved cookies
887 UI.updateSetting('encrypt');
6d6f0db0
SR
888 if (cursorURIsSupported()) {
889 UI.updateSetting('cursor');
890 } else {
891 UI.updateSetting('cursor', !isTouchDevice);
892 UI.disableSetting('cursor');
893 }
a49ade5f 894 UI.updateSetting('view_clip');
6d6f0db0
SR
895 UI.updateSetting('resize');
896 UI.updateSetting('shared');
897 UI.updateSetting('view_only');
898 UI.updateSetting('path');
899 UI.updateSetting('repeaterID');
900 UI.updateSetting('logging');
901 UI.updateSetting('reconnect');
902 UI.updateSetting('reconnect_delay');
903
904 document.getElementById('noVNC_settings')
905 .classList.add("noVNC_open");
906 document.getElementById('noVNC_settings_button')
907 .classList.add("noVNC_selected");
908 },
909
910 closeSettingsPanel: function() {
911 document.getElementById('noVNC_settings')
912 .classList.remove("noVNC_open");
913 document.getElementById('noVNC_settings_button')
914 .classList.remove("noVNC_selected");
915 },
916
917 toggleSettingsPanel: function() {
918 if (document.getElementById('noVNC_settings')
919 .classList.contains("noVNC_open")) {
920 UI.closeSettingsPanel();
921 } else {
922 UI.openSettingsPanel();
923 }
924 },
bbbf42bb 925
95dd6001 926/* ------^-------
927 * /SETTINGS
928 * ==============
929 * XVP
930 * ------v------*/
931
6d6f0db0
SR
932 openXvpPanel: function() {
933 UI.closeAllPanels();
934 UI.openControlbar();
935
936 document.getElementById('noVNC_xvp')
937 .classList.add("noVNC_open");
938 document.getElementById('noVNC_xvp_button')
939 .classList.add("noVNC_selected");
940 },
941
942 closeXvpPanel: function() {
943 document.getElementById('noVNC_xvp')
944 .classList.remove("noVNC_open");
945 document.getElementById('noVNC_xvp_button')
946 .classList.remove("noVNC_selected");
947 },
948
949 toggleXvpPanel: function() {
950 if (document.getElementById('noVNC_xvp')
951 .classList.contains("noVNC_open")) {
952 UI.closeXvpPanel();
953 } else {
954 UI.openXvpPanel();
955 }
956 },
ed8cbe4e 957
6d6f0db0
SR
958 // Disable/enable XVP button
959 updateXvpButton: function(ver) {
960 if (ver >= 1 && !UI.rfb.get_view_only()) {
ed8cbe4e 961 document.getElementById('noVNC_xvp_button')
6d6f0db0
SR
962 .classList.remove("noVNC_hidden");
963 } else {
ed8cbe4e 964 document.getElementById('noVNC_xvp_button')
6d6f0db0
SR
965 .classList.add("noVNC_hidden");
966 // Close XVP panel if open
967 UI.closeXvpPanel();
968 }
969 },
bbbf42bb 970
95dd6001 971/* ------^-------
972 * /XVP
973 * ==============
974 * CLIPBOARD
975 * ------v------*/
f8b399d7 976
6d6f0db0
SR
977 openClipboardPanel: function() {
978 UI.closeAllPanels();
979 UI.openControlbar();
980
981 document.getElementById('noVNC_clipboard')
982 .classList.add("noVNC_open");
983 document.getElementById('noVNC_clipboard_button')
984 .classList.add("noVNC_selected");
985 },
986
987 closeClipboardPanel: function() {
988 document.getElementById('noVNC_clipboard')
989 .classList.remove("noVNC_open");
990 document.getElementById('noVNC_clipboard_button')
991 .classList.remove("noVNC_selected");
992 },
993
994 toggleClipboardPanel: function() {
995 if (document.getElementById('noVNC_clipboard')
996 .classList.contains("noVNC_open")) {
997 UI.closeClipboardPanel();
998 } else {
999 UI.openClipboardPanel();
1000 }
1001 },
1002
1003 clipboardReceive: function(rfb, text) {
1004 Log.Debug(">> UI.clipboardReceive: " + text.substr(0,40) + "...");
1005 document.getElementById('noVNC_clipboard_text').value = text;
1006 Log.Debug("<< UI.clipboardReceive");
1007 },
1008
1009 clipboardClear: function() {
1010 document.getElementById('noVNC_clipboard_text').value = "";
1011 UI.rfb.clipboardPasteFrom("");
1012 },
1013
1014 clipboardSend: function() {
1015 var text = document.getElementById('noVNC_clipboard_text').value;
1016 Log.Debug(">> UI.clipboardSend: " + text.substr(0,40) + "...");
1017 UI.rfb.clipboardPasteFrom(text);
1018 Log.Debug("<< UI.clipboardSend");
1019 },
95dd6001 1020
1021/* ------^-------
1022 * /CLIPBOARD
1023 * ==============
1024 * CONNECTION
1025 * ------v------*/
1026
6d6f0db0
SR
1027 openConnectPanel: function() {
1028 document.getElementById('noVNC_connect_dlg')
1029 .classList.add("noVNC_open");
1030 },
b3c932c3 1031
6d6f0db0
SR
1032 closeConnectPanel: function() {
1033 document.getElementById('noVNC_connect_dlg')
1034 .classList.remove("noVNC_open");
1035 },
b3c932c3 1036
6d6f0db0
SR
1037 connect: function(event, password) {
1038 var host = UI.getSetting('host');
1039 var port = UI.getSetting('port');
1040 var path = UI.getSetting('path');
c55f05f6 1041
6d6f0db0
SR
1042 if (typeof password === 'undefined') {
1043 password = WebUtil.getConfigVar('password');
2e735160 1044 UI.reconnect_password = password;
6d6f0db0 1045 }
044d54ed 1046
6d6f0db0
SR
1047 if (password === null) {
1048 password = undefined;
1049 }
512d3605 1050
d593483e
PO
1051 if (!host) {
1052 var msg = _("Must set host");
6d6f0db0
SR
1053 Log.Error(msg);
1054 UI.showStatus(msg, 'error');
1055 return;
1056 }
53fc7392 1057
6d6f0db0 1058 if (!UI.initRFB()) return;
58ded70d 1059
6d6f0db0
SR
1060 UI.closeAllPanels();
1061 UI.closeConnectPanel();
4102b71c 1062
6d6f0db0 1063 UI.rfb.set_encrypt(UI.getSetting('encrypt'));
6d6f0db0
SR
1064 UI.rfb.set_shared(UI.getSetting('shared'));
1065 UI.rfb.set_repeaterID(UI.getSetting('repeaterID'));
53fc7392 1066
6d6f0db0
SR
1067 UI.updateLocalCursor();
1068 UI.updateViewOnly();
ef1e8bab 1069
6d6f0db0
SR
1070 UI.rfb.connect(host, port, password, path);
1071 },
5299db1a 1072
6d6f0db0
SR
1073 disconnect: function() {
1074 UI.closeAllPanels();
1075 UI.rfb.disconnect();
8e0f0088 1076
6d6f0db0
SR
1077 // Disable automatic reconnecting
1078 UI.inhibit_reconnect = true;
044d54ed 1079
6d6f0db0
SR
1080 // Restore the callback used for initial resize
1081 UI.rfb.set_onFBUComplete(UI.initialResize);
f8b399d7 1082
6d6f0db0
SR
1083 // Don't display the connection settings until we're actually disconnected
1084 },
bbbf42bb 1085
6d6f0db0
SR
1086 reconnect: function() {
1087 UI.reconnect_callback = null;
044d54ed 1088
6d6f0db0
SR
1089 // if reconnect has been disabled in the meantime, do nothing.
1090 if (UI.inhibit_reconnect) {
1091 return;
1092 }
044d54ed 1093
6d6f0db0
SR
1094 UI.connect(null, UI.reconnect_password);
1095 },
044d54ed 1096
6d6f0db0
SR
1097 disconnectFinished: function (rfb, reason) {
1098 if (typeof reason !== 'undefined') {
1099 UI.showStatus(reason, 'error');
1100 } else if (UI.getSetting('reconnect', false) === true && !UI.inhibit_reconnect) {
1101 document.getElementById("noVNC_transition_text").textContent = _("Reconnecting...");
1102 document.documentElement.classList.add("noVNC_reconnecting");
044d54ed 1103
6d6f0db0
SR
1104 var delay = parseInt(UI.getSetting('reconnect_delay'));
1105 UI.reconnect_callback = setTimeout(UI.reconnect, delay);
1106 return;
1107 }
044d54ed 1108
6d6f0db0
SR
1109 UI.openControlbar();
1110 UI.openConnectPanel();
1111 },
044d54ed 1112
6d6f0db0
SR
1113 cancelReconnect: function() {
1114 if (UI.reconnect_callback !== null) {
1115 clearTimeout(UI.reconnect_callback);
1116 UI.reconnect_callback = null;
1117 }
044d54ed 1118
6d6f0db0
SR
1119 document.documentElement.classList.remove("noVNC_reconnecting");
1120 UI.openControlbar();
1121 UI.openConnectPanel();
1122 },
3bb12056 1123
7d714b15
SM
1124/* ------^-------
1125 * /CONNECTION
1126 * ==============
1127 * PASSWORD
1128 * ------v------*/
1129
6d6f0db0 1130 passwordRequired: function(rfb, msg) {
7d714b15 1131
6d6f0db0
SR
1132 document.getElementById('noVNC_password_dlg')
1133 .classList.add('noVNC_open');
7d714b15 1134
6d6f0db0
SR
1135 setTimeout(function () {
1136 document.getElementById('noVNC_password_input').focus();
1137 }, 100);
7d714b15 1138
6d6f0db0
SR
1139 if (typeof msg === 'undefined') {
1140 msg = _("Password is required");
1141 }
1142 Log.Warn(msg);
1143 UI.showStatus(msg, "warning");
1144 },
1145
1146 setPassword: function(e) {
c23665dd
SM
1147 var inputElem = document.getElementById('noVNC_password_input');
1148 var password = inputElem.value;
1149 // Clear the input after reading the password
1150 inputElem.value = "";
6d6f0db0
SR
1151 UI.rfb.sendPassword(password);
1152 UI.reconnect_password = password;
1153 document.getElementById('noVNC_password_dlg')
1154 .classList.remove('noVNC_open');
1155 // Prevent actually submitting the form
1156 e.preventDefault();
1157 },
58ded70d 1158
95dd6001 1159/* ------^-------
7d714b15 1160 * /PASSWORD
95dd6001 1161 * ==============
1162 * FULLSCREEN
1163 * ------v------*/
1164
6d6f0db0
SR
1165 toggleFullscreen: function() {
1166 if (document.fullscreenElement || // alternative standard method
1167 document.mozFullScreenElement || // currently working methods
1168 document.webkitFullscreenElement ||
1169 document.msFullscreenElement) {
1170 if (document.exitFullscreen) {
1171 document.exitFullscreen();
1172 } else if (document.mozCancelFullScreen) {
1173 document.mozCancelFullScreen();
1174 } else if (document.webkitExitFullscreen) {
1175 document.webkitExitFullscreen();
1176 } else if (document.msExitFullscreen) {
1177 document.msExitFullscreen();
1178 }
1179 } else {
1180 if (document.documentElement.requestFullscreen) {
1181 document.documentElement.requestFullscreen();
1182 } else if (document.documentElement.mozRequestFullScreen) {
1183 document.documentElement.mozRequestFullScreen();
1184 } else if (document.documentElement.webkitRequestFullscreen) {
1185 document.documentElement.webkitRequestFullscreen(Element.ALLOW_KEYBOARD_INPUT);
1186 } else if (document.body.msRequestFullscreen) {
1187 document.body.msRequestFullscreen();
7d1dc09a 1188 }
6d6f0db0
SR
1189 }
1190 UI.enableDisableViewClip();
1191 UI.updateFullscreenButton();
1192 },
1193
1194 updateFullscreenButton: function() {
1195 if (document.fullscreenElement || // alternative standard method
1196 document.mozFullScreenElement || // currently working methods
1197 document.webkitFullscreenElement ||
1198 document.msFullscreenElement ) {
1199 document.getElementById('noVNC_fullscreen_button')
1200 .classList.add("noVNC_selected");
1201 } else {
1202 document.getElementById('noVNC_fullscreen_button')
1203 .classList.remove("noVNC_selected");
1204 }
1205 },
7d1dc09a 1206
95dd6001 1207/* ------^-------
1208 * /FULLSCREEN
1209 * ==============
1210 * RESIZE
1211 * ------v------*/
777cb7a0 1212
6d6f0db0
SR
1213 // Apply remote resizing or local scaling
1214 applyResizeMode: function() {
1215 if (!UI.rfb) return;
58ded70d 1216
6d6f0db0 1217 var screen = UI.screenSize();
777cb7a0 1218
6d6f0db0 1219 if (screen && UI.connected && UI.rfb.get_display()) {
777cb7a0 1220
6d6f0db0
SR
1221 var display = UI.rfb.get_display();
1222 var resizeMode = UI.getSetting('resize');
1223 display.set_scale(1);
777cb7a0 1224
6d6f0db0
SR
1225 // Make sure the viewport is adjusted first
1226 UI.updateViewClip();
6bfd9dc9 1227
6d6f0db0 1228 if (resizeMode === 'remote') {
777cb7a0 1229
6d6f0db0
SR
1230 // Request changing the resolution of the remote display to
1231 // the size of the local browser viewport.
777cb7a0 1232
6d6f0db0
SR
1233 // In order to not send multiple requests before the browser-resize
1234 // is finished we wait 0.5 seconds before sending the request.
1235 clearTimeout(UI.resizeTimeout);
1236 UI.resizeTimeout = setTimeout(function(){
1237 // Request a remote size covering the viewport
1238 if (UI.rfb.requestDesktopSize(screen.w, screen.h)) {
1239 Log.Debug('Requested new desktop size: ' +
1240 screen.w + 'x' + screen.h);
1241 }
1242 }, 500);
777cb7a0 1243
d1a1e0e5
PO
1244 } else {
1245 UI.updateScaling();
777cb7a0 1246 }
6d6f0db0
SR
1247 }
1248 },
1249
d1a1e0e5
PO
1250 // Re-calculate local scaling
1251 updateScaling: function() {
1252 if (!UI.rfb) return;
1253
1254 var resizeMode = UI.getSetting('resize');
1255 if (resizeMode !== 'scale' && resizeMode !== 'downscale') {
1256 return;
1257 }
1258
1259 var screen = UI.screenSize();
1260
1261 if (!screen || !UI.connected || !UI.rfb.get_display()) {
1262 return;
1263 }
1264
1265 var display = UI.rfb.get_display();
1266 var downscaleOnly = resizeMode === 'downscale';
1267 display.autoscale(screen.w, screen.h, downscaleOnly);
1268 UI.fixScrollbars();
1269 },
1270
6d6f0db0
SR
1271 // Gets the the size of the available viewport in the browser window
1272 screenSize: function() {
1273 var screen = document.getElementById('noVNC_screen');
1274 return {w: screen.offsetWidth, h: screen.offsetHeight};
1275 },
1276
1277 // Normally we only apply the current resize mode after a window resize
1278 // event. This means that when a new connection is opened, there is no
1279 // resize mode active.
1280 // We have to wait until the first FBU because this is where the client
1281 // will find the supported encodings of the server. Some calls later in
1282 // the chain is dependant on knowing the server-capabilities.
1283 initialResize: function(rfb, fbu) {
1284 UI.applyResizeMode();
1285 // After doing this once, we remove the callback.
1286 UI.rfb.set_onFBUComplete(function() { });
1287 },
bbbf42bb 1288
95dd6001 1289/* ------^-------
1290 * /RESIZE
1291 * ==============
a49ade5f 1292 * VIEW CLIPPING
95dd6001 1293 * ------v------*/
1294
6d6f0db0
SR
1295 // Set and configure viewport clipping
1296 setViewClip: function(clip) {
a49ade5f 1297 UI.updateSetting('view_clip', clip);
6d6f0db0
SR
1298 UI.updateViewClip();
1299 },
1300
a49ade5f 1301 // Update parameters that depend on the viewport clip setting
6d6f0db0
SR
1302 updateViewClip: function() {
1303 if (!UI.rfb) return;
1304
1305 var display = UI.rfb.get_display();
1306 var cur_clip = display.get_viewport();
a49ade5f 1307 var new_clip = UI.getSetting('view_clip');
6d6f0db0
SR
1308
1309 var resizeSetting = UI.getSetting('resize');
1310 if (resizeSetting === 'downscale' || resizeSetting === 'scale') {
a49ade5f 1311 // Disable viewport clipping if we are scaling
6d6f0db0
SR
1312 new_clip = false;
1313 } else if (isTouchDevice) {
1314 // Touch devices usually have shit scrollbars
1315 new_clip = true;
1316 }
5f38376a 1317
6d6f0db0
SR
1318 if (cur_clip !== new_clip) {
1319 display.set_viewport(new_clip);
1320 }
8e0f0088 1321
6d6f0db0 1322 var size = UI.screenSize();
fdedbafb 1323
6d6f0db0
SR
1324 if (new_clip && size) {
1325 // When clipping is enabled, the screen is limited to
1326 // the size of the browser window.
1327 display.viewportChangeSize(size.w, size.h);
1328 UI.fixScrollbars();
1329 }
b56772ec 1330
6d6f0db0
SR
1331 // Changing the viewport may change the state of
1332 // the dragging button
1333 UI.updateViewDrag();
1334 },
1335
a49ade5f 1336 // Handle special cases where viewport clipping is forced on/off or locked
6d6f0db0
SR
1337 enableDisableViewClip: function() {
1338 var resizeSetting = UI.getSetting('resize');
1339 // Disable clipping if we are scaling, connected or on touch
1340 if (resizeSetting === 'downscale' || resizeSetting === 'scale' ||
1341 isTouchDevice) {
a49ade5f 1342 UI.disableSetting('view_clip');
6d6f0db0 1343 } else {
a49ade5f 1344 UI.enableSetting('view_clip');
6d6f0db0
SR
1345 }
1346 },
30bfff81 1347
95dd6001 1348/* ------^-------
a49ade5f 1349 * /VIEW CLIPPING
95dd6001 1350 * ==============
1351 * VIEWDRAG
1352 * ------v------*/
1353
6d6f0db0
SR
1354 toggleViewDrag: function() {
1355 if (!UI.rfb) return;
bbbf42bb 1356
6d6f0db0
SR
1357 var drag = UI.rfb.get_viewportDrag();
1358 UI.setViewDrag(!drag);
1359 },
f0d9ab96 1360
6d6f0db0
SR
1361 // Set the view drag mode which moves the viewport on mouse drags
1362 setViewDrag: function(drag) {
1363 if (!UI.rfb) return;
f0d9ab96 1364
6d6f0db0 1365 UI.rfb.set_viewportDrag(drag);
f0d9ab96 1366
6d6f0db0
SR
1367 UI.updateViewDrag();
1368 },
f0d9ab96 1369
6d6f0db0
SR
1370 updateViewDrag: function() {
1371 var clipping = false;
bbbf42bb 1372
6d6f0db0 1373 if (!UI.connected) return;
6244e383 1374
6d6f0db0
SR
1375 // Check if viewport drag is possible. It is only possible
1376 // if the remote display is clipping the client display.
1377 if (UI.rfb.get_display().get_viewport() &&
1378 UI.rfb.get_display().clippingDisplay()) {
1379 clipping = true;
1380 }
31ddaa1c 1381
6d6f0db0 1382 var viewDragButton = document.getElementById('noVNC_view_drag_button');
29a0e6a8 1383
6d6f0db0
SR
1384 if (!clipping &&
1385 UI.rfb.get_viewportDrag()) {
1386 // The size of the remote display is the same or smaller
1387 // than the client display. Make sure viewport drag isn't
1388 // active when it can't be used.
1389 UI.rfb.set_viewportDrag(false);
1390 }
1391
1392 if (UI.rfb.get_viewportDrag()) {
1393 viewDragButton.classList.add("noVNC_selected");
1394 } else {
1395 viewDragButton.classList.remove("noVNC_selected");
1396 }
1397
1398 // Different behaviour for touch vs non-touch
1399 // The button is disabled instead of hidden on touch devices
1400 if (isTouchDevice) {
1401 viewDragButton.classList.remove("noVNC_hidden");
6244e383 1402
6d6f0db0
SR
1403 if (clipping) {
1404 viewDragButton.disabled = false;
31ddaa1c 1405 } else {
6d6f0db0 1406 viewDragButton.disabled = true;
6244e383 1407 }
6d6f0db0
SR
1408 } else {
1409 viewDragButton.disabled = false;
31ddaa1c 1410
6d6f0db0 1411 if (clipping) {
6244e383 1412 viewDragButton.classList.remove("noVNC_hidden");
6244e383 1413 } else {
6d6f0db0 1414 viewDragButton.classList.add("noVNC_hidden");
f8b399d7 1415 }
6d6f0db0
SR
1416 }
1417 },
f8b399d7 1418
95dd6001 1419/* ------^-------
1420 * /VIEWDRAG
1421 * ==============
1422 * KEYBOARD
1423 * ------v------*/
fdf21468 1424
6d6f0db0
SR
1425 showVirtualKeyboard: function() {
1426 if (!isTouchDevice) return;
4b30f9ce 1427
6d6f0db0 1428 var input = document.getElementById('noVNC_keyboardinput');
4b30f9ce 1429
6d6f0db0 1430 if (document.activeElement == input) return;
4b30f9ce 1431
6d6f0db0 1432 input.focus();
4b30f9ce 1433
6d6f0db0
SR
1434 try {
1435 var l = input.value.length;
1436 // Move the caret to the end
1437 input.setSelectionRange(l, l);
1438 } catch (err) {} // setSelectionRange is undefined in Google Chrome
1439 },
4b30f9ce 1440
6d6f0db0
SR
1441 hideVirtualKeyboard: function() {
1442 if (!isTouchDevice) return;
4b30f9ce 1443
6d6f0db0 1444 var input = document.getElementById('noVNC_keyboardinput');
4b30f9ce 1445
6d6f0db0 1446 if (document.activeElement != input) return;
4b30f9ce 1447
6d6f0db0
SR
1448 input.blur();
1449 },
4b30f9ce 1450
6d6f0db0
SR
1451 toggleVirtualKeyboard: function () {
1452 if (document.getElementById('noVNC_keyboard_button')
1453 .classList.contains("noVNC_selected")) {
1454 UI.hideVirtualKeyboard();
1455 } else {
1456 UI.showVirtualKeyboard();
1457 }
1458 },
bbbf42bb 1459
6d6f0db0
SR
1460 onfocusVirtualKeyboard: function(event) {
1461 document.getElementById('noVNC_keyboard_button')
1462 .classList.add("noVNC_selected");
1463 },
fdf21468 1464
6d6f0db0
SR
1465 onblurVirtualKeyboard: function(event) {
1466 document.getElementById('noVNC_keyboard_button')
1467 .classList.remove("noVNC_selected");
1468 },
ffcadf95 1469
6d6f0db0
SR
1470 keepVirtualKeyboard: function(event) {
1471 var input = document.getElementById('noVNC_keyboardinput');
ffcadf95 1472
6d6f0db0
SR
1473 // Only prevent focus change if the virtual keyboard is active
1474 if (document.activeElement != input) {
1475 return;
1476 }
ffcadf95 1477
6d6f0db0
SR
1478 // Only allow focus to move to other elements that need
1479 // focus to function properly
1480 if (event.target.form !== undefined) {
1481 switch (event.target.type) {
1482 case 'text':
1483 case 'email':
1484 case 'search':
1485 case 'password':
1486 case 'tel':
1487 case 'url':
1488 case 'textarea':
1489 case 'select-one':
1490 case 'select-multiple':
1491 return;
ffcadf95 1492 }
6d6f0db0 1493 }
ffcadf95 1494
2afda544
PO
1495 // The default action of touchstart is to generate other
1496 // events, which other elements might depend on. So we can't
1497 // blindly prevent that. Instead restore focus right away.
1498 if (event.type === "touchstart") {
1499 setTimeout(input.focus.bind(input));
1500 } else {
1501 event.preventDefault();
1502 }
6d6f0db0 1503 },
bbbf42bb 1504
6d6f0db0
SR
1505 keyboardinputReset: function() {
1506 var kbi = document.getElementById('noVNC_keyboardinput');
1507 kbi.value = new Array(UI.defaultKeyboardinputLen).join("_");
1508 UI.lastKeyboardinput = kbi.value;
1509 },
bbbf42bb 1510
867daa98
PO
1511 keyEvent: function (keysym, code, down) {
1512 if (!UI.rfb) return;
1513
1514 UI.rfb.sendKey(keysym, code, down);
1515 },
1516
6d6f0db0
SR
1517 // When normal keyboard events are left uncought, use the input events from
1518 // the keyboardinput element instead and generate the corresponding key events.
1519 // This code is required since some browsers on Android are inconsistent in
1520 // sending keyCodes in the normal keyboard events when using on screen keyboards.
1521 keyInput: function(event) {
3b8ec46f 1522
6d6f0db0 1523 if (!UI.rfb) return;
3b8ec46f 1524
6d6f0db0 1525 var newValue = event.target.value;
1138bdd4 1526
6d6f0db0
SR
1527 if (!UI.lastKeyboardinput) {
1528 UI.keyboardinputReset();
1529 }
1530 var oldValue = UI.lastKeyboardinput;
bbbf42bb 1531
6d6f0db0
SR
1532 var newLen;
1533 try {
1534 // Try to check caret position since whitespace at the end
1535 // will not be considered by value.length in some browsers
1536 newLen = Math.max(event.target.selectionStart, newValue.length);
1537 } catch (err) {
1538 // selectionStart is undefined in Google Chrome
1539 newLen = newValue.length;
1540 }
1541 var oldLen = oldValue.length;
1542
1543 var backspaces;
1544 var inputs = newLen - oldLen;
1545 if (inputs < 0) {
1546 backspaces = -inputs;
1547 } else {
1548 backspaces = 0;
1549 }
8e0f0088 1550
6d6f0db0
SR
1551 // Compare the old string with the new to account for
1552 // text-corrections or other input that modify existing text
1553 var i;
1554 for (i = 0; i < Math.min(oldLen, newLen); i++) {
1555 if (newValue.charAt(i) != oldValue.charAt(i)) {
1556 inputs = newLen - i;
1557 backspaces = oldLen - i;
1558 break;
bbbf42bb 1559 }
6d6f0db0 1560 }
bbbf42bb 1561
6d6f0db0
SR
1562 // Send the key events
1563 for (i = 0; i < backspaces; i++) {
94f5cf05 1564 UI.rfb.sendKey(KeyTable.XK_BackSpace, "Backspace");
6d6f0db0
SR
1565 }
1566 for (i = newLen - inputs; i < newLen; i++) {
524d67f2 1567 UI.rfb.sendKey(keysyms.lookup(newValue.charCodeAt(i)));
6d6f0db0 1568 }
bbbf42bb 1569
6d6f0db0
SR
1570 // Control the text content length in the keyboardinput element
1571 if (newLen > 2 * UI.defaultKeyboardinputLen) {
1572 UI.keyboardinputReset();
1573 } else if (newLen < 1) {
1574 // There always have to be some text in the keyboardinput
1575 // element with which backspace can interact.
1576 UI.keyboardinputReset();
1577 // This sometimes causes the keyboard to disappear for a second
1578 // but it is required for the android keyboard to recognize that
1579 // text has been added to the field
1580 event.target.blur();
1581 // This has to be ran outside of the input handler in order to work
1582 setTimeout(event.target.focus.bind(event.target), 0);
1583 } else {
1584 UI.lastKeyboardinput = newValue;
1585 }
1586 },
bbbf42bb 1587
4b30f9ce
SM
1588/* ------^-------
1589 * /KEYBOARD
1590 * ==============
1591 * EXTRA KEYS
1592 * ------v------*/
1593
6d6f0db0
SR
1594 openExtraKeys: function() {
1595 UI.closeAllPanels();
1596 UI.openControlbar();
1597
1598 document.getElementById('noVNC_modifiers')
1599 .classList.add("noVNC_open");
1600 document.getElementById('noVNC_toggle_extra_keys_button')
1601 .classList.add("noVNC_selected");
1602 },
1603
1604 closeExtraKeys: function() {
1605 document.getElementById('noVNC_modifiers')
1606 .classList.remove("noVNC_open");
1607 document.getElementById('noVNC_toggle_extra_keys_button')
1608 .classList.remove("noVNC_selected");
1609 },
1610
1611 toggleExtraKeys: function() {
1612 if(document.getElementById('noVNC_modifiers')
1613 .classList.contains("noVNC_open")) {
1614 UI.closeExtraKeys();
1615 } else {
1616 UI.openExtraKeys();
1617 }
1618 },
1619
1620 sendEsc: function() {
94f5cf05 1621 UI.rfb.sendKey(KeyTable.XK_Escape, "Escape");
6d6f0db0
SR
1622 },
1623
1624 sendTab: function() {
1625 UI.rfb.sendKey(KeyTable.XK_Tab);
1626 },
1627
1628 toggleCtrl: function() {
1629 var btn = document.getElementById('noVNC_toggle_ctrl_button');
1630 if (btn.classList.contains("noVNC_selected")) {
94f5cf05 1631 UI.rfb.sendKey(KeyTable.XK_Control_L, "ControlLeft", false);
6d6f0db0
SR
1632 btn.classList.remove("noVNC_selected");
1633 } else {
94f5cf05 1634 UI.rfb.sendKey(KeyTable.XK_Control_L, "ControlLeft", true);
6d6f0db0
SR
1635 btn.classList.add("noVNC_selected");
1636 }
1637 },
1638
1639 toggleAlt: function() {
1640 var btn = document.getElementById('noVNC_toggle_alt_button');
1641 if (btn.classList.contains("noVNC_selected")) {
94f5cf05 1642 UI.rfb.sendKey(KeyTable.XK_Alt_L, "AltLeft", false);
6d6f0db0
SR
1643 btn.classList.remove("noVNC_selected");
1644 } else {
94f5cf05 1645 UI.rfb.sendKey(KeyTable.XK_Alt_L, "AltLeft", true);
6d6f0db0
SR
1646 btn.classList.add("noVNC_selected");
1647 }
1648 },
bbbf42bb 1649
6d6f0db0
SR
1650 sendCtrlAltDel: function() {
1651 UI.rfb.sendCtrlAltDel();
1652 },
bbbf42bb 1653
95dd6001 1654/* ------^-------
4b30f9ce 1655 * /EXTRA KEYS
95dd6001 1656 * ==============
1657 * MISC
1658 * ------v------*/
1659
6d6f0db0
SR
1660 setMouseButton: function(num) {
1661 var view_only = UI.rfb.get_view_only();
1662 if (UI.rfb && !view_only) {
1663 UI.rfb.get_mouse().set_touchButton(num);
1664 }
95dd6001 1665
6d6f0db0
SR
1666 var blist = [0, 1,2,4];
1667 for (var b = 0; b < blist.length; b++) {
1668 var button = document.getElementById('noVNC_mouse_button' +
1669 blist[b]);
1670 if (blist[b] === num && !view_only) {
1671 button.classList.remove("noVNC_hidden");
1672 } else {
1673 button.classList.add("noVNC_hidden");
ceb847b0 1674 }
6d6f0db0
SR
1675 }
1676 },
ef1e8bab 1677
6d6f0db0 1678 updateLocalCursor: function() {
e6a8eb15 1679 if (!UI.rfb) return;
6d6f0db0
SR
1680 UI.rfb.set_local_cursor(UI.getSetting('cursor'));
1681 },
1682
1683 updateViewOnly: function() {
e6a8eb15 1684 if (!UI.rfb) return;
6d6f0db0
SR
1685 UI.rfb.set_view_only(UI.getSetting('view_only'));
1686 },
1687
1688 updateLogging: function() {
1689 WebUtil.init_logging(UI.getSetting('logging'));
1690 },
1691
1692 updateSessionSize: function(rfb, width, height) {
1693 UI.updateViewClip();
d1a1e0e5 1694 UI.updateScaling();
6d6f0db0
SR
1695 UI.fixScrollbars();
1696 },
1697
1698 fixScrollbars: function() {
1699 // This is a hack because Chrome screws up the calculation
1700 // for when scrollbars are needed. So to fix it we temporarily
1701 // toggle them off and on.
1702 var screen = document.getElementById('noVNC_screen');
1703 screen.style.overflow = 'hidden';
1704 // Force Chrome to recalculate the layout by asking for
1705 // an element's dimensions
1706 screen.getBoundingClientRect();
41c958d4 1707 screen.style.overflow = "";
6d6f0db0
SR
1708 },
1709
1710 updateDesktopName: function(rfb, name) {
1711 UI.desktopName = name;
1712 // Display the desktop name in the document title
1713 document.title = name + " - noVNC";
1714 },
1715
1716 bell: function(rfb) {
1717 if (WebUtil.getConfigVar('bell', 'on') === 'on') {
a342ed70
SM
1718 var promise = document.getElementById('noVNC_bell').play();
1719 // The standards disagree on the return value here
1720 if (promise) {
1721 promise.catch(function(e) {
d4fc89d8
SM
1722 if (e.name === "NotAllowedError") {
1723 // Ignore when the browser doesn't let us play audio.
1724 // It is common that the browsers require audio to be
1725 // initiated from a user action.
1726 } else {
1727 Log.Error("Unable to play bell: " + e);
1728 }
1729 });
a342ed70 1730 }
6d6f0db0
SR
1731 }
1732 },
63bf2ba5 1733
6d6f0db0
SR
1734 //Helper to add options to dropdown.
1735 addOption: function(selectbox, text, value) {
1736 var optn = document.createElement("OPTION");
1737 optn.text = text;
1738 optn.value = value;
1739 selectbox.options.add(optn);
1740 },
bbbf42bb 1741
95dd6001 1742/* ------^-------
1743 * /MISC
1744 * ==============
1745 */
6d6f0db0
SR
1746};
1747
1748// Set up translations
a0513c87 1749var LINGUAS = ["de", "el", "nl", "pl", "sv"];
6d6f0db0
SR
1750l10n.setup(LINGUAS);
1751if (l10n.language !== "en" && l10n.dictionary === undefined) {
1752 WebUtil.fetchJSON('app/locale/' + l10n.language + '.json', function (translations) {
1753 l10n.dictionary = translations;
1754
1755 // wait for translations to load before loading the UI
1756 UI.prime();
1757 }, function (err) {
adfc9d3f 1758 throw err;
6d6f0db0
SR
1759 });
1760} else {
1761 UI.prime();
1762}
1763
3ae0bb09 1764export default UI;