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 * Translation from Guacamole protocol line caps to Layer line caps.
81 * Translation from Guacamole protocol line caps to Layer line caps.
90 var display = document.createElement("div");
91 display.style.position = "relative";
92 display.style.width = displayWidth + "px";
93 display.style.height = displayHeight + "px";
95 // Create default layer
96 var default_layer_container = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
98 // Position default layer
99 var default_layer_container_element = default_layer_container.getElement();
100 default_layer_container_element.style.position = "absolute";
101 default_layer_container_element.style.left = "0px";
102 default_layer_container_element.style.top = "0px";
104 // Create cursor layer
105 var cursor = new Guacamole.Client.LayerContainer(0, 0);
106 cursor.getLayer().setChannelMask(Guacamole.Layer.SRC);
108 // Position cursor layer
109 var cursor_element = cursor.getElement();
110 cursor_element.style.position = "absolute";
111 cursor_element.style.left = "0px";
112 cursor_element.style.top = "0px";
114 // Add default layer and cursor to display
115 display.appendChild(default_layer_container.getElement());
116 display.appendChild(cursor.getElement());
118 // Initially, only default layer exists
119 var layers = [default_layer_container];
121 // No initial buffers
124 tunnel.onerror = function(message) {
125 if (guac_client.onerror)
126 guac_client.onerror(message);
129 function setState(state) {
130 if (state != currentState) {
131 currentState = state;
132 if (guac_client.onstatechange)
133 guac_client.onstatechange(currentState);
137 function isConnected() {
138 return currentState == STATE_CONNECTED
139 || currentState == STATE_WAITING;
142 var cursorHotspotX = 0;
143 var cursorHotspotY = 0;
148 function moveCursor(x, y) {
150 var element = cursor.getElement();
153 element.style.left = (x - cursorHotspotX) + "px";
154 element.style.top = (y - cursorHotspotY) + "px";
156 // Update stored position
162 guac_client.getDisplay = function() {
166 guac_client.sendKeyEvent = function(pressed, keysym) {
167 // Do not send requests if not connected
171 tunnel.sendMessage("key", keysym, pressed);
174 guac_client.sendMouseState = function(mouseState) {
176 // Do not send requests if not connected
180 // Update client-side cursor
188 if (mouseState.left) buttonMask |= 1;
189 if (mouseState.middle) buttonMask |= 2;
190 if (mouseState.right) buttonMask |= 4;
191 if (mouseState.up) buttonMask |= 8;
192 if (mouseState.down) buttonMask |= 16;
195 tunnel.sendMessage("mouse", mouseState.x, mouseState.y, buttonMask);
198 guac_client.setClipboard = function(data) {
200 // Do not send requests if not connected
204 tunnel.sendMessage("clipboard", data);
208 guac_client.onstatechange = null;
209 guac_client.onname = null;
210 guac_client.onerror = null;
211 guac_client.onclipboard = null;
214 function getBufferLayer(index) {
217 var buffer = buffers[index];
219 // Create buffer if necessary
220 if (buffer == null) {
221 buffer = new Guacamole.Layer(0, 0);
223 buffers[index] = buffer;
230 function getLayerContainer(index) {
232 var layer = layers[index];
236 layer = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
237 layers[index] = layer;
239 // Get and position layer
240 var layer_element = layer.getElement();
241 layer_element.style.position = "absolute";
242 layer_element.style.left = "0px";
243 layer_element.style.top = "0px";
245 // Add to default layer container
246 default_layer_container.getElement().appendChild(layer_element);
254 function getLayer(index) {
256 // If buffer, just get layer
258 return getBufferLayer(index);
260 // Otherwise, retrieve layer from layer container
261 return getLayerContainer(index).getLayer();
265 var instructionHandlers = {
267 "arc": function(parameters) {
269 var layer = getLayer(parseInt(parameters[0]));
270 var x = parseInt(parameters[1]);
271 var y = parseInt(parameters[2]);
272 var radius = parseInt(parameters[3]);
273 var startAngle = parseFloat(parameters[4]);
274 var endAngle = parseFloat(parameters[5]);
276 layer.arc(x, y, radius, startAngle, endAngle);
280 "cfill": function(parameters) {
282 var channelMask = parseInt(parameters[0]);
283 var layer = getLayer(parseInt(parameters[1]));
284 var r = parseInt(parameters[2]);
285 var g = parseInt(parameters[3]);
286 var b = parseInt(parameters[4]);
287 var a = parseInt(parameters[5]);
289 layer.setChannelMask(channelMask);
291 layer.fillColor(r, g, b, a);
295 "clip": function(parameters) {
297 var layer = getLayer(parseInt(parameters[0]));
303 "clipboard": function(parameters) {
304 if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
307 "close": function(parameters) {
309 var layer = getLayer(parseInt(parameters[0]));
315 "copy": function(parameters) {
317 var srcL = getLayer(parseInt(parameters[0]));
318 var srcX = parseInt(parameters[1]);
319 var srcY = parseInt(parameters[2]);
320 var srcWidth = parseInt(parameters[3]);
321 var srcHeight = parseInt(parameters[4]);
322 var channelMask = parseInt(parameters[5]);
323 var dstL = getLayer(parseInt(parameters[6]));
324 var dstX = parseInt(parameters[7]);
325 var dstY = parseInt(parameters[8]);
327 dstL.setChannelMask(channelMask);
341 "cstroke": function(parameters) {
343 var channelMask = parseInt(parameters[0]);
344 var layer = getLayer(parseInt(parameters[1]));
345 var cap = lineCap[parseInt(parameters[2])];
346 var join = lineJoin[parseInt(parameters[3])];
347 var thickness = parseInt(parameters[4]);
348 var r = parseInt(parameters[5]);
349 var g = parseInt(parameters[6]);
350 var b = parseInt(parameters[7]);
351 var a = parseInt(parameters[8]);
353 layer.setChannelMask(channelMask);
355 layer.strokeColor(cap, join, thickness, r, g, b, a);
359 "cursor": function(parameters) {
361 cursorHotspotX = parseInt(parameters[0]);
362 cursorHotspotY = parseInt(parameters[1]);
363 var srcL = getLayer(parseInt(parameters[2]));
364 var srcX = parseInt(parameters[3]);
365 var srcY = parseInt(parameters[4]);
366 var srcWidth = parseInt(parameters[5]);
367 var srcHeight = parseInt(parameters[6]);
370 cursor.resize(srcWidth, srcHeight);
372 // Draw cursor to cursor layer
373 cursor.getLayer().copy(
383 // Update cursor position (hotspot may have changed)
384 moveCursor(cursorX, cursorY);
388 "curve": function(parameters) {
390 var layer = getLayer(parseInt(parameters[0]));
391 var cp1x = parseInt(parameters[1]);
392 var cp1y = parseInt(parameters[2]);
393 var cp2x = parseInt(parameters[3]);
394 var cp2y = parseInt(parameters[4]);
395 var x = parseInt(parameters[5]);
396 var y = parseInt(parameters[6]);
398 layer.curveTo(cp1x, cp1y, cp2x, cp2y, x, y);
402 "dispose": function(parameters) {
404 var layer_index = parseInt(parameters[0]);
406 // If visible layer, remove from parent
407 if (layer_index > 0) {
409 // Get container element
410 var layer_container = getLayerContainer(layer_index).getElement();
412 // Remove from parent
413 layer_container.parentNode.removeChild(layer_container);
416 delete layers[layer_index];
420 // If buffer, just delete reference
421 else if (layer_index < 0)
422 delete buffers[-1 - layer_index];
424 // Attempting to dispose the root layer currently has no effect.
428 "error": function(parameters) {
429 if (guac_client.onerror) guac_client.onerror(parameters[0]);
430 guac_client.disconnect();
433 "lfill": function(parameters) {
435 var channelMask = parseInt(parameters[0]);
436 var layer = getLayer(parseInt(parameters[1]));
437 var srcLayer = getLayer(parseInt(parameters[2]));
439 layer.setChannelMask(channelMask);
441 layer.fillLayer(srcLayer);
445 "line": function(parameters) {
447 var layer = getLayer(parseInt(parameters[0]));
448 var x = parseInt(parameters[1]);
449 var y = parseInt(parameters[2]);
455 "lstroke": function(parameters) {
457 var channelMask = parseInt(parameters[0]);
458 var layer = getLayer(parseInt(parameters[1]));
459 var srcLayer = getLayer(parseInt(parameters[2]));
461 layer.setChannelMask(channelMask);
463 layer.strokeLayer(srcLayer);
467 "move": function(parameters) {
469 var layer_index = parseInt(parameters[0]);
470 var parent_index = parseInt(parameters[1]);
471 var x = parseInt(parameters[2]);
472 var y = parseInt(parameters[3]);
473 var z = parseInt(parameters[4]);
475 // Only valid for non-default layers
476 if (layer_index > 0 && parent_index >= 0) {
478 // Get container element
479 var layer_container = getLayerContainer(layer_index).getElement();
480 var parent = getLayerContainer(parent_index).getElement();
482 // Set parent if necessary
483 if (!(layer_container.parentNode === parent))
484 parent.appendChild(layer_container);
487 layer_container.style.left = x + "px";
488 layer_container.style.top = y + "px";
489 layer_container.style.zIndex = z;
495 "name": function(parameters) {
496 if (guac_client.onname) guac_client.onname(parameters[0]);
499 "png": function(parameters) {
501 var channelMask = parseInt(parameters[0]);
502 var layer = getLayer(parseInt(parameters[1]));
503 var x = parseInt(parameters[2]);
504 var y = parseInt(parameters[3]);
505 var data = parameters[4];
507 layer.setChannelMask(channelMask);
512 "data:image/png;base64," + data
515 // If received first update, no longer waiting.
516 if (currentState == STATE_WAITING)
517 setState(STATE_CONNECTED);
521 "rect": function(parameters) {
523 var layer = getLayer(parseInt(parameters[0]));
524 var x = parseInt(parameters[1]);
525 var y = parseInt(parameters[2]);
526 var w = parseInt(parameters[3]);
527 var h = parseInt(parameters[4]);
529 layer.rect(x, y, w, h);
533 "reset": function(parameters) {
535 var layer = getLayer(parseInt(parameters[0]));
541 "size": function(parameters) {
543 var layer_index = parseInt(parameters[0]);
544 var width = parseInt(parameters[1]);
545 var height = parseInt(parameters[2]);
548 var layer_container = getLayerContainer(layer_index);
549 layer_container.resize(width, height);
551 // If layer is default, resize display
552 if (layer_index == 0) {
554 displayWidth = width;
555 displayHeight = height;
557 // Update (set) display size
558 display.style.width = displayWidth + "px";
559 display.style.height = displayHeight + "px";
565 "start": function(parameters) {
567 var layer = getLayer(parseInt(parameters[0]));
568 var x = parseInt(parameters[1]);
569 var y = parseInt(parameters[2]);
575 "sync": function(parameters) {
577 var timestamp = parameters[0];
579 // When all layers have finished rendering all instructions
580 // UP TO THIS POINT IN TIME, send sync response.
582 var layersToSync = 0;
583 function syncLayer() {
587 // Send sync response when layers are finished
588 if (layersToSync == 0) {
589 if (timestamp != currentTimestamp) {
590 tunnel.sendMessage("sync", timestamp);
591 currentTimestamp = timestamp;
597 // Count active, not-ready layers and install sync tracking hooks
598 for (var i=0; i<layers.length; i++) {
600 var layer = layers[i].getLayer();
601 if (layer && !layer.isReady()) {
603 layer.sync(syncLayer);
608 // If all layers are ready, then we didn't install any hooks.
609 // Send sync message now,
610 if (layersToSync == 0) {
611 if (timestamp != currentTimestamp) {
612 tunnel.sendMessage("sync", timestamp);
613 currentTimestamp = timestamp;
619 "transfer": function(parameters) {
621 var srcL = getLayer(parseInt(parameters[0]));
622 var srcX = parseInt(parameters[1]);
623 var srcY = parseInt(parameters[2]);
624 var srcWidth = parseInt(parameters[3]);
625 var srcHeight = parseInt(parameters[4]);
626 var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
627 var dstL = getLayer(parseInt(parameters[6]));
628 var dstX = parseInt(parameters[7]);
629 var dstY = parseInt(parameters[8]);
647 tunnel.oninstruction = function(opcode, parameters) {
649 var handler = instructionHandlers[opcode];
656 guac_client.disconnect = function() {
658 // Only attempt disconnection not disconnected.
659 if (currentState != STATE_DISCONNECTED
660 && currentState != STATE_DISCONNECTING) {
662 setState(STATE_DISCONNECTING);
666 window.clearInterval(pingInterval);
668 // Send disconnect message and disconnect
669 tunnel.sendMessage("disconnect");
671 setState(STATE_DISCONNECTED);
677 guac_client.connect = function(data) {
679 setState(STATE_CONNECTING);
682 tunnel.connect(data);
685 setState(STATE_IDLE);
689 // Ping every 5 seconds (ensure connection alive)
690 pingInterval = window.setInterval(function() {
691 tunnel.sendMessage("sync", currentTimestamp);
694 setState(STATE_WAITING);
701 * Simple container for Guacamole.Layer, allowing layers to be easily
702 * repositioned and nested. This allows certain operations to be accelerated
703 * through DOM manipulation, rather than raster operations.
707 * @param {Number} width The width of the Layer, in pixels. The canvas element
708 * backing this Layer will be given this width.
710 * @param {Number} height The height of the Layer, in pixels. The canvas element
711 * backing this Layer will be given this height.
713 Guacamole.Client.LayerContainer = function(width, height) {
716 * Reference to this LayerContainer.
719 var layer_container = this;
721 // Create layer with given size
722 var layer = new Guacamole.Layer(width, height);
724 // Set layer position
725 var canvas = layer.getCanvas();
726 canvas.style.position = "absolute";
727 canvas.style.left = "0px";
728 canvas.style.top = "0px";
730 // Create div with given size
731 var div = document.createElement("div");
732 div.appendChild(canvas);
733 div.style.width = width + "px";
734 div.style.height = height + "px";
737 * Changes the size of this LayerContainer and the contained Layer to the
738 * given width and height.
740 * @param {Number} width The new width to assign to this Layer.
741 * @param {Number} height The new height to assign to this Layer.
743 layer_container.resize = function(width, height) {
746 layer.resize(width, height);
748 // Resize containing div
749 div.style.width = width + "px";
750 div.style.height = height + "px";
755 * Returns the Layer contained within this LayerContainer.
756 * @returns {Guacamole.Layer} The Layer contained within this LayerContainer.
758 layer_container.getLayer = function() {
763 * Returns the element containing the Layer within this LayerContainer.
764 * @returns {Element} The element containing the Layer within this LayerContainer.
766 layer_container.getElement = function() {
773 * Map of all Guacamole binary raster operations to transfer functions.
776 Guacamole.Client.DefaultTransferFunction = {
779 0x0: function (src, dst) {
780 dst.red = dst.green = dst.blue = 0x00;
784 0xF: function (src, dst) {
785 dst.red = dst.green = dst.blue = 0xFF;
789 0x3: function (src, dst) {
791 dst.green = src.green;
793 dst.alpha = src.alpha;
797 0x5: function (src, dst) {
802 0xC: function (src, dst) {
803 dst.red = 0xFF & ~src.red;
804 dst.green = 0xFF & ~src.green;
805 dst.blue = 0xFF & ~src.blue;
806 dst.alpha = src.alpha;
810 0xA: function (src, dst) {
811 dst.red = 0xFF & ~dst.red;
812 dst.green = 0xFF & ~dst.green;
813 dst.blue = 0xFF & ~dst.blue;
817 0x1: function (src, dst) {
818 dst.red = ( src.red & dst.red);
819 dst.green = ( src.green & dst.green);
820 dst.blue = ( src.blue & dst.blue);
824 0xE: function (src, dst) {
825 dst.red = 0xFF & ~( src.red & dst.red);
826 dst.green = 0xFF & ~( src.green & dst.green);
827 dst.blue = 0xFF & ~( src.blue & dst.blue);
831 0x7: function (src, dst) {
832 dst.red = ( src.red | dst.red);
833 dst.green = ( src.green | dst.green);
834 dst.blue = ( src.blue | dst.blue);
838 0x8: function (src, dst) {
839 dst.red = 0xFF & ~( src.red | dst.red);
840 dst.green = 0xFF & ~( src.green | dst.green);
841 dst.blue = 0xFF & ~( src.blue | dst.blue);
845 0x6: function (src, dst) {
846 dst.red = ( src.red ^ dst.red);
847 dst.green = ( src.green ^ dst.green);
848 dst.blue = ( src.blue ^ dst.blue);
852 0x9: function (src, dst) {
853 dst.red = 0xFF & ~( src.red ^ dst.red);
854 dst.green = 0xFF & ~( src.green ^ dst.green);
855 dst.blue = 0xFF & ~( src.blue ^ dst.blue);
858 /* AND inverted source */
859 0x4: function (src, dst) {
860 dst.red = 0xFF & (~src.red & dst.red);
861 dst.green = 0xFF & (~src.green & dst.green);
862 dst.blue = 0xFF & (~src.blue & dst.blue);
865 /* OR inverted source */
866 0xD: function (src, dst) {
867 dst.red = 0xFF & (~src.red | dst.red);
868 dst.green = 0xFF & (~src.green | dst.green);
869 dst.blue = 0xFF & (~src.blue | dst.blue);
872 /* AND inverted destination */
873 0x2: function (src, dst) {
874 dst.red = 0xFF & ( src.red & ~dst.red);
875 dst.green = 0xFF & ( src.green & ~dst.green);
876 dst.blue = 0xFF & ( src.blue & ~dst.blue);
879 /* OR inverted destination */
880 0xB: function (src, dst) {
881 dst.red = 0xFF & ( src.red | ~dst.red);
882 dst.green = 0xFF & ( src.green | ~dst.green);
883 dst.blue = 0xFF & ( src.blue | ~dst.blue);