remoting/webapp/base/js/host.js

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview
   7  * The deserialized form of the chromoting host as returned by Apiary.
   8  */
   9
  10 'use strict';
  11
  12 /** @suppress {duplicate} */
  13 var remoting = remoting || {};
  14
  15 (function() {
  16
  17 'use strict';
  18
  19 /**
  20  * @param {!string} hostId
  21  *
  22  * TODO(kelvinp):Make fields private and expose them via getters.
  23  * @constructor
  24  */
  25 remoting.Host = function(hostId) {
  26   /** @const {string} */
  27   this.hostId = hostId;
  28   /** @type {string} */
  29   this.hostName = '';
  30   /**
  31    * Either 'ONLINE' or 'OFFLINE'.
  32    * @type {string}
  33    */
  34   this.status = '';
  35   /** @type {string} */
  36   this.jabberId = '';
  37   /** @type {string} */
  38   this.publicKey = '';
  39   /** @type {string} */
  40   this.hostVersion = '';
  41   /** @type {Array<string>} */
  42   this.tokenUrlPatterns = [];
  43   /** @type {string} */
  44   this.updatedTime = '';
  45   /** @type {string} */
  46   this.hostOfflineReason = '';
  47
  48   /**
  49    * TODO(kelvinp): Remove this once we have migrated away from XMPP based
  50    * logging (crbug.com/523423).
  51    *
  52    * @type {string}
  53    */
  54   this.loggingChannel = '';
  55   /** @type {remoting.Host.Options} */
  56   this.options = new remoting.Host.Options(hostId);
  57 };
  58
  59 /**
  60  * @constructor
  61  * @param {!string} hostId
  62  * @struct
  63  */
  64 remoting.Host.Options = function(hostId) {
  65   /** @private @const */
  66   this.hostId_ = hostId;
  67   /** @type {boolean} */
  68   this.shrinkToFit = true;
  69   /** @type {boolean} */
  70   this.resizeToClient = true;
  71   /** @type {!Object} */
  72   this.remapKeys = {};
  73   /** @type {number} */
  74   this.desktopScale = 1;
  75   /** @type {remoting.PairingInfo} */
  76   this.pairingInfo = {clientId: '', sharedSecret: ''};
  77 };
  78
  79 remoting.Host.Options.prototype.save = function() {
  80   // TODO(kelvinp): Migrate pairingInfo to use this class as well and get rid of
  81   // remoting.HostSettings.
  82   remoting.HostSettings.save(this.hostId_, this);
  83 };
  84
  85
  86 /** @return {Promise} A promise that resolves when the settings are loaded. */
  87 remoting.Host.Options.prototype.load = function() {
  88   var that = this;
  89   return base.Promise.as(remoting.HostSettings.load, [this.hostId_]).then(
  90     /**
  91      * @param {Object<string|boolean|number|!Object>} options
  92      */
  93     function(options) {
  94       // Must be defaulted to true so that app-remoting can resize the host
  95       // upon launching.
  96       // TODO(kelvinp): Uses a separate host options for app-remoting that
  97       // hardcodes resizeToClient to true.
  98       that.resizeToClient =
  99           base.getBooleanAttr(options, 'resizeToClient', true);
 100       that.shrinkToFit = base.getBooleanAttr(options, 'shrinkToFit', true);
 101       that.desktopScale = base.getNumberAttr(options, 'desktopScale', 1);
 102       that.pairingInfo =
 103           /** @type {remoting.PairingInfo} */ (
 104               base.getObjectAttr(options, 'pairingInfo', that.pairingInfo));
 105
 106       // Load the key remappings, allowing for either old or new formats.
 107       var remappings = /** string|!Object */ (options['remapKeys']);
 108       if (typeof(remappings) === 'string') {
 109         remappings = remoting.Host.Options.convertRemapKeys(remappings);
 110       } else if (typeof(remappings) !== 'object') {
 111         remappings = {};
 112       }
 113       that.remapKeys = /** @type {!Object} */ (base.deepCopy(remappings));
 114     });
 115 };
 116
 117 /**
 118  * Convert an old-style string key remapping into a new-style dictionary one.
 119  *
 120  * @param {string} remappings
 121  * @return {!Object} The same remapping expressed as a dictionary.
 122  */
 123 remoting.Host.Options.convertRemapKeys = function(remappings) {
 124   var remappingsArr = remappings.split(',');
 125   var result = {};
 126   for (var i = 0; i < remappingsArr.length; ++i) {
 127     var keyCodes = remappingsArr[i].split('>');
 128     if (keyCodes.length != 2) {
 129       console.log('bad remapKey: ' + remappingsArr[i]);
 130       continue;
 131     }
 132     var fromKey = parseInt(keyCodes[0], 0);
 133     var toKey = parseInt(keyCodes[1], 0);
 134     if (!fromKey || !toKey) {
 135       console.log('bad remapKey code: ' + remappingsArr[i]);
 136       continue;
 137     }
 138     result[fromKey] = toKey;
 139   }
 140   return result;
 141 };
 142
 143 /**
 144  * Determine whether a host needs to be manually updated. This is the case if
 145  * the host's major version number is more than 2 lower than that of the web-
 146  * app (a difference of 2 is tolerated due to the different update mechanisms
 147  * and to handle cases where we may skip releasing a version) and if the host is
 148  * on-line (off-line hosts are not expected to auto-update).
 149  *
 150  * @param {remoting.Host} host The host information from the directory.
 151  * @param {string|number} webappVersion The version number of the web-app, in
 152  *     either dotted-decimal notation notation, or directly represented by the
 153  *     major version.
 154  * @return {boolean} True if the host is on-line but out-of-date.
 155  */
 156 remoting.Host.needsUpdate = function(host, webappVersion) {
 157   if (host.status != 'ONLINE') {
 158     return false;
 159   }
 160   var hostMajorVersion = parseInt(host.hostVersion, 10);
 161   if (isNaN(hostMajorVersion)) {
 162     // Host versions 26 and higher include the version number in heartbeats,
 163     // so if it's missing then the host is at most version 25.
 164     hostMajorVersion = 25;
 165   }
 166   return (parseInt(webappVersion, 10) - hostMajorVersion) > 2;
 167 };
 168
 169 })();