2 * noVNC: HTML5 VNC client
3 * Copyright (C) 2012 Joel Martin
4 * Copyright (C) 2018 Samuel Mannehed for Cendio AB
5 * Licensed under MPL 2.0 (see LICENSE.txt)
7 * See README.md for usage and integration instructions.
9 * TIGHT decoder portion:
10 * (c) 2012 Michael Tinglof, Joe Balaz, Les Piech (Mercuri.ca)
13 import * as Log
from './util/logging.js';
14 import { decodeUTF8
} from './util/strings.js';
15 import { supportsCursorURIs
, isTouchDevice
} from './util/browser.js';
16 import EventTargetMixin
from './util/eventtarget.js';
17 import Display
from "./display.js";
18 import Keyboard
from "./input/keyboard.js";
19 import Mouse
from "./input/mouse.js";
20 import Websock
from "./websock.js";
21 import DES
from "./des.js";
22 import KeyTable
from "./input/keysym.js";
23 import XtScancode
from "./input/xtscancodes.js";
24 import Inflator
from "./inflator.js";
25 import { encodings
, encodingName
} from "./encodings.js";
26 import "./util/polyfill.js";
28 // How many seconds to wait for a disconnect to finish
29 const DISCONNECT_TIMEOUT
= 3;
31 export default function RFB(target
, url
, options
) {
33 throw Error("Must specify target");
36 throw Error("Must specify URL");
39 this._target
= target
;
43 options
= options
|| {};
44 this._rfb_credentials
= options
.credentials
|| {};
45 this._shared
= 'shared' in options
? !!options
.shared
: true;
46 this._repeaterID
= options
.repeaterID
|| '';
49 this._rfb_connection_state
= '';
50 this._rfb_init_state
= '';
51 this._rfb_auth_scheme
= '';
52 this._rfb_clean_disconnect
= true;
54 // Server capabilities
55 this._rfb_version
= 0;
56 this._rfb_max_version
= 3.8;
57 this._rfb_tightvnc
= false;
58 this._rfb_xvp_ver
= 0;
65 this._capabilities
= { power
: false };
67 this._supportsFence
= false;
69 this._supportsContinuousUpdates
= false;
70 this._enabledContinuousUpdates
= false;
72 this._supportsSetDesktopSize
= false;
74 this._screen_flags
= 0;
76 this._qemuExtKeyEventSupported
= false;
79 this._sock
= null; // Websock object
80 this._display
= null; // Display object
81 this._flushing
= false; // Display flushing state
82 this._keyboard
= null; // Keyboard input handler object
83 this._mouse
= null; // Mouse input handler object
86 this._disconnTimer
= null; // disconnection timer
87 this._resizeTimeout
= null; // resize rate limiting
89 // Decoder states and stats
90 this._encHandlers
= {};
95 subrects
: 0, // RRE and HEXTILE
106 zlibs
: [] // TIGHT zlib streams
108 for (let i
= 0; i
< 4; i
++) {
109 this._FBU
.zlibs
[i
] = new Inflator();
112 this._destBuff
= null;
113 this._paletteBuff
= new Uint8Array(1024); // 256 * 4 (max palette size * max bytes-per-pixel)
115 this._rre_chunk_sz
= 100;
131 this._mouse_buttonMask
= 0;
132 this._mouse_arr
= [];
133 this._viewportDragging
= false;
134 this._viewportDragPos
= {};
135 this._viewportHasMoved
= false;
137 // Bound event handlers
138 this._eventHandlers
= {
139 focusCanvas
: this._focusCanvas
.bind(this),
140 windowResize
: this._windowResize
.bind(this),
144 Log
.Debug(">> RFB.constructor");
146 // Create DOM elements
147 this._screen
= document
.createElement('div');
148 this._screen
.style
.display
= 'flex';
149 this._screen
.style
.width
= '100%';
150 this._screen
.style
.height
= '100%';
151 this._screen
.style
.overflow
= 'auto';
152 this._screen
.style
.backgroundColor
= 'rgb(40, 40, 40)';
153 this._canvas
= document
.createElement('canvas');
154 this._canvas
.style
.margin
= 'auto';
155 // Some browsers add an outline on focus
156 this._canvas
.style
.outline
= 'none';
157 // IE miscalculates width without this :(
158 this._canvas
.style
.flexShrink
= '0';
159 this._canvas
.width
= 0;
160 this._canvas
.height
= 0;
161 this._canvas
.tabIndex
= -1;
162 this._screen
.appendChild(this._canvas
);
164 // populate encHandlers with bound versions
165 this._encHandlers
[encodings
.encodingRaw
] = RFB
.encodingHandlers
.RAW
.bind(this);
166 this._encHandlers
[encodings
.encodingCopyRect
] = RFB
.encodingHandlers
.COPYRECT
.bind(this);
167 this._encHandlers
[encodings
.encodingRRE
] = RFB
.encodingHandlers
.RRE
.bind(this);
168 this._encHandlers
[encodings
.encodingHextile
] = RFB
.encodingHandlers
.HEXTILE
.bind(this);
169 this._encHandlers
[encodings
.encodingTight
] = RFB
.encodingHandlers
.TIGHT
.bind(this, false);
170 this._encHandlers
[encodings
.encodingTightPNG
] = RFB
.encodingHandlers
.TIGHT
.bind(this, true);
172 this._encHandlers
[encodings
.pseudoEncodingDesktopSize
] = RFB
.encodingHandlers
.DesktopSize
.bind(this);
173 this._encHandlers
[encodings
.pseudoEncodingLastRect
] = RFB
.encodingHandlers
.last_rect
.bind(this);
174 this._encHandlers
[encodings
.pseudoEncodingCursor
] = RFB
.encodingHandlers
.Cursor
.bind(this);
175 this._encHandlers
[encodings
.pseudoEncodingQEMUExtendedKeyEvent
] = RFB
.encodingHandlers
.QEMUExtendedKeyEvent
.bind(this);
176 this._encHandlers
[encodings
.pseudoEncodingExtendedDesktopSize
] = RFB
.encodingHandlers
.ExtendedDesktopSize
.bind(this);
178 // NB: nothing that needs explicit teardown should be done
179 // before this point, since this can throw an exception
181 this._display
= new Display(this._canvas
);
183 Log
.Error("Display exception: " + exc
);
186 this._display
.onflush
= this._onFlush
.bind(this);
187 this._display
.clear();
189 this._keyboard
= new Keyboard(this._canvas
);
190 this._keyboard
.onkeyevent
= this._handleKeyEvent
.bind(this);
192 this._mouse
= new Mouse(this._canvas
);
193 this._mouse
.onmousebutton
= this._handleMouseButton
.bind(this);
194 this._mouse
.onmousemove
= this._handleMouseMove
.bind(this);
196 this._sock
= new Websock();
197 this._sock
.on('message', this._handle_message
.bind(this));
198 this._sock
.on('open', function () {
199 if ((this._rfb_connection_state
=== 'connecting') &&
200 (this._rfb_init_state
=== '')) {
201 this._rfb_init_state
= 'ProtocolVersion';
202 Log
.Debug("Starting VNC handshake");
204 this._fail("Unexpected server connection while " +
205 this._rfb_connection_state
);
208 this._sock
.on('close', function (e
) {
209 Log
.Debug("WebSocket on-close event");
212 msg
= "(code: " + e
.code
;
214 msg
+= ", reason: " + e
.reason
;
218 switch (this._rfb_connection_state
) {
220 this._fail("Connection closed " + msg
);
223 // Handle disconnects that were initiated server-side
224 this._updateConnectionState('disconnecting');
225 this._updateConnectionState('disconnected');
227 case 'disconnecting':
228 // Normal disconnection path
229 this._updateConnectionState('disconnected');
232 this._fail("Unexpected server disconnect " +
233 "when already disconnected " + msg
);
236 this._fail("Unexpected server disconnect before connecting " +
240 this._sock
.off('close');
242 this._sock
.on('error', function (e
) {
243 Log
.Warn("WebSocket on-error event");
246 // Slight delay of the actual connection so that the caller has
247 // time to set up callbacks
248 setTimeout(this._updateConnectionState
.bind(this, 'connecting'));
250 Log
.Debug("<< RFB.constructor");
254 // ===== PROPERTIES =====
260 get viewOnly() { return this._viewOnly
; },
261 set viewOnly(viewOnly
) {
262 this._viewOnly
= viewOnly
;
264 if (this._rfb_connection_state
=== "connecting" ||
265 this._rfb_connection_state
=== "connected") {
267 this._keyboard
.ungrab();
268 this._mouse
.ungrab();
270 this._keyboard
.grab();
276 get capabilities() { return this._capabilities
; },
278 get touchButton() { return this._mouse
.touchButton
; },
279 set touchButton(button
) { this._mouse
.touchButton
= button
; },
281 _clipViewport
: false,
282 get clipViewport() { return this._clipViewport
; },
283 set clipViewport(viewport
) {
284 this._clipViewport
= viewport
;
288 _scaleViewport
: false,
289 get scaleViewport() { return this._scaleViewport
; },
290 set scaleViewport(scale
) {
291 this._scaleViewport
= scale
;
292 // Scaling trumps clipping, so we may need to adjust
293 // clipping when enabling or disabling scaling
294 if (scale
&& this._clipViewport
) {
298 if (!scale
&& this._clipViewport
) {
303 _resizeSession
: false,
304 get resizeSession() { return this._resizeSession
; },
305 set resizeSession(resize
) {
306 this._resizeSession
= resize
;
308 this._requestRemoteResize();
312 // ===== PUBLIC METHODS =====
314 disconnect: function () {
315 this._updateConnectionState('disconnecting');
316 this._sock
.off('error');
317 this._sock
.off('message');
318 this._sock
.off('open');
321 sendCredentials: function (creds
) {
322 this._rfb_credentials
= creds
;
323 setTimeout(this._init_msg
.bind(this), 0);
326 sendCtrlAltDel: function () {
327 if (this._rfb_connection_state
!== 'connected' || this._viewOnly
) { return; }
328 Log
.Info("Sending Ctrl-Alt-Del");
330 this.sendKey(KeyTable
.XK_Control_L
, "ControlLeft", true);
331 this.sendKey(KeyTable
.XK_Alt_L
, "AltLeft", true);
332 this.sendKey(KeyTable
.XK_Delete
, "Delete", true);
333 this.sendKey(KeyTable
.XK_Delete
, "Delete", false);
334 this.sendKey(KeyTable
.XK_Alt_L
, "AltLeft", false);
335 this.sendKey(KeyTable
.XK_Control_L
, "ControlLeft", false);
338 machineShutdown: function () {
342 machineReboot: function () {
346 machineReset: function () {
350 // Send a key press. If 'down' is not specified then send a down key
351 // followed by an up key.
352 sendKey: function (keysym
, code
, down
) {
353 if (this._rfb_connection_state
!== 'connected' || this._viewOnly
) { return; }
355 if (down
=== undefined) {
356 this.sendKey(keysym
, code
, true);
357 this.sendKey(keysym
, code
, false);
361 const scancode
= XtScancode
[code
];
363 if (this._qemuExtKeyEventSupported
&& scancode
) {
365 keysym
= keysym
|| 0;
367 Log
.Info("Sending key (" + (down
? "down" : "up") + "): keysym " + keysym
+ ", scancode " + scancode
);
369 RFB
.messages
.QEMUExtendedKeyEvent(this._sock
, keysym
, down
, scancode
);
374 Log
.Info("Sending keysym (" + (down
? "down" : "up") + "): " + keysym
);
375 RFB
.messages
.keyEvent(this._sock
, keysym
, down
? 1 : 0);
380 this._canvas
.focus();
387 clipboardPasteFrom: function (text
) {
388 if (this._rfb_connection_state
!== 'connected' || this._viewOnly
) { return; }
389 RFB
.messages
.clientCutText(this._sock
, text
);
392 // ===== PRIVATE METHODS =====
394 _connect: function () {
395 Log
.Debug(">> RFB.connect");
397 Log
.Info("connecting to " + this._url
);
400 // WebSocket.onopen transitions to the RFB init states
401 this._sock
.open(this._url
, ['binary']);
403 if (e
.name
=== 'SyntaxError') {
404 this._fail("Invalid host or port (" + e
+ ")");
406 this._fail("Error when opening socket (" + e
+ ")");
410 // Make our elements part of the page
411 this._target
.appendChild(this._screen
);
413 // Monitor size changes of the screen
414 // FIXME: Use ResizeObserver, or hidden overflow
415 window
.addEventListener('resize', this._eventHandlers
.windowResize
);
417 // Always grab focus on some kind of click event
418 this._canvas
.addEventListener("mousedown", this._eventHandlers
.focusCanvas
);
419 this._canvas
.addEventListener("touchstart", this._eventHandlers
.focusCanvas
);
421 Log
.Debug("<< RFB.connect");
424 _disconnect: function () {
425 Log
.Debug(">> RFB.disconnect");
426 this._canvas
.removeEventListener("mousedown", this._eventHandlers
.focusCanvas
);
427 this._canvas
.removeEventListener("touchstart", this._eventHandlers
.focusCanvas
);
428 window
.removeEventListener('resize', this._eventHandlers
.windowResize
);
429 this._keyboard
.ungrab();
430 this._mouse
.ungrab();
434 this._target
.removeChild(this._screen
);
436 if (e
.name
=== 'NotFoundError') {
437 // Some cases where the initial connection fails
438 // can disconnect before the _screen is created
443 clearTimeout(this._resizeTimeout
);
444 Log
.Debug("<< RFB.disconnect");
447 _print_stats: function () {
448 const stats
= this._encStats
;
450 Log
.Info("Encoding stats for this connection:");
451 Object
.keys(stats
).forEach(function (key
) {
452 const s
= stats
[key
];
453 if (s
[0] + s
[1] > 0) {
454 Log
.Info(" " + encodingName(key
) + ": " + s
[0] + " rects");
458 Log
.Info("Encoding stats since page load:");
459 Object
.keys(stats
).forEach(function (key
) {
460 const s
= stats
[key
];
461 Log
.Info(" " + encodingName(key
) + ": " + s
[1] + " rects");
465 _focusCanvas: function(event
) {
466 // Respect earlier handlers' request to not do side-effects
467 if (event
.defaultPrevented
) {
471 if (!this.focusOnClick
) {
478 _windowResize: function (event
) {
479 // If the window resized then our screen element might have
480 // as well. Update the viewport dimensions.
481 window
.requestAnimationFrame(function () {
486 if (this._resizeSession
) {
487 // Request changing the resolution of the remote display to
488 // the size of the local browser viewport.
490 // In order to not send multiple requests before the browser-resize
491 // is finished we wait 0.5 seconds before sending the request.
492 clearTimeout(this._resizeTimeout
);
493 this._resizeTimeout
= setTimeout(this._requestRemoteResize
.bind(this), 500);
497 // Update state of clipping in Display object, and make sure the
498 // configured viewport matches the current screen size
499 _updateClip: function () {
500 const cur_clip
= this._display
.clipViewport
;
501 let new_clip
= this._clipViewport
;
503 if (this._scaleViewport
) {
504 // Disable viewport clipping if we are scaling
508 if (cur_clip
!== new_clip
) {
509 this._display
.clipViewport
= new_clip
;
513 // When clipping is enabled, the screen is limited to
514 // the size of the container.
515 const size
= this._screenSize();
516 this._display
.viewportChangeSize(size
.w
, size
.h
);
517 this._fixScrollbars();
521 _updateScale: function () {
522 if (!this._scaleViewport
) {
523 this._display
.scale
= 1.0;
525 const size
= this._screenSize();
526 this._display
.autoscale(size
.w
, size
.h
);
528 this._fixScrollbars();
531 // Requests a change of remote desktop size. This message is an extension
532 // and may only be sent if we have received an ExtendedDesktopSize message
533 _requestRemoteResize: function () {
534 clearTimeout(this._resizeTimeout
);
535 this._resizeTimeout
= null;
537 if (!this._resizeSession
|| this._viewOnly
||
538 !this._supportsSetDesktopSize
) {
542 const size
= this._screenSize();
543 RFB
.messages
.setDesktopSize(this._sock
, size
.w
, size
.h
,
544 this._screen_id
, this._screen_flags
);
546 Log
.Debug('Requested new desktop size: ' +
547 size
.w
+ 'x' + size
.h
);
550 // Gets the the size of the available screen
551 _screenSize: function () {
552 return { w
: this._screen
.offsetWidth
,
553 h
: this._screen
.offsetHeight
};
556 _fixScrollbars: function () {
557 // This is a hack because Chrome screws up the calculation
558 // for when scrollbars are needed. So to fix it we temporarily
559 // toggle them off and on.
560 const orig
= this._screen
.style
.overflow
;
561 this._screen
.style
.overflow
= 'hidden';
562 // Force Chrome to recalculate the layout by asking for
563 // an element's dimensions
564 this._screen
.getBoundingClientRect();
565 this._screen
.style
.overflow
= orig
;
573 * disconnected - permanent state
575 _updateConnectionState: function (state
) {
576 const oldstate
= this._rfb_connection_state
;
578 if (state
=== oldstate
) {
579 Log
.Debug("Already in state '" + state
+ "', ignoring");
583 // The 'disconnected' state is permanent for each RFB object
584 if (oldstate
=== 'disconnected') {
585 Log
.Error("Tried changing state of a disconnected RFB object");
589 // Ensure proper transitions before doing anything
592 if (oldstate
!== 'connecting') {
593 Log
.Error("Bad transition to connected state, " +
594 "previous connection state: " + oldstate
);
600 if (oldstate
!== 'disconnecting') {
601 Log
.Error("Bad transition to disconnected state, " +
602 "previous connection state: " + oldstate
);
608 if (oldstate
!== '') {
609 Log
.Error("Bad transition to connecting state, " +
610 "previous connection state: " + oldstate
);
615 case 'disconnecting':
616 if (oldstate
!== 'connected' && oldstate
!== 'connecting') {
617 Log
.Error("Bad transition to disconnecting state, " +
618 "previous connection state: " + oldstate
);
624 Log
.Error("Unknown connection state: " + state
);
628 // State change actions
630 this._rfb_connection_state
= state
;
632 const smsg
= "New state '" + state
+ "', was '" + oldstate
+ "'.";
635 if (this._disconnTimer
&& state
!== 'disconnecting') {
636 Log
.Debug("Clearing disconnect timer");
637 clearTimeout(this._disconnTimer
);
638 this._disconnTimer
= null;
640 // make sure we don't get a double event
641 this._sock
.off('close');
650 this.dispatchEvent(new CustomEvent("connect", { detail
: {} }));
653 case 'disconnecting':
656 this._disconnTimer
= setTimeout(function () {
657 Log
.Error("Disconnection timed out.");
658 this._updateConnectionState('disconnected');
659 }.bind(this), DISCONNECT_TIMEOUT
* 1000);
663 this.dispatchEvent(new CustomEvent(
664 "disconnect", { detail
:
665 { clean
: this._rfb_clean_disconnect
} }));
670 /* Print errors and disconnect
672 * The parameter 'details' is used for information that
673 * should be logged but not sent to the user interface.
675 _fail: function (details
) {
676 switch (this._rfb_connection_state
) {
677 case 'disconnecting':
678 Log
.Error("Failed when disconnecting: " + details
);
681 Log
.Error("Failed while connected: " + details
);
684 Log
.Error("Failed when connecting: " + details
);
687 Log
.Error("RFB failure: " + details
);
690 this._rfb_clean_disconnect
= false; //This is sent to the UI
692 // Transition to disconnected without waiting for socket to close
693 this._updateConnectionState('disconnecting');
694 this._updateConnectionState('disconnected');
699 _setCapability: function (cap
, val
) {
700 this._capabilities
[cap
] = val
;
701 this.dispatchEvent(new CustomEvent("capabilities",
702 { detail
: { capabilities
: this._capabilities
} }));
705 _handle_message: function () {
706 if (this._sock
.rQlen() === 0) {
707 Log
.Warn("handle_message called on an empty receive queue");
711 switch (this._rfb_connection_state
) {
713 Log
.Error("Got data while disconnected");
717 if (this._flushing
) {
720 if (!this._normal_msg()) {
723 if (this._sock
.rQlen() === 0) {
734 _handleKeyEvent: function (keysym
, code
, down
) {
735 this.sendKey(keysym
, code
, down
);
738 _handleMouseButton: function (x
, y
, down
, bmask
) {
740 this._mouse_buttonMask
|= bmask
;
742 this._mouse_buttonMask
&= ~bmask
;
745 if (this.dragViewport
) {
746 if (down
&& !this._viewportDragging
) {
747 this._viewportDragging
= true;
748 this._viewportDragPos
= {'x': x
, 'y': y
};
749 this._viewportHasMoved
= false;
751 // Skip sending mouse events
754 this._viewportDragging
= false;
756 // If we actually performed a drag then we are done
757 // here and should not send any mouse events
758 if (this._viewportHasMoved
) {
762 // Otherwise we treat this as a mouse click event.
763 // Send the button down event here, as the button up
764 // event is sent at the end of this function.
765 RFB
.messages
.pointerEvent(this._sock
,
766 this._display
.absX(x
),
767 this._display
.absY(y
),
772 if (this._viewOnly
) { return; } // View only, skip mouse events
774 if (this._rfb_connection_state
!== 'connected') { return; }
775 RFB
.messages
.pointerEvent(this._sock
, this._display
.absX(x
), this._display
.absY(y
), this._mouse_buttonMask
);
778 _handleMouseMove: function (x
, y
) {
779 if (this._viewportDragging
) {
780 const deltaX
= this._viewportDragPos
.x
- x
;
781 const deltaY
= this._viewportDragPos
.y
- y
;
783 // The goal is to trigger on a certain physical width, the
784 // devicePixelRatio brings us a bit closer but is not optimal.
785 const dragThreshold
= 10 * (window
.devicePixelRatio
|| 1);
787 if (this._viewportHasMoved
|| (Math
.abs(deltaX
) > dragThreshold
||
788 Math
.abs(deltaY
) > dragThreshold
)) {
789 this._viewportHasMoved
= true;
791 this._viewportDragPos
= {'x': x
, 'y': y
};
792 this._display
.viewportChangePos(deltaX
, deltaY
);
795 // Skip sending mouse events
799 if (this._viewOnly
) { return; } // View only, skip mouse events
801 if (this._rfb_connection_state
!== 'connected') { return; }
802 RFB
.messages
.pointerEvent(this._sock
, this._display
.absX(x
), this._display
.absY(y
), this._mouse_buttonMask
);
807 _negotiate_protocol_version: function () {
808 if (this._sock
.rQlen() < 12) {
809 return this._fail("Received incomplete protocol version.");
812 const sversion
= this._sock
.rQshiftStr(12).substr(4, 7);
813 Log
.Info("Server ProtocolVersion: " + sversion
);
816 case "000.000": // UltraVNC repeater
820 case "003.006": // UltraVNC
821 case "003.889": // Apple Remote Desktop
822 this._rfb_version
= 3.3;
825 this._rfb_version
= 3.7;
828 case "004.000": // Intel AMT KVM
829 case "004.001": // RealVNC 4.6
830 case "005.000": // RealVNC 5.3
831 this._rfb_version
= 3.8;
834 return this._fail("Invalid server version " + sversion
);
838 let repeaterID
= "ID:" + this._repeaterID
;
839 while (repeaterID
.length
< 250) {
842 this._sock
.send_string(repeaterID
);
846 if (this._rfb_version
> this._rfb_max_version
) {
847 this._rfb_version
= this._rfb_max_version
;
850 const cversion
= "00" + parseInt(this._rfb_version
, 10) +
851 ".00" + ((this._rfb_version
* 10) % 10);
852 this._sock
.send_string("RFB " + cversion
+ "\n");
853 Log
.Debug('Sent ProtocolVersion: ' + cversion
);
855 this._rfb_init_state
= 'Security';
858 _negotiate_security: function () {
859 // Polyfill since IE and PhantomJS doesn't have
860 // TypedArray.includes()
861 function includes(item
, array
) {
862 for (let i
= 0; i
< array
.length
; i
++) {
863 if (array
[i
] === item
) {
870 if (this._rfb_version
>= 3.7) {
871 // Server sends supported list, client decides
872 const num_types
= this._sock
.rQshift8();
873 if (this._sock
.rQwait("security type", num_types
, 1)) { return false; }
875 if (num_types
=== 0) {
876 return this._handle_security_failure("no security types");
879 const types
= this._sock
.rQshiftBytes(num_types
);
880 Log
.Debug("Server security types: " + types
);
882 // Look for each auth in preferred order
883 this._rfb_auth_scheme
= 0;
884 if (includes(1, types
)) {
885 this._rfb_auth_scheme
= 1; // None
886 } else if (includes(22, types
)) {
887 this._rfb_auth_scheme
= 22; // XVP
888 } else if (includes(16, types
)) {
889 this._rfb_auth_scheme
= 16; // Tight
890 } else if (includes(2, types
)) {
891 this._rfb_auth_scheme
= 2; // VNC Auth
893 return this._fail("Unsupported security types (types: " + types
+ ")");
896 this._sock
.send([this._rfb_auth_scheme
]);
899 if (this._sock
.rQwait("security scheme", 4)) { return false; }
900 this._rfb_auth_scheme
= this._sock
.rQshift32();
903 this._rfb_init_state
= 'Authentication';
904 Log
.Debug('Authenticating using scheme: ' + this._rfb_auth_scheme
);
906 return this._init_msg(); // jump to authentication
910 * Get the security failure reason if sent from the server and
911 * send the 'securityfailure' event.
913 * - The optional parameter context can be used to add some extra
914 * context to the log output.
916 * - The optional parameter security_result_status can be used to
917 * add a custom status code to the event.
919 _handle_security_failure: function (context
, security_result_status
) {
921 if (typeof context
=== 'undefined') {
924 context
= " on " + context
;
927 if (typeof security_result_status
=== 'undefined') {
928 security_result_status
= 1; // fail
931 if (this._sock
.rQwait("reason length", 4)) {
934 const strlen
= this._sock
.rQshift32();
938 if (this._sock
.rQwait("reason", strlen
, 8)) { return false; }
939 reason
= this._sock
.rQshiftStr(strlen
);
943 this.dispatchEvent(new CustomEvent(
945 { detail
: { status
: security_result_status
, reason
: reason
} }));
947 return this._fail("Security negotiation failed" + context
+
948 " (reason: " + reason
+ ")");
950 this.dispatchEvent(new CustomEvent(
952 { detail
: { status
: security_result_status
} }));
954 return this._fail("Security negotiation failed" + context
);
959 _negotiate_xvp_auth: function () {
960 if (!this._rfb_credentials
.username
||
961 !this._rfb_credentials
.password
||
962 !this._rfb_credentials
.target
) {
963 this.dispatchEvent(new CustomEvent(
964 "credentialsrequired",
965 { detail
: { types
: ["username", "password", "target"] } }));
969 const xvp_auth_str
= String
.fromCharCode(this._rfb_credentials
.username
.length
) +
970 String
.fromCharCode(this._rfb_credentials
.target
.length
) +
971 this._rfb_credentials
.username
+
972 this._rfb_credentials
.target
;
973 this._sock
.send_string(xvp_auth_str
);
974 this._rfb_auth_scheme
= 2;
975 return this._negotiate_authentication();
978 _negotiate_std_vnc_auth: function () {
979 if (this._sock
.rQwait("auth challenge", 16)) { return false; }
981 if (!this._rfb_credentials
.password
) {
982 this.dispatchEvent(new CustomEvent(
983 "credentialsrequired",
984 { detail
: { types
: ["password"] } }));
988 // TODO(directxman12): make genDES not require an Array
989 const challenge
= Array
.prototype.slice
.call(this._sock
.rQshiftBytes(16));
990 const response
= RFB
.genDES(this._rfb_credentials
.password
, challenge
);
991 this._sock
.send(response
);
992 this._rfb_init_state
= "SecurityResult";
996 _negotiate_tight_tunnels: function (numTunnels
) {
997 const clientSupportedTunnelTypes
= {
998 0: { vendor
: 'TGHT', signature
: 'NOTUNNEL' }
1000 const serverSupportedTunnelTypes
= {};
1001 // receive tunnel capabilities
1002 for (let i
= 0; i
< numTunnels
; i
++) {
1003 const cap_code
= this._sock
.rQshift32();
1004 const cap_vendor
= this._sock
.rQshiftStr(4);
1005 const cap_signature
= this._sock
.rQshiftStr(8);
1006 serverSupportedTunnelTypes
[cap_code
] = { vendor
: cap_vendor
, signature
: cap_signature
};
1009 Log
.Debug("Server Tight tunnel types: " + serverSupportedTunnelTypes
);
1011 // Siemens touch panels have a VNC server that supports NOTUNNEL,
1012 // but forgets to advertise it. Try to detect such servers by
1013 // looking for their custom tunnel type.
1014 if (serverSupportedTunnelTypes
[1] &&
1015 (serverSupportedTunnelTypes
[1].vendor
=== "SICR") &&
1016 (serverSupportedTunnelTypes
[1].signature
=== "SCHANNEL")) {
1017 Log
.Debug("Detected Siemens server. Assuming NOTUNNEL support.");
1018 serverSupportedTunnelTypes
[0] = { vendor
: 'TGHT', signature
: 'NOTUNNEL' };
1021 // choose the notunnel type
1022 if (serverSupportedTunnelTypes
[0]) {
1023 if (serverSupportedTunnelTypes
[0].vendor
!= clientSupportedTunnelTypes
[0].vendor
||
1024 serverSupportedTunnelTypes
[0].signature
!= clientSupportedTunnelTypes
[0].signature
) {
1025 return this._fail("Client's tunnel type had the incorrect " +
1026 "vendor or signature");
1028 Log
.Debug("Selected tunnel type: " + clientSupportedTunnelTypes
[0]);
1029 this._sock
.send([0, 0, 0, 0]); // use NOTUNNEL
1030 return false; // wait until we receive the sub auth count to continue
1032 return this._fail("Server wanted tunnels, but doesn't support " +
1033 "the notunnel type");
1037 _negotiate_tight_auth: function () {
1038 if (!this._rfb_tightvnc
) { // first pass, do the tunnel negotiation
1039 if (this._sock
.rQwait("num tunnels", 4)) { return false; }
1040 const numTunnels
= this._sock
.rQshift32();
1041 if (numTunnels
> 0 && this._sock
.rQwait("tunnel capabilities", 16 * numTunnels
, 4)) { return false; }
1043 this._rfb_tightvnc
= true;
1045 if (numTunnels
> 0) {
1046 this._negotiate_tight_tunnels(numTunnels
);
1047 return false; // wait until we receive the sub auth to continue
1051 // second pass, do the sub-auth negotiation
1052 if (this._sock
.rQwait("sub auth count", 4)) { return false; }
1053 const subAuthCount
= this._sock
.rQshift32();
1054 if (subAuthCount
=== 0) { // empty sub-auth list received means 'no auth' subtype selected
1055 this._rfb_init_state
= 'SecurityResult';
1059 if (this._sock
.rQwait("sub auth capabilities", 16 * subAuthCount
, 4)) { return false; }
1061 const clientSupportedTypes
= {
1066 const serverSupportedTypes
= [];
1068 for (let i
= 0; i
< subAuthCount
; i
++) {
1069 this._sock
.rQshift32(); // capNum
1070 const capabilities
= this._sock
.rQshiftStr(12);
1071 serverSupportedTypes
.push(capabilities
);
1074 Log
.Debug("Server Tight authentication types: " + serverSupportedTypes
);
1076 for (let authType
in clientSupportedTypes
) {
1077 if (serverSupportedTypes
.indexOf(authType
) != -1) {
1078 this._sock
.send([0, 0, 0, clientSupportedTypes
[authType
]]);
1079 Log
.Debug("Selected authentication type: " + authType
);
1082 case 'STDVNOAUTH__': // no auth
1083 this._rfb_init_state
= 'SecurityResult';
1085 case 'STDVVNCAUTH_': // VNC auth
1086 this._rfb_auth_scheme
= 2;
1087 return this._init_msg();
1089 return this._fail("Unsupported tiny auth scheme " +
1090 "(scheme: " + authType
+ ")");
1095 return this._fail("No supported sub-auth types!");
1098 _negotiate_authentication: function () {
1099 switch (this._rfb_auth_scheme
) {
1100 case 0: // connection failed
1101 return this._handle_security_failure("authentication scheme");
1104 if (this._rfb_version
>= 3.8) {
1105 this._rfb_init_state
= 'SecurityResult';
1108 this._rfb_init_state
= 'ClientInitialisation';
1109 return this._init_msg();
1111 case 22: // XVP auth
1112 return this._negotiate_xvp_auth();
1114 case 2: // VNC authentication
1115 return this._negotiate_std_vnc_auth();
1117 case 16: // TightVNC Security Type
1118 return this._negotiate_tight_auth();
1121 return this._fail("Unsupported auth scheme (scheme: " +
1122 this._rfb_auth_scheme
+ ")");
1126 _handle_security_result: function () {
1127 if (this._sock
.rQwait('VNC auth response ', 4)) { return false; }
1129 const status
= this._sock
.rQshift32();
1131 if (status
=== 0) { // OK
1132 this._rfb_init_state
= 'ClientInitialisation';
1133 Log
.Debug('Authentication OK');
1134 return this._init_msg();
1136 if (this._rfb_version
>= 3.8) {
1137 return this._handle_security_failure("security result", status
);
1139 this.dispatchEvent(new CustomEvent(
1141 { detail
: { status
: status
} }));
1143 return this._fail("Security handshake failed");
1148 _negotiate_server_init: function () {
1149 if (this._sock
.rQwait("server initialization", 24)) { return false; }
1152 const width
= this._sock
.rQshift16();
1153 const height
= this._sock
.rQshift16();
1156 const bpp
= this._sock
.rQshift8();
1157 const depth
= this._sock
.rQshift8();
1158 const big_endian
= this._sock
.rQshift8();
1159 const true_color
= this._sock
.rQshift8();
1161 const red_max
= this._sock
.rQshift16();
1162 const green_max
= this._sock
.rQshift16();
1163 const blue_max
= this._sock
.rQshift16();
1164 const red_shift
= this._sock
.rQshift8();
1165 const green_shift
= this._sock
.rQshift8();
1166 const blue_shift
= this._sock
.rQshift8();
1167 this._sock
.rQskipBytes(3); // padding
1169 // NB(directxman12): we don't want to call any callbacks or print messages until
1170 // *after* we're past the point where we could backtrack
1172 /* Connection name/title */
1173 const name_length = this._sock.rQshift32();
1174 if (this._sock.rQwait('server init name', name_length, 24)) { return false; }
1175 this._fb_name = decodeUTF8(this._sock.rQshiftStr(name_length));
1177 if (this._rfb_tightvnc) {
1178 if (this._sock.rQwait('TightVNC extended server init header', 8, 24 + name_length)) { return false; }
1179 // In TightVNC mode, ServerInit message is extended
1180 const numServerMessages = this._sock.rQshift16();
1181 const numClientMessages = this._sock.rQshift16();
1182 const numEncodings = this._sock.rQshift16();
1183 this._sock.rQskipBytes(2); // padding
1185 const totalMessagesLength = (numServerMessages + numClientMessages + numEncodings) * 16;
1186 if (this._sock.rQwait('TightVNC extended server init header', totalMessagesLength, 32 + name_length)) { return false; }
1188 // we don't actually do anything with the capability information that TIGHT sends,
1189 // so we just skip the all of this.
1191 // TIGHT server message capabilities
1192 this._sock.rQskipBytes(16 * numServerMessages);
1194 // TIGHT client message capabilities
1195 this._sock.rQskipBytes(16 * numClientMessages);
1197 // TIGHT encoding capabilities
1198 this._sock.rQskipBytes(16 * numEncodings);
1201 // NB(directxman12): these are down here so that we don't run them multiple times
1203 Log.Info("Screen: " + width + "x" + height +
1204 ", bpp: " + bpp + ", depth: " + depth +
1205 ", big_endian: " + big_endian +
1206 ", true_color: " + true_color +
1207 ", red_max: " + red_max +
1208 ", green_max: " + green_max +
1209 ", blue_max: " + blue_max +
1210 ", red_shift: " + red_shift +
1211 ", green_shift: " + green_shift +
1212 ", blue_shift: " + blue_shift);
1214 if (big_endian !== 0) {
1215 Log.Warn("Server native endian is not little endian");
1218 if (red_shift !== 16) {
1219 Log.Warn("Server native red-shift is not 16");
1222 if (blue_shift !== 0) {
1223 Log.Warn("Server native blue-shift is not 0");
1226 // we're past the point where we could backtrack, so it's safe to call this
1227 this.dispatchEvent(new CustomEvent(
1229 { detail: { name: this._fb_name } }));
1231 this._resize(width, height);
1233 if (!this._viewOnly) { this._keyboard.grab(); }
1234 if (!this._viewOnly) { this._mouse.grab(); }
1236 this._fb_depth = 24;
1238 if (this._fb_name === "Intel(r) AMT KVM") {
1239 Log.Warn("Intel AMT KVM only supports 8/16 bit depths. Using low color mode.");
1243 RFB.messages.pixelFormat(this._sock, this._fb_depth, true);
1244 this._sendEncodings();
1245 RFB.messages.fbUpdateRequest(this._sock, false, 0, 0, this._fb_width, this._fb_height);
1247 this._timing.fbu_rt_start = (new Date()).getTime();
1248 this._timing.pixels = 0;
1250 // Cursor will be server side until the server decides to honor
1251 // our request and send over the cursor image
1252 this._display.disableLocalCursor();
1254 this._updateConnectionState('connected');
1258 _sendEncodings: function () {
1261 // In preference order
1262 encs.push(encodings.encodingCopyRect);
1263 // Only supported with full depth support
1264 if (this._fb_depth == 24) {
1265 encs.push(encodings.encodingTight);
1266 encs.push(encodings.encodingTightPNG);
1267 encs.push(encodings.encodingHextile);
1268 encs.push(encodings.encodingRRE);
1270 encs.push(encodings.encodingRaw);
1272 // Psuedo-encoding settings
1273 encs.push(encodings.pseudoEncodingQualityLevel0 + 6);
1274 encs.push(encodings.pseudoEncodingCompressLevel0 + 2);
1276 encs.push(encodings.pseudoEncodingDesktopSize);
1277 encs.push(encodings.pseudoEncodingLastRect);
1278 encs.push(encodings.pseudoEncodingQEMUExtendedKeyEvent);
1279 encs.push(encodings.pseudoEncodingExtendedDesktopSize);
1280 encs.push(encodings.pseudoEncodingXvp);
1281 encs.push(encodings.pseudoEncodingFence);
1282 encs.push(encodings.pseudoEncodingContinuousUpdates);
1284 if (supportsCursorURIs() &&
1285 !isTouchDevice && this._fb_depth == 24) {
1286 encs.push(encodings.pseudoEncodingCursor);
1289 RFB.messages.clientEncodings(this._sock, encs);
1292 /* RFB protocol initialization states:
1297 * ClientInitialization - not triggered by server message
1298 * ServerInitialization
1300 _init_msg: function () {
1301 switch (this._rfb_init_state
) {
1302 case 'ProtocolVersion':
1303 return this._negotiate_protocol_version();
1306 return this._negotiate_security();
1308 case 'Authentication':
1309 return this._negotiate_authentication();
1311 case 'SecurityResult':
1312 return this._handle_security_result();
1314 case 'ClientInitialisation':
1315 this._sock
.send([this._shared
? 1 : 0]); // ClientInitialisation
1316 this._rfb_init_state
= 'ServerInitialisation';
1319 case 'ServerInitialisation':
1320 return this._negotiate_server_init();
1323 return this._fail("Unknown init state (state: " +
1324 this._rfb_init_state
+ ")");
1328 _handle_set_colour_map_msg: function () {
1329 Log
.Debug("SetColorMapEntries");
1331 return this._fail("Unexpected SetColorMapEntries message");
1334 _handle_server_cut_text: function () {
1335 Log
.Debug("ServerCutText");
1337 if (this._sock
.rQwait("ServerCutText header", 7, 1)) { return false; }
1338 this._sock
.rQskipBytes(3); // Padding
1339 const length
= this._sock
.rQshift32();
1340 if (this._sock
.rQwait("ServerCutText", length
, 8)) { return false; }
1342 const text
= this._sock
.rQshiftStr(length
);
1344 if (this._viewOnly
) { return true; }
1346 this.dispatchEvent(new CustomEvent(
1348 { detail
: { text
: text
} }));
1353 _handle_server_fence_msg: function() {
1354 if (this._sock
.rQwait("ServerFence header", 8, 1)) { return false; }
1355 this._sock
.rQskipBytes(3); // Padding
1356 let flags
= this._sock
.rQshift32();
1357 let length
= this._sock
.rQshift8();
1359 if (this._sock
.rQwait("ServerFence payload", length
, 9)) { return false; }
1362 Log
.Warn("Bad payload length (" + length
+ ") in fence response");
1366 const payload
= this._sock
.rQshiftStr(length
);
1368 this._supportsFence
= true;
1373 * (1<<0) - BlockBefore
1374 * (1<<1) - BlockAfter
1379 if (!(flags
& (1<<31))) {
1380 return this._fail("Unexpected fence response");
1383 // Filter out unsupported flags
1384 // FIXME: support syncNext
1385 flags
&= (1<<0) | (1<<1);
1387 // BlockBefore and BlockAfter are automatically handled by
1388 // the fact that we process each incoming message
1390 RFB
.messages
.clientFence(this._sock
, flags
, payload
);
1395 _handle_xvp_msg: function () {
1396 if (this._sock
.rQwait("XVP version and message", 3, 1)) { return false; }
1397 this._sock
.rQskip8(); // Padding
1398 const xvp_ver
= this._sock
.rQshift8();
1399 const xvp_msg
= this._sock
.rQshift8();
1403 Log
.Error("XVP Operation Failed");
1406 this._rfb_xvp_ver
= xvp_ver
;
1407 Log
.Info("XVP extensions enabled (version " + this._rfb_xvp_ver
+ ")");
1408 this._setCapability("power", true);
1411 this._fail("Illegal server XVP message (msg: " + xvp_msg
+ ")");
1418 _normal_msg: function () {
1420 if (this._FBU
.rects
> 0) {
1423 msg_type
= this._sock
.rQshift8();
1428 case 0: // FramebufferUpdate
1429 ret
= this._framebufferUpdate();
1430 if (ret
&& !this._enabledContinuousUpdates
) {
1431 RFB
.messages
.fbUpdateRequest(this._sock
, true, 0, 0,
1432 this._fb_width
, this._fb_height
);
1436 case 1: // SetColorMapEntries
1437 return this._handle_set_colour_map_msg();
1441 this.dispatchEvent(new CustomEvent(
1446 case 3: // ServerCutText
1447 return this._handle_server_cut_text();
1449 case 150: // EndOfContinuousUpdates
1450 first
= !this._supportsContinuousUpdates
;
1451 this._supportsContinuousUpdates
= true;
1452 this._enabledContinuousUpdates
= false;
1454 this._enabledContinuousUpdates
= true;
1455 this._updateContinuousUpdates();
1456 Log
.Info("Enabling continuous updates.");
1458 // FIXME: We need to send a framebufferupdaterequest here
1459 // if we add support for turning off continuous updates
1463 case 248: // ServerFence
1464 return this._handle_server_fence_msg();
1467 return this._handle_xvp_msg();
1470 this._fail("Unexpected server message (type " + msg_type
+ ")");
1471 Log
.Debug("sock.rQslice(0, 30): " + this._sock
.rQslice(0, 30));
1476 _onFlush: function() {
1477 this._flushing
= false;
1478 // Resume processing
1479 if (this._sock
.rQlen() > 0) {
1480 this._handle_message();
1484 _framebufferUpdate: function () {
1485 if (this._FBU
.rects
=== 0) {
1486 if (this._sock
.rQwait("FBU header", 3, 1)) { return false; }
1487 this._sock
.rQskip8(); // Padding
1488 this._FBU
.rects
= this._sock
.rQshift16();
1489 this._FBU
.bytes
= 0;
1490 this._timing
.cur_fbu
= 0;
1491 if (this._timing
.fbu_rt_start
> 0) {
1492 const now
= (new Date()).getTime();
1493 Log
.Info("First FBU latency: " + (now
- this._timing
.fbu_rt_start
));
1496 // Make sure the previous frame is fully rendered first
1497 // to avoid building up an excessive queue
1498 if (this._display
.pending()) {
1499 this._flushing
= true;
1500 this._display
.flush();
1505 while (this._FBU
.rects
> 0) {
1506 if (this._rfb_connection_state
!== 'connected') { return false; }
1508 if (this._sock
.rQwait("FBU", this._FBU
.bytes
)) { return false; }
1509 if (this._FBU
.bytes
=== 0) {
1510 if (this._sock
.rQwait("rect header", 12)) { return false; }
1511 /* New FramebufferUpdate */
1513 const hdr
= this._sock
.rQshiftBytes(12);
1514 this._FBU
.x
= (hdr
[0] << 8) + hdr
[1];
1515 this._FBU
.y
= (hdr
[2] << 8) + hdr
[3];
1516 this._FBU
.width
= (hdr
[4] << 8) + hdr
[5];
1517 this._FBU
.height
= (hdr
[6] << 8) + hdr
[7];
1518 this._FBU
.encoding
= parseInt((hdr
[8] << 24) + (hdr
[9] << 16) +
1519 (hdr
[10] << 8) + hdr
[11], 10);
1521 if (!this._encHandlers
[this._FBU
.encoding
]) {
1522 this._fail("Unsupported encoding (encoding: " +
1523 this._FBU
.encoding
+ ")");
1528 this._timing
.last_fbu
= (new Date()).getTime();
1530 const ret
= this._encHandlers
[this._FBU
.encoding
]();
1532 const now
= (new Date()).getTime();
1533 this._timing
.cur_fbu
+= (now
- this._timing
.last_fbu
);
1536 if (!(this._FBU
.encoding
in this._encStats
)) {
1537 this._encStats
[this._FBU
.encoding
] = [0, 0];
1539 this._encStats
[this._FBU
.encoding
][0]++;
1540 this._encStats
[this._FBU
.encoding
][1]++;
1541 this._timing
.pixels
+= this._FBU
.width
* this._FBU
.height
;
1544 if (this._timing
.pixels
>= (this._fb_width
* this._fb_height
)) {
1545 if ((this._FBU
.width
=== this._fb_width
&& this._FBU
.height
=== this._fb_height
) ||
1546 this._timing
.fbu_rt_start
> 0) {
1547 this._timing
.full_fbu_total
+= this._timing
.cur_fbu
;
1548 this._timing
.full_fbu_cnt
++;
1549 Log
.Info("Timing of full FBU, curr: " +
1550 this._timing
.cur_fbu
+ ", total: " +
1551 this._timing
.full_fbu_total
+ ", cnt: " +
1552 this._timing
.full_fbu_cnt
+ ", avg: " +
1553 (this._timing
.full_fbu_total
/ this._timing
.full_fbu_cnt
));
1556 if (this._timing
.fbu_rt_start
> 0) {
1557 const fbu_rt_diff
= now
- this._timing
.fbu_rt_start
;
1558 this._timing
.fbu_rt_total
+= fbu_rt_diff
;
1559 this._timing
.fbu_rt_cnt
++;
1560 Log
.Info("full FBU round-trip, cur: " +
1561 fbu_rt_diff
+ ", total: " +
1562 this._timing
.fbu_rt_total
+ ", cnt: " +
1563 this._timing
.fbu_rt_cnt
+ ", avg: " +
1564 (this._timing
.fbu_rt_total
/ this._timing
.fbu_rt_cnt
));
1565 this._timing
.fbu_rt_start
= 0;
1569 if (!ret
) { return ret
; } // need more data
1572 this._display
.flip();
1574 return true; // We finished this FBU
1577 _updateContinuousUpdates: function() {
1578 if (!this._enabledContinuousUpdates
) { return; }
1580 RFB
.messages
.enableContinuousUpdates(this._sock
, true, 0, 0,
1581 this._fb_width
, this._fb_height
);
1584 _resize: function(width
, height
) {
1585 this._fb_width
= width
;
1586 this._fb_height
= height
;
1588 this._destBuff
= new Uint8Array(this._fb_width
* this._fb_height
* 4);
1590 this._display
.resize(this._fb_width
, this._fb_height
);
1592 // Adjust the visible viewport based on the new dimensions
1594 this._updateScale();
1596 this._timing
.fbu_rt_start
= (new Date()).getTime();
1597 this._updateContinuousUpdates();
1600 _xvpOp: function (ver
, op
) {
1601 if (this._rfb_xvp_ver
< ver
) { return; }
1602 Log
.Info("Sending XVP operation " + op
+ " (version " + ver
+ ")");
1603 RFB
.messages
.xvpOp(this._sock
, ver
, op
);
1607 Object
.assign(RFB
.prototype, EventTargetMixin
);
1611 keyEvent: function (sock
, keysym
, down
) {
1612 const buff
= sock
._sQ
;
1613 const offset
= sock
._sQlen
;
1615 buff
[offset
] = 4; // msg-type
1616 buff
[offset
+ 1] = down
;
1618 buff
[offset
+ 2] = 0;
1619 buff
[offset
+ 3] = 0;
1621 buff
[offset
+ 4] = (keysym
>> 24);
1622 buff
[offset
+ 5] = (keysym
>> 16);
1623 buff
[offset
+ 6] = (keysym
>> 8);
1624 buff
[offset
+ 7] = keysym
;
1630 QEMUExtendedKeyEvent: function (sock
, keysym
, down
, keycode
) {
1631 function getRFBkeycode(xt_scancode
) {
1632 const upperByte
= (keycode
>> 8);
1633 const lowerByte
= (keycode
& 0x00ff);
1634 if (upperByte
=== 0xe0 && lowerByte
< 0x7f) {
1635 return lowerByte
| 0x80;
1640 const buff
= sock
._sQ
;
1641 const offset
= sock
._sQlen
;
1643 buff
[offset
] = 255; // msg-type
1644 buff
[offset
+ 1] = 0; // sub msg-type
1646 buff
[offset
+ 2] = (down
>> 8);
1647 buff
[offset
+ 3] = down
;
1649 buff
[offset
+ 4] = (keysym
>> 24);
1650 buff
[offset
+ 5] = (keysym
>> 16);
1651 buff
[offset
+ 6] = (keysym
>> 8);
1652 buff
[offset
+ 7] = keysym
;
1654 const RFBkeycode
= getRFBkeycode(keycode
);
1656 buff
[offset
+ 8] = (RFBkeycode
>> 24);
1657 buff
[offset
+ 9] = (RFBkeycode
>> 16);
1658 buff
[offset
+ 10] = (RFBkeycode
>> 8);
1659 buff
[offset
+ 11] = RFBkeycode
;
1665 pointerEvent: function (sock
, x
, y
, mask
) {
1666 const buff
= sock
._sQ
;
1667 const offset
= sock
._sQlen
;
1669 buff
[offset
] = 5; // msg-type
1671 buff
[offset
+ 1] = mask
;
1673 buff
[offset
+ 2] = x
>> 8;
1674 buff
[offset
+ 3] = x
;
1676 buff
[offset
+ 4] = y
>> 8;
1677 buff
[offset
+ 5] = y
;
1683 // TODO(directxman12): make this unicode compatible?
1684 clientCutText: function (sock
, text
) {
1685 const buff
= sock
._sQ
;
1686 const offset
= sock
._sQlen
;
1688 buff
[offset
] = 6; // msg-type
1690 buff
[offset
+ 1] = 0; // padding
1691 buff
[offset
+ 2] = 0; // padding
1692 buff
[offset
+ 3] = 0; // padding
1694 const length
= text
.length
;
1696 buff
[offset
+ 4] = length
>> 24;
1697 buff
[offset
+ 5] = length
>> 16;
1698 buff
[offset
+ 6] = length
>> 8;
1699 buff
[offset
+ 7] = length
;
1703 // We have to keep track of from where in the text we begin creating the
1704 // buffer for the flush in the next iteration.
1707 let remaining
= length
;
1708 while (remaining
> 0) {
1710 const flushSize
= Math
.min(remaining
, (sock
._sQbufferSize
- sock
._sQlen
));
1711 if (flushSize
<= 0) {
1712 this._fail("Clipboard contents could not be sent");
1716 for (let i
= 0; i
< flushSize
; i
++) {
1717 buff
[sock
._sQlen
+ i
] = text
.charCodeAt(textOffset
+ i
);
1720 sock
._sQlen
+= flushSize
;
1723 remaining
-= flushSize
;
1724 textOffset
+= flushSize
;
1728 setDesktopSize: function (sock
, width
, height
, id
, flags
) {
1729 const buff
= sock
._sQ
;
1730 const offset
= sock
._sQlen
;
1732 buff
[offset
] = 251; // msg-type
1733 buff
[offset
+ 1] = 0; // padding
1734 buff
[offset
+ 2] = width
>> 8; // width
1735 buff
[offset
+ 3] = width
;
1736 buff
[offset
+ 4] = height
>> 8; // height
1737 buff
[offset
+ 5] = height
;
1739 buff
[offset
+ 6] = 1; // number-of-screens
1740 buff
[offset
+ 7] = 0; // padding
1743 buff
[offset
+ 8] = id
>> 24; // id
1744 buff
[offset
+ 9] = id
>> 16;
1745 buff
[offset
+ 10] = id
>> 8;
1746 buff
[offset
+ 11] = id
;
1747 buff
[offset
+ 12] = 0; // x-position
1748 buff
[offset
+ 13] = 0;
1749 buff
[offset
+ 14] = 0; // y-position
1750 buff
[offset
+ 15] = 0;
1751 buff
[offset
+ 16] = width
>> 8; // width
1752 buff
[offset
+ 17] = width
;
1753 buff
[offset
+ 18] = height
>> 8; // height
1754 buff
[offset
+ 19] = height
;
1755 buff
[offset
+ 20] = flags
>> 24; // flags
1756 buff
[offset
+ 21] = flags
>> 16;
1757 buff
[offset
+ 22] = flags
>> 8;
1758 buff
[offset
+ 23] = flags
;
1764 clientFence: function (sock
, flags
, payload
) {
1765 const buff
= sock
._sQ
;
1766 const offset
= sock
._sQlen
;
1768 buff
[offset
] = 248; // msg-type
1770 buff
[offset
+ 1] = 0; // padding
1771 buff
[offset
+ 2] = 0; // padding
1772 buff
[offset
+ 3] = 0; // padding
1774 buff
[offset
+ 4] = flags
>> 24; // flags
1775 buff
[offset
+ 5] = flags
>> 16;
1776 buff
[offset
+ 6] = flags
>> 8;
1777 buff
[offset
+ 7] = flags
;
1779 const n
= payload
.length
;
1781 buff
[offset
+ 8] = n
; // length
1783 for (let i
= 0; i
< n
; i
++) {
1784 buff
[offset
+ 9 + i
] = payload
.charCodeAt(i
);
1787 sock
._sQlen
+= 9 + n
;
1791 enableContinuousUpdates: function (sock
, enable
, x
, y
, width
, height
) {
1792 const buff
= sock
._sQ
;
1793 const offset
= sock
._sQlen
;
1795 buff
[offset
] = 150; // msg-type
1796 buff
[offset
+ 1] = enable
; // enable-flag
1798 buff
[offset
+ 2] = x
>> 8; // x
1799 buff
[offset
+ 3] = x
;
1800 buff
[offset
+ 4] = y
>> 8; // y
1801 buff
[offset
+ 5] = y
;
1802 buff
[offset
+ 6] = width
>> 8; // width
1803 buff
[offset
+ 7] = width
;
1804 buff
[offset
+ 8] = height
>> 8; // height
1805 buff
[offset
+ 9] = height
;
1811 pixelFormat: function (sock
, depth
, true_color
) {
1812 const buff
= sock
._sQ
;
1813 const offset
= sock
._sQlen
;
1819 } else if (depth
> 8) {
1825 const bits
= Math
.floor(depth
/3);
1827 buff
[offset
] = 0; // msg-type
1829 buff
[offset
+ 1] = 0; // padding
1830 buff
[offset
+ 2] = 0; // padding
1831 buff
[offset
+ 3] = 0; // padding
1833 buff
[offset
+ 4] = bpp
; // bits-per-pixel
1834 buff
[offset
+ 5] = depth
; // depth
1835 buff
[offset
+ 6] = 0; // little-endian
1836 buff
[offset
+ 7] = true_color
? 1 : 0; // true-color
1838 buff
[offset
+ 8] = 0; // red-max
1839 buff
[offset
+ 9] = (1 << bits
) - 1; // red-max
1841 buff
[offset
+ 10] = 0; // green-max
1842 buff
[offset
+ 11] = (1 << bits
) - 1; // green-max
1844 buff
[offset
+ 12] = 0; // blue-max
1845 buff
[offset
+ 13] = (1 << bits
) - 1; // blue-max
1847 buff
[offset
+ 14] = bits
* 2; // red-shift
1848 buff
[offset
+ 15] = bits
* 1; // green-shift
1849 buff
[offset
+ 16] = bits
* 0; // blue-shift
1851 buff
[offset
+ 17] = 0; // padding
1852 buff
[offset
+ 18] = 0; // padding
1853 buff
[offset
+ 19] = 0; // padding
1859 clientEncodings: function (sock
, encodings
) {
1860 const buff
= sock
._sQ
;
1861 const offset
= sock
._sQlen
;
1863 buff
[offset
] = 2; // msg-type
1864 buff
[offset
+ 1] = 0; // padding
1866 buff
[offset
+ 2] = encodings
.length
>> 8;
1867 buff
[offset
+ 3] = encodings
.length
;
1870 for (let i
= 0; i
< encodings
.length
; i
++) {
1871 const enc
= encodings
[i
];
1872 buff
[j
] = enc
>> 24;
1873 buff
[j
+ 1] = enc
>> 16;
1874 buff
[j
+ 2] = enc
>> 8;
1880 sock
._sQlen
+= j
- offset
;
1884 fbUpdateRequest: function (sock
, incremental
, x
, y
, w
, h
) {
1885 const buff
= sock
._sQ
;
1886 const offset
= sock
._sQlen
;
1888 if (typeof(x
) === "undefined") { x
= 0; }
1889 if (typeof(y
) === "undefined") { y
= 0; }
1891 buff
[offset
] = 3; // msg-type
1892 buff
[offset
+ 1] = incremental
? 1 : 0;
1894 buff
[offset
+ 2] = (x
>> 8) & 0xFF;
1895 buff
[offset
+ 3] = x
& 0xFF;
1897 buff
[offset
+ 4] = (y
>> 8) & 0xFF;
1898 buff
[offset
+ 5] = y
& 0xFF;
1900 buff
[offset
+ 6] = (w
>> 8) & 0xFF;
1901 buff
[offset
+ 7] = w
& 0xFF;
1903 buff
[offset
+ 8] = (h
>> 8) & 0xFF;
1904 buff
[offset
+ 9] = h
& 0xFF;
1910 xvpOp: function (sock
, ver
, op
) {
1911 const buff
= sock
._sQ
;
1912 const offset
= sock
._sQlen
;
1914 buff
[offset
] = 250; // msg-type
1915 buff
[offset
+ 1] = 0; // padding
1917 buff
[offset
+ 2] = ver
;
1918 buff
[offset
+ 3] = op
;
1925 RFB
.genDES = function (password
, challenge
) {
1927 for (let i
= 0; i
< password
.length
; i
++) {
1928 passwd
.push(password
.charCodeAt(i
));
1930 return (new DES(passwd
)).encrypt(challenge
);
1933 RFB
.encodingHandlers
= {
1935 if (this._FBU
.lines
=== 0) {
1936 this._FBU
.lines
= this._FBU
.height
;
1939 const pixelSize
= this._fb_depth
== 8 ? 1 : 4;
1940 this._FBU
.bytes
= this._FBU
.width
* pixelSize
; // at least a line
1941 if (this._sock
.rQwait("RAW", this._FBU
.bytes
)) { return false; }
1942 const cur_y
= this._FBU
.y
+ (this._FBU
.height
- this._FBU
.lines
);
1943 const curr_height
= Math
.min(this._FBU
.lines
,
1944 Math
.floor(this._sock
.rQlen() / (this._FBU
.width
* pixelSize
)));
1945 let data
= this._sock
.get_rQ();
1946 let index
= this._sock
.get_rQi();
1947 if (this._fb_depth
== 8) {
1948 const pixels
= this._FBU
.width
* curr_height
1949 const newdata
= new Uint8Array(pixels
* 4);
1950 for (let i
= 0; i
< pixels
; i
++) {
1951 newdata
[i
* 4 + 0] = ((data
[index
+ i
] >> 0) & 0x3) * 255 / 3;
1952 newdata
[i
* 4 + 1] = ((data
[index
+ i
] >> 2) & 0x3) * 255 / 3;
1953 newdata
[i
* 4 + 2] = ((data
[index
+ i
] >> 4) & 0x3) * 255 / 3;
1954 newdata
[i
* 4 + 4] = 0;
1959 this._display
.blitImage(this._FBU
.x
, cur_y
, this._FBU
.width
,
1960 curr_height
, data
, index
);
1961 this._sock
.rQskipBytes(this._FBU
.width
* curr_height
* pixelSize
);
1962 this._FBU
.lines
-= curr_height
;
1964 if (this._FBU
.lines
> 0) {
1965 this._FBU
.bytes
= this._FBU
.width
* pixelSize
; // At least another line
1968 this._FBU
.bytes
= 0;
1974 COPYRECT: function () {
1975 this._FBU
.bytes
= 4;
1976 if (this._sock
.rQwait("COPYRECT", 4)) { return false; }
1977 this._display
.copyImage(this._sock
.rQshift16(), this._sock
.rQshift16(),
1978 this._FBU
.x
, this._FBU
.y
, this._FBU
.width
,
1982 this._FBU
.bytes
= 0;
1988 if (this._FBU
.subrects
=== 0) {
1989 this._FBU
.bytes
= 4 + 4;
1990 if (this._sock
.rQwait("RRE", 4 + 4)) { return false; }
1991 this._FBU
.subrects
= this._sock
.rQshift32();
1992 color
= this._sock
.rQshiftBytes(4); // Background
1993 this._display
.fillRect(this._FBU
.x
, this._FBU
.y
, this._FBU
.width
, this._FBU
.height
, color
);
1996 while (this._FBU
.subrects
> 0 && this._sock
.rQlen() >= (4 + 8)) {
1997 color
= this._sock
.rQshiftBytes(4);
1998 const x
= this._sock
.rQshift16();
1999 const y
= this._sock
.rQshift16();
2000 const width
= this._sock
.rQshift16();
2001 const height
= this._sock
.rQshift16();
2002 this._display
.fillRect(this._FBU
.x
+ x
, this._FBU
.y
+ y
, width
, height
, color
);
2003 this._FBU
.subrects
--;
2006 if (this._FBU
.subrects
> 0) {
2007 const chunk
= Math
.min(this._rre_chunk_sz
, this._FBU
.subrects
);
2008 this._FBU
.bytes
= (4 + 8) * chunk
;
2011 this._FBU
.bytes
= 0;
2017 HEXTILE: function () {
2018 const rQ
= this._sock
.get_rQ();
2019 let rQi
= this._sock
.get_rQi();
2021 if (this._FBU
.tiles
=== 0) {
2022 this._FBU
.tiles_x
= Math
.ceil(this._FBU
.width
/ 16);
2023 this._FBU
.tiles_y
= Math
.ceil(this._FBU
.height
/ 16);
2024 this._FBU
.total_tiles
= this._FBU
.tiles_x
* this._FBU
.tiles_y
;
2025 this._FBU
.tiles
= this._FBU
.total_tiles
;
2028 while (this._FBU
.tiles
> 0) {
2029 this._FBU
.bytes
= 1;
2030 if (this._sock
.rQwait("HEXTILE subencoding", this._FBU
.bytes
)) { return false; }
2031 const subencoding
= rQ
[rQi
]; // Peek
2032 if (subencoding
> 30) { // Raw
2033 this._fail("Illegal hextile subencoding (subencoding: " +
2039 const curr_tile
= this._FBU
.total_tiles
- this._FBU
.tiles
;
2040 const tile_x
= curr_tile
% this._FBU
.tiles_x
;
2041 const tile_y
= Math
.floor(curr_tile
/ this._FBU
.tiles_x
);
2042 const x
= this._FBU
.x
+ tile_x
* 16;
2043 const y
= this._FBU
.y
+ tile_y
* 16;
2044 const w
= Math
.min(16, (this._FBU
.x
+ this._FBU
.width
) - x
);
2045 const h
= Math
.min(16, (this._FBU
.y
+ this._FBU
.height
) - y
);
2047 // Figure out how much we are expecting
2048 if (subencoding
& 0x01) { // Raw
2049 this._FBU
.bytes
+= w
* h
* 4;
2051 if (subencoding
& 0x02) { // Background
2052 this._FBU
.bytes
+= 4;
2054 if (subencoding
& 0x04) { // Foreground
2055 this._FBU
.bytes
+= 4;
2057 if (subencoding
& 0x08) { // AnySubrects
2058 this._FBU
.bytes
++; // Since we aren't shifting it off
2059 if (this._sock
.rQwait("hextile subrects header", this._FBU
.bytes
)) { return false; }
2060 subrects
= rQ
[rQi
+ this._FBU
.bytes
- 1]; // Peek
2061 if (subencoding
& 0x10) { // SubrectsColoured
2062 this._FBU
.bytes
+= subrects
* (4 + 2);
2064 this._FBU
.bytes
+= subrects
* 2;
2069 if (this._sock
.rQwait("hextile", this._FBU
.bytes
)) { return false; }
2071 // We know the encoding and have a whole tile
2072 this._FBU
.subencoding
= rQ
[rQi
];
2074 if (this._FBU
.subencoding
=== 0) {
2075 if (this._FBU
.lastsubencoding
& 0x01) {
2076 // Weird: ignore blanks are RAW
2077 Log
.Debug(" Ignoring blank after RAW");
2079 this._display
.fillRect(x
, y
, w
, h
, this._FBU
.background
);
2081 } else if (this._FBU
.subencoding
& 0x01) { // Raw
2082 this._display
.blitImage(x
, y
, w
, h
, rQ
, rQi
);
2083 rQi
+= this._FBU
.bytes
- 1;
2085 if (this._FBU
.subencoding
& 0x02) { // Background
2086 this._FBU
.background
= [rQ
[rQi
], rQ
[rQi
+ 1], rQ
[rQi
+ 2], rQ
[rQi
+ 3]];
2089 if (this._FBU
.subencoding
& 0x04) { // Foreground
2090 this._FBU
.foreground
= [rQ
[rQi
], rQ
[rQi
+ 1], rQ
[rQi
+ 2], rQ
[rQi
+ 3]];
2094 this._display
.startTile(x
, y
, w
, h
, this._FBU
.background
);
2095 if (this._FBU
.subencoding
& 0x08) { // AnySubrects
2099 for (let s
= 0; s
< subrects
; s
++) {
2101 if (this._FBU
.subencoding
& 0x10) { // SubrectsColoured
2102 color
= [rQ
[rQi
], rQ
[rQi
+ 1], rQ
[rQi
+ 2], rQ
[rQi
+ 3]];
2105 color
= this._FBU
.foreground
;
2109 const sx
= (xy
>> 4);
2110 const sy
= (xy
& 0x0f);
2114 const sw
= (wh
>> 4) + 1;
2115 const sh
= (wh
& 0x0f) + 1;
2117 this._display
.subTile(sx
, sy
, sw
, sh
, color
);
2120 this._display
.finishTile();
2122 this._sock
.set_rQi(rQi
);
2123 this._FBU
.lastsubencoding
= this._FBU
.subencoding
;
2124 this._FBU
.bytes
= 0;
2128 if (this._FBU
.tiles
=== 0) {
2135 TIGHT: function (isTightPNG
) {
2136 this._FBU
.bytes
= 1; // compression-control byte
2137 if (this._sock
.rQwait("TIGHT compression-control", this._FBU
.bytes
)) { return false; }
2139 let resetStreams
= 0;
2141 const decompress = function (data
, expected
) {
2142 for (let i
= 0; i
< 4; i
++) {
2143 if ((resetStreams
>> i
) & 1) {
2144 this._FBU
.zlibs
[i
].reset();
2145 Log
.Info("Reset zlib stream " + i
);
2149 //const uncompressed = this._FBU.zlibs[streamId].uncompress(data, 0);
2150 const uncompressed
= this._FBU
.zlibs
[streamId
].inflate(data
, true, expected
);
2151 /*if (uncompressed.status !== 0) {
2152 Log.Error("Invalid data in zlib stream");
2155 //return uncompressed.data;
2156 return uncompressed
;
2159 const indexedToRGBX2Color = function (data
, palette
, width
, height
) {
2160 // Convert indexed (palette based) image data to RGB
2161 // TODO: reduce number of calculations inside loop
2162 const dest
= this._destBuff
;
2163 const w
= Math
.floor((width
+ 7) / 8);
2164 const w1
= Math
.floor(width
/ 8);
2166 /*for (let y = 0; y < height; y++) {
2168 const yoffset = y * width;
2169 const ybitoffset = y * w;
2170 let xoffset, targetbyte;
2171 for (x = 0; x < w1; x++) {
2172 xoffset = yoffset + x * 8;
2173 targetbyte = data[ybitoffset + x];
2174 for (b = 7; b >= 0; b--) {
2175 dp = (xoffset + 7 - b) * 3;
2176 sp = (targetbyte >> b & 1) * 3;
2177 dest[dp] = palette[sp];
2178 dest[dp + 1] = palette[sp + 1];
2179 dest[dp + 2] = palette[sp + 2];
2183 xoffset = yoffset + x * 8;
2184 targetbyte = data[ybitoffset + x];
2185 for (b = 7; b >= 8 - width % 8; b--) {
2186 dp = (xoffset + 7 - b) * 3;
2187 sp = (targetbyte >> b & 1) * 3;
2188 dest[dp] = palette[sp];
2189 dest[dp + 1] = palette[sp + 1];
2190 dest[dp + 2] = palette[sp + 2];
2194 for (let y
= 0; y
< height
; y
++) {
2196 for (x
= 0; x
< w1
; x
++) {
2197 for (let b
= 7; b
>= 0; b
--) {
2198 dp
= (y
* width
+ x
* 8 + 7 - b
) * 4;
2199 sp
= (data
[y
* w
+ x
] >> b
& 1) * 3;
2200 dest
[dp
] = palette
[sp
];
2201 dest
[dp
+ 1] = palette
[sp
+ 1];
2202 dest
[dp
+ 2] = palette
[sp
+ 2];
2207 for (let b
= 7; b
>= 8 - width
% 8; b
--) {
2208 dp
= (y
* width
+ x
* 8 + 7 - b
) * 4;
2209 sp
= (data
[y
* w
+ x
] >> b
& 1) * 3;
2210 dest
[dp
] = palette
[sp
];
2211 dest
[dp
+ 1] = palette
[sp
+ 1];
2212 dest
[dp
+ 2] = palette
[sp
+ 2];
2220 const indexedToRGBX = function (data
, palette
, width
, height
) {
2221 // Convert indexed (palette based) image data to RGB
2222 const dest
= this._destBuff
;
2223 const total
= width
* height
* 4;
2224 for (let i
= 0, j
= 0; i
< total
; i
+= 4, j
++) {
2225 const sp
= data
[j
] * 3;
2226 dest
[i
] = palette
[sp
];
2227 dest
[i
+ 1] = palette
[sp
+ 1];
2228 dest
[i
+ 2] = palette
[sp
+ 2];
2235 const rQi
= this._sock
.get_rQi();
2236 const rQ
= this._sock
.rQwhole();
2238 let cl_header
, cl_data
;
2240 const handlePalette = function () {
2241 const numColors
= rQ
[rQi
+ 2] + 1;
2242 const paletteSize
= numColors
* 3;
2243 this._FBU
.bytes
+= paletteSize
;
2244 if (this._sock
.rQwait("TIGHT palette " + cmode
, this._FBU
.bytes
)) { return false; }
2246 const bpp
= (numColors
<= 2) ? 1 : 8;
2247 const rowSize
= Math
.floor((this._FBU
.width
* bpp
+ 7) / 8);
2249 if (rowSize
* this._FBU
.height
< 12) {
2252 cl_data
= rowSize
* this._FBU
.height
;
2253 //clength = [0, rowSize * this._FBU.height];
2255 // begin inline getTightCLength (returning two-item arrays is bad for performance with GC)
2256 const cl_offset
= rQi
+ 3 + paletteSize
;
2259 cl_data
+= rQ
[cl_offset
] & 0x7f;
2260 if (rQ
[cl_offset
] & 0x80) {
2262 cl_data
+= (rQ
[cl_offset
+ 1] & 0x7f) << 7;
2263 if (rQ
[cl_offset
+ 1] & 0x80) {
2265 cl_data
+= rQ
[cl_offset
+ 2] << 14;
2268 // end inline getTightCLength
2271 this._FBU
.bytes
+= cl_header
+ cl_data
;
2272 if (this._sock
.rQwait("TIGHT " + cmode
, this._FBU
.bytes
)) { return false; }
2274 // Shift ctl, filter id, num colors, palette entries, and clength off
2275 this._sock
.rQskipBytes(3);
2276 //const palette = this._sock.rQshiftBytes(paletteSize);
2277 this._sock
.rQshiftTo(this._paletteBuff
, paletteSize
);
2278 this._sock
.rQskipBytes(cl_header
);
2281 data
= this._sock
.rQshiftBytes(cl_data
);
2283 data
= decompress(this._sock
.rQshiftBytes(cl_data
), rowSize
* this._FBU
.height
);
2286 // Convert indexed (palette based) image data to RGB
2288 if (numColors
== 2) {
2289 rgbx
= indexedToRGBX2Color(data
, this._paletteBuff
, this._FBU
.width
, this._FBU
.height
);
2291 rgbx
= indexedToRGBX(data
, this._paletteBuff
, this._FBU
.width
, this._FBU
.height
);
2294 this._display
.blitRgbxImage(this._FBU
.x
, this._FBU
.y
, this._FBU
.width
, this._FBU
.height
, rgbx
, 0, false);
2300 const handleCopy = function () {
2302 const uncompressedSize
= this._FBU
.width
* this._FBU
.height
* 3;
2303 if (uncompressedSize
< 12) {
2306 cl_data
= uncompressedSize
;
2308 // begin inline getTightCLength (returning two-item arrays is for peformance with GC)
2309 const cl_offset
= rQi
+ 1;
2312 cl_data
+= rQ
[cl_offset
] & 0x7f;
2313 if (rQ
[cl_offset
] & 0x80) {
2315 cl_data
+= (rQ
[cl_offset
+ 1] & 0x7f) << 7;
2316 if (rQ
[cl_offset
+ 1] & 0x80) {
2318 cl_data
+= rQ
[cl_offset
+ 2] << 14;
2321 // end inline getTightCLength
2323 this._FBU
.bytes
= 1 + cl_header
+ cl_data
;
2324 if (this._sock
.rQwait("TIGHT " + cmode
, this._FBU
.bytes
)) { return false; }
2326 // Shift ctl, clength off
2327 this._sock
.rQshiftBytes(1 + cl_header
);
2330 data
= this._sock
.rQshiftBytes(cl_data
);
2332 data
= decompress(this._sock
.rQshiftBytes(cl_data
), uncompressedSize
);
2335 this._display
.blitRgbImage(this._FBU
.x
, this._FBU
.y
, this._FBU
.width
, this._FBU
.height
, data
, 0, false);
2340 let ctl
= this._sock
.rQpeek8();
2342 // Keep tight reset bits
2343 resetStreams
= ctl
& 0xF;
2345 // Figure out filter
2347 streamId
= ctl
& 0x3;
2349 if (ctl
=== 0x08) cmode
= "fill";
2350 else if (ctl
=== 0x09) cmode
= "jpeg";
2351 else if (ctl
=== 0x0A) cmode
= "png";
2352 else if (ctl
& 0x04) cmode
= "filter";
2353 else if (ctl
< 0x04) cmode
= "copy";
2354 else return this._fail("Illegal tight compression received (ctl: " +
2357 if (isTightPNG
&& (ctl
< 0x08)) {
2358 return this._fail("BasicCompression received in TightPNG rect");
2360 if (!isTightPNG
&& (ctl
=== 0x0A)) {
2361 return this._fail("PNG received in standard Tight rect");
2365 // fill use depth because TPIXELs drop the padding byte
2366 case "fill": // TPIXEL
2367 this._FBU
.bytes
+= 3;
2369 case "jpeg": // max clength
2370 this._FBU
.bytes
+= 3;
2372 case "png": // max clength
2373 this._FBU
.bytes
+= 3;
2375 case "filter": // filter id + num colors if palette
2376 this._FBU
.bytes
+= 2;
2382 if (this._sock
.rQwait("TIGHT " + cmode
, this._FBU
.bytes
)) { return false; }
2384 // Determine FBU.bytes
2385 let cl_offset
, filterId
;
2389 this._display
.fillRect(this._FBU
.x
, this._FBU
.y
, this._FBU
.width
, this._FBU
.height
, [rQ
[rQi
+ 3], rQ
[rQi
+ 2], rQ
[rQi
+ 1]], false);
2390 this._sock
.rQskipBytes(4);
2394 // begin inline getTightCLength (returning two-item arrays is for peformance with GC)
2395 cl_offset
= rQi
+ 1;
2398 cl_data
+= rQ
[cl_offset
] & 0x7f;
2399 if (rQ
[cl_offset
] & 0x80) {
2401 cl_data
+= (rQ
[cl_offset
+ 1] & 0x7f) << 7;
2402 if (rQ
[cl_offset
+ 1] & 0x80) {
2404 cl_data
+= rQ
[cl_offset
+ 2] << 14;
2407 // end inline getTightCLength
2408 this._FBU
.bytes
= 1 + cl_header
+ cl_data
; // ctl + clength size + jpeg-data
2409 if (this._sock
.rQwait("TIGHT " + cmode
, this._FBU
.bytes
)) { return false; }
2411 // We have everything, render it
2412 this._sock
.rQskipBytes(1 + cl_header
); // shift off clt + compact length
2413 data
= this._sock
.rQshiftBytes(cl_data
);
2414 this._display
.imageRect(this._FBU
.x
, this._FBU
.y
, "image/" + cmode
, data
);
2417 filterId
= rQ
[rQi
+ 1];
2418 if (filterId
=== 1) {
2419 if (!handlePalette()) { return false; }
2421 // Filter 0, Copy could be valid here, but servers don't send it as an explicit filter
2422 // Filter 2, Gradient is valid but not use if jpeg is enabled
2423 this._fail("Unsupported tight subencoding received " +
2424 "(filter: " + filterId
+ ")");
2428 if (!handleCopy()) { return false; }
2433 this._FBU
.bytes
= 0;
2439 last_rect: function () {
2440 this._FBU
.rects
= 0;
2444 ExtendedDesktopSize: function () {
2445 this._FBU
.bytes
= 1;
2446 if (this._sock
.rQwait("ExtendedDesktopSize", this._FBU
.bytes
)) { return false; }
2448 const firstUpdate
= !this._supportsSetDesktopSize
;
2449 this._supportsSetDesktopSize
= true;
2451 // Normally we only apply the current resize mode after a
2452 // window resize event. However there is no such trigger on the
2453 // initial connect. And we don't know if the server supports
2454 // resizing until we've gotten here.
2456 this._requestRemoteResize();
2459 const number_of_screens
= this._sock
.rQpeek8();
2461 this._FBU
.bytes
= 4 + (number_of_screens
* 16);
2462 if (this._sock
.rQwait("ExtendedDesktopSize", this._FBU
.bytes
)) { return false; }
2464 this._sock
.rQskipBytes(1); // number-of-screens
2465 this._sock
.rQskipBytes(3); // padding
2467 for (let i
= 0; i
< number_of_screens
; i
+= 1) {
2468 // Save the id and flags of the first screen
2470 this._screen_id
= this._sock
.rQshiftBytes(4); // id
2471 this._sock
.rQskipBytes(2); // x-position
2472 this._sock
.rQskipBytes(2); // y-position
2473 this._sock
.rQskipBytes(2); // width
2474 this._sock
.rQskipBytes(2); // height
2475 this._screen_flags
= this._sock
.rQshiftBytes(4); // flags
2477 this._sock
.rQskipBytes(16);
2482 * The x-position indicates the reason for the change:
2484 * 0 - server resized on its own
2485 * 1 - this client requested the resize
2486 * 2 - another client requested the resize
2489 // We need to handle errors when we requested the resize.
2490 if (this._FBU
.x
=== 1 && this._FBU
.y
!== 0) {
2492 // The y-position indicates the status code from the server
2493 switch (this._FBU
.y
) {
2495 msg
= "Resize is administratively prohibited";
2498 msg
= "Out of resources";
2501 msg
= "Invalid screen layout";
2504 msg
= "Unknown reason";
2507 Log
.Warn("Server did not accept the resize request: "
2510 this._resize(this._FBU
.width
, this._FBU
.height
);
2513 this._FBU
.bytes
= 0;
2514 this._FBU
.rects
-= 1;
2518 DesktopSize: function () {
2519 this._resize(this._FBU
.width
, this._FBU
.height
);
2520 this._FBU
.bytes
= 0;
2521 this._FBU
.rects
-= 1;
2525 Cursor: function () {
2526 Log
.Debug(">> set_cursor");
2527 const x
= this._FBU
.x
; // hotspot-x
2528 const y
= this._FBU
.y
; // hotspot-y
2529 const w
= this._FBU
.width
;
2530 const h
= this._FBU
.height
;
2532 const pixelslength
= w
* h
* 4;
2533 const masklength
= Math
.floor((w
+ 7) / 8) * h
;
2535 this._FBU
.bytes
= pixelslength
+ masklength
;
2536 if (this._sock
.rQwait("cursor encoding", this._FBU
.bytes
)) { return false; }
2538 this._display
.changeCursor(this._sock
.rQshiftBytes(pixelslength
),
2539 this._sock
.rQshiftBytes(masklength
),
2542 this._FBU
.bytes
= 0;
2545 Log
.Debug("<< set_cursor");
2549 QEMUExtendedKeyEvent: function () {
2552 // Old Safari doesn't support creating keyboard events
2554 const keyboardEvent
= document
.createEvent("keyboardEvent");
2555 if (keyboardEvent
.code
!== undefined) {
2556 this._qemuExtKeyEventSupported
= true;