src/main/resources/guacamole.js

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   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/
   9  *
  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
  13  * License.
  14  *
  15  * The Original Code is guacamole-common-js.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2010
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  * Matt Hortman
  24  *
  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.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 // Guacamole namespace
  40 var Guacamole = Guacamole || {};
  41
  42
  43 /**
  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.
  47  *
  48  * @constructor
  49  * @param {Guacamole.Tunnel} tunnel The tunnel to use to send and receive
  50  *                                  Guacamole instructions.
  51  */
  52 Guacamole.Client = function(tunnel) {
  53
  54     var guac_client = this;
  55
  56     var STATE_IDLE          = 0;
  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;
  62
  63     var currentState = STATE_IDLE;
  64
  65     var currentTimestamp = 0;
  66     var pingInterval = null;
  67
  68     var displayWidth = 0;
  69     var displayHeight = 0;
  70
  71     // Create display
  72     var display = document.createElement("div");
  73     display.style.position = "relative";
  74     display.style.width = displayWidth + "px";
  75     display.style.height = displayHeight + "px";
  76
  77     // Create default layer
  78     var default_layer_container = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
  79
  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";
  85
  86     // Create cursor layer
  87     var cursor = new Guacamole.Client.LayerContainer(0, 0);
  88     cursor.getLayer().setChannelMask(Guacamole.Layer.SRC);
  89
  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";
  95
  96     // Add default layer and cursor to display
  97     display.appendChild(default_layer_container.getElement());
  98     display.appendChild(cursor.getElement());
  99
 100     // Initially, only default layer exists
 101     var layers =  [default_layer_container];
 102
 103     // No initial buffers
 104     var buffers = [];
 105
 106     tunnel.onerror = function(message) {
 107         if (guac_client.onerror)
 108             guac_client.onerror(message);
 109     };
 110
 111     function setState(state) {
 112         if (state != currentState) {
 113             currentState = state;
 114             if (guac_client.onstatechange)
 115                 guac_client.onstatechange(currentState);
 116         }
 117     }
 118
 119     function isConnected() {
 120         return currentState == STATE_CONNECTED
 121             || currentState == STATE_WAITING;
 122     }
 123
 124     var cursorHotspotX = 0;
 125     var cursorHotspotY = 0;
 126
 127     var cursorX = 0;
 128     var cursorY = 0;
 129
 130     function moveCursor(x, y) {
 131
 132         var element = cursor.getElement();
 133
 134         // Update rect
 135         element.style.left = (x - cursorHotspotX) + "px";
 136         element.style.top  = (y - cursorHotspotY) + "px";
 137
 138         // Update stored position
 139         cursorX = x;
 140         cursorY = y;
 141
 142     }
 143
 144     guac_client.getDisplay = function() {
 145         return display;
 146     };
 147
 148     guac_client.sendKeyEvent = function(pressed, keysym) {
 149         // Do not send requests if not connected
 150         if (!isConnected())
 151             return;
 152
 153         tunnel.sendMessage("key", keysym, pressed);
 154     };
 155
 156     guac_client.sendMouseState = function(mouseState) {
 157
 158         // Do not send requests if not connected
 159         if (!isConnected())
 160             return;
 161
 162         // Update client-side cursor
 163         moveCursor(
 164             mouseState.x,
 165             mouseState.y
 166         );
 167
 168         // Build mask
 169         var buttonMask = 0;
 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;
 175
 176         // Send message
 177         tunnel.sendMessage("mouse", mouseState.x, mouseState.y, buttonMask);
 178     };
 179
 180     guac_client.setClipboard = function(data) {
 181
 182         // Do not send requests if not connected
 183         if (!isConnected())
 184             return;
 185
 186         tunnel.sendMessage("clipboard", data);
 187     };
 188
 189     // Handlers
 190     guac_client.onstatechange = null;
 191     guac_client.onname = null;
 192     guac_client.onerror = null;
 193     guac_client.onclipboard = null;
 194
 195     // Layers
 196     function getBufferLayer(index) {
 197
 198         index = -1 - index;
 199         var buffer = buffers[index];
 200
 201         // Create buffer if necessary
 202         if (buffer == null) {
 203             buffer = new Guacamole.Layer(0, 0);
 204             buffer.autosize = 1;
 205             buffers[index] = buffer;
 206         }
 207
 208         return buffer;
 209
 210     }
 211
 212     function getLayerContainer(index) {
 213
 214         var layer = layers[index];
 215         if (layer == null) {
 216
 217             // Add new layer
 218             layer = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
 219             layers[index] = layer;
 220
 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";
 226
 227             // Add to default layer container
 228             default_layer_container.getElement().appendChild(layer_element);
 229
 230         }
 231
 232         return layer;
 233
 234     }
 235
 236     function getLayer(index) {
 237
 238         // If buffer, just get layer
 239         if (index < 0)
 240             return getBufferLayer(index);
 241
 242         // Otherwise, retrieve layer from layer container
 243         return getLayerContainer(index).getLayer();
 244
 245     }
 246
 247     var instructionHandlers = {
 248
 249         "cfill": function(parameters) {
 250
 251             var channelMask = parseInt(parameters[0]);
 252             var layer = getLayer(parseInt(parameters[1]));
 253             var r = parseInt(parameters[2]);
 254             var g = parseInt(parameters[3]);
 255             var b = parseInt(parameters[4]);
 256             var a = parseInt(parameters[5]);
 257
 258             layer.setChannelMask(channelMask);
 259
 260             layer.fillColor(r, g, b, a);
 261
 262         },
 263
 264         "clip": function(parameters) {
 265
 266             var layer = getLayer(parseInt(parameters[0]));
 267
 268             layer.clip();
 269
 270         },
 271
 272         "clipboard": function(parameters) {
 273             if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
 274         },
 275
 276         "copy": function(parameters) {
 277
 278             var srcL = getLayer(parseInt(parameters[0]));
 279             var srcX = parseInt(parameters[1]);
 280             var srcY = parseInt(parameters[2]);
 281             var srcWidth = parseInt(parameters[3]);
 282             var srcHeight = parseInt(parameters[4]);
 283             var channelMask = parseInt(parameters[5]);
 284             var dstL = getLayer(parseInt(parameters[6]));
 285             var dstX = parseInt(parameters[7]);
 286             var dstY = parseInt(parameters[8]);
 287
 288             dstL.setChannelMask(channelMask);
 289
 290             dstL.copy(
 291                 srcL,
 292                 srcX,
 293                 srcY,
 294                 srcWidth,
 295                 srcHeight,
 296                 dstX,
 297                 dstY
 298             );
 299
 300         },
 301
 302         "cursor": function(parameters) {
 303
 304             cursorHotspotX = parseInt(parameters[0]);
 305             cursorHotspotY = parseInt(parameters[1]);
 306             var srcL = getLayer(parseInt(parameters[2]));
 307             var srcX = parseInt(parameters[3]);
 308             var srcY = parseInt(parameters[4]);
 309             var srcWidth = parseInt(parameters[5]);
 310             var srcHeight = parseInt(parameters[6]);
 311
 312             // Reset cursor size
 313             cursor.resize(srcWidth, srcHeight);
 314
 315             // Draw cursor to cursor layer
 316             cursor.getLayer().copy(
 317                 srcL,
 318                 srcX,
 319                 srcY,
 320                 srcWidth,
 321                 srcHeight,
 322                 0,
 323                 0
 324             );
 325
 326             // Update cursor position (hotspot may have changed)
 327             moveCursor(cursorX, cursorY);
 328
 329         },
 330
 331         "dispose": function(parameters) {
 332
 333             var layer_index = parseInt(parameters[0]);
 334
 335             // If visible layer, remove from parent
 336             if (layer_index > 0) {
 337
 338                 // Get container element
 339                 var layer_container = getLayerContainer(layer_index).getElement();
 340
 341                 // Remove from parent
 342                 layer_container.parentNode.removeChild(layer_container);
 343
 344                 // Delete reference
 345                 delete layers[layer_index];
 346
 347             }
 348
 349             // If buffer, just delete reference
 350             else if (layer_index < 0)
 351                 delete buffers[-1 - layer_index];
 352
 353             // Attempting to dispose the root layer currently has no effect.
 354
 355         },
 356
 357         "error": function(parameters) {
 358             if (guac_client.onerror) guac_client.onerror(parameters[0]);
 359             guac_client.disconnect();
 360         },
 361
 362         "move": function(parameters) {
 363
 364             var layer_index = parseInt(parameters[0]);
 365             var parent_index = parseInt(parameters[1]);
 366             var x = parseInt(parameters[2]);
 367             var y = parseInt(parameters[3]);
 368             var z = parseInt(parameters[4]);
 369
 370             // Only valid for non-default layers
 371             if (layer_index > 0 && parent_index >= 0) {
 372
 373                 // Get container element
 374                 var layer_container = getLayerContainer(layer_index).getElement();
 375                 var parent = getLayerContainer(parent_index).getElement();
 376
 377                 // Set parent if necessary
 378                 if (!(layer_container.parentNode === parent))
 379                     parent.appendChild(layer_container);
 380
 381                 // Move layer
 382                 layer_container.style.left   = x + "px";
 383                 layer_container.style.top    = y + "px";
 384                 layer_container.style.zIndex = z;
 385
 386             }
 387
 388         },
 389
 390         "name": function(parameters) {
 391             if (guac_client.onname) guac_client.onname(parameters[0]);
 392         },
 393
 394         "png": function(parameters) {
 395
 396             var channelMask = parseInt(parameters[0]);
 397             var layer = getLayer(parseInt(parameters[1]));
 398             var x = parseInt(parameters[2]);
 399             var y = parseInt(parameters[3]);
 400             var data = parameters[4];
 401
 402             layer.setChannelMask(channelMask);
 403
 404             layer.draw(
 405                 x,
 406                 y,
 407                 "data:image/png;base64," + data
 408             );
 409
 410             // If received first update, no longer waiting.
 411             if (currentState == STATE_WAITING)
 412                 setState(STATE_CONNECTED);
 413
 414         },
 415
 416         "rect": function(parameters) {
 417
 418             var layer = getLayer(parseInt(parameters[0]));
 419             var x = parseInt(parameters[1]);
 420             var y = parseInt(parameters[2]);
 421             var w = parseInt(parameters[3]);
 422             var h = parseInt(parameters[4]);
 423
 424             layer.rect(x, y, w, h);
 425
 426         },
 427
 428         "reset": function(parameters) {
 429
 430             var layer = getLayer(parseInt(parameters[0]));
 431
 432             layer.reset();
 433
 434         },
 435
 436         "size": function(parameters) {
 437
 438             var layer_index = parseInt(parameters[0]);
 439             var width = parseInt(parameters[1]);
 440             var height = parseInt(parameters[2]);
 441
 442             // Resize layer
 443             var layer_container = getLayerContainer(layer_index);
 444             layer_container.resize(width, height);
 445
 446             // If layer is default, resize display
 447             if (layer_index == 0) {
 448
 449                 displayWidth = width;
 450                 displayHeight = height;
 451
 452                 // Update (set) display size
 453                 display.style.width = displayWidth + "px";
 454                 display.style.height = displayHeight + "px";
 455
 456             }
 457
 458         },
 459
 460         "sync": function(parameters) {
 461
 462             var timestamp = parameters[0];
 463
 464             // When all layers have finished rendering all instructions
 465             // UP TO THIS POINT IN TIME, send sync response.
 466
 467             var layersToSync = 0;
 468             function syncLayer() {
 469
 470                 layersToSync--;
 471
 472                 // Send sync response when layers are finished
 473                 if (layersToSync == 0) {
 474                     if (timestamp != currentTimestamp) {
 475                         tunnel.sendMessage("sync", timestamp);
 476                         currentTimestamp = timestamp;
 477                     }
 478                 }
 479
 480             }
 481
 482             // Count active, not-ready layers and install sync tracking hooks
 483             for (var i=0; i<layers.length; i++) {
 484
 485                 var layer = layers[i].getLayer();
 486                 if (layer && !layer.isReady()) {
 487                     layersToSync++;
 488                     layer.sync(syncLayer);
 489                 }
 490
 491             }
 492
 493             // If all layers are ready, then we didn't install any hooks.
 494             // Send sync message now,
 495             if (layersToSync == 0) {
 496                 if (timestamp != currentTimestamp) {
 497                     tunnel.sendMessage("sync", timestamp);
 498                     currentTimestamp = timestamp;
 499                 }
 500             }
 501
 502         },
 503
 504         "transfer": function(parameters) {
 505
 506             var srcL = getLayer(parseInt(parameters[0]));
 507             var srcX = parseInt(parameters[1]);
 508             var srcY = parseInt(parameters[2]);
 509             var srcWidth = parseInt(parameters[3]);
 510             var srcHeight = parseInt(parameters[4]);
 511             var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
 512             var dstL = getLayer(parseInt(parameters[6]));
 513             var dstX = parseInt(parameters[7]);
 514             var dstY = parseInt(parameters[8]);
 515
 516             dstL.transfer(
 517                 srcL,
 518                 srcX,
 519                 srcY,
 520                 srcWidth,
 521                 srcHeight,
 522                 dstX,
 523                 dstY,
 524                 transferFunction
 525             );
 526
 527         }
 528
 529     };
 530
 531
 532     tunnel.oninstruction = function(opcode, parameters) {
 533
 534         var handler = instructionHandlers[opcode];
 535         if (handler)
 536             handler(parameters);
 537
 538     };
 539
 540
 541     guac_client.disconnect = function() {
 542
 543         // Only attempt disconnection not disconnected.
 544         if (currentState != STATE_DISCONNECTED
 545                 && currentState != STATE_DISCONNECTING) {
 546
 547             setState(STATE_DISCONNECTING);
 548
 549             // Stop ping
 550             if (pingInterval)
 551                 window.clearInterval(pingInterval);
 552
 553             // Send disconnect message and disconnect
 554             tunnel.sendMessage("disconnect");
 555             tunnel.disconnect();
 556             setState(STATE_DISCONNECTED);
 557
 558         }
 559
 560     };
 561
 562     guac_client.connect = function(data) {
 563
 564         setState(STATE_CONNECTING);
 565
 566         try {
 567             tunnel.connect(data);
 568         }
 569         catch (e) {
 570             setState(STATE_IDLE);
 571             throw e;
 572         }
 573
 574         // Ping every 5 seconds (ensure connection alive)
 575         pingInterval = window.setInterval(function() {
 576             tunnel.sendMessage("sync", currentTimestamp);
 577         }, 5000);
 578
 579         setState(STATE_WAITING);
 580     };
 581
 582 };
 583
 584
 585 /**
 586  * Simple container for Guacamole.Layer, allowing layers to be easily
 587  * repositioned and nested. This allows certain operations to be accelerated
 588  * through DOM manipulation, rather than raster operations.
 589  *
 590  * @constructor
 591  *
 592  * @param {Number} width The width of the Layer, in pixels. The canvas element
 593  *                       backing this Layer will be given this width.
 594  *
 595  * @param {Number} height The height of the Layer, in pixels. The canvas element
 596  *                        backing this Layer will be given this height.
 597  */
 598 Guacamole.Client.LayerContainer = function(width, height) {
 599
 600     /**
 601      * Reference to this LayerContainer.
 602      * @private
 603      */
 604     var layer_container = this;
 605
 606     // Create layer with given size
 607     var layer = new Guacamole.Layer(width, height);
 608
 609     // Set layer position
 610     var canvas = layer.getCanvas();
 611     canvas.style.position = "absolute";
 612     canvas.style.left = "0px";
 613     canvas.style.top = "0px";
 614
 615     // Create div with given size
 616     var div = document.createElement("div");
 617     div.appendChild(canvas);
 618     div.style.width = width + "px";
 619     div.style.height = height + "px";
 620
 621     /**
 622      * Changes the size of this LayerContainer and the contained Layer to the
 623      * given width and height.
 624      *
 625      * @param {Number} width The new width to assign to this Layer.
 626      * @param {Number} height The new height to assign to this Layer.
 627      */
 628     layer_container.resize = function(width, height) {
 629
 630         // Resize layer
 631         layer.resize(width, height);
 632
 633         // Resize containing div
 634         div.style.width = width + "px";
 635         div.style.height = height + "px";
 636
 637     };
 638
 639     /**
 640      * Returns the Layer contained within this LayerContainer.
 641      * @returns {Guacamole.Layer} The Layer contained within this LayerContainer.
 642      */
 643     layer_container.getLayer = function() {
 644         return layer;
 645     };
 646
 647     /**
 648      * Returns the element containing the Layer within this LayerContainer.
 649      * @returns {Element} The element containing the Layer within this LayerContainer.
 650      */
 651     layer_container.getElement = function() {
 652         return div;
 653     };
 654
 655 };
 656
 657 /**
 658  * Map of all Guacamole binary raster operations to transfer functions.
 659  * @private
 660  */
 661 Guacamole.Client.DefaultTransferFunction = {
 662
 663     /* BLACK */
 664     0x0: function (src, dst) {
 665         dst.red = dst.green = dst.blue = 0x00;
 666     },
 667
 668     /* WHITE */
 669     0xF: function (src, dst) {
 670         dst.red = dst.green = dst.blue = 0xFF;
 671     },
 672
 673     /* SRC */
 674     0x3: function (src, dst) {
 675         dst.red   = src.red;
 676         dst.green = src.green;
 677         dst.blue  = src.blue;
 678         dst.alpha = src.alpha;
 679     },
 680
 681     /* DEST (no-op) */
 682     0x5: function (src, dst) {
 683         // Do nothing
 684     },
 685
 686     /* Invert SRC */
 687     0xC: function (src, dst) {
 688         dst.red   = 0xFF & ~src.red;
 689         dst.green = 0xFF & ~src.green;
 690         dst.blue  = 0xFF & ~src.blue;
 691         dst.alpha =  src.alpha;
 692     },
 693
 694     /* Invert DEST */
 695     0xA: function (src, dst) {
 696         dst.red   = 0xFF & ~dst.red;
 697         dst.green = 0xFF & ~dst.green;
 698         dst.blue  = 0xFF & ~dst.blue;
 699     },
 700
 701     /* AND */
 702     0x1: function (src, dst) {
 703         dst.red   =  ( src.red   &  dst.red);
 704         dst.green =  ( src.green &  dst.green);
 705         dst.blue  =  ( src.blue  &  dst.blue);
 706     },
 707
 708     /* NAND */
 709     0xE: function (src, dst) {
 710         dst.red   = 0xFF & ~( src.red   &  dst.red);
 711         dst.green = 0xFF & ~( src.green &  dst.green);
 712         dst.blue  = 0xFF & ~( src.blue  &  dst.blue);
 713     },
 714
 715     /* OR */
 716     0x7: function (src, dst) {
 717         dst.red   =  ( src.red   |  dst.red);
 718         dst.green =  ( src.green |  dst.green);
 719         dst.blue  =  ( src.blue  |  dst.blue);
 720     },
 721
 722     /* NOR */
 723     0x8: function (src, dst) {
 724         dst.red   = 0xFF & ~( src.red   |  dst.red);
 725         dst.green = 0xFF & ~( src.green |  dst.green);
 726         dst.blue  = 0xFF & ~( src.blue  |  dst.blue);
 727     },
 728
 729     /* XOR */
 730     0x6: function (src, dst) {
 731         dst.red   =  ( src.red   ^  dst.red);
 732         dst.green =  ( src.green ^  dst.green);
 733         dst.blue  =  ( src.blue  ^  dst.blue);
 734     },
 735
 736     /* XNOR */
 737     0x9: function (src, dst) {
 738         dst.red   = 0xFF & ~( src.red   ^  dst.red);
 739         dst.green = 0xFF & ~( src.green ^  dst.green);
 740         dst.blue  = 0xFF & ~( src.blue  ^  dst.blue);
 741     },
 742
 743     /* AND inverted source */
 744     0x4: function (src, dst) {
 745         dst.red   =  0xFF & (~src.red   &  dst.red);
 746         dst.green =  0xFF & (~src.green &  dst.green);
 747         dst.blue  =  0xFF & (~src.blue  &  dst.blue);
 748     },
 749
 750     /* OR inverted source */
 751     0xD: function (src, dst) {
 752         dst.red   =  0xFF & (~src.red   |  dst.red);
 753         dst.green =  0xFF & (~src.green |  dst.green);
 754         dst.blue  =  0xFF & (~src.blue  |  dst.blue);
 755     },
 756
 757     /* AND inverted destination */
 758     0x2: function (src, dst) {
 759         dst.red   =  0xFF & ( src.red   & ~dst.red);
 760         dst.green =  0xFF & ( src.green & ~dst.green);
 761         dst.blue  =  0xFF & ( src.blue  & ~dst.blue);
 762     },
 763
 764     /* OR inverted destination */
 765     0xB: function (src, dst) {
 766         dst.red   =  0xFF & ( src.red   | ~dst.red);
 767         dst.green =  0xFF & ( src.green | ~dst.green);
 768         dst.blue  =  0xFF & ( src.blue  | ~dst.blue);
 769     }
 770
 771 };