2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
15 * The Original Code is guacamole-common-js.
17 * The Initial Developer of the Original Code is
19 * Portions created by the Initial Developer are Copyright (C) 2010
20 * the Initial Developer. All Rights Reserved.
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
37 * ***** END LICENSE BLOCK ***** */
39 // Guacamole namespace
40 var Guacamole = Guacamole || {};
44 * Guacamole protocol client. Given a display element and {@link Guacamole.Tunnel},
45 * automatically handles incoming and outgoing Guacamole instructions via the
46 * provided tunnel, updating the display using one or more canvas elements.
49 * @param {Guacamole.Tunnel} tunnel The tunnel to use to send and receive
50 * Guacamole instructions.
52 Guacamole.Client = function(tunnel) {
54 var guac_client = this;
57 var STATE_CONNECTING = 1;
58 var STATE_WAITING = 2;
59 var STATE_CONNECTED = 3;
60 var STATE_DISCONNECTING = 4;
61 var STATE_DISCONNECTED = 5;
63 var currentState = STATE_IDLE;
65 var currentTimestamp = 0;
66 var pingInterval = null;
69 var displayHeight = 0;
72 var display = document.createElement("div");
73 display.style.position = "relative";
74 display.style.width = displayWidth + "px";
75 display.style.height = displayHeight + "px";
77 // Create default layer
78 var default_layer_container = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
80 // Position default layer
81 var default_layer_container_element = default_layer_container.getElement();
82 default_layer_container_element.style.position = "absolute";
83 default_layer_container_element.style.left = "0px";
84 default_layer_container_element.style.top = "0px";
86 // Create cursor layer
87 var cursor = new Guacamole.Client.LayerContainer(0, 0);
88 cursor.getLayer().setChannelMask(Guacamole.Layer.SRC);
90 // Position cursor layer
91 var cursor_element = cursor.getElement();
92 cursor_element.style.position = "absolute";
93 cursor_element.style.left = "0px";
94 cursor_element.style.top = "0px";
96 // Add default layer and cursor to display
97 display.appendChild(default_layer_container.getElement());
98 display.appendChild(cursor.getElement());
100 // Initially, only default layer exists
101 var layers = [default_layer_container];
103 // No initial buffers
106 tunnel.onerror = function(message) {
107 if (guac_client.onerror)
108 guac_client.onerror(message);
111 function setState(state) {
112 if (state != currentState) {
113 currentState = state;
114 if (guac_client.onstatechange)
115 guac_client.onstatechange(currentState);
119 function isConnected() {
120 return currentState == STATE_CONNECTED
121 || currentState == STATE_WAITING;
124 var cursorHotspotX = 0;
125 var cursorHotspotY = 0;
130 function moveCursor(x, y) {
132 var element = cursor.getElement();
135 element.style.left = (x - cursorHotspotX) + "px";
136 element.style.top = (y - cursorHotspotY) + "px";
138 // Update stored position
144 guac_client.getDisplay = function() {
148 guac_client.sendKeyEvent = function(pressed, keysym) {
149 // Do not send requests if not connected
153 tunnel.sendMessage("key", keysym, pressed);
156 guac_client.sendMouseState = function(mouseState) {
158 // Do not send requests if not connected
162 // Update client-side cursor
170 if (mouseState.left) buttonMask |= 1;
171 if (mouseState.middle) buttonMask |= 2;
172 if (mouseState.right) buttonMask |= 4;
173 if (mouseState.up) buttonMask |= 8;
174 if (mouseState.down) buttonMask |= 16;
177 tunnel.sendMessage("mouse", mouseState.x, mouseState.y, buttonMask);
180 guac_client.setClipboard = function(data) {
182 // Do not send requests if not connected
186 tunnel.sendMessage("clipboard", data);
190 guac_client.onstatechange = null;
191 guac_client.onname = null;
192 guac_client.onerror = null;
193 guac_client.onclipboard = null;
196 function getBufferLayer(index) {
199 var buffer = buffers[index];
201 // Create buffer if necessary
202 if (buffer == null) {
203 buffer = new Guacamole.Layer(0, 0);
205 buffers[index] = buffer;
212 function getLayerContainer(index) {
214 var layer = layers[index];
218 layer = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
219 layers[index] = layer;
221 // Get and position layer
222 var layer_element = layer.getElement();
223 layer_element.style.position = "absolute";
224 layer_element.style.left = "0px";
225 layer_element.style.top = "0px";
227 // Add to default layer container
228 default_layer_container.getElement().appendChild(layer_element);
236 function getLayer(index) {
238 // If buffer, just get layer
240 return getBufferLayer(index);
242 // Otherwise, retrieve layer from layer container
243 return getLayerContainer(index).getLayer();
247 var instructionHandlers = {
249 "error": function(parameters) {
250 if (guac_client.onerror) guac_client.onerror(parameters[0]);
251 guac_client.disconnect();
254 "name": function(parameters) {
255 if (guac_client.onname) guac_client.onname(parameters[0]);
258 "clipboard": function(parameters) {
259 if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
262 "size": function(parameters) {
264 var layer_index = parseInt(parameters[0]);
265 var width = parseInt(parameters[1]);
266 var height = parseInt(parameters[2]);
268 // Only valid for layers (buffers auto-resize)
269 if (layer_index >= 0) {
272 var layer_container = getLayerContainer(layer_index);
273 layer_container.resize(width, height);
275 // If layer is default, resize display
276 if (layer_index == 0) {
278 displayWidth = width;
279 displayHeight = height;
281 // Update (set) display size
282 display.style.width = displayWidth + "px";
283 display.style.height = displayHeight + "px";
287 } // end if layer (not buffer)
291 "move": function(parameters) {
293 var layer_index = parseInt(parameters[0]);
294 var parent_index = parseInt(parameters[1]);
295 var x = parseInt(parameters[2]);
296 var y = parseInt(parameters[3]);
297 var z = parseInt(parameters[4]);
299 // Only valid for non-default layers
300 if (layer_index > 0 && parent_index >= 0) {
302 // Get container element
303 var layer_container = getLayerContainer(layer_index).getElement();
304 var parent = getLayerContainer(parent_index).getElement();
306 // Set parent if necessary
307 if (!(layer_container.parentNode === parent))
308 parent.appendChild(layer_container);
311 layer_container.style.left = x + "px";
312 layer_container.style.top = y + "px";
313 layer_container.style.zIndex = z;
319 "dispose": function(parameters) {
321 var layer_index = parseInt(parameters[0]);
323 // If visible layer, remove from parent
324 if (layer_index > 0) {
326 // Get container element
327 var layer_container = getLayerContainer(layer_index).getElement();
329 // Remove from parent
330 layer_container.parentNode.removeChild(layer_container);
333 delete layers[layer_index];
337 // If buffer, just delete reference
338 else if (layer_index < 0)
339 delete buffers[-1 - layer_index];
341 // Attempting to dispose the root layer currently has no effect.
345 "png": function(parameters) {
347 var channelMask = parseInt(parameters[0]);
348 var layer = getLayer(parseInt(parameters[1]));
349 var x = parseInt(parameters[2]);
350 var y = parseInt(parameters[3]);
351 var data = parameters[4];
353 layer.setChannelMask(channelMask);
358 "data:image/png;base64," + data
361 // If received first update, no longer waiting.
362 if (currentState == STATE_WAITING)
363 setState(STATE_CONNECTED);
367 "copy": function(parameters) {
369 var srcL = getLayer(parseInt(parameters[0]));
370 var srcX = parseInt(parameters[1]);
371 var srcY = parseInt(parameters[2]);
372 var srcWidth = parseInt(parameters[3]);
373 var srcHeight = parseInt(parameters[4]);
374 var channelMask = parseInt(parameters[5]);
375 var dstL = getLayer(parseInt(parameters[6]));
376 var dstX = parseInt(parameters[7]);
377 var dstY = parseInt(parameters[8]);
379 dstL.setChannelMask(channelMask);
393 "transfer": function(parameters) {
395 var srcL = getLayer(parseInt(parameters[0]));
396 var srcX = parseInt(parameters[1]);
397 var srcY = parseInt(parameters[2]);
398 var srcWidth = parseInt(parameters[3]);
399 var srcHeight = parseInt(parameters[4]);
400 var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
401 var dstL = getLayer(parseInt(parameters[6]));
402 var dstX = parseInt(parameters[7]);
403 var dstY = parseInt(parameters[8]);
418 "rect": function(parameters) {
420 var layer = getLayer(parseInt(parameters[0]));
421 var x = parseInt(parameters[1]);
422 var y = parseInt(parameters[2]);
423 var w = parseInt(parameters[3]);
424 var h = parseInt(parameters[4]);
426 layer.rect(x, y, w, h);
430 "reset": function(parameters) {
432 var layer = getLayer(parseInt(parameters[0]));
438 "clip": function(parameters) {
440 var layer = getLayer(parseInt(parameters[0]));
446 "cfill": function(parameters) {
448 var channelMask = parseInt(parameters[0]);
449 var layer = getLayer(parseInt(parameters[1]));
450 var r = parseInt(parameters[2]);
451 var g = parseInt(parameters[3]);
452 var b = parseInt(parameters[4]);
453 var a = parseInt(parameters[5]);
455 layer.setChannelMask(channelMask);
457 layer.fillColor(r, g, b, a);
461 "cursor": function(parameters) {
463 cursorHotspotX = parseInt(parameters[0]);
464 cursorHotspotY = parseInt(parameters[1]);
465 var srcL = getLayer(parseInt(parameters[2]));
466 var srcX = parseInt(parameters[3]);
467 var srcY = parseInt(parameters[4]);
468 var srcWidth = parseInt(parameters[5]);
469 var srcHeight = parseInt(parameters[6]);
472 cursor.resize(srcWidth, srcHeight);
474 // Draw cursor to cursor layer
475 cursor.getLayer().copy(
485 // Update cursor position (hotspot may have changed)
486 moveCursor(cursorX, cursorY);
490 "sync": function(parameters) {
492 var timestamp = parameters[0];
494 // When all layers have finished rendering all instructions
495 // UP TO THIS POINT IN TIME, send sync response.
497 var layersToSync = 0;
498 function syncLayer() {
502 // Send sync response when layers are finished
503 if (layersToSync == 0) {
504 if (timestamp != currentTimestamp) {
505 tunnel.sendMessage("sync", timestamp);
506 currentTimestamp = timestamp;
512 // Count active, not-ready layers and install sync tracking hooks
513 for (var i=0; i<layers.length; i++) {
515 var layer = layers[i].getLayer();
516 if (layer && !layer.isReady()) {
518 layer.sync(syncLayer);
523 // If all layers are ready, then we didn't install any hooks.
524 // Send sync message now,
525 if (layersToSync == 0) {
526 if (timestamp != currentTimestamp) {
527 tunnel.sendMessage("sync", timestamp);
528 currentTimestamp = timestamp;
537 tunnel.oninstruction = function(opcode, parameters) {
539 var handler = instructionHandlers[opcode];
546 guac_client.disconnect = function() {
548 // Only attempt disconnection not disconnected.
549 if (currentState != STATE_DISCONNECTED
550 && currentState != STATE_DISCONNECTING) {
552 setState(STATE_DISCONNECTING);
556 window.clearInterval(pingInterval);
558 // Send disconnect message and disconnect
559 tunnel.sendMessage("disconnect");
561 setState(STATE_DISCONNECTED);
567 guac_client.connect = function(data) {
569 setState(STATE_CONNECTING);
572 tunnel.connect(data);
575 setState(STATE_IDLE);
579 // Ping every 5 seconds (ensure connection alive)
580 pingInterval = window.setInterval(function() {
581 tunnel.sendMessage("sync", currentTimestamp);
584 setState(STATE_WAITING);
591 * Simple container for Guacamole.Layer, allowing layers to be easily
592 * repositioned and nested. This allows certain operations to be accelerated
593 * through DOM manipulation, rather than raster operations.
597 * @param {Number} width The width of the Layer, in pixels. The canvas element
598 * backing this Layer will be given this width.
600 * @param {Number} height The height of the Layer, in pixels. The canvas element
601 * backing this Layer will be given this height.
603 Guacamole.Client.LayerContainer = function(width, height) {
606 * Reference to this LayerContainer.
609 var layer_container = this;
611 // Create layer with given size
612 var layer = new Guacamole.Layer(width, height);
614 // Set layer position
615 var canvas = layer.getCanvas();
616 canvas.style.position = "absolute";
617 canvas.style.left = "0px";
618 canvas.style.top = "0px";
620 // Create div with given size
621 var div = document.createElement("div");
622 div.appendChild(canvas);
623 div.style.width = width + "px";
624 div.style.height = height + "px";
627 * Changes the size of this LayerContainer and the contained Layer to the
628 * given width and height.
630 * @param {Number} width The new width to assign to this Layer.
631 * @param {Number} height The new height to assign to this Layer.
633 layer_container.resize = function(width, height) {
636 layer.resize(width, height);
638 // Resize containing div
639 div.style.width = width + "px";
640 div.style.height = height + "px";
645 * Returns the Layer contained within this LayerContainer.
646 * @returns {Guacamole.Layer} The Layer contained within this LayerContainer.
648 layer_container.getLayer = function() {
653 * Returns the element containing the Layer within this LayerContainer.
654 * @returns {Element} The element containing the Layer within this LayerContainer.
656 layer_container.getElement = function() {
663 * Map of all Guacamole binary raster operations to transfer functions.
666 Guacamole.Client.DefaultTransferFunction = {
669 0x0: function (src, dst) {
670 dst.red = dst.green = dst.blue = 0x00;
674 0xF: function (src, dst) {
675 dst.red = dst.green = dst.blue = 0xFF;
679 0x3: function (src, dst) {
681 dst.green = src.green;
683 dst.alpha = src.alpha;
687 0x5: function (src, dst) {
692 0xC: function (src, dst) {
693 dst.red = 0xFF & ~src.red;
694 dst.green = 0xFF & ~src.green;
695 dst.blue = 0xFF & ~src.blue;
696 dst.alpha = src.alpha;
700 0xA: function (src, dst) {
701 dst.red = 0xFF & ~dst.red;
702 dst.green = 0xFF & ~dst.green;
703 dst.blue = 0xFF & ~dst.blue;
707 0x1: function (src, dst) {
708 dst.red = ( src.red & dst.red);
709 dst.green = ( src.green & dst.green);
710 dst.blue = ( src.blue & dst.blue);
714 0xE: function (src, dst) {
715 dst.red = 0xFF & ~( src.red & dst.red);
716 dst.green = 0xFF & ~( src.green & dst.green);
717 dst.blue = 0xFF & ~( src.blue & dst.blue);
721 0x7: function (src, dst) {
722 dst.red = ( src.red | dst.red);
723 dst.green = ( src.green | dst.green);
724 dst.blue = ( src.blue | dst.blue);
728 0x8: function (src, dst) {
729 dst.red = 0xFF & ~( src.red | dst.red);
730 dst.green = 0xFF & ~( src.green | dst.green);
731 dst.blue = 0xFF & ~( src.blue | dst.blue);
735 0x6: function (src, dst) {
736 dst.red = ( src.red ^ dst.red);
737 dst.green = ( src.green ^ dst.green);
738 dst.blue = ( src.blue ^ dst.blue);
742 0x9: function (src, dst) {
743 dst.red = 0xFF & ~( src.red ^ dst.red);
744 dst.green = 0xFF & ~( src.green ^ dst.green);
745 dst.blue = 0xFF & ~( src.blue ^ dst.blue);
748 /* AND inverted source */
749 0x4: function (src, dst) {
750 dst.red = 0xFF & (~src.red & dst.red);
751 dst.green = 0xFF & (~src.green & dst.green);
752 dst.blue = 0xFF & (~src.blue & dst.blue);
755 /* OR inverted source */
756 0xD: function (src, dst) {
757 dst.red = 0xFF & (~src.red | dst.red);
758 dst.green = 0xFF & (~src.green | dst.green);
759 dst.blue = 0xFF & (~src.blue | dst.blue);
762 /* AND inverted destination */
763 0x2: function (src, dst) {
764 dst.red = 0xFF & ( src.red & ~dst.red);
765 dst.green = 0xFF & ( src.green & ~dst.green);
766 dst.blue = 0xFF & ( src.blue & ~dst.blue);
769 /* OR inverted destination */
770 0xB: function (src, dst) {
771 dst.red = 0xFF & ( src.red | ~dst.red);
772 dst.green = 0xFF & ( src.green | ~dst.green);
773 dst.blue = 0xFF & ( src.blue | ~dst.blue);