CRD Viewport Management refactor

remoting/webapp/crd/js/session_connector_impl.js

 // Copyright 2013 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
  * Connect set-up state machine for Me2Me and IT2Me
  */
 
 'use strict';
@@ skipping 99 matching lines @@
   // Initialize/declare per-connection state.
   this.reset();
 };
 
 /**
  * Reset the per-connection state so that the object can be re-used for a
  * second connection. Note the none of the shared WCS state is reset.
  */
 remoting.SessionConnectorImpl.prototype.reset = function() {
   /**
-   * String used to identify the host to which to connect. For IT2Me, this is
-   * the first 7 digits of the access code; for Me2Me it is the host identifier.
-   *
-   * @type {string}
-   * @private
-   */
-  this.hostId_ = '';
-
-  /**
    * For paired connections, the client id of this device, issued by the host.
    *
    * @type {string}
    * @private
    */
   this.clientPairingId_ = '';
 
   /**
    * For paired connections, the paired secret for this device, issued by the
    * host.
    *
    * @type {string}
    * @private
    */
   this.clientPairedSecret_ = '';
 
   /**
    * String used to authenticate to the host on connection. For IT2Me, this is
    * the access code; for Me2Me it is the PIN.
    *
    * @type {string}
    * @private
    */
   this.passPhrase_ = '';
 
   /**
-   * @type {string}
+   * @type {remoting.Host}
    * @private
    */
-  this.hostJid_ = '';
-
-  /**
-   * @type {string}
-   * @private
-   */
-  this.hostPublicKey_ = '';
+  this.host_ = null;
 
   /**
    * @type {boolean}
    * @private
    */
   this.logHostOfflineErrors_ = false;
 
   /**
    * @type {remoting.ClientSession}
    * @private
@@ skipping 13 matching lines @@
    */
   this.fetchPin_ = function(onPinFetched) {};
 
   /**
    * @type {function(string, string, string,
    *                 function(string, string):void): void}
    * @private
    */
   this.fetchThirdPartyToken_ = function(
       tokenUrl, scope, onThirdPartyTokenFetched) {};
-
-  /**
-   * Host 'name', as displayed in the client tool-bar. For a Me2Me connection,
-   * this is the name of the host; for an IT2Me connection, it is the email
-   * address of the person sharing their computer.
-   *
-   * @type {string}
-   * @private
-   */
-  this.hostDisplayName_ = '';
 };
 
 /**
  * Initiate a Me2Me connection.
  *
  * This doesn't report host-offline errors because the connection will
  * be retried and retryConnectMe2Me is responsible for reporting these errors.
  *
  * @param {remoting.Host} host The Me2Me host to which to connect.
  * @param {function(boolean, function(string):void):void} fetchPin Function to
  *     interactively obtain the PIN from the user.
  * @param {function(string, string, string,
  *                  function(string, string): void): void}
  *     fetchThirdPartyToken Function to obtain a token from a third party
  *     authenticaiton server.
  * @param {string} clientPairingId The client id issued by the host when
  *     this device was paired, if it is already paired.
  * @param {string} clientPairedSecret The shared secret issued by the host when
  *     this device was paired, if it is already paired.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.connectMe2Me =
     function(host, fetchPin, fetchThirdPartyToken,
              clientPairingId, clientPairedSecret) {
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.ME2ME;
   this.logHostOfflineErrors_ = false;
-  this.connectMe2MeInternal_(
-      host.hostId, host.jabberId, host.publicKey, host.hostName,
-      fetchPin, fetchThirdPartyToken,
-      clientPairingId, clientPairedSecret);
+  this.connectMe2MeInternal_(host, fetchPin, fetchThirdPartyToken,
+                             clientPairingId, clientPairedSecret);
 };
 
 /**
  * Retry connecting to a Me2Me host after a connection failure.
  *
  * This is the same as connectMe2Me except that is will log errors if the
  * host is offline.
  *
  * @param {remoting.Host} host The Me2Me host to refresh.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.retryConnectMe2Me = function(host) {
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.ME2ME;
   this.logHostOfflineErrors_ = true;
-  this.connectMe2MeInternal_(
-      host.hostId, host.jabberId, host.publicKey, host.hostName,
-      this.fetchPin_, this.fetchThirdPartyToken_,
-      this.clientPairingId_, this.clientPairedSecret_);
+  this.connectMe2MeInternal_(host, this.fetchPin_, this.fetchThirdPartyToken_,
+                             this.clientPairingId_, this.clientPairedSecret_);
 };
 
 /**
  * Initiate a Me2App connection.
  *
  * @param {remoting.Host} host The Me2Me host to which to connect.
  * @param {function(string, string, string,
  *                  function(string, string): void): void}
  *     fetchThirdPartyToken Function to obtain a token from a third party
  *     authenticaiton server.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.connectMe2App =
     function(host, fetchThirdPartyToken) {
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.APP_REMOTING;
   this.logHostOfflineErrors_ = true;
-  this.connectMe2MeInternal_(
-      host.hostId, host.jabberId, host.publicKey, host.hostName,
-      function() {}, fetchThirdPartyToken, '', '');
+  this.connectMe2MeInternal_(host, function() {}, fetchThirdPartyToken, '', '');
 };
 
 /**
  * Update the pairing info so that the reconnect function will work correctly.
  *
  * @param {string} clientId The paired client id.
  * @param {string} sharedSecret The shared secret.
  */
 remoting.SessionConnectorImpl.prototype.updatePairingInfo =
     function(clientId, sharedSecret) {
   this.clientPairingId_ = clientId;
   this.clientPairedSecret_ = sharedSecret;
 };
 
 /**
  * Initiate a Me2Me connection.
  *
- * @param {string} hostId ID of the Me2Me host.
- * @param {string} hostJid XMPP JID of the host.
- * @param {string} hostPublicKey Public Key of the host.
- * @param {string} hostDisplayName Display name (friendly name) of the host.
+ * @param {remoting.Host} host the Host to connect to.
  * @param {function(boolean, function(string):void):void} fetchPin Function to
  *     interactively obtain the PIN from the user.
  * @param {function(string, string, string,
  *                  function(string, string): void): void}
  *     fetchThirdPartyToken Function to obtain a token from a third party
  *     authenticaiton server.
  * @param {string} clientPairingId The client id issued by the host when
  *     this device was paired, if it is already paired.
  * @param {string} clientPairedSecret The shared secret issued by the host when
  *     this device was paired, if it is already paired.
  * @return {void} Nothing.
  * @private
  */
 remoting.SessionConnectorImpl.prototype.connectMe2MeInternal_ =
-    function(hostId, hostJid, hostPublicKey, hostDisplayName,
-             fetchPin, fetchThirdPartyToken,
+    function(host, fetchPin, fetchThirdPartyToken,
              clientPairingId, clientPairedSecret) {
   // Cancel any existing connect operation.
   this.cancel();
 
-  this.hostId_ = hostId;
-  this.hostJid_ = hostJid;
-  this.hostPublicKey_ = hostPublicKey;
+  this.host_ = host;
   this.fetchPin_ = fetchPin;
   this.fetchThirdPartyToken_ = fetchThirdPartyToken;
-  this.hostDisplayName_ = hostDisplayName;
   this.updatePairingInfo(clientPairingId, clientPairedSecret);
 
   this.connectSignaling_();
-}
+};
 
 /**
  * Initiate an IT2Me connection.
  *
  * @param {string} accessCode The access code as entered by the user.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.connectIT2Me = function(accessCode) {
   var kSupportIdLen = 7;
   var kHostSecretLen = 5;
   var kAccessCodeLen = kSupportIdLen + kHostSecretLen;
 
   // Cancel any existing connect operation.
   this.cancel();
 
   var normalizedAccessCode = this.normalizeAccessCode_(accessCode);
   if (normalizedAccessCode.length != kAccessCodeLen) {
     this.onError_(remoting.Error.INVALID_ACCESS_CODE);
     return;
   }
 
-  this.hostId_ = normalizedAccessCode.substring(0, kSupportIdLen);
+  var hostId = normalizedAccessCode.substring(0, kSupportIdLen);
   this.passPhrase_ = normalizedAccessCode;
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.IT2ME;
-  remoting.identity.callWithToken(this.connectIT2MeWithToken_.bind(this),
-                                  this.onError_);
+  remoting.identity.callWithToken(
+      this.connectIT2MeWithToken_.bind(this, hostId), this.onError_);
 };
 
 /**
  * Reconnect a closed connection.
  *
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.reconnect = function() {
   if (this.connectionMode_ == remoting.DesktopConnectedView.Mode.IT2ME) {
     console.error('reconnect not supported for IT2Me.');
     return;
   }
   this.logHostOfflineErrors_ = false;
-  this.connectMe2MeInternal_(
-      this.hostId_, this.hostJid_, this.hostPublicKey_, this.hostDisplayName_,
-      this.fetchPin_, this.fetchThirdPartyToken_,
-      this.clientPairingId_, this.clientPairedSecret_);
+  this.connectMe2MeInternal_(this.host_, this.fetchPin_,
+                             this.fetchThirdPartyToken_, this.clientPairingId_,
+                             this.clientPairedSecret_);
 };
 
 /**
  * Cancel a connection-in-progress.
  */
 remoting.SessionConnectorImpl.prototype.cancel = function() {
   if (this.clientSession_) {
     this.clientSession_.removePlugin();
     this.clientSession_ = null;
   }
@@ skipping 12 matching lines @@
 remoting.SessionConnectorImpl.prototype.getConnectionMode = function() {
   return this.connectionMode_;
 };
 
 /**
  * Get host ID.
  *
  * @return {string}
  */
 remoting.SessionConnectorImpl.prototype.getHostId = function() {
-  return this.hostId_;
+  return this.host_.hostId;
 };
 
 /**
  * @private
  */
 remoting.SessionConnectorImpl.prototype.connectSignaling_ = function() {
   base.dispose(this.signalStrategy_);
   this.signalStrategy_ = null;
 
   /** @type {remoting.SessionConnectorImpl} */
@@ skipping 28 matching lines @@
 };
 
 /**
  * @private
  * @param {remoting.SignalStrategy.State} state
  */
 remoting.SessionConnectorImpl.prototype.onSignalingState_ = function(state) {
   switch (state) {
     case remoting.SignalStrategy.State.CONNECTED:
       // Proceed only if the connection hasn't been canceled.
-      if (this.hostJid_) {
+      if (this.host_.jabberId) {
         this.createSession_();
       }
       break;
 
     case remoting.SignalStrategy.State.FAILED:
       this.onError_(this.signalStrategy_.getError());
       break;
   }
 };
 
 /**
  * Continue an IT2Me connection once an access token has been obtained.
  *
+ * @param {string} hostId
  * @param {string} token An OAuth2 access token.
  * @return {void} Nothing.
  * @private
  */
 remoting.SessionConnectorImpl.prototype.connectIT2MeWithToken_ =
-    function(token) {
+    function(hostId, token) {
   // Resolve the host id to get the host JID.
   this.pendingXhr_ = remoting.xhr.get(
       remoting.settings.DIRECTORY_API_BASE_URL + '/support-hosts/' +
-          encodeURIComponent(this.hostId_),
-      this.onIT2MeHostInfo_.bind(this),
+          encodeURIComponent(hostId),
+      this.onIT2MeHostInfo_.bind(this, hostId),
       '',
       { 'Authorization': 'OAuth ' + token });
 };
 
 /**
  * Continue an IT2Me connection once the host JID has been looked up.
  *
+ * @param {string} hostId
  * @param {XMLHttpRequest} xhr The server response to the support-hosts query.
  * @return {void} Nothing.
  * @private
  */
-remoting.SessionConnectorImpl.prototype.onIT2MeHostInfo_ = function(xhr) {
+remoting.SessionConnectorImpl.prototype.onIT2MeHostInfo_ = function(hostId,
+                                                                    xhr) {
   this.pendingXhr_ = null;
   if (xhr.status == 200) {
     var host = /** @type {{data: {jabberId: string, publicKey: string}}} */
         (base.jsonParseSafe(xhr.responseText));
     if (host && host.data && host.data.jabberId && host.data.publicKey) {
-      this.hostJid_ = host.data.jabberId;
-      this.hostPublicKey_ = host.data.publicKey;
-      this.hostDisplayName_ = this.hostJid_.split('/')[0];
+      this.host_ = new remoting.Host();
+      this.host_.hostId = hostId;
+      this.host_.jabberId = host.data.jabberId;
+      this.host_.publicKey = host.data.publicKey;
+      this.host_.hostName = host.data.jabberId.split('/')[0];
       this.connectSignaling_();
       return;
     } else {
       console.error('Invalid "support-hosts" response from server.');
     }
   } else {
     this.onError_(this.translateSupportHostsError_(xhr.status));
   }
 };
 
 /**
  * Creates ClientSession object.
  */
 remoting.SessionConnectorImpl.prototype.createSession_ = function() {
   // In some circumstances, the WCS <iframe> can get reloaded, which results
   // in a new clientJid and a new callback. In this case, remove the old
   // client plugin before instantiating a new one.
   if (this.clientSession_) {
     this.clientSession_.removePlugin();
     this.clientSession_ = null;
   }
 
   var authenticationMethods =
      'third_party,spake2_pair,spake2_hmac,spake2_plain';
   this.clientSession_ = new remoting.ClientSession(
-      this.signalStrategy_, this.clientContainer_, this.hostDisplayName_,
-      this.passPhrase_, this.fetchPin_, this.fetchThirdPartyToken_,
-      authenticationMethods, this.hostId_, this.hostJid_, this.hostPublicKey_,
+      this.host_, this.signalStrategy_, this.clientContainer_, this.passPhrase_,
+      this.fetchPin_, this.fetchThirdPartyToken_, authenticationMethods,
       this.connectionMode_, this.clientPairingId_, this.clientPairedSecret_,
       this.defaultRemapKeys_);
   this.clientSession_.logHostOfflineErrors(this.logHostOfflineErrors_);
   this.clientSession_.addEventListener(
       remoting.ClientSession.Events.stateChanged,
       this.bound_.onStateChange);
   this.clientSession_.createPluginAndConnect(this.onExtensionMessage_,
                                              this.requiredCapabilities_);
 };
 
@@ skipping 122 matching lines @@
  */
 remoting.DefaultSessionConnectorFactory.prototype.createConnector =
     function(clientContainer, onConnected, onError, onExtensionMessage,
              onConnectionFailed, requiredCapabilities, defaultRemapKeys) {
   return new remoting.SessionConnectorImpl(clientContainer, onConnected,
                                            onError, onExtensionMessage,
                                            onConnectionFailed,
                                            requiredCapabilities,
                                            defaultRemapKeys);
 };