Source: main/webapp/modules/Status.js

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *   http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing,
  13.  * software distributed under the License is distributed on an
  14.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15.  * KIND, either express or implied.  See the License for the
  16.  * specific language governing permissions and limitations
  17.  * under the License.
  18.  */
  20. var Guacamole = Guacamole || {};
  22. /**
  23.  * A Guacamole status. Each Guacamole status consists of a status code, defined
  24.  * by the protocol, and an optional human-readable message, usually only
  25.  * included for debugging convenience.
  26.  *
  27.  * @constructor
  28.  * @param {!number} code
  29.  *     The Guacamole status code, as defined by Guacamole.Status.Code.
  30.  *
  31.  * @param {string} [message]
  32.  *     An optional human-readable message.
  33.  */
  34. Guacamole.Status = function(code, message) {
  36.     /**
  37.      * Reference to this Guacamole.Status.
  38.      *
  39.      * @private
  40.      * @type {!Guacamole.Status}
  41.      */
  42.     var guac_status = this;
  44.     /**
  45.      * The Guacamole status code.
  46.      *
  47.      * @see Guacamole.Status.Code
  48.      * @type {!number}
  49.      */
  50.     this.code = code;
  52.     /**
  53.      * An arbitrary human-readable message associated with this status, if any.
  54.      * The human-readable message is not required, and is generally provided
  55.      * for debugging purposes only. For user feedback, it is better to translate
  56.      * the Guacamole status code into a message.
  57.      * 
  58.      * @type {string}
  59.      */
  60.     this.message = message;
  62.     /**
  63.      * Returns whether this status represents an error.
  64.      *
  65.      * @returns {!boolean}
  66.      *     true if this status represents an error, false otherwise.
  67.      */
  68.     this.isError = function() {
  69.         return guac_status.code < 0 || guac_status.code > 0x00FF;
  70.     };
  72. };
  74. /**
  75.  * Enumeration of all Guacamole status codes.
  76.  */
  77. Guacamole.Status.Code = {
  79.     /**
  80.      * The operation succeeded.
  81.      *
  82.      * @type {!number}
  83.      */
  84.     "SUCCESS": 0x0000,
  86.     /**
  87.      * The requested operation is unsupported.
  88.      *
  89.      * @type {!number}
  90.      */
  91.     "UNSUPPORTED": 0x0100,
  93.     /**
  94.      * The operation could not be performed due to an internal failure.
  95.      *
  96.      * @type {!number}
  97.      */
  98.     "SERVER_ERROR": 0x0200,
  100.     /**
  101.      * The operation could not be performed as the server is busy.
  102.      *
  103.      * @type {!number}
  104.      */
  105.     "SERVER_BUSY": 0x0201,
  107.     /**
  108.      * The operation could not be performed because the upstream server is not
  109.      * responding.
  110.      *
  111.      * @type {!number}
  112.      */
  113.     "UPSTREAM_TIMEOUT": 0x0202,
  115.     /**
  116.      * The operation was unsuccessful due to an error or otherwise unexpected
  117.      * condition of the upstream server.
  118.      *
  119.      * @type {!number}
  120.      */
  121.     "UPSTREAM_ERROR": 0x0203,
  123.     /**
  124.      * The operation could not be performed as the requested resource does not
  125.      * exist.
  126.      *
  127.      * @type {!number}
  128.      */
  129.     "RESOURCE_NOT_FOUND": 0x0204,
  131.     /**
  132.      * The operation could not be performed as the requested resource is
  133.      * already in use.
  134.      *
  135.      * @type {!number}
  136.      */
  137.     "RESOURCE_CONFLICT": 0x0205,
  139.     /**
  140.      * The operation could not be performed as the requested resource is now
  141.      * closed.
  142.      *
  143.      * @type {!number}
  144.      */
  145.     "RESOURCE_CLOSED": 0x0206,
  147.     /**
  148.      * The operation could not be performed because the upstream server does
  149.      * not appear to exist.
  150.      *
  151.      * @type {!number}
  152.      */
  153.     "UPSTREAM_NOT_FOUND": 0x0207,
  155.     /**
  156.      * The operation could not be performed because the upstream server is not
  157.      * available to service the request.
  158.      *
  159.      * @type {!number}
  160.      */
  161.     "UPSTREAM_UNAVAILABLE": 0x0208,
  163.     /**
  164.      * The session within the upstream server has ended because it conflicted
  165.      * with another session.
  166.      *
  167.      * @type {!number}
  168.      */
  169.     "SESSION_CONFLICT": 0x0209,
  171.     /**
  172.      * The session within the upstream server has ended because it appeared to
  173.      * be inactive.
  174.      *
  175.      * @type {!number}
  176.      */
  177.     "SESSION_TIMEOUT": 0x020A,
  179.     /**
  180.      * The session within the upstream server has been forcibly terminated.
  181.      *
  182.      * @type {!number}
  183.      */
  184.     "SESSION_CLOSED": 0x020B,
  186.     /**
  187.      * The operation could not be performed because bad parameters were given.
  188.      *
  189.      * @type {!number}
  190.      */
  191.     "CLIENT_BAD_REQUEST": 0x0300,
  193.     /**
  194.      * Permission was denied to perform the operation, as the user is not yet
  195.      * authorized (not yet logged in, for example).
  196.      *
  197.      * @type {!number}
  198.      */
  199.     "CLIENT_UNAUTHORIZED": 0x0301,
  201.     /**
  202.      * Permission was denied to perform the operation, and this permission will
  203.      * not be granted even if the user is authorized.
  204.      *
  205.      * @type {!number}
  206.      */
  207.     "CLIENT_FORBIDDEN": 0x0303,
  209.     /**
  210.      * The client took too long to respond.
  211.      *
  212.      * @type {!number}
  213.      */
  214.     "CLIENT_TIMEOUT": 0x0308,
  216.     /**
  217.      * The client sent too much data.
  218.      *
  219.      * @type {!number}
  220.      */
  221.     "CLIENT_OVERRUN": 0x030D,
  223.     /**
  224.      * The client sent data of an unsupported or unexpected type.
  225.      *
  226.      * @type {!number}
  227.      */
  228.     "CLIENT_BAD_TYPE": 0x030F,
  230.     /**
  231.      * The operation failed because the current client is already using too
  232.      * many resources.
  233.      *
  234.      * @type {!number}
  235.      */
  236.     "CLIENT_TOO_MANY": 0x031D
  238. };
  240. /**
  241.  * Returns the Guacamole protocol status code which most closely
  242.  * represents the given HTTP status code.
  243.  *
  244.  * @param {!number} status
  245.  *     The HTTP status code to translate into a Guacamole protocol status
  246.  *     code.
  247.  *
  248.  * @returns {!number}
  249.  *     The Guacamole protocol status code which most closely represents the
  250.  *     given HTTP status code.
  251.  */
  252. Guacamole.Status.Code.fromHTTPCode = function fromHTTPCode(status) {
  254.     // Translate status codes with known equivalents
  255.     switch (status) {
  257.         // HTTP 400 - Bad request
  258.         case 400:
  259.             return Guacamole.Status.Code.CLIENT_BAD_REQUEST;
  261.         // HTTP 403 - Forbidden
  262.         case 403:
  263.             return Guacamole.Status.Code.CLIENT_FORBIDDEN;
  265.         // HTTP 404 - Resource not found
  266.         case 404:
  267.             return Guacamole.Status.Code.RESOURCE_NOT_FOUND;
  269.         // HTTP 429 - Too many requests
  270.         case 429:
  271.             return Guacamole.Status.Code.CLIENT_TOO_MANY;
  273.         // HTTP 503 - Server unavailable
  274.         case 503:
  275.             return Guacamole.Status.Code.SERVER_BUSY;
  277.     }
  279.     // Default all other codes to generic internal error
  280.     return Guacamole.Status.Code.SERVER_ERROR;
  282. };
  284. /**
  285.  * Returns the Guacamole protocol status code which most closely
  286.  * represents the given WebSocket status code.
  287.  *
  288.  * @param {!number} code
  289.  *     The WebSocket status code to translate into a Guacamole protocol
  290.  *     status code.
  291.  *
  292.  * @returns {!number}
  293.  *     The Guacamole protocol status code which most closely represents the
  294.  *     given WebSocket status code.
  295.  */
  296. Guacamole.Status.Code.fromWebSocketCode = function fromWebSocketCode(code) {
  298.     // Translate status codes with known equivalents
  299.     switch (code) {
  301.         // Successful disconnect (no error)
  302.         case 1000: // Normal Closure
  303.             return Guacamole.Status.Code.SUCCESS;
  305.         // Codes which indicate the server is not reachable
  306.         case 1006: // Abnormal Closure (also signalled by JavaScript when the connection cannot be opened in the first place)
  307.         case 1015: // TLS Handshake
  308.             return Guacamole.Status.Code.UPSTREAM_NOT_FOUND;
  310.         // Codes which indicate the server is reachable but busy/unavailable
  311.         case 1001: // Going Away
  312.         case 1012: // Service Restart
  313.         case 1013: // Try Again Later
  314.         case 1014: // Bad Gateway
  315.             return Guacamole.Status.Code.UPSTREAM_UNAVAILABLE;
  317.     }
  319.     // Default all other codes to generic internal error
  320.     return Guacamole.Status.Code.SERVER_ERROR;
  322. };