]> git.proxmox.com Git - mirror_novnc.git/blame - core/rfb.js
Remove unused encoding handlers
[mirror_novnc.git] / core / rfb.js
CommitLineData
a7a89626
JM
1/*
2 * noVNC: HTML5 VNC client
d58f8b51 3 * Copyright (C) 2012 Joel Martin
7a16304e 4 * Copyright (C) 2016 Samuel Mannehed for Cendio AB
1d728ace 5 * Licensed under MPL 2.0 (see LICENSE.txt)
a7a89626
JM
6 *
7 * See README.md for usage and integration instructions.
d38db74a
MT
8 *
9 * TIGHT decoder portion:
10 * (c) 2012 Michael Tinglof, Joe Balaz, Les Piech (Mercuri.ca)
a7a89626
JM
11 */
12
6d6f0db0
SR
13import * as Log from './util/logging.js';
14import _ from './util/localization.js';
15import { decodeUTF8 } from './util/strings.js';
16import { set_defaults, make_properties } from './util/properties.js';
3ae0bb09
SR
17import Display from "./display.js";
18import { Keyboard, Mouse } from "./input/devices.js";
19import Websock from "./websock.js";
20import Base64 from "./base64.js";
21import DES from "./des.js";
22import KeyTable from "./input/keysym.js";
23import XtScancode from "./input/xtscancodes.js";
fba220c6 24import Inflator from "./inflator.js";
3ae0bb09 25
b1dee947 26/*jslint white: false, browser: true */
ae510306 27/*global window, Util, Display, Keyboard, Mouse, Websock, Websock_native, Base64, DES, KeyTable, Inflator, XtScancode */
a7a89626 28
3ae0bb09 29export default function RFB(defaults) {
b1dee947 30 "use strict";
ae510306
SR
31 if (!defaults) {
32 defaults = {};
33 }
34
35 this._rfb_host = '';
36 this._rfb_port = 5900;
37 this._rfb_password = '';
38 this._rfb_path = '';
39
3bb12056 40 this._rfb_connection_state = '';
c00ee156 41 this._rfb_init_state = '';
ae510306
SR
42 this._rfb_version = 0;
43 this._rfb_max_version = 3.8;
44 this._rfb_auth_scheme = '';
3bb12056 45 this._rfb_disconnect_reason = "";
ae510306
SR
46
47 this._rfb_tightvnc = false;
48 this._rfb_xvp_ver = 0;
49
50 // In preference order
51 this._encodings = [
52 ['COPYRECT', 0x01 ],
53 ['TIGHT', 0x07 ],
54 ['TIGHT_PNG', -260 ],
55 ['HEXTILE', 0x05 ],
56 ['RRE', 0x02 ],
57 ['RAW', 0x00 ],
58
59 // Psuedo-encoding settings
60
61 //['JPEG_quality_lo', -32 ],
62 ['JPEG_quality_med', -26 ],
63 //['JPEG_quality_hi', -23 ],
64 //['compress_lo', -255 ],
a124c8ea
AP
65 ['compress_hi', -254 ],
66 //['compress_max', -247 ],
ae510306
SR
67
68 ['DesktopSize', -223 ],
69 ['last_rect', -224 ],
70 ['Cursor', -239 ],
71 ['QEMUExtendedKeyEvent', -258 ],
72 ['ExtendedDesktopSize', -308 ],
73 ['xvp', -309 ],
74 ['Fence', -312 ],
75 ['ContinuousUpdates', -313 ]
76 ];
77
78 this._encHandlers = {};
79 this._encNames = {};
80 this._encStats = {};
81
82 this._sock = null; // Websock object
83 this._display = null; // Display object
d9ca5e5b 84 this._flushing = false; // Display flushing state
ae510306
SR
85 this._keyboard = null; // Keyboard input handler object
86 this._mouse = null; // Mouse input handler object
87 this._disconnTimer = null; // disconnection timer
ae510306
SR
88
89 this._supportsFence = false;
90
91 this._supportsContinuousUpdates = false;
92 this._enabledContinuousUpdates = false;
93
94 // Frame buffer update state
95 this._FBU = {
96 rects: 0,
97 subrects: 0, // RRE
98 lines: 0, // RAW
99 tiles: 0, // HEXTILE
100 bytes: 0,
101 x: 0,
102 y: 0,
103 width: 0,
104 height: 0,
105 encoding: 0,
106 subencoding: -1,
107 background: null,
108 zlib: [] // TIGHT zlib streams
109 };
5210330a 110
ae510306
SR
111 this._fb_width = 0;
112 this._fb_height = 0;
113 this._fb_name = "";
b1dee947 114
ae510306
SR
115 this._destBuff = null;
116 this._paletteBuff = new Uint8Array(1024); // 256 * 4 (max palette size * max bytes-per-pixel)
b1dee947 117
ae510306 118 this._rre_chunk_sz = 100;
b1dee947 119
ae510306
SR
120 this._timing = {
121 last_fbu: 0,
122 fbu_total: 0,
123 fbu_total_cnt: 0,
124 full_fbu_total: 0,
125 full_fbu_cnt: 0,
b1dee947 126
ae510306
SR
127 fbu_rt_start: 0,
128 fbu_rt_total: 0,
129 fbu_rt_cnt: 0,
130 pixels: 0
131 };
132
133 this._supportsSetDesktopSize = false;
134 this._screen_id = 0;
135 this._screen_flags = 0;
136
137 // Mouse state
138 this._mouse_buttonMask = 0;
139 this._mouse_arr = [];
140 this._viewportDragging = false;
141 this._viewportDragPos = {};
142 this._viewportHasMoved = false;
143
144 // QEMU Extended Key Event support - default to false
145 this._qemuExtKeyEventSupported = false;
146
147 // set the default value on user-facing properties
6d6f0db0 148 set_defaults(this, defaults, {
ae510306
SR
149 'target': 'null', // VNC display rendering Canvas object
150 'focusContainer': document, // DOM element that captures keyboard input
151 'encrypt': false, // Use TLS/SSL/wss encryption
ae510306
SR
152 'local_cursor': false, // Request locally rendered cursor
153 'shared': true, // Request shared mode
154 'view_only': false, // Disable client mouse/keyboard
155 'xvp_password_sep': '@', // Separator for XVP password fields
156 'disconnectTimeout': 3, // Time (s) to wait for disconnection
157 'wsProtocols': ['binary'], // Protocols to use in the WebSocket connection
158 'repeaterID': '', // [UltraVNC] RepeaterID to connect to
159 'viewportDrag': false, // Move the viewport on mouse drags
160
161 // Callback functions
3bb12056 162 'onUpdateState': function () { }, // onUpdateState(rfb, state, oldstate): connection state change
a7127fee 163 'onNotification': function () { }, // onNotification(rfb, msg, level, options): notification for UI
3bb12056 164 'onDisconnected': function () { }, // onDisconnected(rfb, reason): disconnection finished
7d714b15 165 'onPasswordRequired': function () { }, // onPasswordRequired(rfb, msg): VNC password is required
ae510306
SR
166 'onClipboard': function () { }, // onClipboard(rfb, text): RFB clipboard contents received
167 'onBell': function () { }, // onBell(rfb): RFB Bell message received
168 'onFBUReceive': function () { }, // onFBUReceive(rfb, fbu): RFB FBU received but not yet processed
169 'onFBUComplete': function () { }, // onFBUComplete(rfb, fbu): RFB FBU received and processed
170 'onFBResize': function () { }, // onFBResize(rfb, width, height): frame buffer resized
171 'onDesktopName': function () { }, // onDesktopName(rfb, name): desktop name received
172 'onXvpInit': function () { } // onXvpInit(version): XVP extensions active for this connection
173 });
174
175 // main setup
6d6f0db0 176 Log.Debug(">> RFB.constructor");
ae510306
SR
177
178 // populate encHandlers with bound versions
179 Object.keys(RFB.encodingHandlers).forEach(function (encName) {
180 this._encHandlers[encName] = RFB.encodingHandlers[encName].bind(this);
181 }.bind(this));
182
183 // Create lookup tables based on encoding number
184 for (var i = 0; i < this._encodings.length; i++) {
185 this._encHandlers[this._encodings[i][1]] = this._encHandlers[this._encodings[i][0]];
186 this._encNames[this._encodings[i][1]] = this._encodings[i][0];
187 this._encStats[this._encodings[i][1]] = [0, 0];
188 }
189
190 // NB: nothing that needs explicit teardown should be done
191 // before this point, since this can throw an exception
192 try {
d9ca5e5b
PO
193 this._display = new Display({target: this._target,
194 onFlush: this._onFlush.bind(this)});
ae510306 195 } catch (exc) {
6d6f0db0 196 Log.Error("Display exception: " + exc);
ae510306
SR
197 throw exc;
198 }
199
200 this._keyboard = new Keyboard({target: this._focusContainer,
d0703d1b 201 onKeyEvent: this._handleKeyEvent.bind(this)});
ae510306
SR
202
203 this._mouse = new Mouse({target: this._target,
204 onMouseButton: this._handleMouseButton.bind(this),
9e6f71cb 205 onMouseMove: this._handleMouseMove.bind(this)});
ae510306
SR
206
207 this._sock = new Websock();
208 this._sock.on('message', this._handle_message.bind(this));
209 this._sock.on('open', function () {
c2a4d3ef 210 if ((this._rfb_connection_state === 'connecting') &&
c00ee156
SM
211 (this._rfb_init_state === '')) {
212 this._rfb_init_state = 'ProtocolVersion';
6d6f0db0 213 Log.Debug("Starting VNC handshake");
ae510306 214 } else {
67cd2072 215 this._fail("Unexpected server connection");
ae510306
SR
216 }
217 }.bind(this));
218 this._sock.on('close', function (e) {
6d6f0db0 219 Log.Warn("WebSocket on-close event");
ae510306
SR
220 var msg = "";
221 if (e.code) {
222 msg = " (code: " + e.code;
223 if (e.reason) {
224 msg += ", reason: " + e.reason;
b1dee947 225 }
ae510306
SR
226 msg += ")";
227 }
c00ee156 228 switch (this._rfb_connection_state) {
c2a4d3ef 229 case 'disconnecting':
3bb12056 230 this._updateConnectionState('disconnected');
c00ee156 231 break;
c2a4d3ef 232 case 'connecting':
67cd2072 233 this._fail('Failed to connect to server', msg);
c00ee156 234 break;
b45905ab
SM
235 case 'connected':
236 // Handle disconnects that were initiated server-side
237 this._updateConnectionState('disconnecting');
238 this._updateConnectionState('disconnected');
239 break;
c00ee156 240 case 'disconnected':
67cd2072
SM
241 this._fail("Unexpected server disconnect",
242 "Already disconnected: " + msg);
c00ee156
SM
243 break;
244 default:
67cd2072
SM
245 this._fail("Unexpected server disconnect",
246 "Not in any state yet: " + msg);
c00ee156 247 break;
a679a97d 248 }
ae510306
SR
249 this._sock.off('close');
250 }.bind(this));
251 this._sock.on('error', function (e) {
6d6f0db0 252 Log.Warn("WebSocket on-error event");
ae510306 253 });
8db09746 254
ae510306 255 this._init_vars();
6c145147 256 this._cleanup();
ae510306
SR
257
258 var rmode = this._display.get_render_mode();
6d6f0db0 259 Log.Info("Using native WebSockets, render mode: " + rmode);
ae510306 260
6d6f0db0 261 Log.Debug("<< RFB.constructor");
ae510306 262};
a7a89626 263
6d6f0db0
SR
264RFB.prototype = {
265 // Public methods
266 connect: function (host, port, password, path) {
267 this._rfb_host = host;
268 this._rfb_port = port;
269 this._rfb_password = (password !== undefined) ? password : "";
270 this._rfb_path = (path !== undefined) ? path : "";
271
272 if (!this._rfb_host || !this._rfb_port) {
273 return this._fail(
274 _("Must set host and port"));
275 }
a7a89626 276
6d6f0db0
SR
277 this._rfb_init_state = '';
278 this._updateConnectionState('connecting');
279 return true;
280 },
281
282 disconnect: function () {
283 this._updateConnectionState('disconnecting');
284 this._sock.off('error');
285 this._sock.off('message');
286 this._sock.off('open');
287 },
288
289 sendPassword: function (passwd) {
290 this._rfb_password = passwd;
291 setTimeout(this._init_msg.bind(this), 0);
292 },
293
294 sendCtrlAltDel: function () {
295 if (this._rfb_connection_state !== 'connected' || this._view_only) { return false; }
296 Log.Info("Sending Ctrl-Alt-Del");
297
94f5cf05
PO
298 this.sendKey(KeyTable.XK_Control_L, "ControlLeft", true);
299 this.sendKey(KeyTable.XK_Alt_L, "AltLeft", true);
300 this.sendKey(KeyTable.XK_Delete, "Delete", true);
301 this.sendKey(KeyTable.XK_Delete, "Delete", false);
302 this.sendKey(KeyTable.XK_Alt_L, "AltLeft", false);
303 this.sendKey(KeyTable.XK_Control_L, "ControlLeft", false);
304
6d6f0db0
SR
305 return true;
306 },
307
308 xvpOp: function (ver, op) {
309 if (this._rfb_xvp_ver < ver) { return false; }
310 Log.Info("Sending XVP operation " + op + " (version " + ver + ")");
311 this._sock.send_string("\xFA\x00" + String.fromCharCode(ver) + String.fromCharCode(op));
312 return true;
313 },
314
315 xvpShutdown: function () {
316 return this.xvpOp(1, 2);
317 },
318
319 xvpReboot: function () {
320 return this.xvpOp(1, 3);
321 },
322
323 xvpReset: function () {
324 return this.xvpOp(1, 4);
325 },
326
327 // Send a key press. If 'down' is not specified then send a down key
328 // followed by an up key.
94f5cf05 329 sendKey: function (keysym, code, down) {
6d6f0db0 330 if (this._rfb_connection_state !== 'connected' || this._view_only) { return false; }
94f5cf05
PO
331
332 if (down === undefined) {
333 this.sendKey(keysym, code, true);
334 this.sendKey(keysym, code, false);
335 return true;
336 }
337
be70fe0a 338 var scancode = XtScancode[code];
94f5cf05 339
be70fe0a 340 if (this._qemuExtKeyEventSupported && scancode) {
459ed008
PO
341 // 0 is NoSymbol
342 keysym = keysym || 0;
343
94f5cf05
PO
344 Log.Info("Sending key (" + (down ? "down" : "up") + "): keysym " + keysym + ", scancode " + scancode);
345
346 RFB.messages.QEMUExtendedKeyEvent(this._sock, keysym, down, scancode);
347 } else {
459ed008
PO
348 if (!keysym) {
349 return false;
350 }
6d6f0db0
SR
351 Log.Info("Sending keysym (" + (down ? "down" : "up") + "): " + keysym);
352 RFB.messages.keyEvent(this._sock, keysym, down ? 1 : 0);
6d6f0db0 353 }
94f5cf05 354
6d6f0db0
SR
355 return true;
356 },
357
358 clipboardPasteFrom: function (text) {
359 if (this._rfb_connection_state !== 'connected' || this._view_only) { return; }
360 RFB.messages.clientCutText(this._sock, text);
361 },
362
363 // Requests a change of remote desktop size. This message is an extension
364 // and may only be sent if we have received an ExtendedDesktopSize message
365 requestDesktopSize: function (width, height) {
366 if (this._rfb_connection_state !== 'connected' ||
367 this._view_only) {
368 return false;
369 }
e3efeb32 370
6d6f0db0
SR
371 if (this._supportsSetDesktopSize) {
372 RFB.messages.setDesktopSize(this._sock, width, height,
373 this._screen_id, this._screen_flags);
374 this._sock.flush();
4e0c36dd 375 return true;
6d6f0db0
SR
376 } else {
377 return false;
378 }
379 },
b1dee947 380
b1dee947 381
6d6f0db0 382 // Private methods
b0ec6509 383
6d6f0db0
SR
384 _connect: function () {
385 Log.Debug(">> RFB.connect");
386 this._init_vars();
b0ec6509 387
6d6f0db0
SR
388 var uri;
389 if (typeof UsingSocketIO !== 'undefined') {
390 uri = 'http';
391 } else {
392 uri = this._encrypt ? 'wss' : 'ws';
393 }
b1dee947 394
6d6f0db0
SR
395 uri += '://' + this._rfb_host + ':' + this._rfb_port + '/' + this._rfb_path;
396 Log.Info("connecting to " + uri);
b1dee947 397
6d6f0db0
SR
398 try {
399 // WebSocket.onopen transitions to the RFB init states
400 this._sock.open(uri, this._wsProtocols);
401 } catch (e) {
402 if (e.name === 'SyntaxError') {
403 this._fail("Invalid host or port value given", e);
b1dee947 404 } else {
6d6f0db0 405 this._fail("Error while connecting", e);
159ad55d 406 }
6d6f0db0 407 }
e3efeb32 408
6d6f0db0
SR
409 Log.Debug("<< RFB.connect");
410 },
411
412 _disconnect: function () {
413 Log.Debug(">> RFB.disconnect");
414 this._cleanup();
415 this._sock.close();
416 this._print_stats();
417 Log.Debug("<< RFB.disconnect");
418 },
419
420 _init_vars: function () {
421 // reset state
422 this._FBU.rects = 0;
423 this._FBU.subrects = 0; // RRE and HEXTILE
424 this._FBU.lines = 0; // RAW
425 this._FBU.tiles = 0; // HEXTILE
426 this._FBU.zlibs = []; // TIGHT zlib encoders
427 this._mouse_buttonMask = 0;
428 this._mouse_arr = [];
429 this._rfb_tightvnc = false;
430
431 // Clear the per connection encoding stats
432 var i;
433 for (i = 0; i < this._encodings.length; i++) {
434 this._encStats[this._encodings[i][1]][0] = 0;
435 }
a7a89626 436
6d6f0db0
SR
437 for (i = 0; i < 4; i++) {
438 this._FBU.zlibs[i] = new Inflator();
439 }
440 },
a7a89626 441
6d6f0db0
SR
442 _print_stats: function () {
443 Log.Info("Encoding stats for this connection:");
444 var i, s;
445 for (i = 0; i < this._encodings.length; i++) {
446 s = this._encStats[this._encodings[i][1]];
447 if (s[0] + s[1] > 0) {
448 Log.Info(" " + this._encodings[i][0] + ": " + s[0] + " rects");
b1dee947 449 }
6d6f0db0 450 }
a7a89626 451
6d6f0db0
SR
452 Log.Info("Encoding stats since page load:");
453 for (i = 0; i < this._encodings.length; i++) {
454 s = this._encStats[this._encodings[i][1]];
455 Log.Info(" " + this._encodings[i][0] + ": " + s[1] + " rects");
456 }
457 },
458
459 _cleanup: function () {
460 if (!this._view_only) { this._keyboard.ungrab(); }
461 if (!this._view_only) { this._mouse.ungrab(); }
462 this._display.defaultCursor();
463 if (Log.get_logging() !== 'debug') {
464 // Show noVNC logo on load and when disconnected, unless in
465 // debug mode
466 this._display.clear();
467 }
468 },
469
470 /*
471 * Connection states:
472 * connecting
473 * connected
474 * disconnecting
475 * disconnected - permanent state
476 */
477 _updateConnectionState: function (state) {
478 var oldstate = this._rfb_connection_state;
479
480 if (state === oldstate) {
481 Log.Debug("Already in state '" + state + "', ignoring");
482 return;
483 }
484
485 // The 'disconnected' state is permanent for each RFB object
486 if (oldstate === 'disconnected') {
487 Log.Error("Tried changing state of a disconnected RFB object");
488 return;
489 }
490
491 // Ensure proper transitions before doing anything
492 switch (state) {
493 case 'connected':
494 if (oldstate !== 'connecting') {
495 Log.Error("Bad transition to connected state, " +
496 "previous connection state: " + oldstate);
497 return;
b1dee947 498 }
6d6f0db0 499 break;
a7a89626 500
6d6f0db0
SR
501 case 'disconnected':
502 if (oldstate !== 'disconnecting') {
503 Log.Error("Bad transition to disconnected state, " +
504 "previous connection state: " + oldstate);
505 return;
506 }
507 break;
a7a89626 508
6d6f0db0
SR
509 case 'connecting':
510 if (oldstate !== '') {
511 Log.Error("Bad transition to connecting state, " +
512 "previous connection state: " + oldstate);
513 return;
514 }
515 break;
b1dee947 516
6d6f0db0
SR
517 case 'disconnecting':
518 if (oldstate !== 'connected' && oldstate !== 'connecting') {
519 Log.Error("Bad transition to disconnecting state, " +
520 "previous connection state: " + oldstate);
521 return;
522 }
523 break;
a679a97d 524
6d6f0db0
SR
525 default:
526 Log.Error("Unknown connection state: " + state);
3bb12056 527 return;
6d6f0db0 528 }
b1dee947 529
6d6f0db0 530 // State change actions
3bb12056 531
6d6f0db0
SR
532 this._rfb_connection_state = state;
533 this._onUpdateState(this, state, oldstate);
b2e961d4 534
6d6f0db0
SR
535 var smsg = "New state '" + state + "', was '" + oldstate + "'.";
536 Log.Debug(smsg);
b2e961d4 537
6d6f0db0
SR
538 if (this._disconnTimer && state !== 'disconnecting') {
539 Log.Debug("Clearing disconnect timer");
540 clearTimeout(this._disconnTimer);
541 this._disconnTimer = null;
3bb12056 542
6d6f0db0
SR
543 // make sure we don't get a double event
544 this._sock.off('close');
545 }
b2e961d4 546
6d6f0db0
SR
547 switch (state) {
548 case 'disconnected':
549 // Call onDisconnected callback after onUpdateState since
550 // we don't know if the UI only displays the latest message
551 if (this._rfb_disconnect_reason !== "") {
552 this._onDisconnected(this, this._rfb_disconnect_reason);
553 } else {
554 // No reason means clean disconnect
555 this._onDisconnected(this);
556 }
557 break;
b2e961d4 558
6d6f0db0
SR
559 case 'connecting':
560 this._connect();
561 break;
b2e961d4 562
6d6f0db0
SR
563 case 'disconnecting':
564 this._disconnect();
b2e961d4 565
6d6f0db0
SR
566 this._disconnTimer = setTimeout(function () {
567 this._rfb_disconnect_reason = _("Disconnect timeout");
568 this._updateConnectionState('disconnected');
569 }.bind(this), this._disconnectTimeout * 1000);
570 break;
571 }
572 },
573
574 /* Print errors and disconnect
575 *
576 * The optional parameter 'details' is used for information that
577 * should be logged but not sent to the user interface.
578 */
579 _fail: function (msg, details) {
580 var fullmsg = msg;
581 if (typeof details !== 'undefined') {
582 fullmsg = msg + " (" + details + ")";
583 }
584 switch (this._rfb_connection_state) {
585 case 'disconnecting':
586 Log.Error("Failed when disconnecting: " + fullmsg);
587 break;
588 case 'connected':
589 Log.Error("Failed while connected: " + fullmsg);
590 break;
591 case 'connecting':
592 Log.Error("Failed when connecting: " + fullmsg);
593 break;
594 default:
595 Log.Error("RFB failure: " + fullmsg);
596 break;
597 }
598 this._rfb_disconnect_reason = msg; //This is sent to the UI
599
600 // Transition to disconnected without waiting for socket to close
601 this._updateConnectionState('disconnecting');
602 this._updateConnectionState('disconnected');
603
604 return false;
605 },
606
607 /*
608 * Send a notification to the UI. Valid levels are:
609 * 'normal'|'warn'|'error'
610 *
611 * NOTE: Options could be added in the future.
612 * NOTE: If this function is called multiple times, remember that the
613 * interface could be only showing the latest notification.
614 */
615 _notification: function(msg, level, options) {
616 switch (level) {
617 case 'normal':
618 case 'warn':
619 case 'error':
620 Log.Debug("Notification[" + level + "]:" + msg);
621 break;
622 default:
623 Log.Error("Invalid notification level: " + level);
624 return;
625 }
b2e961d4 626
6d6f0db0
SR
627 if (options) {
628 this._onNotification(this, msg, level, options);
629 } else {
630 this._onNotification(this, msg, level);
631 }
632 },
b1dee947 633
6d6f0db0
SR
634 _handle_message: function () {
635 if (this._sock.rQlen() === 0) {
636 Log.Warn("handle_message called on an empty receive queue");
637 return;
638 }
b1dee947 639
6d6f0db0
SR
640 switch (this._rfb_connection_state) {
641 case 'disconnected':
642 Log.Error("Got data while disconnected");
643 break;
644 case 'connected':
645 while (true) {
646 if (this._flushing) {
647 break;
648 }
649 if (!this._normal_msg()) {
650 break;
651 }
652 if (this._sock.rQlen() === 0) {
653 break;
654 }
655 }
656 break;
657 default:
658 this._init_msg();
659 break;
660 }
661 },
3bb12056 662
d0703d1b
PO
663 _handleKeyEvent: function (keysym, code, down) {
664 this.sendKey(keysym, code, down);
6d6f0db0 665 },
06a9ef0c 666
6d6f0db0
SR
667 _handleMouseButton: function (x, y, down, bmask) {
668 if (down) {
669 this._mouse_buttonMask |= bmask;
670 } else {
270bdbd7 671 this._mouse_buttonMask &= ~bmask;
6d6f0db0 672 }
a7127fee 673
6d6f0db0
SR
674 if (this._viewportDrag) {
675 if (down && !this._viewportDragging) {
676 this._viewportDragging = true;
677 this._viewportDragPos = {'x': x, 'y': y};
a7127fee 678
6d6f0db0 679 // Skip sending mouse events
b1dee947 680 return;
6d6f0db0
SR
681 } else {
682 this._viewportDragging = false;
8db09746 683
6d6f0db0
SR
684 // If the viewport didn't actually move, then treat as a mouse click event
685 // Send the button down event here, as the button up event is sent at the end of this function
686 if (!this._viewportHasMoved && !this._view_only) {
687 RFB.messages.pointerEvent(this._sock, this._display.absX(x), this._display.absY(y), bmask);
688 }
689 this._viewportHasMoved = false;
b1dee947 690 }
6d6f0db0 691 }
8db09746 692
6d6f0db0 693 if (this._view_only) { return; } // View only, skip mouse events
8f06673a 694
6d6f0db0
SR
695 if (this._rfb_connection_state !== 'connected') { return; }
696 RFB.messages.pointerEvent(this._sock, this._display.absX(x), this._display.absY(y), this._mouse_buttonMask);
697 },
8db09746 698
6d6f0db0
SR
699 _handleMouseMove: function (x, y) {
700 if (this._viewportDragging) {
701 var deltaX = this._viewportDragPos.x - x;
702 var deltaY = this._viewportDragPos.y - y;
8db09746 703
6d6f0db0
SR
704 // The goal is to trigger on a certain physical width, the
705 // devicePixelRatio brings us a bit closer but is not optimal.
706 var dragThreshold = 10 * (window.devicePixelRatio || 1);
8db09746 707
6d6f0db0
SR
708 if (this._viewportHasMoved || (Math.abs(deltaX) > dragThreshold ||
709 Math.abs(deltaY) > dragThreshold)) {
710 this._viewportHasMoved = true;
27e77d46 711
6d6f0db0
SR
712 this._viewportDragPos = {'x': x, 'y': y};
713 this._display.viewportChangePos(deltaX, deltaY);
b50f3406 714 }
8db09746 715
6d6f0db0
SR
716 // Skip sending mouse events
717 return;
718 }
b1dee947 719
6d6f0db0 720 if (this._view_only) { return; } // View only, skip mouse events
b1dee947 721
6d6f0db0
SR
722 if (this._rfb_connection_state !== 'connected') { return; }
723 RFB.messages.pointerEvent(this._sock, this._display.absX(x), this._display.absY(y), this._mouse_buttonMask);
724 },
b1dee947 725
6d6f0db0 726 // Message Handlers
27e77d46 727
6d6f0db0
SR
728 _negotiate_protocol_version: function () {
729 if (this._sock.rQlen() < 12) {
730 return this._fail("Error while negotiating with server",
731 "Incomplete protocol version");
732 }
32df3fdb 733
6d6f0db0
SR
734 var sversion = this._sock.rQshiftStr(12).substr(4, 7);
735 Log.Info("Server ProtocolVersion: " + sversion);
736 var is_repeater = 0;
737 switch (sversion) {
738 case "000.000": // UltraVNC repeater
739 is_repeater = 1;
740 break;
741 case "003.003":
742 case "003.006": // UltraVNC
743 case "003.889": // Apple Remote Desktop
744 this._rfb_version = 3.3;
745 break;
746 case "003.007":
747 this._rfb_version = 3.7;
748 break;
749 case "003.008":
750 case "004.000": // Intel AMT KVM
751 case "004.001": // RealVNC 4.6
752 case "005.000": // RealVNC 5.3
753 this._rfb_version = 3.8;
754 break;
755 default:
756 return this._fail("Unsupported server",
757 "Invalid server version: " + sversion);
758 }
8db09746 759
6d6f0db0
SR
760 if (is_repeater) {
761 var repeaterID = this._repeaterID;
762 while (repeaterID.length < 250) {
763 repeaterID += "\0";
b1dee947 764 }
6d6f0db0
SR
765 this._sock.send_string(repeaterID);
766 return true;
767 }
b1dee947 768
6d6f0db0
SR
769 if (this._rfb_version > this._rfb_max_version) {
770 this._rfb_version = this._rfb_max_version;
771 }
b1dee947 772
6d6f0db0
SR
773 var cversion = "00" + parseInt(this._rfb_version, 10) +
774 ".00" + ((this._rfb_version * 10) % 10);
775 this._sock.send_string("RFB " + cversion + "\n");
776 Log.Debug('Sent ProtocolVersion: ' + cversion);
b1dee947 777
6d6f0db0
SR
778 this._rfb_init_state = 'Security';
779 },
b1dee947 780
6d6f0db0
SR
781 _negotiate_security: function () {
782 // Polyfill since IE and PhantomJS doesn't have
783 // TypedArray.includes()
784 function includes(item, array) {
785 for (var i = 0; i < array.length; i++) {
786 if (array[i] === item) {
787 return true;
788 }
b1dee947 789 }
6d6f0db0
SR
790 return false;
791 }
b1dee947 792
6d6f0db0
SR
793 if (this._rfb_version >= 3.7) {
794 // Server sends supported list, client decides
795 var num_types = this._sock.rQshift8();
796 if (this._sock.rQwait("security type", num_types, 1)) { return false; }
b1dee947 797
6d6f0db0
SR
798 if (num_types === 0) {
799 var strlen = this._sock.rQshift32();
800 var reason = this._sock.rQshiftStr(strlen);
801 return this._fail("Error while negotiating with server",
802 "Security failure: " + reason);
803 }
804
805 var types = this._sock.rQshiftBytes(num_types);
806 Log.Debug("Server security types: " + types);
807
808 // Look for each auth in preferred order
809 this._rfb_auth_scheme = 0;
810 if (includes(1, types)) {
811 this._rfb_auth_scheme = 1; // None
812 } else if (includes(22, types)) {
813 this._rfb_auth_scheme = 22; // XVP
814 } else if (includes(16, types)) {
815 this._rfb_auth_scheme = 16; // Tight
816 } else if (includes(2, types)) {
817 this._rfb_auth_scheme = 2; // VNC Auth
818 } else {
819 return this._fail("Unsupported server",
820 "Unsupported security types: " + types);
8db09746 821 }
b1dee947 822
6d6f0db0
SR
823 this._sock.send([this._rfb_auth_scheme]);
824 } else {
825 // Server decides
826 if (this._sock.rQwait("security scheme", 4)) { return false; }
827 this._rfb_auth_scheme = this._sock.rQshift32();
828 }
b1dee947 829
6d6f0db0
SR
830 this._rfb_init_state = 'Authentication';
831 Log.Debug('Authenticating using scheme: ' + this._rfb_auth_scheme);
b1dee947 832
6d6f0db0
SR
833 return this._init_msg(); // jump to authentication
834 },
b1dee947 835
6d6f0db0
SR
836 // authentication
837 _negotiate_xvp_auth: function () {
838 var xvp_sep = this._xvp_password_sep;
839 var xvp_auth = this._rfb_password.split(xvp_sep);
840 if (xvp_auth.length < 3) {
841 var msg = 'XVP credentials required (user' + xvp_sep +
842 'target' + xvp_sep + 'password) -- got only ' + this._rfb_password;
843 this._onPasswordRequired(this, msg);
844 return false;
845 }
0ee5ca6e 846
6d6f0db0
SR
847 var xvp_auth_str = String.fromCharCode(xvp_auth[0].length) +
848 String.fromCharCode(xvp_auth[1].length) +
849 xvp_auth[0] +
850 xvp_auth[1];
851 this._sock.send_string(xvp_auth_str);
852 this._rfb_password = xvp_auth.slice(2).join(xvp_sep);
853 this._rfb_auth_scheme = 2;
854 return this._negotiate_authentication();
855 },
856
857 _negotiate_std_vnc_auth: function () {
858 if (this._rfb_password.length === 0) {
859 this._onPasswordRequired(this);
860 return false;
861 }
b1dee947 862
6d6f0db0
SR
863 if (this._sock.rQwait("auth challenge", 16)) { return false; }
864
865 // TODO(directxman12): make genDES not require an Array
866 var challenge = Array.prototype.slice.call(this._sock.rQshiftBytes(16));
867 var response = RFB.genDES(this._rfb_password, challenge);
868 this._sock.send(response);
869 this._rfb_init_state = "SecurityResult";
870 return true;
871 },
872
873 _negotiate_tight_tunnels: function (numTunnels) {
874 var clientSupportedTunnelTypes = {
875 0: { vendor: 'TGHT', signature: 'NOTUNNEL' }
876 };
877 var serverSupportedTunnelTypes = {};
878 // receive tunnel capabilities
879 for (var i = 0; i < numTunnels; i++) {
880 var cap_code = this._sock.rQshift32();
881 var cap_vendor = this._sock.rQshiftStr(4);
882 var cap_signature = this._sock.rQshiftStr(8);
883 serverSupportedTunnelTypes[cap_code] = { vendor: cap_vendor, signature: cap_signature };
884 }
885
886 // choose the notunnel type
887 if (serverSupportedTunnelTypes[0]) {
888 if (serverSupportedTunnelTypes[0].vendor != clientSupportedTunnelTypes[0].vendor ||
889 serverSupportedTunnelTypes[0].signature != clientSupportedTunnelTypes[0].signature) {
890 return this._fail("Unsupported server",
891 "Client's tunnel type had the incorrect " +
892 "vendor or signature");
b1dee947 893 }
6d6f0db0
SR
894 this._sock.send([0, 0, 0, 0]); // use NOTUNNEL
895 return false; // wait until we receive the sub auth count to continue
896 } else {
897 return this._fail("Unsupported server",
898 "Server wanted tunnels, but doesn't support " +
899 "the notunnel type");
900 }
901 },
b1dee947 902
6d6f0db0
SR
903 _negotiate_tight_auth: function () {
904 if (!this._rfb_tightvnc) { // first pass, do the tunnel negotiation
905 if (this._sock.rQwait("num tunnels", 4)) { return false; }
906 var numTunnels = this._sock.rQshift32();
907 if (numTunnels > 0 && this._sock.rQwait("tunnel capabilities", 16 * numTunnels, 4)) { return false; }
c00ee156 908
6d6f0db0 909 this._rfb_tightvnc = true;
b1dee947 910
6d6f0db0
SR
911 if (numTunnels > 0) {
912 this._negotiate_tight_tunnels(numTunnels);
913 return false; // wait until we receive the sub auth to continue
b1dee947 914 }
6d6f0db0 915 }
b1dee947 916
6d6f0db0
SR
917 // second pass, do the sub-auth negotiation
918 if (this._sock.rQwait("sub auth count", 4)) { return false; }
919 var subAuthCount = this._sock.rQshift32();
920 if (subAuthCount === 0) { // empty sub-auth list received means 'no auth' subtype selected
921 this._rfb_init_state = 'SecurityResult';
922 return true;
923 }
b1dee947 924
6d6f0db0 925 if (this._sock.rQwait("sub auth capabilities", 16 * subAuthCount, 4)) { return false; }
b1dee947 926
6d6f0db0
SR
927 var clientSupportedTypes = {
928 'STDVNOAUTH__': 1,
929 'STDVVNCAUTH_': 2
930 };
b1dee947 931
6d6f0db0 932 var serverSupportedTypes = [];
95eb681b 933
6d6f0db0
SR
934 for (var i = 0; i < subAuthCount; i++) {
935 var capNum = this._sock.rQshift32();
936 var capabilities = this._sock.rQshiftStr(12);
937 serverSupportedTypes.push(capabilities);
938 }
d86cc2d9 939
6d6f0db0
SR
940 for (var authType in clientSupportedTypes) {
941 if (serverSupportedTypes.indexOf(authType) != -1) {
942 this._sock.send([0, 0, 0, clientSupportedTypes[authType]]);
d86cc2d9 943
6d6f0db0
SR
944 switch (authType) {
945 case 'STDVNOAUTH__': // no auth
946 this._rfb_init_state = 'SecurityResult';
947 return true;
948 case 'STDVVNCAUTH_': // VNC auth
949 this._rfb_auth_scheme = 2;
950 return this._init_msg();
951 default:
952 return this._fail("Unsupported server",
953 "Unsupported tiny auth scheme: " +
954 authType);
b1dee947
SR
955 }
956 }
6d6f0db0 957 }
b1dee947 958
6d6f0db0
SR
959 return this._fail("Unsupported server",
960 "No supported sub-auth types!");
961 },
962
963 _negotiate_authentication: function () {
964 switch (this._rfb_auth_scheme) {
965 case 0: // connection failed
966 if (this._sock.rQwait("auth reason", 4)) { return false; }
967 var strlen = this._sock.rQshift32();
968 var reason = this._sock.rQshiftStr(strlen);
969 return this._fail("Authentication failure", reason);
970
971 case 1: // no auth
972 if (this._rfb_version >= 3.8) {
973 this._rfb_init_state = 'SecurityResult';
974 return true;
975 }
976 this._rfb_init_state = 'ClientInitialisation';
977 return this._init_msg();
95eb681b 978
6d6f0db0
SR
979 case 22: // XVP auth
980 return this._negotiate_xvp_auth();
d86cc2d9 981
6d6f0db0
SR
982 case 2: // VNC authentication
983 return this._negotiate_std_vnc_auth();
d86cc2d9 984
6d6f0db0
SR
985 case 16: // TightVNC Security Type
986 return this._negotiate_tight_auth();
d86cc2d9 987
6d6f0db0
SR
988 default:
989 return this._fail("Unsupported server",
990 "Unsupported auth scheme: " +
991 this._rfb_auth_scheme);
992 }
993 },
994
995 _handle_security_result: function () {
996 if (this._sock.rQwait('VNC auth response ', 4)) { return false; }
997 switch (this._sock.rQshift32()) {
998 case 0: // OK
999 this._rfb_init_state = 'ClientInitialisation';
1000 Log.Debug('Authentication OK');
1001 return this._init_msg();
1002 case 1: // failed
1003 if (this._rfb_version >= 3.8) {
1004 var length = this._sock.rQshift32();
1005 if (this._sock.rQwait("SecurityResult reason", length, 8)) { return false; }
1006 var reason = this._sock.rQshiftStr(length);
1007 return this._fail("Authentication failure", reason);
1008 } else {
1009 return this._fail("Authentication failure");
d86cc2d9 1010 }
6d6f0db0
SR
1011 case 2:
1012 return this._fail("Too many authentication attempts");
1013 default:
1014 return this._fail("Unsupported server",
1015 "Unknown SecurityResult");
1016 }
1017 },
1018
1019 _negotiate_server_init: function () {
1020 if (this._sock.rQwait("server initialization", 24)) { return false; }
1021
1022 /* Screen size */
91d5c625
PO
1023 var width = this._sock.rQshift16();
1024 var height = this._sock.rQshift16();
6d6f0db0
SR
1025
1026 /* PIXEL_FORMAT */
1027 var bpp = this._sock.rQshift8();
1028 var depth = this._sock.rQshift8();
1029 var big_endian = this._sock.rQshift8();
1030 var true_color = this._sock.rQshift8();
1031
1032 var red_max = this._sock.rQshift16();
1033 var green_max = this._sock.rQshift16();
1034 var blue_max = this._sock.rQshift16();
1035 var red_shift = this._sock.rQshift8();
1036 var green_shift = this._sock.rQshift8();
1037 var blue_shift = this._sock.rQshift8();
1038 this._sock.rQskipBytes(3); // padding
1039
1040 // NB(directxman12): we don't want to call any callbacks or print messages until
1041 // *after* we're past the point where we could backtrack
1042
1043 /* Connection name/title */
1044 var name_length = this._sock.rQshift32();
1045 if (this._sock.rQwait('server init name', name_length, 24)) { return false; }
1046 this._fb_name = decodeUTF8(this._sock.rQshiftStr(name_length));
1047
1048 if (this._rfb_tightvnc) {
1049 if (this._sock.rQwait('TightVNC extended server init header', 8, 24 + name_length)) { return false; }
1050 // In TightVNC mode, ServerInit message is extended
1051 var numServerMessages = this._sock.rQshift16();
1052 var numClientMessages = this._sock.rQshift16();
1053 var numEncodings = this._sock.rQshift16();
1054 this._sock.rQskipBytes(2); // padding
1055
1056 var totalMessagesLength = (numServerMessages + numClientMessages + numEncodings) * 16;
1057 if (this._sock.rQwait('TightVNC extended server init header', totalMessagesLength, 32 + name_length)) { return false; }
1058
1059 // we don't actually do anything with the capability information that TIGHT sends,
1060 // so we just skip the all of this.
1061
1062 // TIGHT server message capabilities
1063 this._sock.rQskipBytes(16 * numServerMessages);
1064
1065 // TIGHT client message capabilities
1066 this._sock.rQskipBytes(16 * numClientMessages);
1067
1068 // TIGHT encoding capabilities
1069 this._sock.rQskipBytes(16 * numEncodings);
1070 }
d86cc2d9 1071
6d6f0db0
SR
1072 // NB(directxman12): these are down here so that we don't run them multiple times
1073 // if we backtrack
91d5c625 1074 Log.Info("Screen: " + width + "x" + height +
6d6f0db0
SR
1075 ", bpp: " + bpp + ", depth: " + depth +
1076 ", big_endian: " + big_endian +
1077 ", true_color: " + true_color +
1078 ", red_max: " + red_max +
1079 ", green_max: " + green_max +
1080 ", blue_max: " + blue_max +
1081 ", red_shift: " + red_shift +
1082 ", green_shift: " + green_shift +
1083 ", blue_shift: " + blue_shift);
1084
1085 if (big_endian !== 0) {
1086 Log.Warn("Server native endian is not little endian");
1087 }
b1dee947 1088
6d6f0db0
SR
1089 if (red_shift !== 16) {
1090 Log.Warn("Server native red-shift is not 16");
1091 }
b1dee947 1092
6d6f0db0
SR
1093 if (blue_shift !== 0) {
1094 Log.Warn("Server native blue-shift is not 0");
1095 }
b1dee947 1096
6d6f0db0
SR
1097 // we're past the point where we could backtrack, so it's safe to call this
1098 this._onDesktopName(this, this._fb_name);
b1dee947 1099
91d5c625 1100 this._resize(width, height);
b1dee947 1101
6d6f0db0
SR
1102 if (!this._view_only) { this._keyboard.grab(); }
1103 if (!this._view_only) { this._mouse.grab(); }
b1dee947 1104
26586b9d
PO
1105 RFB.messages.pixelFormat(this._sock, 4, 3, true);
1106 RFB.messages.clientEncodings(this._sock, this._encodings, this._local_cursor);
6d6f0db0
SR
1107 RFB.messages.fbUpdateRequest(this._sock, false, 0, 0, this._fb_width, this._fb_height);
1108
1109 this._timing.fbu_rt_start = (new Date()).getTime();
1110 this._timing.pixels = 0;
1111
1112 this._updateConnectionState('connected');
1113 return true;
1114 },
1115
1116 /* RFB protocol initialization states:
1117 * ProtocolVersion
1118 * Security
1119 * Authentication
1120 * SecurityResult
1121 * ClientInitialization - not triggered by server message
1122 * ServerInitialization
1123 */
1124 _init_msg: function () {
1125 switch (this._rfb_init_state) {
1126 case 'ProtocolVersion':
1127 return this._negotiate_protocol_version();
1128
1129 case 'Security':
1130 return this._negotiate_security();
1131
1132 case 'Authentication':
1133 return this._negotiate_authentication();
1134
1135 case 'SecurityResult':
1136 return this._handle_security_result();
1137
1138 case 'ClientInitialisation':
1139 this._sock.send([this._shared ? 1 : 0]); // ClientInitialisation
1140 this._rfb_init_state = 'ServerInitialisation';
1141 return true;
b1dee947 1142
6d6f0db0
SR
1143 case 'ServerInitialisation':
1144 return this._negotiate_server_init();
b1dee947 1145
6d6f0db0
SR
1146 default:
1147 return this._fail("Internal error", "Unknown init state: " +
1148 this._rfb_init_state);
1149 }
1150 },
b1dee947 1151
6d6f0db0
SR
1152 _handle_set_colour_map_msg: function () {
1153 Log.Debug("SetColorMapEntries");
b1dee947 1154
26586b9d 1155 return this._fail("Protocol error", "Unexpected SetColorMapEntries message");
6d6f0db0 1156 },
b1dee947 1157
6d6f0db0
SR
1158 _handle_server_cut_text: function () {
1159 Log.Debug("ServerCutText");
b1dee947 1160
6d6f0db0
SR
1161 if (this._sock.rQwait("ServerCutText header", 7, 1)) { return false; }
1162 this._sock.rQskipBytes(3); // Padding
1163 var length = this._sock.rQshift32();
1164 if (this._sock.rQwait("ServerCutText", length, 8)) { return false; }
b1dee947 1165
6d6f0db0 1166 var text = this._sock.rQshiftStr(length);
b4ff032e
SR
1167
1168 if (this._view_only) { return true; }
1169
6d6f0db0 1170 this._onClipboard(this, text);
b1dee947 1171
6d6f0db0
SR
1172 return true;
1173 },
b1dee947 1174
6d6f0db0
SR
1175 _handle_server_fence_msg: function() {
1176 if (this._sock.rQwait("ServerFence header", 8, 1)) { return false; }
1177 this._sock.rQskipBytes(3); // Padding
1178 var flags = this._sock.rQshift32();
1179 var length = this._sock.rQshift8();
b1dee947 1180
6d6f0db0 1181 if (this._sock.rQwait("ServerFence payload", length, 9)) { return false; }
b1dee947 1182
6d6f0db0
SR
1183 if (length > 64) {
1184 Log.Warn("Bad payload length (" + length + ") in fence response");
1185 length = 64;
1186 }
4e0c36dd 1187
6d6f0db0 1188 var payload = this._sock.rQshiftStr(length);
b1dee947 1189
6d6f0db0 1190 this._supportsFence = true;
b1dee947 1191
6d6f0db0
SR
1192 /*
1193 * Fence flags
1194 *
1195 * (1<<0) - BlockBefore
1196 * (1<<1) - BlockAfter
1197 * (1<<2) - SyncNext
1198 * (1<<31) - Request
1199 */
b1dee947 1200
6d6f0db0
SR
1201 if (!(flags & (1<<31))) {
1202 return this._fail("Internal error",
1203 "Unexpected fence response");
1204 }
b1dee947 1205
6d6f0db0
SR
1206 // Filter out unsupported flags
1207 // FIXME: support syncNext
1208 flags &= (1<<0) | (1<<1);
b1dee947 1209
6d6f0db0
SR
1210 // BlockBefore and BlockAfter are automatically handled by
1211 // the fact that we process each incoming message
1212 // synchronuosly.
1213 RFB.messages.clientFence(this._sock, flags, payload);
f78a652e 1214
6d6f0db0
SR
1215 return true;
1216 },
b1dee947 1217
6d6f0db0
SR
1218 _handle_xvp_msg: function () {
1219 if (this._sock.rQwait("XVP version and message", 3, 1)) { return false; }
1220 this._sock.rQskip8(); // Padding
1221 var xvp_ver = this._sock.rQshift8();
1222 var xvp_msg = this._sock.rQshift8();
b1dee947 1223
6d6f0db0
SR
1224 switch (xvp_msg) {
1225 case 0: // XVP_FAIL
1226 Log.Error("Operation Failed");
1227 this._notification("XVP Operation Failed", 'error');
1228 break;
1229 case 1: // XVP_INIT
1230 this._rfb_xvp_ver = xvp_ver;
1231 Log.Info("XVP extensions enabled (version " + this._rfb_xvp_ver + ")");
1232 this._onXvpInit(this._rfb_xvp_ver);
1233 break;
1234 default:
1235 this._fail("Unexpected server message",
1236 "Illegal server XVP message " + xvp_msg);
1237 break;
1238 }
b1dee947 1239
6d6f0db0
SR
1240 return true;
1241 },
3df13262 1242
6d6f0db0
SR
1243 _normal_msg: function () {
1244 var msg_type;
76a86ff5 1245
6d6f0db0
SR
1246 if (this._FBU.rects > 0) {
1247 msg_type = 0;
1248 } else {
1249 msg_type = this._sock.rQshift8();
1250 }
76a86ff5 1251
6d6f0db0
SR
1252 switch (msg_type) {
1253 case 0: // FramebufferUpdate
1254 var ret = this._framebufferUpdate();
1255 if (ret && !this._enabledContinuousUpdates) {
1256 RFB.messages.fbUpdateRequest(this._sock, true, 0, 0,
1257 this._fb_width, this._fb_height);
1258 }
1259 return ret;
3df13262 1260
6d6f0db0
SR
1261 case 1: // SetColorMapEntries
1262 return this._handle_set_colour_map_msg();
1263
1264 case 2: // Bell
1265 Log.Debug("Bell");
1266 this._onBell(this);
1267 return true;
1268
1269 case 3: // ServerCutText
1270 return this._handle_server_cut_text();
1271
1272 case 150: // EndOfContinuousUpdates
1273 var first = !(this._supportsContinuousUpdates);
1274 this._supportsContinuousUpdates = true;
1275 this._enabledContinuousUpdates = false;
1276 if (first) {
1277 this._enabledContinuousUpdates = true;
1278 this._updateContinuousUpdates();
1279 Log.Info("Enabling continuous updates.");
1280 } else {
1281 // FIXME: We need to send a framebufferupdaterequest here
1282 // if we add support for turning off continuous updates
1283 }
1284 return true;
3df13262 1285
6d6f0db0
SR
1286 case 248: // ServerFence
1287 return this._handle_server_fence_msg();
3df13262 1288
6d6f0db0
SR
1289 case 250: // XVP
1290 return this._handle_xvp_msg();
3df13262 1291
6d6f0db0
SR
1292 default:
1293 this._fail("Unexpected server message", "Type:" + msg_type);
1294 Log.Debug("sock.rQslice(0, 30): " + this._sock.rQslice(0, 30));
1295 return true;
1296 }
1297 },
3df13262 1298
6d6f0db0
SR
1299 _onFlush: function() {
1300 this._flushing = false;
1301 // Resume processing
1302 if (this._sock.rQlen() > 0) {
1303 this._handle_message();
1304 }
1305 },
3df13262 1306
6d6f0db0
SR
1307 _framebufferUpdate: function () {
1308 var ret = true;
1309 var now;
3df13262 1310
6d6f0db0
SR
1311 if (this._FBU.rects === 0) {
1312 if (this._sock.rQwait("FBU header", 3, 1)) { return false; }
b1dee947 1313 this._sock.rQskip8(); // Padding
6d6f0db0
SR
1314 this._FBU.rects = this._sock.rQshift16();
1315 this._FBU.bytes = 0;
1316 this._timing.cur_fbu = 0;
1317 if (this._timing.fbu_rt_start > 0) {
1318 now = (new Date()).getTime();
1319 Log.Info("First FBU latency: " + (now - this._timing.fbu_rt_start));
b1dee947
SR
1320 }
1321
6d6f0db0
SR
1322 // Make sure the previous frame is fully rendered first
1323 // to avoid building up an excessive queue
1324 if (this._display.pending()) {
1325 this._flushing = true;
1326 this._display.flush();
1327 return false;
1328 }
1329 }
b1dee947 1330
6d6f0db0
SR
1331 while (this._FBU.rects > 0) {
1332 if (this._rfb_connection_state !== 'connected') { return false; }
b1dee947 1333
6d6f0db0
SR
1334 if (this._sock.rQwait("FBU", this._FBU.bytes)) { return false; }
1335 if (this._FBU.bytes === 0) {
1336 if (this._sock.rQwait("rect header", 12)) { return false; }
1337 /* New FramebufferUpdate */
b1dee947 1338
6d6f0db0
SR
1339 var hdr = this._sock.rQshiftBytes(12);
1340 this._FBU.x = (hdr[0] << 8) + hdr[1];
1341 this._FBU.y = (hdr[2] << 8) + hdr[3];
1342 this._FBU.width = (hdr[4] << 8) + hdr[5];
1343 this._FBU.height = (hdr[6] << 8) + hdr[7];
1344 this._FBU.encoding = parseInt((hdr[8] << 24) + (hdr[9] << 16) +
1345 (hdr[10] << 8) + hdr[11], 10);
b1dee947 1346
6d6f0db0
SR
1347 this._onFBUReceive(this,
1348 {'x': this._FBU.x, 'y': this._FBU.y,
1349 'width': this._FBU.width, 'height': this._FBU.height,
1350 'encoding': this._FBU.encoding,
1351 'encodingName': this._encNames[this._FBU.encoding]});
b1dee947 1352
6d6f0db0
SR
1353 if (!this._encNames[this._FBU.encoding]) {
1354 this._fail("Unexpected server message",
1355 "Unsupported encoding " +
1356 this._FBU.encoding);
1357 return false;
1358 }
1359 }
b1dee947 1360
6d6f0db0 1361 this._timing.last_fbu = (new Date()).getTime();
76a86ff5 1362
6d6f0db0 1363 ret = this._encHandlers[this._FBU.encoding]();
3df13262 1364
6d6f0db0
SR
1365 now = (new Date()).getTime();
1366 this._timing.cur_fbu += (now - this._timing.last_fbu);
b1dee947 1367
6d6f0db0
SR
1368 if (ret) {
1369 this._encStats[this._FBU.encoding][0]++;
1370 this._encStats[this._FBU.encoding][1]++;
1371 this._timing.pixels += this._FBU.width * this._FBU.height;
b1dee947 1372 }
b1dee947 1373
6d6f0db0
SR
1374 if (this._timing.pixels >= (this._fb_width * this._fb_height)) {
1375 if ((this._FBU.width === this._fb_width && this._FBU.height === this._fb_height) ||
1376 this._timing.fbu_rt_start > 0) {
1377 this._timing.full_fbu_total += this._timing.cur_fbu;
1378 this._timing.full_fbu_cnt++;
1379 Log.Info("Timing of full FBU, curr: " +
1380 this._timing.cur_fbu + ", total: " +
1381 this._timing.full_fbu_total + ", cnt: " +
1382 this._timing.full_fbu_cnt + ", avg: " +
1383 (this._timing.full_fbu_total / this._timing.full_fbu_cnt));
b1dee947 1384 }
d9ca5e5b 1385
6d6f0db0
SR
1386 if (this._timing.fbu_rt_start > 0) {
1387 var fbu_rt_diff = now - this._timing.fbu_rt_start;
1388 this._timing.fbu_rt_total += fbu_rt_diff;
1389 this._timing.fbu_rt_cnt++;
1390 Log.Info("full FBU round-trip, cur: " +
1391 fbu_rt_diff + ", total: " +
1392 this._timing.fbu_rt_total + ", cnt: " +
1393 this._timing.fbu_rt_cnt + ", avg: " +
1394 (this._timing.fbu_rt_total / this._timing.fbu_rt_cnt));
1395 this._timing.fbu_rt_start = 0;
d9ca5e5b 1396 }
b1dee947
SR
1397 }
1398
6d6f0db0
SR
1399 if (!ret) { return ret; } // need more data
1400 }
b1dee947 1401
6d6f0db0 1402 this._display.flip();
b1dee947 1403
6d6f0db0
SR
1404 this._onFBUComplete(this,
1405 {'x': this._FBU.x, 'y': this._FBU.y,
1406 'width': this._FBU.width, 'height': this._FBU.height,
1407 'encoding': this._FBU.encoding,
1408 'encodingName': this._encNames[this._FBU.encoding]});
b1dee947 1409
6d6f0db0
SR
1410 return true; // We finished this FBU
1411 },
b1dee947 1412
6d6f0db0
SR
1413 _updateContinuousUpdates: function() {
1414 if (!this._enabledContinuousUpdates) { return; }
b1dee947 1415
6d6f0db0
SR
1416 RFB.messages.enableContinuousUpdates(this._sock, true, 0, 0,
1417 this._fb_width, this._fb_height);
91d5c625
PO
1418 },
1419
1420 _resize: function(width, height) {
1421 this._fb_width = width;
1422 this._fb_height = height;
1423
1424 this._destBuff = new Uint8Array(this._fb_width * this._fb_height * 4);
1425
1426 this._display.resize(this._fb_width, this._fb_height);
1427 this._onFBResize(this, this._fb_width, this._fb_height);
1428
1429 this._timing.fbu_rt_start = (new Date()).getTime();
1430 this._updateContinuousUpdates();
6d6f0db0
SR
1431 }
1432};
8db09746 1433
6d6f0db0
SR
1434make_properties(RFB, [
1435 ['target', 'wo', 'dom'], // VNC display rendering Canvas object
1436 ['focusContainer', 'wo', 'dom'], // DOM element that captures keyboard input
1437 ['encrypt', 'rw', 'bool'], // Use TLS/SSL/wss encryption
6d6f0db0
SR
1438 ['local_cursor', 'rw', 'bool'], // Request locally rendered cursor
1439 ['shared', 'rw', 'bool'], // Request shared mode
1440 ['view_only', 'rw', 'bool'], // Disable client mouse/keyboard
1441 ['xvp_password_sep', 'rw', 'str'], // Separator for XVP password fields
1442 ['disconnectTimeout', 'rw', 'int'], // Time (s) to wait for disconnection
1443 ['wsProtocols', 'rw', 'arr'], // Protocols to use in the WebSocket connection
1444 ['repeaterID', 'rw', 'str'], // [UltraVNC] RepeaterID to connect to
1445 ['viewportDrag', 'rw', 'bool'], // Move the viewport on mouse drags
1446
1447 // Callback functions
1448 ['onUpdateState', 'rw', 'func'], // onUpdateState(rfb, state, oldstate): connection state change
1449 ['onNotification', 'rw', 'func'], // onNotification(rfb, msg, level, options): notification for the UI
1450 ['onDisconnected', 'rw', 'func'], // onDisconnected(rfb, reason): disconnection finished
1451 ['onPasswordRequired', 'rw', 'func'], // onPasswordRequired(rfb, msg): VNC password is required
1452 ['onClipboard', 'rw', 'func'], // onClipboard(rfb, text): RFB clipboard contents received
1453 ['onBell', 'rw', 'func'], // onBell(rfb): RFB Bell message received
1454 ['onFBUReceive', 'rw', 'func'], // onFBUReceive(rfb, fbu): RFB FBU received but not yet processed
1455 ['onFBUComplete', 'rw', 'func'], // onFBUComplete(rfb, fbu): RFB FBU received and processed
1456 ['onFBResize', 'rw', 'func'], // onFBResize(rfb, width, height): frame buffer resized
1457 ['onDesktopName', 'rw', 'func'], // onDesktopName(rfb, name): desktop name received
1458 ['onXvpInit', 'rw', 'func'] // onXvpInit(version): XVP extensions active for this connection
1459]);
1460
1461RFB.prototype.set_local_cursor = function (cursor) {
1462 if (!cursor || (cursor in {'0': 1, 'no': 1, 'false': 1})) {
1463 this._local_cursor = false;
1464 this._display.disableLocalCursor(); //Only show server-side cursor
1465 } else {
1466 if (this._display.get_cursor_uri()) {
1467 this._local_cursor = true;
1468 } else {
1469 Log.Warn("Browser does not support local cursor");
1470 this._display.disableLocalCursor();
1471 }
1472 }
d86cc2d9 1473
6d6f0db0
SR
1474 // Need to send an updated list of encodings if we are connected
1475 if (this._rfb_connection_state === "connected") {
26586b9d 1476 RFB.messages.clientEncodings(this._sock, this._encodings, cursor);
6d6f0db0
SR
1477 }
1478};
2ba767a7 1479
6d6f0db0
SR
1480RFB.prototype.set_view_only = function (view_only) {
1481 this._view_only = view_only;
8db09746 1482
6d6f0db0
SR
1483 if (this._rfb_connection_state === "connecting" ||
1484 this._rfb_connection_state === "connected") {
1485 if (view_only) {
1486 this._keyboard.ungrab();
1487 this._mouse.ungrab();
1488 } else {
1489 this._keyboard.grab();
1490 this._mouse.grab();
1491 }
1492 }
1493};
76a86ff5 1494
6d6f0db0
SR
1495RFB.prototype.get_display = function () { return this._display; };
1496RFB.prototype.get_keyboard = function () { return this._keyboard; };
1497RFB.prototype.get_mouse = function () { return this._mouse; };
76a86ff5 1498
6d6f0db0
SR
1499// Class Methods
1500RFB.messages = {
1501 keyEvent: function (sock, keysym, down) {
1502 var buff = sock._sQ;
1503 var offset = sock._sQlen;
8db09746 1504
6d6f0db0
SR
1505 buff[offset] = 4; // msg-type
1506 buff[offset + 1] = down;
b1dee947 1507
6d6f0db0
SR
1508 buff[offset + 2] = 0;
1509 buff[offset + 3] = 0;
fb49f91b 1510
6d6f0db0
SR
1511 buff[offset + 4] = (keysym >> 24);
1512 buff[offset + 5] = (keysym >> 16);
1513 buff[offset + 6] = (keysym >> 8);
1514 buff[offset + 7] = keysym;
b1dee947 1515
6d6f0db0
SR
1516 sock._sQlen += 8;
1517 sock.flush();
1518 },
ef1e8bab 1519
6d6f0db0
SR
1520 QEMUExtendedKeyEvent: function (sock, keysym, down, keycode) {
1521 function getRFBkeycode(xt_scancode) {
1522 var upperByte = (keycode >> 8);
1523 var lowerByte = (keycode & 0x00ff);
1524 if (upperByte === 0xe0 && lowerByte < 0x7f) {
1525 lowerByte = lowerByte | 0x80;
1526 return lowerByte;
ef1e8bab 1527 }
6d6f0db0 1528 return xt_scancode;
ef1e8bab 1529 }
b1dee947 1530
6d6f0db0
SR
1531 var buff = sock._sQ;
1532 var offset = sock._sQlen;
8f06673a 1533
6d6f0db0
SR
1534 buff[offset] = 255; // msg-type
1535 buff[offset + 1] = 0; // sub msg-type
8f06673a 1536
6d6f0db0
SR
1537 buff[offset + 2] = (down >> 8);
1538 buff[offset + 3] = down;
8f06673a 1539
6d6f0db0
SR
1540 buff[offset + 4] = (keysym >> 24);
1541 buff[offset + 5] = (keysym >> 16);
1542 buff[offset + 6] = (keysym >> 8);
1543 buff[offset + 7] = keysym;
8f06673a 1544
6d6f0db0 1545 var RFBkeycode = getRFBkeycode(keycode);
8f06673a 1546
6d6f0db0
SR
1547 buff[offset + 8] = (RFBkeycode >> 24);
1548 buff[offset + 9] = (RFBkeycode >> 16);
1549 buff[offset + 10] = (RFBkeycode >> 8);
1550 buff[offset + 11] = RFBkeycode;
8f06673a 1551
6d6f0db0
SR
1552 sock._sQlen += 12;
1553 sock.flush();
1554 },
8f06673a 1555
6d6f0db0
SR
1556 pointerEvent: function (sock, x, y, mask) {
1557 var buff = sock._sQ;
1558 var offset = sock._sQlen;
8f06673a 1559
6d6f0db0 1560 buff[offset] = 5; // msg-type
9ff86fb7 1561
6d6f0db0 1562 buff[offset + 1] = mask;
9ff86fb7 1563
6d6f0db0
SR
1564 buff[offset + 2] = x >> 8;
1565 buff[offset + 3] = x;
9ff86fb7 1566
6d6f0db0
SR
1567 buff[offset + 4] = y >> 8;
1568 buff[offset + 5] = y;
9ff86fb7 1569
6d6f0db0
SR
1570 sock._sQlen += 6;
1571 sock.flush();
1572 },
9ff86fb7 1573
6d6f0db0
SR
1574 // TODO(directxman12): make this unicode compatible?
1575 clientCutText: function (sock, text) {
1576 var buff = sock._sQ;
1577 var offset = sock._sQlen;
b1dee947 1578
6d6f0db0 1579 buff[offset] = 6; // msg-type
9ff86fb7 1580
6d6f0db0
SR
1581 buff[offset + 1] = 0; // padding
1582 buff[offset + 2] = 0; // padding
1583 buff[offset + 3] = 0; // padding
9ff86fb7 1584
6d6f0db0 1585 var n = text.length;
9ff86fb7 1586
6d6f0db0
SR
1587 buff[offset + 4] = n >> 24;
1588 buff[offset + 5] = n >> 16;
1589 buff[offset + 6] = n >> 8;
1590 buff[offset + 7] = n;
9ff86fb7 1591
6d6f0db0
SR
1592 for (var i = 0; i < n; i++) {
1593 buff[offset + 8 + i] = text.charCodeAt(i);
1594 }
9ff86fb7 1595
6d6f0db0
SR
1596 sock._sQlen += 8 + n;
1597 sock.flush();
1598 },
1599
1600 setDesktopSize: function (sock, width, height, id, flags) {
1601 var buff = sock._sQ;
1602 var offset = sock._sQlen;
1603
1604 buff[offset] = 251; // msg-type
1605 buff[offset + 1] = 0; // padding
1606 buff[offset + 2] = width >> 8; // width
1607 buff[offset + 3] = width;
1608 buff[offset + 4] = height >> 8; // height
1609 buff[offset + 5] = height;
1610
1611 buff[offset + 6] = 1; // number-of-screens
1612 buff[offset + 7] = 0; // padding
1613
1614 // screen array
1615 buff[offset + 8] = id >> 24; // id
1616 buff[offset + 9] = id >> 16;
1617 buff[offset + 10] = id >> 8;
1618 buff[offset + 11] = id;
1619 buff[offset + 12] = 0; // x-position
1620 buff[offset + 13] = 0;
1621 buff[offset + 14] = 0; // y-position
1622 buff[offset + 15] = 0;
1623 buff[offset + 16] = width >> 8; // width
1624 buff[offset + 17] = width;
1625 buff[offset + 18] = height >> 8; // height
1626 buff[offset + 19] = height;
1627 buff[offset + 20] = flags >> 24; // flags
1628 buff[offset + 21] = flags >> 16;
1629 buff[offset + 22] = flags >> 8;
1630 buff[offset + 23] = flags;
1631
1632 sock._sQlen += 24;
1633 sock.flush();
1634 },
1635
1636 clientFence: function (sock, flags, payload) {
1637 var buff = sock._sQ;
1638 var offset = sock._sQlen;
1639
1640 buff[offset] = 248; // msg-type
1641
1642 buff[offset + 1] = 0; // padding
1643 buff[offset + 2] = 0; // padding
1644 buff[offset + 3] = 0; // padding
1645
1646 buff[offset + 4] = flags >> 24; // flags
1647 buff[offset + 5] = flags >> 16;
1648 buff[offset + 6] = flags >> 8;
1649 buff[offset + 7] = flags;
1650
1651 var n = payload.length;
1652
1653 buff[offset + 8] = n; // length
1654
1655 for (var i = 0; i < n; i++) {
1656 buff[offset + 9 + i] = payload.charCodeAt(i);
1657 }
a7a89626 1658
6d6f0db0
SR
1659 sock._sQlen += 9 + n;
1660 sock.flush();
1661 },
3df13262 1662
6d6f0db0
SR
1663 enableContinuousUpdates: function (sock, enable, x, y, width, height) {
1664 var buff = sock._sQ;
1665 var offset = sock._sQlen;
3df13262 1666
6d6f0db0
SR
1667 buff[offset] = 150; // msg-type
1668 buff[offset + 1] = enable; // enable-flag
76a86ff5 1669
6d6f0db0
SR
1670 buff[offset + 2] = x >> 8; // x
1671 buff[offset + 3] = x;
1672 buff[offset + 4] = y >> 8; // y
1673 buff[offset + 5] = y;
1674 buff[offset + 6] = width >> 8; // width
1675 buff[offset + 7] = width;
1676 buff[offset + 8] = height >> 8; // height
1677 buff[offset + 9] = height;
76a86ff5 1678
6d6f0db0
SR
1679 sock._sQlen += 10;
1680 sock.flush();
1681 },
76a86ff5 1682
6d6f0db0
SR
1683 pixelFormat: function (sock, bpp, depth, true_color) {
1684 var buff = sock._sQ;
1685 var offset = sock._sQlen;
ae116051 1686
6d6f0db0 1687 buff[offset] = 0; // msg-type
9ff86fb7 1688
6d6f0db0
SR
1689 buff[offset + 1] = 0; // padding
1690 buff[offset + 2] = 0; // padding
1691 buff[offset + 3] = 0; // padding
9ff86fb7 1692
6d6f0db0
SR
1693 buff[offset + 4] = bpp * 8; // bits-per-pixel
1694 buff[offset + 5] = depth * 8; // depth
1695 buff[offset + 6] = 0; // little-endian
1696 buff[offset + 7] = true_color ? 1 : 0; // true-color
9ff86fb7 1697
6d6f0db0
SR
1698 buff[offset + 8] = 0; // red-max
1699 buff[offset + 9] = 255; // red-max
9ff86fb7 1700
6d6f0db0
SR
1701 buff[offset + 10] = 0; // green-max
1702 buff[offset + 11] = 255; // green-max
9ff86fb7 1703
6d6f0db0
SR
1704 buff[offset + 12] = 0; // blue-max
1705 buff[offset + 13] = 255; // blue-max
9ff86fb7 1706
6d6f0db0
SR
1707 buff[offset + 14] = 16; // red-shift
1708 buff[offset + 15] = 8; // green-shift
1709 buff[offset + 16] = 0; // blue-shift
9ff86fb7 1710
6d6f0db0
SR
1711 buff[offset + 17] = 0; // padding
1712 buff[offset + 18] = 0; // padding
1713 buff[offset + 19] = 0; // padding
9ff86fb7 1714
6d6f0db0
SR
1715 sock._sQlen += 20;
1716 sock.flush();
1717 },
9ff86fb7 1718
26586b9d 1719 clientEncodings: function (sock, encodings, local_cursor) {
6d6f0db0
SR
1720 var buff = sock._sQ;
1721 var offset = sock._sQlen;
b1dee947 1722
6d6f0db0
SR
1723 buff[offset] = 2; // msg-type
1724 buff[offset + 1] = 0; // padding
b1dee947 1725
6d6f0db0 1726 // offset + 2 and offset + 3 are encoding count
9ff86fb7 1727
6d6f0db0
SR
1728 var i, j = offset + 4, cnt = 0;
1729 for (i = 0; i < encodings.length; i++) {
1730 if (encodings[i][0] === "Cursor" && !local_cursor) {
1731 Log.Debug("Skipping Cursor pseudo-encoding");
6d6f0db0
SR
1732 } else {
1733 var enc = encodings[i][1];
1734 buff[j] = enc >> 24;
1735 buff[j + 1] = enc >> 16;
1736 buff[j + 2] = enc >> 8;
1737 buff[j + 3] = enc;
9ff86fb7 1738
6d6f0db0
SR
1739 j += 4;
1740 cnt++;
b1dee947 1741 }
6d6f0db0 1742 }
a7a89626 1743
6d6f0db0
SR
1744 buff[offset + 2] = cnt >> 8;
1745 buff[offset + 3] = cnt;
a7a89626 1746
6d6f0db0
SR
1747 sock._sQlen += j - offset;
1748 sock.flush();
1749 },
a679a97d 1750
6d6f0db0
SR
1751 fbUpdateRequest: function (sock, incremental, x, y, w, h) {
1752 var buff = sock._sQ;
1753 var offset = sock._sQlen;
9ff86fb7 1754
6d6f0db0
SR
1755 if (typeof(x) === "undefined") { x = 0; }
1756 if (typeof(y) === "undefined") { y = 0; }
b1dee947 1757
6d6f0db0
SR
1758 buff[offset] = 3; // msg-type
1759 buff[offset + 1] = incremental ? 1 : 0;
9ff86fb7 1760
6d6f0db0
SR
1761 buff[offset + 2] = (x >> 8) & 0xFF;
1762 buff[offset + 3] = x & 0xFF;
9ff86fb7 1763
6d6f0db0
SR
1764 buff[offset + 4] = (y >> 8) & 0xFF;
1765 buff[offset + 5] = y & 0xFF;
9ff86fb7 1766
6d6f0db0
SR
1767 buff[offset + 6] = (w >> 8) & 0xFF;
1768 buff[offset + 7] = w & 0xFF;
9ff86fb7 1769
6d6f0db0
SR
1770 buff[offset + 8] = (h >> 8) & 0xFF;
1771 buff[offset + 9] = h & 0xFF;
b1dee947 1772
6d6f0db0
SR
1773 sock._sQlen += 10;
1774 sock.flush();
1775 }
1776};
b1dee947 1777
6d6f0db0
SR
1778RFB.genDES = function (password, challenge) {
1779 var passwd = [];
1780 for (var i = 0; i < password.length; i++) {
1781 passwd.push(password.charCodeAt(i));
1782 }
1783 return (new DES(passwd)).encrypt(challenge);
1784};
b1dee947 1785
6d6f0db0
SR
1786RFB.encodingHandlers = {
1787 RAW: function () {
1788 if (this._FBU.lines === 0) {
1789 this._FBU.lines = this._FBU.height;
1790 }
a7a89626 1791
26586b9d 1792 this._FBU.bytes = this._FBU.width * 4; // at least a line
6d6f0db0
SR
1793 if (this._sock.rQwait("RAW", this._FBU.bytes)) { return false; }
1794 var cur_y = this._FBU.y + (this._FBU.height - this._FBU.lines);
1795 var curr_height = Math.min(this._FBU.lines,
26586b9d 1796 Math.floor(this._sock.rQlen() / (this._FBU.width * 4)));
6d6f0db0
SR
1797 this._display.blitImage(this._FBU.x, cur_y, this._FBU.width,
1798 curr_height, this._sock.get_rQ(),
1799 this._sock.get_rQi());
26586b9d 1800 this._sock.rQskipBytes(this._FBU.width * curr_height * 4);
6d6f0db0
SR
1801 this._FBU.lines -= curr_height;
1802
1803 if (this._FBU.lines > 0) {
26586b9d 1804 this._FBU.bytes = this._FBU.width * 4; // At least another line
6d6f0db0
SR
1805 } else {
1806 this._FBU.rects--;
1807 this._FBU.bytes = 0;
1808 }
b1dee947 1809
6d6f0db0
SR
1810 return true;
1811 },
1812
1813 COPYRECT: function () {
1814 this._FBU.bytes = 4;
1815 if (this._sock.rQwait("COPYRECT", 4)) { return false; }
1816 this._display.copyImage(this._sock.rQshift16(), this._sock.rQshift16(),
1817 this._FBU.x, this._FBU.y, this._FBU.width,
1818 this._FBU.height);
1819
1820 this._FBU.rects--;
1821 this._FBU.bytes = 0;
1822 return true;
1823 },
1824
1825 RRE: function () {
1826 var color;
1827 if (this._FBU.subrects === 0) {
26586b9d
PO
1828 this._FBU.bytes = 4 + 4;
1829 if (this._sock.rQwait("RRE", 4 + 4)) { return false; }
6d6f0db0 1830 this._FBU.subrects = this._sock.rQshift32();
26586b9d 1831 color = this._sock.rQshiftBytes(4); // Background
6d6f0db0
SR
1832 this._display.fillRect(this._FBU.x, this._FBU.y, this._FBU.width, this._FBU.height, color);
1833 }
b1dee947 1834
26586b9d
PO
1835 while (this._FBU.subrects > 0 && this._sock.rQlen() >= (4 + 8)) {
1836 color = this._sock.rQshiftBytes(4);
6d6f0db0
SR
1837 var x = this._sock.rQshift16();
1838 var y = this._sock.rQshift16();
1839 var width = this._sock.rQshift16();
1840 var height = this._sock.rQshift16();
1841 this._display.fillRect(this._FBU.x + x, this._FBU.y + y, width, height, color);
1842 this._FBU.subrects--;
1843 }
f00193e0 1844
6d6f0db0
SR
1845 if (this._FBU.subrects > 0) {
1846 var chunk = Math.min(this._rre_chunk_sz, this._FBU.subrects);
26586b9d 1847 this._FBU.bytes = (4 + 8) * chunk;
6d6f0db0 1848 } else {
b1dee947
SR
1849 this._FBU.rects--;
1850 this._FBU.bytes = 0;
6d6f0db0 1851 }
b1dee947 1852
6d6f0db0
SR
1853 return true;
1854 },
b1dee947 1855
6d6f0db0
SR
1856 HEXTILE: function () {
1857 var rQ = this._sock.get_rQ();
1858 var rQi = this._sock.get_rQi();
b1dee947 1859
6d6f0db0
SR
1860 if (this._FBU.tiles === 0) {
1861 this._FBU.tiles_x = Math.ceil(this._FBU.width / 16);
1862 this._FBU.tiles_y = Math.ceil(this._FBU.height / 16);
1863 this._FBU.total_tiles = this._FBU.tiles_x * this._FBU.tiles_y;
1864 this._FBU.tiles = this._FBU.total_tiles;
1865 }
b1dee947 1866
6d6f0db0
SR
1867 while (this._FBU.tiles > 0) {
1868 this._FBU.bytes = 1;
1869 if (this._sock.rQwait("HEXTILE subencoding", this._FBU.bytes)) { return false; }
1870 var subencoding = rQ[rQi]; // Peek
1871 if (subencoding > 30) { // Raw
1872 this._fail("Unexpected server message",
1873 "Illegal hextile subencoding: " + subencoding);
1874 return false;
b1dee947
SR
1875 }
1876
6d6f0db0
SR
1877 var subrects = 0;
1878 var curr_tile = this._FBU.total_tiles - this._FBU.tiles;
1879 var tile_x = curr_tile % this._FBU.tiles_x;
1880 var tile_y = Math.floor(curr_tile / this._FBU.tiles_x);
1881 var x = this._FBU.x + tile_x * 16;
1882 var y = this._FBU.y + tile_y * 16;
1883 var w = Math.min(16, (this._FBU.x + this._FBU.width) - x);
1884 var h = Math.min(16, (this._FBU.y + this._FBU.height) - y);
b1dee947 1885
6d6f0db0
SR
1886 // Figure out how much we are expecting
1887 if (subencoding & 0x01) { // Raw
26586b9d 1888 this._FBU.bytes += w * h * 4;
6d6f0db0
SR
1889 } else {
1890 if (subencoding & 0x02) { // Background
26586b9d 1891 this._FBU.bytes += 4;
6d6f0db0
SR
1892 }
1893 if (subencoding & 0x04) { // Foreground
26586b9d 1894 this._FBU.bytes += 4;
6d6f0db0
SR
1895 }
1896 if (subencoding & 0x08) { // AnySubrects
1897 this._FBU.bytes++; // Since we aren't shifting it off
1898 if (this._sock.rQwait("hextile subrects header", this._FBU.bytes)) { return false; }
1899 subrects = rQ[rQi + this._FBU.bytes - 1]; // Peek
1900 if (subencoding & 0x10) { // SubrectsColoured
26586b9d 1901 this._FBU.bytes += subrects * (4 + 2);
6d6f0db0
SR
1902 } else {
1903 this._FBU.bytes += subrects * 2;
b1dee947
SR
1904 }
1905 }
6d6f0db0 1906 }
b1dee947 1907
6d6f0db0 1908 if (this._sock.rQwait("hextile", this._FBU.bytes)) { return false; }
b1dee947 1909
6d6f0db0
SR
1910 // We know the encoding and have a whole tile
1911 this._FBU.subencoding = rQ[rQi];
1912 rQi++;
1913 if (this._FBU.subencoding === 0) {
1914 if (this._FBU.lastsubencoding & 0x01) {
1915 // Weird: ignore blanks are RAW
1916 Log.Debug(" Ignoring blank after RAW");
b1dee947 1917 } else {
6d6f0db0
SR
1918 this._display.fillRect(x, y, w, h, this._FBU.background);
1919 }
1920 } else if (this._FBU.subencoding & 0x01) { // Raw
1921 this._display.blitImage(x, y, w, h, rQ, rQi);
1922 rQi += this._FBU.bytes - 1;
1923 } else {
1924 if (this._FBU.subencoding & 0x02) { // Background
26586b9d
PO
1925 this._FBU.background = [rQ[rQi], rQ[rQi + 1], rQ[rQi + 2], rQ[rQi + 3]];
1926 rQi += 4;
6d6f0db0
SR
1927 }
1928 if (this._FBU.subencoding & 0x04) { // Foreground
26586b9d
PO
1929 this._FBU.foreground = [rQ[rQi], rQ[rQi + 1], rQ[rQi + 2], rQ[rQi + 3]];
1930 rQi += 4;
6d6f0db0 1931 }
b1dee947 1932
6d6f0db0
SR
1933 this._display.startTile(x, y, w, h, this._FBU.background);
1934 if (this._FBU.subencoding & 0x08) { // AnySubrects
1935 subrects = rQ[rQi];
1936 rQi++;
b1dee947 1937
6d6f0db0
SR
1938 for (var s = 0; s < subrects; s++) {
1939 var color;
1940 if (this._FBU.subencoding & 0x10) { // SubrectsColoured
26586b9d
PO
1941 color = [rQ[rQi], rQ[rQi + 1], rQ[rQi + 2], rQ[rQi + 3]];
1942 rQi += 4;
6d6f0db0
SR
1943 } else {
1944 color = this._FBU.foreground;
1945 }
1946 var xy = rQ[rQi];
1947 rQi++;
1948 var sx = (xy >> 4);
1949 var sy = (xy & 0x0f);
a7a89626 1950
6d6f0db0
SR
1951 var wh = rQ[rQi];
1952 rQi++;
1953 var sw = (wh >> 4) + 1;
1954 var sh = (wh & 0x0f) + 1;
a7a89626 1955
6d6f0db0 1956 this._display.subTile(sx, sy, sw, sh, color);
b1dee947 1957 }
a7a89626 1958 }
6d6f0db0 1959 this._display.finishTile();
a7a89626 1960 }
6d6f0db0
SR
1961 this._sock.set_rQi(rQi);
1962 this._FBU.lastsubencoding = this._FBU.subencoding;
1963 this._FBU.bytes = 0;
1964 this._FBU.tiles--;
1965 }
d065cad9 1966
6d6f0db0
SR
1967 if (this._FBU.tiles === 0) {
1968 this._FBU.rects--;
1969 }
b1dee947 1970
6d6f0db0
SR
1971 return true;
1972 },
b1dee947 1973
3e8b26ab 1974 TIGHT: function () {
6d6f0db0
SR
1975 this._FBU.bytes = 1; // compression-control byte
1976 if (this._sock.rQwait("TIGHT compression-control", this._FBU.bytes)) { return false; }
1977
1978 var checksum = function (data) {
1979 var sum = 0;
1980 for (var i = 0; i < data.length; i++) {
1981 sum += data[i];
1982 if (sum > 65536) sum -= 65536;
1983 }
1984 return sum;
1985 };
1986
1987 var resetStreams = 0;
1988 var streamId = -1;
1989 var decompress = function (data, expected) {
1990 for (var i = 0; i < 4; i++) {
1991 if ((resetStreams >> i) & 1) {
1992 this._FBU.zlibs[i].reset();
1993 Log.Info("Reset zlib stream " + i);
b1dee947 1994 }
6d6f0db0 1995 }
de84e098 1996
6d6f0db0
SR
1997 //var uncompressed = this._FBU.zlibs[streamId].uncompress(data, 0);
1998 var uncompressed = this._FBU.zlibs[streamId].inflate(data, true, expected);
1999 /*if (uncompressed.status !== 0) {
2000 Log.Error("Invalid data in zlib stream");
2001 }*/
2002
2003 //return uncompressed.data;
2004 return uncompressed;
2005 }.bind(this);
2006
2007 var indexedToRGBX2Color = function (data, palette, width, height) {
2008 // Convert indexed (palette based) image data to RGB
2009 // TODO: reduce number of calculations inside loop
2010 var dest = this._destBuff;
2011 var w = Math.floor((width + 7) / 8);
2012 var w1 = Math.floor(width / 8);
2013
2014 /*for (var y = 0; y < height; y++) {
2015 var b, x, dp, sp;
2016 var yoffset = y * width;
2017 var ybitoffset = y * w;
2018 var xoffset, targetbyte;
2019 for (x = 0; x < w1; x++) {
d1800d09
SR
2020 xoffset = yoffset + x * 8;
2021 targetbyte = data[ybitoffset + x];
6d6f0db0 2022 for (b = 7; b >= 0; b--) {
d1800d09
SR
2023 dp = (xoffset + 7 - b) * 3;
2024 sp = (targetbyte >> b & 1) * 3;
2025 dest[dp] = palette[sp];
2026 dest[dp + 1] = palette[sp + 1];
2027 dest[dp + 2] = palette[sp + 2];
2028 }
6d6f0db0
SR
2029 }
2030
2031 xoffset = yoffset + x * 8;
2032 targetbyte = data[ybitoffset + x];
2033 for (b = 7; b >= 8 - width % 8; b--) {
2034 dp = (xoffset + 7 - b) * 3;
2035 sp = (targetbyte >> b & 1) * 3;
2036 dest[dp] = palette[sp];
2037 dest[dp + 1] = palette[sp + 1];
2038 dest[dp + 2] = palette[sp + 2];
2039 }
2040 }*/
d1800d09 2041
6d6f0db0
SR
2042 for (var y = 0; y < height; y++) {
2043 var b, x, dp, sp;
2044 for (x = 0; x < w1; x++) {
2045 for (b = 7; b >= 0; b--) {
d1800d09
SR
2046 dp = (y * width + x * 8 + 7 - b) * 4;
2047 sp = (data[y * w + x] >> b & 1) * 3;
2048 dest[dp] = palette[sp];
2049 dest[dp + 1] = palette[sp + 1];
2050 dest[dp + 2] = palette[sp + 2];
2051 dest[dp + 3] = 255;
e16ad2fd
JM
2052 }
2053 }
b1dee947 2054
6d6f0db0
SR
2055 for (b = 7; b >= 8 - width % 8; b--) {
2056 dp = (y * width + x * 8 + 7 - b) * 4;
2057 sp = (data[y * w + x] >> b & 1) * 3;
2058 dest[dp] = palette[sp];
2059 dest[dp + 1] = palette[sp + 1];
2060 dest[dp + 2] = palette[sp + 2];
2061 dest[dp + 3] = 255;
d1800d09 2062 }
6d6f0db0 2063 }
d1800d09 2064
6d6f0db0
SR
2065 return dest;
2066 }.bind(this);
2067
2068 var indexedToRGBX = function (data, palette, width, height) {
2069 // Convert indexed (palette based) image data to RGB
2070 var dest = this._destBuff;
2071 var total = width * height * 4;
2072 for (var i = 0, j = 0; i < total; i += 4, j++) {
2073 var sp = data[j] * 3;
2074 dest[i] = palette[sp];
2075 dest[i + 1] = palette[sp + 1];
2076 dest[i + 2] = palette[sp + 2];
2077 dest[i + 3] = 255;
2078 }
2079
2080 return dest;
2081 }.bind(this);
2082
2083 var rQi = this._sock.get_rQi();
2084 var rQ = this._sock.rQwhole();
2085 var cmode, data;
2086 var cl_header, cl_data;
2087
2088 var handlePalette = function () {
2089 var numColors = rQ[rQi + 2] + 1;
26586b9d 2090 var paletteSize = numColors * 3;
6d6f0db0
SR
2091 this._FBU.bytes += paletteSize;
2092 if (this._sock.rQwait("TIGHT palette " + cmode, this._FBU.bytes)) { return false; }
2093
2094 var bpp = (numColors <= 2) ? 1 : 8;
2095 var rowSize = Math.floor((this._FBU.width * bpp + 7) / 8);
2096 var raw = false;
2097 if (rowSize * this._FBU.height < 12) {
2098 raw = true;
2099 cl_header = 0;
2100 cl_data = rowSize * this._FBU.height;
2101 //clength = [0, rowSize * this._FBU.height];
2102 } else {
2103 // begin inline getTightCLength (returning two-item arrays is bad for performance with GC)
2104 var cl_offset = rQi + 3 + paletteSize;
2105 cl_header = 1;
2106 cl_data = 0;
2107 cl_data += rQ[cl_offset] & 0x7f;
2108 if (rQ[cl_offset] & 0x80) {
2109 cl_header++;
2110 cl_data += (rQ[cl_offset + 1] & 0x7f) << 7;
2111 if (rQ[cl_offset + 1] & 0x80) {
d1800d09 2112 cl_header++;
6d6f0db0 2113 cl_data += rQ[cl_offset + 2] << 14;
d1800d09 2114 }
e16ad2fd 2115 }
6d6f0db0
SR
2116 // end inline getTightCLength
2117 }
b1dee947 2118
6d6f0db0
SR
2119 this._FBU.bytes += cl_header + cl_data;
2120 if (this._sock.rQwait("TIGHT " + cmode, this._FBU.bytes)) { return false; }
b1dee947 2121
6d6f0db0
SR
2122 // Shift ctl, filter id, num colors, palette entries, and clength off
2123 this._sock.rQskipBytes(3);
2124 //var palette = this._sock.rQshiftBytes(paletteSize);
2125 this._sock.rQshiftTo(this._paletteBuff, paletteSize);
2126 this._sock.rQskipBytes(cl_header);
b1dee947 2127
6d6f0db0
SR
2128 if (raw) {
2129 data = this._sock.rQshiftBytes(cl_data);
2130 } else {
2131 data = decompress(this._sock.rQshiftBytes(cl_data), rowSize * this._FBU.height);
2132 }
b1dee947 2133
6d6f0db0
SR
2134 // Convert indexed (palette based) image data to RGB
2135 var rgbx;
2136 if (numColors == 2) {
2137 rgbx = indexedToRGBX2Color(data, this._paletteBuff, this._FBU.width, this._FBU.height);
2138 this._display.blitRgbxImage(this._FBU.x, this._FBU.y, this._FBU.width, this._FBU.height, rgbx, 0, false);
2139 } else {
2140 rgbx = indexedToRGBX(data, this._paletteBuff, this._FBU.width, this._FBU.height);
2141 this._display.blitRgbxImage(this._FBU.x, this._FBU.y, this._FBU.width, this._FBU.height, rgbx, 0, false);
2142 }
b1dee947 2143
b1dee947 2144
6d6f0db0
SR
2145 return true;
2146 }.bind(this);
2147
2148 var handleCopy = function () {
2149 var raw = false;
26586b9d 2150 var uncompressedSize = this._FBU.width * this._FBU.height * 3;
6d6f0db0
SR
2151 if (uncompressedSize < 12) {
2152 raw = true;
2153 cl_header = 0;
2154 cl_data = uncompressedSize;
2155 } else {
2156 // begin inline getTightCLength (returning two-item arrays is for peformance with GC)
2157 var cl_offset = rQi + 1;
2158 cl_header = 1;
2159 cl_data = 0;
2160 cl_data += rQ[cl_offset] & 0x7f;
2161 if (rQ[cl_offset] & 0x80) {
2162 cl_header++;
2163 cl_data += (rQ[cl_offset + 1] & 0x7f) << 7;
2164 if (rQ[cl_offset + 1] & 0x80) {
d1800d09 2165 cl_header++;
6d6f0db0 2166 cl_data += rQ[cl_offset + 2] << 14;
d1800d09 2167 }
b1dee947 2168 }
6d6f0db0
SR
2169 // end inline getTightCLength
2170 }
2171 this._FBU.bytes = 1 + cl_header + cl_data;
2172 if (this._sock.rQwait("TIGHT " + cmode, this._FBU.bytes)) { return false; }
b1dee947 2173
6d6f0db0
SR
2174 // Shift ctl, clength off
2175 this._sock.rQshiftBytes(1 + cl_header);
b1dee947 2176
6d6f0db0
SR
2177 if (raw) {
2178 data = this._sock.rQshiftBytes(cl_data);
2179 } else {
2180 data = decompress(this._sock.rQshiftBytes(cl_data), uncompressedSize);
2181 }
b1dee947 2182
6d6f0db0 2183 this._display.blitRgbImage(this._FBU.x, this._FBU.y, this._FBU.width, this._FBU.height, data, 0, false);
b1dee947 2184
6d6f0db0
SR
2185 return true;
2186 }.bind(this);
b1dee947 2187
6d6f0db0 2188 var ctl = this._sock.rQpeek8();
b1dee947 2189
6d6f0db0
SR
2190 // Keep tight reset bits
2191 resetStreams = ctl & 0xF;
b1dee947 2192
6d6f0db0
SR
2193 // Figure out filter
2194 ctl = ctl >> 4;
2195 streamId = ctl & 0x3;
b1dee947 2196
6d6f0db0
SR
2197 if (ctl === 0x08) cmode = "fill";
2198 else if (ctl === 0x09) cmode = "jpeg";
2199 else if (ctl === 0x0A) cmode = "png";
2200 else if (ctl & 0x04) cmode = "filter";
2201 else if (ctl < 0x04) cmode = "copy";
2202 else return this._fail("Unexpected server message",
2203 "Illegal tight compression received, " +
2204 "ctl: " + ctl);
b1dee947 2205
6d6f0db0 2206 switch (cmode) {
26586b9d 2207 // fill use depth because TPIXELs drop the padding byte
6d6f0db0 2208 case "fill": // TPIXEL
26586b9d 2209 this._FBU.bytes += 3;
6d6f0db0
SR
2210 break;
2211 case "jpeg": // max clength
2212 this._FBU.bytes += 3;
2213 break;
2214 case "png": // max clength
2215 this._FBU.bytes += 3;
2216 break;
2217 case "filter": // filter id + num colors if palette
2218 this._FBU.bytes += 2;
2219 break;
2220 case "copy":
2221 break;
2222 }
d065cad9 2223
6d6f0db0 2224 if (this._sock.rQwait("TIGHT " + cmode, this._FBU.bytes)) { return false; }
b1dee947 2225
6d6f0db0
SR
2226 // Determine FBU.bytes
2227 switch (cmode) {
2228 case "fill":
2229 // skip ctl byte
2230 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);
2231 this._sock.rQskipBytes(4);
2232 break;
2233 case "png":
2234 case "jpeg":
2235 // begin inline getTightCLength (returning two-item arrays is for peformance with GC)
2236 var cl_offset = rQi + 1;
2237 cl_header = 1;
2238 cl_data = 0;
2239 cl_data += rQ[cl_offset] & 0x7f;
2240 if (rQ[cl_offset] & 0x80) {
2241 cl_header++;
2242 cl_data += (rQ[cl_offset + 1] & 0x7f) << 7;
2243 if (rQ[cl_offset + 1] & 0x80) {
d1800d09 2244 cl_header++;
6d6f0db0 2245 cl_data += rQ[cl_offset + 2] << 14;
b1dee947 2246 }
6d6f0db0
SR
2247 }
2248 // end inline getTightCLength
2249 this._FBU.bytes = 1 + cl_header + cl_data; // ctl + clength size + jpeg-data
2250 if (this._sock.rQwait("TIGHT " + cmode, this._FBU.bytes)) { return false; }
798340b9 2251
6d6f0db0
SR
2252 // We have everything, render it
2253 this._sock.rQskipBytes(1 + cl_header); // shift off clt + compact length
2254 data = this._sock.rQshiftBytes(cl_data);
2255 this._display.imageRect(this._FBU.x, this._FBU.y, "image/" + cmode, data);
2256 break;
2257 case "filter":
2258 var filterId = rQ[rQi + 1];
2259 if (filterId === 1) {
2260 if (!handlePalette()) { return false; }
b0ec6509 2261 } else {
6d6f0db0
SR
2262 // Filter 0, Copy could be valid here, but servers don't send it as an explicit filter
2263 // Filter 2, Gradient is valid but not use if jpeg is enabled
2264 this._fail("Unexpected server message",
2265 "Unsupported tight subencoding received, " +
2266 "filter: " + filterId);
b0ec6509 2267 }
6d6f0db0
SR
2268 break;
2269 case "copy":
2270 if (!handleCopy()) { return false; }
2271 break;
2272 }
b0ec6509 2273
6d6f0db0
SR
2274
2275 this._FBU.bytes = 0;
2276 this._FBU.rects--;
2277
2278 return true;
2279 },
2280
6d6f0db0
SR
2281 last_rect: function () {
2282 this._FBU.rects = 0;
2283 return true;
2284 },
2285
6d6f0db0
SR
2286 ExtendedDesktopSize: function () {
2287 this._FBU.bytes = 1;
2288 if (this._sock.rQwait("ExtendedDesktopSize", this._FBU.bytes)) { return false; }
2289
2290 this._supportsSetDesktopSize = true;
2291 var number_of_screens = this._sock.rQpeek8();
2292
2293 this._FBU.bytes = 4 + (number_of_screens * 16);
2294 if (this._sock.rQwait("ExtendedDesktopSize", this._FBU.bytes)) { return false; }
2295
2296 this._sock.rQskipBytes(1); // number-of-screens
2297 this._sock.rQskipBytes(3); // padding
2298
2299 for (var i = 0; i < number_of_screens; i += 1) {
2300 // Save the id and flags of the first screen
2301 if (i === 0) {
2302 this._screen_id = this._sock.rQshiftBytes(4); // id
2303 this._sock.rQskipBytes(2); // x-position
2304 this._sock.rQskipBytes(2); // y-position
2305 this._sock.rQskipBytes(2); // width
2306 this._sock.rQskipBytes(2); // height
2307 this._screen_flags = this._sock.rQshiftBytes(4); // flags
2308 } else {
2309 this._sock.rQskipBytes(16);
798340b9 2310 }
6d6f0db0 2311 }
b0ec6509 2312
6d6f0db0
SR
2313 /*
2314 * The x-position indicates the reason for the change:
2315 *
2316 * 0 - server resized on its own
2317 * 1 - this client requested the resize
2318 * 2 - another client requested the resize
2319 */
b0ec6509 2320
6d6f0db0
SR
2321 // We need to handle errors when we requested the resize.
2322 if (this._FBU.x === 1 && this._FBU.y !== 0) {
2323 var msg = "";
2324 // The y-position indicates the status code from the server
2325 switch (this._FBU.y) {
2326 case 1:
2327 msg = "Resize is administratively prohibited";
2328 break;
2329 case 2:
2330 msg = "Out of resources";
2331 break;
2332 case 3:
2333 msg = "Invalid screen layout";
2334 break;
2335 default:
2336 msg = "Unknown reason";
2337 break;
2338 }
2339 this._notification("Server did not accept the resize request: "
2340 + msg, 'normal');
910fd3af
PO
2341 } else {
2342 this._resize(this._FBU.width, this._FBU.height);
6d6f0db0 2343 }
b1dee947 2344
91d5c625
PO
2345 this._FBU.bytes = 0;
2346 this._FBU.rects -= 1;
6d6f0db0
SR
2347 return true;
2348 },
b1dee947 2349
6d6f0db0 2350 DesktopSize: function () {
91d5c625
PO
2351 this._resize(this._FBU.width, this._FBU.height);
2352 this._FBU.bytes = 0;
2353 this._FBU.rects -= 1;
6d6f0db0
SR
2354 return true;
2355 },
8db09746 2356
6d6f0db0
SR
2357 Cursor: function () {
2358 Log.Debug(">> set_cursor");
2359 var x = this._FBU.x; // hotspot-x
2360 var y = this._FBU.y; // hotspot-y
2361 var w = this._FBU.width;
2362 var h = this._FBU.height;
8db09746 2363
26586b9d 2364 var pixelslength = w * h * 4;
6d6f0db0 2365 var masklength = Math.floor((w + 7) / 8) * h;
a7a89626 2366
6d6f0db0
SR
2367 this._FBU.bytes = pixelslength + masklength;
2368 if (this._sock.rQwait("cursor encoding", this._FBU.bytes)) { return false; }
b1dee947 2369
6d6f0db0
SR
2370 this._display.changeCursor(this._sock.rQshiftBytes(pixelslength),
2371 this._sock.rQshiftBytes(masklength),
2372 x, y, w, h);
b1dee947 2373
6d6f0db0
SR
2374 this._FBU.bytes = 0;
2375 this._FBU.rects--;
8f06673a 2376
6d6f0db0
SR
2377 Log.Debug("<< set_cursor");
2378 return true;
2379 },
25e4928f 2380
6d6f0db0
SR
2381 QEMUExtendedKeyEvent: function () {
2382 this._FBU.rects--;
25e4928f 2383
2bf4cf5a
PO
2384 // Old Safari doesn't support creating keyboard events
2385 try {
2386 var keyboardEvent = document.createEvent("keyboardEvent");
2387 if (keyboardEvent.code !== undefined) {
2388 this._qemuExtKeyEventSupported = true;
2389 }
2390 } catch (err) {
058be785 2391 }
6d6f0db0 2392 },
6d6f0db0 2393};