remoting/webapp/base/js/host.js

// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * @fileoverview
 * The deserialized form of the chromoting host as returned by Apiary.
 */

'use strict';

/** @suppress {duplicate} */
var remoting = remoting || {};

(function() {

'use strict';

/**
 * @param {!string} hostId
 *
 * TODO(kelvinp):Make fields private and expose them via getters.
 * @constructor
 */
remoting.Host = function(hostId) {
  /** @const {string} */
  this.hostId = hostId;
  /** @type {string} */
  this.hostName = '';
  /**
   * Either 'ONLINE' or 'OFFLINE'.
   * @type {string}
   */
  this.status = '';
  /** @type {string} */
  this.jabberId = '';
  /** @type {string} */
  this.publicKey = '';
  /** @type {string} */
  this.hostVersion = '';
  /** @type {remoting.ChromotingEvent.Os} */
  this.hostOs = remoting.ChromotingEvent.Os.OTHER;
  /** @type {string} */
  this.hostOsVersion = '';
  /** @type {Array<string>} */
  this.tokenUrlPatterns = [];
  /** @type {string} */
  this.updatedTime = '';
  /** @type {string} */
  this.hostOfflineReason = '';
  /** @type {remoting.HostOptions} */
  this.options = new remoting.HostOptions(hostId);
};

/**
 * Create a typed Host instance from an untyped Object.
 *
 * @param {Object} object
 * @return {remoting.Host}
 */
remoting.Host.fromObject = function(object) {
  try {
    var result = new remoting.Host(base.assertString(object.hostId));
    result.hostName = base.assertString(object.hostName);
    result.status = base.assertString(object.status);
    result.jabberId = base.assertString(object.jabberId);
    result.publicKey = base.assertString(object.publicKey);
    result.hostVersion = base.assertString(object.hostVersion);
    result.hostOs = base.assertNumber(object.hostOs);
    result.hostOsVersion = base.assertString(object.hostOsVersion);
    result.tokenUrlPatterns = base.assertArray(object.tokenUrlPatterns);
    result.updatedTime = base.assertString(object.updatedTime);
    result.hostOfflineReason = base.assertString(object.hostOfflineReason);
    result.options = remoting.HostOptions.fromObject(
        base.assertObject(object.options), base.assertString(object.hostId));
    return result;
  } catch (e) {
    console.error(e);
    return null;
  }
};

/**
 * Determine whether a host needs to be manually updated. This is the case if
 * the host's major version number is more than 2 lower than that of the web-
 * app (a difference of 2 is tolerated due to the different update mechanisms
 * and to handle cases where we may skip releasing a version) and if the host is
 * on-line (off-line hosts are not expected to auto-update).
 *
 * @param {remoting.Host} host The host information from the directory.
 * @param {string|number} webappVersion The version number of the web-app, in
 *     either dotted-decimal notation notation, or directly represented by the
 *     major version.
 * @return {boolean} True if the host is on-line but out-of-date.
 */
remoting.Host.needsUpdate = function(host, webappVersion) {
  if (host.status != 'ONLINE') {
    return false;
  }
  var hostMajorVersion = parseInt(host.hostVersion, 10);
  if (isNaN(hostMajorVersion)) {
    // Host versions 26 and higher include the version number in heartbeats,
    // so if it's missing then the host is at most version 25.
    hostMajorVersion = 25;
  }
  return (parseInt(webappVersion, 10) - hostMajorVersion) > 2;
};

})();