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