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();
267 var instructionHandlers = {
269 "arc": function(parameters) {
271 var layer = getLayer(parseInt(parameters[0]));
272 var x = parseInt(parameters[1]);
273 var y = parseInt(parameters[2]);
274 var radius = parseInt(parameters[3]);
275 var startAngle = parseFloat(parameters[4]);
276 var endAngle = parseFloat(parameters[5]);
278 layer.arc(x, y, radius, startAngle, endAngle);
282 "cfill": function(parameters) {
284 var channelMask = parseInt(parameters[0]);
285 var layer = getLayer(parseInt(parameters[1]));
286 var r = parseInt(parameters[2]);
287 var g = parseInt(parameters[3]);
288 var b = parseInt(parameters[4]);
289 var a = parseInt(parameters[5]);
291 layer.setChannelMask(channelMask);
293 layer.fillColor(r, g, b, a);
297 "clip": function(parameters) {
299 var layer = getLayer(parseInt(parameters[0]));
305 "clipboard": function(parameters) {
306 if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
309 "close": function(parameters) {
311 var layer = getLayer(parseInt(parameters[0]));
317 "copy": function(parameters) {
319 var srcL = getLayer(parseInt(parameters[0]));
320 var srcX = parseInt(parameters[1]);
321 var srcY = parseInt(parameters[2]);
322 var srcWidth = parseInt(parameters[3]);
323 var srcHeight = parseInt(parameters[4]);
324 var channelMask = parseInt(parameters[5]);
325 var dstL = getLayer(parseInt(parameters[6]));
326 var dstX = parseInt(parameters[7]);
327 var dstY = parseInt(parameters[8]);
329 dstL.setChannelMask(channelMask);
343 "cstroke": function(parameters) {
345 var channelMask = parseInt(parameters[0]);
346 var layer = getLayer(parseInt(parameters[1]));
347 var cap = lineCap[parseInt(parameters[2])];
348 var join = lineJoin[parseInt(parameters[3])];
349 var thickness = parseInt(parameters[4]);
350 var r = parseInt(parameters[5]);
351 var g = parseInt(parameters[6]);
352 var b = parseInt(parameters[7]);
353 var a = parseInt(parameters[8]);
355 layer.setChannelMask(channelMask);
357 layer.strokeColor(cap, join, thickness, r, g, b, a);
361 "cursor": function(parameters) {
363 cursorHotspotX = parseInt(parameters[0]);
364 cursorHotspotY = parseInt(parameters[1]);
365 var srcL = getLayer(parseInt(parameters[2]));
366 var srcX = parseInt(parameters[3]);
367 var srcY = parseInt(parameters[4]);
368 var srcWidth = parseInt(parameters[5]);
369 var srcHeight = parseInt(parameters[6]);
372 cursor.resize(srcWidth, srcHeight);
374 // Draw cursor to cursor layer
375 cursor.getLayer().copy(
385 // Update cursor position (hotspot may have changed)
386 moveCursor(cursorX, cursorY);
390 "curve": function(parameters) {
392 var layer = getLayer(parseInt(parameters[0]));
393 var cp1x = parseInt(parameters[1]);
394 var cp1y = parseInt(parameters[2]);
395 var cp2x = parseInt(parameters[3]);
396 var cp2y = parseInt(parameters[4]);
397 var x = parseInt(parameters[5]);
398 var y = parseInt(parameters[6]);
400 layer.curveTo(cp1x, cp1y, cp2x, cp2y, x, y);
404 "dispose": function(parameters) {
406 var layer_index = parseInt(parameters[0]);
408 // If visible layer, remove from parent
409 if (layer_index > 0) {
411 // Get container element
412 var layer_container = getLayerContainer(layer_index).getElement();
414 // Remove from parent
415 layer_container.parentNode.removeChild(layer_container);
418 delete layers[layer_index];
422 // If buffer, just delete reference
423 else if (layer_index < 0)
424 delete buffers[-1 - layer_index];
426 // Attempting to dispose the root layer currently has no effect.
430 "distort": function(parameters) {
432 var layer_index = parseInt(parameters[0]);
433 var a = parseFloat(parameters[1]);
434 var b = parseFloat(parameters[2]);
435 var c = parseFloat(parameters[3]);
436 var d = parseFloat(parameters[4]);
437 var e = parseFloat(parameters[5]);
438 var f = parseFloat(parameters[6]);
440 // Only valid for visible layers (not buffers)
441 if (layer_index >= 0) {
443 // Get container element
444 var layer_container = getLayerContainer(layer_index).getElement();
446 // Set layer transform
447 layer_container.style.transform =
448 layer_container.style.WebkitTransform =
449 layer_container.style.MozTransform =
450 layer_container.style.OTransform =
451 layer_container.style.msTransform =
458 "matrix(" + a + "," + b + "," + c + "," + d + "," + e + "," + f + ")";
464 "error": function(parameters) {
465 if (guac_client.onerror) guac_client.onerror(parameters[0]);
466 guac_client.disconnect();
469 "identity": function(parameters) {
471 var layer = getLayer(parseInt(parameters[0]));
473 layer.setTransform(1, 0, 0, 1, 0, 0);
477 "lfill": function(parameters) {
479 var channelMask = parseInt(parameters[0]);
480 var layer = getLayer(parseInt(parameters[1]));
481 var srcLayer = getLayer(parseInt(parameters[2]));
483 layer.setChannelMask(channelMask);
485 layer.fillLayer(srcLayer);
489 "line": function(parameters) {
491 var layer = getLayer(parseInt(parameters[0]));
492 var x = parseInt(parameters[1]);
493 var y = parseInt(parameters[2]);
499 "lstroke": function(parameters) {
501 var channelMask = parseInt(parameters[0]);
502 var layer = getLayer(parseInt(parameters[1]));
503 var srcLayer = getLayer(parseInt(parameters[2]));
505 layer.setChannelMask(channelMask);
507 layer.strokeLayer(srcLayer);
511 "move": function(parameters) {
513 var layer_index = parseInt(parameters[0]);
514 var parent_index = parseInt(parameters[1]);
515 var x = parseInt(parameters[2]);
516 var y = parseInt(parameters[3]);
517 var z = parseInt(parameters[4]);
519 // Only valid for non-default layers
520 if (layer_index > 0 && parent_index >= 0) {
522 // Get container element
523 var layer_container = getLayerContainer(layer_index).getElement();
524 var parent = getLayerContainer(parent_index).getElement();
526 // Set parent if necessary
527 if (!(layer_container.parentNode === parent))
528 parent.appendChild(layer_container);
531 layer_container.style.left = x + "px";
532 layer_container.style.top = y + "px";
533 layer_container.style.zIndex = z;
539 "name": function(parameters) {
540 if (guac_client.onname) guac_client.onname(parameters[0]);
543 "png": function(parameters) {
545 var channelMask = parseInt(parameters[0]);
546 var layer = getLayer(parseInt(parameters[1]));
547 var x = parseInt(parameters[2]);
548 var y = parseInt(parameters[3]);
549 var data = parameters[4];
551 layer.setChannelMask(channelMask);
556 "data:image/png;base64," + data
559 // If received first update, no longer waiting.
560 if (currentState == STATE_WAITING)
561 setState(STATE_CONNECTED);
565 "pop": function(parameters) {
567 var layer = getLayer(parseInt(parameters[0]));
573 "push": function(parameters) {
575 var layer = getLayer(parseInt(parameters[0]));
581 "rect": function(parameters) {
583 var layer = getLayer(parseInt(parameters[0]));
584 var x = parseInt(parameters[1]);
585 var y = parseInt(parameters[2]);
586 var w = parseInt(parameters[3]);
587 var h = parseInt(parameters[4]);
589 layer.rect(x, y, w, h);
593 "reset": function(parameters) {
595 var layer = getLayer(parseInt(parameters[0]));
601 "shade": function(parameters) {
603 var layer_index = parseInt(parameters[0]);
604 var a = parseInt(parameters[1]);
606 // Only valid for visible layers (not buffers)
607 if (layer_index >= 0) {
609 // Get container element
610 var layer_container = getLayerContainer(layer_index).getElement();
613 layer_container.style.opacity = a/255.0;
619 "size": function(parameters) {
621 var layer_index = parseInt(parameters[0]);
622 var width = parseInt(parameters[1]);
623 var height = parseInt(parameters[2]);
626 var layer_container = getLayerContainer(layer_index);
627 layer_container.resize(width, height);
629 // If layer is default, resize display
630 if (layer_index == 0) {
632 displayWidth = width;
633 displayHeight = height;
635 // Update (set) display size
636 display.style.width = displayWidth + "px";
637 display.style.height = displayHeight + "px";
643 "start": function(parameters) {
645 var layer = getLayer(parseInt(parameters[0]));
646 var x = parseInt(parameters[1]);
647 var y = parseInt(parameters[2]);
653 "sync": function(parameters) {
655 var timestamp = parameters[0];
657 // When all layers have finished rendering all instructions
658 // UP TO THIS POINT IN TIME, send sync response.
660 var layersToSync = 0;
661 function syncLayer() {
665 // Send sync response when layers are finished
666 if (layersToSync == 0) {
667 if (timestamp != currentTimestamp) {
668 tunnel.sendMessage("sync", timestamp);
669 currentTimestamp = timestamp;
675 // Count active, not-ready layers and install sync tracking hooks
676 for (var i=0; i<layers.length; i++) {
678 var layer = layers[i].getLayer();
679 if (layer && !layer.isReady()) {
681 layer.sync(syncLayer);
686 // If all layers are ready, then we didn't install any hooks.
687 // Send sync message now,
688 if (layersToSync == 0) {
689 if (timestamp != currentTimestamp) {
690 tunnel.sendMessage("sync", timestamp);
691 currentTimestamp = timestamp;
697 "transfer": function(parameters) {
699 var srcL = getLayer(parseInt(parameters[0]));
700 var srcX = parseInt(parameters[1]);
701 var srcY = parseInt(parameters[2]);
702 var srcWidth = parseInt(parameters[3]);
703 var srcHeight = parseInt(parameters[4]);
704 var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
705 var dstL = getLayer(parseInt(parameters[6]));
706 var dstX = parseInt(parameters[7]);
707 var dstY = parseInt(parameters[8]);
722 "transform": function(parameters) {
724 var layer = getLayer(parseInt(parameters[0]));
725 var a = parseFloat(parameters[1]);
726 var b = parseFloat(parameters[2]);
727 var c = parseFloat(parameters[3]);
728 var d = parseFloat(parameters[4]);
729 var e = parseFloat(parameters[5]);
730 var f = parseFloat(parameters[6]);
732 layer.transform(a, b, c, d, e, f);
739 tunnel.oninstruction = function(opcode, parameters) {
741 var handler = instructionHandlers[opcode];
748 guac_client.disconnect = function() {
750 // Only attempt disconnection not disconnected.
751 if (currentState != STATE_DISCONNECTED
752 && currentState != STATE_DISCONNECTING) {
754 setState(STATE_DISCONNECTING);
758 window.clearInterval(pingInterval);
760 // Send disconnect message and disconnect
761 tunnel.sendMessage("disconnect");
763 setState(STATE_DISCONNECTED);
769 guac_client.connect = function(data) {
771 setState(STATE_CONNECTING);
774 tunnel.connect(data);
777 setState(STATE_IDLE);
781 // Ping every 5 seconds (ensure connection alive)
782 pingInterval = window.setInterval(function() {
783 tunnel.sendMessage("sync", currentTimestamp);
786 setState(STATE_WAITING);
793 * Simple container for Guacamole.Layer, allowing layers to be easily
794 * repositioned and nested. This allows certain operations to be accelerated
795 * through DOM manipulation, rather than raster operations.
799 * @param {Number} width The width of the Layer, in pixels. The canvas element
800 * backing this Layer will be given this width.
802 * @param {Number} height The height of the Layer, in pixels. The canvas element
803 * backing this Layer will be given this height.
805 Guacamole.Client.LayerContainer = function(width, height) {
808 * Reference to this LayerContainer.
811 var layer_container = this;
813 // Create layer with given size
814 var layer = new Guacamole.Layer(width, height);
816 // Set layer position
817 var canvas = layer.getCanvas();
818 canvas.style.position = "absolute";
819 canvas.style.left = "0px";
820 canvas.style.top = "0px";
822 // Create div with given size
823 var div = document.createElement("div");
824 div.appendChild(canvas);
825 div.style.width = width + "px";
826 div.style.height = height + "px";
829 * Changes the size of this LayerContainer and the contained Layer to the
830 * given width and height.
832 * @param {Number} width The new width to assign to this Layer.
833 * @param {Number} height The new height to assign to this Layer.
835 layer_container.resize = function(width, height) {
838 layer.resize(width, height);
840 // Resize containing div
841 div.style.width = width + "px";
842 div.style.height = height + "px";
847 * Returns the Layer contained within this LayerContainer.
848 * @returns {Guacamole.Layer} The Layer contained within this LayerContainer.
850 layer_container.getLayer = function() {
855 * Returns the element containing the Layer within this LayerContainer.
856 * @returns {Element} The element containing the Layer within this LayerContainer.
858 layer_container.getElement = function() {
865 * Map of all Guacamole binary raster operations to transfer functions.
868 Guacamole.Client.DefaultTransferFunction = {
871 0x0: function (src, dst) {
872 dst.red = dst.green = dst.blue = 0x00;
876 0xF: function (src, dst) {
877 dst.red = dst.green = dst.blue = 0xFF;
881 0x3: function (src, dst) {
883 dst.green = src.green;
885 dst.alpha = src.alpha;
889 0x5: function (src, dst) {
894 0xC: function (src, dst) {
895 dst.red = 0xFF & ~src.red;
896 dst.green = 0xFF & ~src.green;
897 dst.blue = 0xFF & ~src.blue;
898 dst.alpha = src.alpha;
902 0xA: function (src, dst) {
903 dst.red = 0xFF & ~dst.red;
904 dst.green = 0xFF & ~dst.green;
905 dst.blue = 0xFF & ~dst.blue;
909 0x1: function (src, dst) {
910 dst.red = ( src.red & dst.red);
911 dst.green = ( src.green & dst.green);
912 dst.blue = ( src.blue & dst.blue);
916 0xE: function (src, dst) {
917 dst.red = 0xFF & ~( src.red & dst.red);
918 dst.green = 0xFF & ~( src.green & dst.green);
919 dst.blue = 0xFF & ~( src.blue & dst.blue);
923 0x7: function (src, dst) {
924 dst.red = ( src.red | dst.red);
925 dst.green = ( src.green | dst.green);
926 dst.blue = ( src.blue | dst.blue);
930 0x8: function (src, dst) {
931 dst.red = 0xFF & ~( src.red | dst.red);
932 dst.green = 0xFF & ~( src.green | dst.green);
933 dst.blue = 0xFF & ~( src.blue | dst.blue);
937 0x6: 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 0x9: 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);
950 /* AND inverted source */
951 0x4: function (src, dst) {
952 dst.red = 0xFF & (~src.red & dst.red);
953 dst.green = 0xFF & (~src.green & dst.green);
954 dst.blue = 0xFF & (~src.blue & dst.blue);
957 /* OR inverted source */
958 0xD: 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);
964 /* AND inverted destination */
965 0x2: function (src, dst) {
966 dst.red = 0xFF & ( src.red & ~dst.red);
967 dst.green = 0xFF & ( src.green & ~dst.green);
968 dst.blue = 0xFF & ( src.blue & ~dst.blue);
971 /* OR inverted destination */
972 0xB: 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);