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";
103 default_layer_container_element.style.overflow = "hidden";
105 // Create cursor layer
106 var cursor = new Guacamole.Client.LayerContainer(0, 0);
107 cursor.getLayer().setChannelMask(Guacamole.Layer.SRC);
109 // Position cursor layer
110 var cursor_element = cursor.getElement();
111 cursor_element.style.position = "absolute";
112 cursor_element.style.left = "0px";
113 cursor_element.style.top = "0px";
115 // Add default layer and cursor to display
116 display.appendChild(default_layer_container.getElement());
117 display.appendChild(cursor.getElement());
119 // Initially, only default layer exists
120 var layers = [default_layer_container];
122 // No initial buffers
125 tunnel.onerror = function(message) {
126 if (guac_client.onerror)
127 guac_client.onerror(message);
130 function setState(state) {
131 if (state != currentState) {
132 currentState = state;
133 if (guac_client.onstatechange)
134 guac_client.onstatechange(currentState);
138 function isConnected() {
139 return currentState == STATE_CONNECTED
140 || currentState == STATE_WAITING;
143 var cursorHotspotX = 0;
144 var cursorHotspotY = 0;
149 function moveCursor(x, y) {
151 var element = cursor.getElement();
154 element.style.left = (x - cursorHotspotX) + "px";
155 element.style.top = (y - cursorHotspotY) + "px";
157 // Update stored position
163 guac_client.getDisplay = function() {
167 guac_client.sendKeyEvent = function(pressed, keysym) {
168 // Do not send requests if not connected
172 tunnel.sendMessage("key", keysym, pressed);
175 guac_client.sendMouseState = function(mouseState) {
177 // Do not send requests if not connected
181 // Update client-side cursor
189 if (mouseState.left) buttonMask |= 1;
190 if (mouseState.middle) buttonMask |= 2;
191 if (mouseState.right) buttonMask |= 4;
192 if (mouseState.up) buttonMask |= 8;
193 if (mouseState.down) buttonMask |= 16;
196 tunnel.sendMessage("mouse", mouseState.x, mouseState.y, buttonMask);
199 guac_client.setClipboard = function(data) {
201 // Do not send requests if not connected
205 tunnel.sendMessage("clipboard", data);
209 guac_client.onstatechange = null;
210 guac_client.onname = null;
211 guac_client.onerror = null;
212 guac_client.onclipboard = null;
215 function getBufferLayer(index) {
218 var buffer = buffers[index];
220 // Create buffer if necessary
221 if (buffer == null) {
222 buffer = new Guacamole.Layer(0, 0);
224 buffers[index] = buffer;
231 function getLayerContainer(index) {
233 var layer = layers[index];
237 layer = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
238 layers[index] = layer;
240 // Get and position layer
241 var layer_element = layer.getElement();
242 layer_element.style.position = "absolute";
243 layer_element.style.left = "0px";
244 layer_element.style.top = "0px";
245 layer_element.style.overflow = "hidden";
247 // Add to default layer container
248 default_layer_container.getElement().appendChild(layer_element);
256 function getLayer(index) {
258 // If buffer, just get layer
260 return getBufferLayer(index);
262 // Otherwise, retrieve layer from layer container
263 return getLayerContainer(index).getLayer();
268 * Handlers for all defined layer properties.
270 var layerPropertyHandlers = {
272 "miter-limit": function(layer, value) {
273 layer.setMiterLimit(parseFloat(value));
279 * Handlers for all instruction opcodes receivable by a Guacamole protocol
282 var instructionHandlers = {
284 "arc": function(parameters) {
286 var layer = getLayer(parseInt(parameters[0]));
287 var x = parseInt(parameters[1]);
288 var y = parseInt(parameters[2]);
289 var radius = parseInt(parameters[3]);
290 var startAngle = parseFloat(parameters[4]);
291 var endAngle = parseFloat(parameters[5]);
293 layer.arc(x, y, radius, startAngle, endAngle);
297 "cfill": function(parameters) {
299 var channelMask = parseInt(parameters[0]);
300 var layer = getLayer(parseInt(parameters[1]));
301 var r = parseInt(parameters[2]);
302 var g = parseInt(parameters[3]);
303 var b = parseInt(parameters[4]);
304 var a = parseInt(parameters[5]);
306 layer.setChannelMask(channelMask);
308 layer.fillColor(r, g, b, a);
312 "clip": function(parameters) {
314 var layer = getLayer(parseInt(parameters[0]));
320 "clipboard": function(parameters) {
321 if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
324 "close": function(parameters) {
326 var layer = getLayer(parseInt(parameters[0]));
332 "copy": function(parameters) {
334 var srcL = getLayer(parseInt(parameters[0]));
335 var srcX = parseInt(parameters[1]);
336 var srcY = parseInt(parameters[2]);
337 var srcWidth = parseInt(parameters[3]);
338 var srcHeight = parseInt(parameters[4]);
339 var channelMask = parseInt(parameters[5]);
340 var dstL = getLayer(parseInt(parameters[6]));
341 var dstX = parseInt(parameters[7]);
342 var dstY = parseInt(parameters[8]);
344 dstL.setChannelMask(channelMask);
358 "cstroke": function(parameters) {
360 var channelMask = parseInt(parameters[0]);
361 var layer = getLayer(parseInt(parameters[1]));
362 var cap = lineCap[parseInt(parameters[2])];
363 var join = lineJoin[parseInt(parameters[3])];
364 var thickness = parseInt(parameters[4]);
365 var r = parseInt(parameters[5]);
366 var g = parseInt(parameters[6]);
367 var b = parseInt(parameters[7]);
368 var a = parseInt(parameters[8]);
370 layer.setChannelMask(channelMask);
372 layer.strokeColor(cap, join, thickness, r, g, b, a);
376 "cursor": function(parameters) {
378 cursorHotspotX = parseInt(parameters[0]);
379 cursorHotspotY = parseInt(parameters[1]);
380 var srcL = getLayer(parseInt(parameters[2]));
381 var srcX = parseInt(parameters[3]);
382 var srcY = parseInt(parameters[4]);
383 var srcWidth = parseInt(parameters[5]);
384 var srcHeight = parseInt(parameters[6]);
387 cursor.resize(srcWidth, srcHeight);
389 // Draw cursor to cursor layer
390 cursor.getLayer().copy(
400 // Update cursor position (hotspot may have changed)
401 moveCursor(cursorX, cursorY);
405 "curve": function(parameters) {
407 var layer = getLayer(parseInt(parameters[0]));
408 var cp1x = parseInt(parameters[1]);
409 var cp1y = parseInt(parameters[2]);
410 var cp2x = parseInt(parameters[3]);
411 var cp2y = parseInt(parameters[4]);
412 var x = parseInt(parameters[5]);
413 var y = parseInt(parameters[6]);
415 layer.curveTo(cp1x, cp1y, cp2x, cp2y, x, y);
419 "dispose": function(parameters) {
421 var layer_index = parseInt(parameters[0]);
423 // If visible layer, remove from parent
424 if (layer_index > 0) {
426 // Get container element
427 var layer_container = getLayerContainer(layer_index).getElement();
429 // Remove from parent
430 layer_container.parentNode.removeChild(layer_container);
433 delete layers[layer_index];
437 // If buffer, just delete reference
438 else if (layer_index < 0)
439 delete buffers[-1 - layer_index];
441 // Attempting to dispose the root layer currently has no effect.
445 "distort": function(parameters) {
447 var layer_index = parseInt(parameters[0]);
448 var a = parseFloat(parameters[1]);
449 var b = parseFloat(parameters[2]);
450 var c = parseFloat(parameters[3]);
451 var d = parseFloat(parameters[4]);
452 var e = parseFloat(parameters[5]);
453 var f = parseFloat(parameters[6]);
455 // Only valid for visible layers (not buffers)
456 if (layer_index >= 0) {
458 // Get container element
459 var layer_container = getLayerContainer(layer_index).getElement();
461 // Set layer transform
462 layer_container.style.transform =
463 layer_container.style.WebkitTransform =
464 layer_container.style.MozTransform =
465 layer_container.style.OTransform =
466 layer_container.style.msTransform =
473 "matrix(" + a + "," + b + "," + c + "," + d + "," + e + "," + f + ")";
479 "error": function(parameters) {
480 if (guac_client.onerror) guac_client.onerror(parameters[0]);
481 guac_client.disconnect();
484 "identity": function(parameters) {
486 var layer = getLayer(parseInt(parameters[0]));
488 layer.setTransform(1, 0, 0, 1, 0, 0);
492 "lfill": function(parameters) {
494 var channelMask = parseInt(parameters[0]);
495 var layer = getLayer(parseInt(parameters[1]));
496 var srcLayer = getLayer(parseInt(parameters[2]));
498 layer.setChannelMask(channelMask);
500 layer.fillLayer(srcLayer);
504 "line": function(parameters) {
506 var layer = getLayer(parseInt(parameters[0]));
507 var x = parseInt(parameters[1]);
508 var y = parseInt(parameters[2]);
514 "lstroke": function(parameters) {
516 var channelMask = parseInt(parameters[0]);
517 var layer = getLayer(parseInt(parameters[1]));
518 var srcLayer = getLayer(parseInt(parameters[2]));
520 layer.setChannelMask(channelMask);
522 layer.strokeLayer(srcLayer);
526 "move": function(parameters) {
528 var layer_index = parseInt(parameters[0]);
529 var parent_index = parseInt(parameters[1]);
530 var x = parseInt(parameters[2]);
531 var y = parseInt(parameters[3]);
532 var z = parseInt(parameters[4]);
534 // Only valid for non-default layers
535 if (layer_index > 0 && parent_index >= 0) {
537 // Get container element
538 var layer_container = getLayerContainer(layer_index).getElement();
539 var parent = getLayerContainer(parent_index).getElement();
541 // Set parent if necessary
542 if (!(layer_container.parentNode === parent))
543 parent.appendChild(layer_container);
546 layer_container.style.left = x + "px";
547 layer_container.style.top = y + "px";
548 layer_container.style.zIndex = z;
554 "name": function(parameters) {
555 if (guac_client.onname) guac_client.onname(parameters[0]);
558 "png": function(parameters) {
560 var channelMask = parseInt(parameters[0]);
561 var layer = getLayer(parseInt(parameters[1]));
562 var x = parseInt(parameters[2]);
563 var y = parseInt(parameters[3]);
564 var data = parameters[4];
566 layer.setChannelMask(channelMask);
571 "data:image/png;base64," + data
574 // If received first update, no longer waiting.
575 if (currentState == STATE_WAITING)
576 setState(STATE_CONNECTED);
580 "pop": function(parameters) {
582 var layer = getLayer(parseInt(parameters[0]));
588 "push": function(parameters) {
590 var layer = getLayer(parseInt(parameters[0]));
596 "rect": function(parameters) {
598 var layer = getLayer(parseInt(parameters[0]));
599 var x = parseInt(parameters[1]);
600 var y = parseInt(parameters[2]);
601 var w = parseInt(parameters[3]);
602 var h = parseInt(parameters[4]);
604 layer.rect(x, y, w, h);
608 "reset": function(parameters) {
610 var layer = getLayer(parseInt(parameters[0]));
616 "set": function(parameters) {
618 var layer = getLayer(parseInt(parameters[0]));
619 var name = parameters[1];
620 var value = parameters[2];
622 // Call property handler if defined
623 var handler = layerPropertyHandlers[name];
625 handler(layer, value);
629 "shade": function(parameters) {
631 var layer_index = parseInt(parameters[0]);
632 var a = parseInt(parameters[1]);
634 // Only valid for visible layers (not buffers)
635 if (layer_index >= 0) {
637 // Get container element
638 var layer_container = getLayerContainer(layer_index).getElement();
641 layer_container.style.opacity = a/255.0;
647 "size": function(parameters) {
649 var layer_index = parseInt(parameters[0]);
650 var width = parseInt(parameters[1]);
651 var height = parseInt(parameters[2]);
654 var layer_container = getLayerContainer(layer_index);
655 layer_container.resize(width, height);
657 // If layer is default, resize display
658 if (layer_index == 0) {
660 displayWidth = width;
661 displayHeight = height;
663 // Update (set) display size
664 display.style.width = displayWidth + "px";
665 display.style.height = displayHeight + "px";
671 "start": function(parameters) {
673 var layer = getLayer(parseInt(parameters[0]));
674 var x = parseInt(parameters[1]);
675 var y = parseInt(parameters[2]);
681 "sync": function(parameters) {
683 var timestamp = parameters[0];
685 // When all layers have finished rendering all instructions
686 // UP TO THIS POINT IN TIME, send sync response.
688 var layersToSync = 0;
689 function syncLayer() {
693 // Send sync response when layers are finished
694 if (layersToSync == 0) {
695 if (timestamp != currentTimestamp) {
696 tunnel.sendMessage("sync", timestamp);
697 currentTimestamp = timestamp;
703 // Count active, not-ready layers and install sync tracking hooks
704 for (var i=0; i<layers.length; i++) {
706 var layer = layers[i].getLayer();
707 if (layer && !layer.isReady()) {
709 layer.sync(syncLayer);
714 // If all layers are ready, then we didn't install any hooks.
715 // Send sync message now,
716 if (layersToSync == 0) {
717 if (timestamp != currentTimestamp) {
718 tunnel.sendMessage("sync", timestamp);
719 currentTimestamp = timestamp;
725 "transfer": function(parameters) {
727 var srcL = getLayer(parseInt(parameters[0]));
728 var srcX = parseInt(parameters[1]);
729 var srcY = parseInt(parameters[2]);
730 var srcWidth = parseInt(parameters[3]);
731 var srcHeight = parseInt(parameters[4]);
732 var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
733 var dstL = getLayer(parseInt(parameters[6]));
734 var dstX = parseInt(parameters[7]);
735 var dstY = parseInt(parameters[8]);
750 "transform": function(parameters) {
752 var layer = getLayer(parseInt(parameters[0]));
753 var a = parseFloat(parameters[1]);
754 var b = parseFloat(parameters[2]);
755 var c = parseFloat(parameters[3]);
756 var d = parseFloat(parameters[4]);
757 var e = parseFloat(parameters[5]);
758 var f = parseFloat(parameters[6]);
760 layer.transform(a, b, c, d, e, f);
767 tunnel.oninstruction = function(opcode, parameters) {
769 var handler = instructionHandlers[opcode];
776 guac_client.disconnect = function() {
778 // Only attempt disconnection not disconnected.
779 if (currentState != STATE_DISCONNECTED
780 && currentState != STATE_DISCONNECTING) {
782 setState(STATE_DISCONNECTING);
786 window.clearInterval(pingInterval);
788 // Send disconnect message and disconnect
789 tunnel.sendMessage("disconnect");
791 setState(STATE_DISCONNECTED);
797 guac_client.connect = function(data) {
799 setState(STATE_CONNECTING);
802 tunnel.connect(data);
805 setState(STATE_IDLE);
809 // Ping every 5 seconds (ensure connection alive)
810 pingInterval = window.setInterval(function() {
811 tunnel.sendMessage("sync", currentTimestamp);
814 setState(STATE_WAITING);
821 * Simple container for Guacamole.Layer, allowing layers to be easily
822 * repositioned and nested. This allows certain operations to be accelerated
823 * through DOM manipulation, rather than raster operations.
827 * @param {Number} width The width of the Layer, in pixels. The canvas element
828 * backing this Layer will be given this width.
830 * @param {Number} height The height of the Layer, in pixels. The canvas element
831 * backing this Layer will be given this height.
833 Guacamole.Client.LayerContainer = function(width, height) {
836 * Reference to this LayerContainer.
839 var layer_container = this;
841 // Create layer with given size
842 var layer = new Guacamole.Layer(width, height);
844 // Set layer position
845 var canvas = layer.getCanvas();
846 canvas.style.position = "absolute";
847 canvas.style.left = "0px";
848 canvas.style.top = "0px";
850 // Create div with given size
851 var div = document.createElement("div");
852 div.appendChild(canvas);
853 div.style.width = width + "px";
854 div.style.height = height + "px";
857 * Changes the size of this LayerContainer and the contained Layer to the
858 * given width and height.
860 * @param {Number} width The new width to assign to this Layer.
861 * @param {Number} height The new height to assign to this Layer.
863 layer_container.resize = function(width, height) {
866 layer.resize(width, height);
868 // Resize containing div
869 div.style.width = width + "px";
870 div.style.height = height + "px";
875 * Returns the Layer contained within this LayerContainer.
876 * @returns {Guacamole.Layer} The Layer contained within this LayerContainer.
878 layer_container.getLayer = function() {
883 * Returns the element containing the Layer within this LayerContainer.
884 * @returns {Element} The element containing the Layer within this LayerContainer.
886 layer_container.getElement = function() {
893 * Map of all Guacamole binary raster operations to transfer functions.
896 Guacamole.Client.DefaultTransferFunction = {
899 0x0: function (src, dst) {
900 dst.red = dst.green = dst.blue = 0x00;
904 0xF: function (src, dst) {
905 dst.red = dst.green = dst.blue = 0xFF;
909 0x3: function (src, dst) {
911 dst.green = src.green;
913 dst.alpha = src.alpha;
917 0x5: function (src, dst) {
922 0xC: function (src, dst) {
923 dst.red = 0xFF & ~src.red;
924 dst.green = 0xFF & ~src.green;
925 dst.blue = 0xFF & ~src.blue;
926 dst.alpha = src.alpha;
930 0xA: function (src, dst) {
931 dst.red = 0xFF & ~dst.red;
932 dst.green = 0xFF & ~dst.green;
933 dst.blue = 0xFF & ~dst.blue;
937 0x1: function (src, dst) {
938 dst.red = ( src.red & dst.red);
939 dst.green = ( src.green & dst.green);
940 dst.blue = ( src.blue & dst.blue);
944 0xE: function (src, dst) {
945 dst.red = 0xFF & ~( src.red & dst.red);
946 dst.green = 0xFF & ~( src.green & dst.green);
947 dst.blue = 0xFF & ~( src.blue & dst.blue);
951 0x7: function (src, dst) {
952 dst.red = ( src.red | dst.red);
953 dst.green = ( src.green | dst.green);
954 dst.blue = ( src.blue | dst.blue);
958 0x8: function (src, dst) {
959 dst.red = 0xFF & ~( src.red | dst.red);
960 dst.green = 0xFF & ~( src.green | dst.green);
961 dst.blue = 0xFF & ~( src.blue | dst.blue);
965 0x6: function (src, dst) {
966 dst.red = ( src.red ^ dst.red);
967 dst.green = ( src.green ^ dst.green);
968 dst.blue = ( src.blue ^ dst.blue);
972 0x9: function (src, dst) {
973 dst.red = 0xFF & ~( src.red ^ dst.red);
974 dst.green = 0xFF & ~( src.green ^ dst.green);
975 dst.blue = 0xFF & ~( src.blue ^ dst.blue);
978 /* AND inverted source */
979 0x4: function (src, dst) {
980 dst.red = 0xFF & (~src.red & dst.red);
981 dst.green = 0xFF & (~src.green & dst.green);
982 dst.blue = 0xFF & (~src.blue & dst.blue);
985 /* OR inverted source */
986 0xD: function (src, dst) {
987 dst.red = 0xFF & (~src.red | dst.red);
988 dst.green = 0xFF & (~src.green | dst.green);
989 dst.blue = 0xFF & (~src.blue | dst.blue);
992 /* AND inverted destination */
993 0x2: function (src, dst) {
994 dst.red = 0xFF & ( src.red & ~dst.red);
995 dst.green = 0xFF & ( src.green & ~dst.green);
996 dst.blue = 0xFF & ( src.blue & ~dst.blue);
999 /* OR inverted destination */
1000 0xB: function (src, dst) {
1001 dst.red = 0xFF & ( src.red | ~dst.red);
1002 dst.green = 0xFF & ( src.green | ~dst.green);
1003 dst.blue = 0xFF & ( src.blue | ~dst.blue);