CastExtensionHandler for Chromoting Webapp

remoting/webapp/client_session.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
  * Class handling creation and teardown of a remoting client session.
  *
  * The ClientSession class controls lifetime of the client plugin
  * object and provides the plugin with the functionality it needs to
@@ skipping 148 matching lines @@
   this.resizeToClientButton_ =
       document.getElementById('screen-resize-to-client');
   /** @type {HTMLElement} @private */
   this.shrinkToFitButton_ = document.getElementById('screen-shrink-to-fit');
   /** @type {HTMLElement} @private */
   this.fullScreenButton_ = document.getElementById('toggle-full-screen');
 
   /** @type {remoting.GnubbyAuthHandler} @private */
   this.gnubbyAuthHandler_ = null;
 
+  /** @type {remoting.CastExtensionHandler} @private */
+  this.castExtensionHandler_ = null;
+
   if (this.mode_ == remoting.ClientSession.Mode.IT2ME) {
     // Resize-to-client is not supported for IT2Me hosts.
     this.resizeToClientButton_.hidden = true;
   } else {
     this.resizeToClientButton_.hidden = false;
   }
 
   this.fullScreenButton_.addEventListener(
       'click', this.callToggleFullScreen_, false);
   this.defineEvents(Object.keys(remoting.ClientSession.Events));
@@ skipping 187 matching lines @@
  * Set of capabilities for which hasCapability_() can be used to test.
  *
  * @enum {string}
  */
 remoting.ClientSession.Capability = {
   // When enabled this capability causes the client to send its screen
   // resolution to the host once connection has been established. See
   // this.plugin_.notifyClientResolution().
   SEND_INITIAL_RESOLUTION: 'sendInitialResolution',
   RATE_LIMIT_RESIZE_REQUESTS: 'rateLimitResizeRequests',
-  VIDEO_RECORDER: 'videoRecorder'
+  VIDEO_RECORDER: 'videoRecorder',
+  CAST: 'casting'

[Jamie, 2014/08/13 23:21:04]

I think I would call this capability chromeCast (and CHROME_CAST), since "cast"
is a pretty generic term.

[aiguha, 2014/08/15 07:09:56]

All the Cast docs avoid using Chromecast, because they are trying to imply that
there can be multiple cast devices. Would "CAST_DESKTOP" make more sense?
Changing the actual string will again require updating the Host and Android app,
so it would make sense to do it in a follow if necessary.

[Jamie, 2014/08/15 18:45:43]

How about GOOGLE_CAST, since that's the name of the API? Leaving this for a
follow-up is fine.

 };
 
 /**
  * The set of capabilities negotiated between the client and host.
  * @type {Array.<string>}
  * @private
  */
 remoting.ClientSession.prototype.capabilities_ = null;
 
 /**
@@ skipping 193 matching lines @@
   };
 
   this.plugin_.onConnectionStatusUpdateHandler =
       this.onConnectionStatusUpdate_.bind(this);
   this.plugin_.onConnectionReadyHandler = this.onConnectionReady_.bind(this);
   this.plugin_.onDesktopSizeUpdateHandler =
       this.onDesktopSizeChanged_.bind(this);
   this.plugin_.onSetCapabilitiesHandler = this.onSetCapabilities_.bind(this);
   this.plugin_.onGnubbyAuthHandler = this.processGnubbyAuthMessage_.bind(this);
   this.plugin_.updateMouseCursorImage = this.updateMouseCursorImage_.bind(this);
+  this.plugin_.onCastExtensionHandler =
+      this.processCastExtensionMessage_.bind(this);
   this.initiateConnection_();
 };
 
 /**
  * Deletes the <embed> element from the container, without sending a
  * session_terminate request.  This is to be called when the session was
  * disconnected by the Host.
  *
  * @return {void} Nothing.
  */
@@ skipping 502 matching lines @@
       console.log('Suppressing host-offline error.');
       state = remoting.ClientSession.State.CONNECTION_CANCELED;
     }
   } else if (oldState == remoting.ClientSession.State.CONNECTED &&
              this.state_ == remoting.ClientSession.State.FAILED) {
     state = remoting.ClientSession.State.CONNECTION_DROPPED;
   }
   this.logToServer.logClientSessionStateChange(state, this.error_, this.mode_);
   if (this.state_ == remoting.ClientSession.State.CONNECTED) {
     this.createGnubbyAuthHandler_();
+    this.createCastExtensionHandler_();
   }
 
   this.raiseEvent(remoting.ClientSession.Events.stateChanged,
     new remoting.ClientSession.StateEvent(newState, oldState)
   );
 };
 
 /**
  * This is a callback that gets called when the window is resized.
  *
@@ skipping 449 matching lines @@
  * @return {{top: number, left:number}} The top-left corner of the plugin.
  */
 remoting.ClientSession.prototype.getPluginPositionForTesting = function() {
   var plugin = this.plugin_.element();
   var style = plugin.style;
   return {
     top: parseFloat(style.marginTop),
     left: parseFloat(style.marginLeft)
   };
 };
+
+/**
+ * Send a cast extension message to the host.
+ * @param {Object} data The cast message data.
+ */
+remoting.ClientSession.prototype.sendCastExtensionMessage = function(data) {
+  if (!this.plugin_)
+    return;

[Jamie, 2014/08/13 23:21:04]

Braces for single-line conditionals, for consistency.

[aiguha, 2014/08/15 07:09:56]

sendClipboardItem and sendGnubbbyAuthMessage don't have braces, which is what I
was following. WDYT?

[Jamie, 2014/08/15 18:45:43]

I didn't realize they weren't consistent. Since there are no other critical
changes for this CL, I don't think it needs to change before landing.

+  this.plugin_.sendClientMessage('cast_message', JSON.stringify(data));
+};
+
+/**
+ * Process a remote cast extension message from the host.

[Jamie, 2014/08/13 23:21:04]

s/cast/Cast/, here and below

[aiguha, 2014/08/15 07:09:56]

Done.

+ * @param {string} data Remote cast extension data message.
+ * @private
+ */
+remoting.ClientSession.prototype.processCastExtensionMessage_ = function(data) {
+  if (this.castExtensionHandler_) {
+    this.castExtensionHandler_.onMessage(data);
+  }
+};
+
+/**
+ * Create a cast extension handler and inform the host that cast extension
+ * is supported.
+ * @private
+ */
+remoting.ClientSession.prototype.createCastExtensionHandler_ = function() {
+  if(this.mode_ == remoting.ClientSession.Mode.ME2ME) {

[Jamie, 2014/08/13 23:21:04]

Why is this restricted to Me2Me?

[Jamie, 2014/08/13 23:21:04]

Nit: Space after 'if'

[aiguha, 2014/08/15 07:09:56]

Done.

[aiguha, 2014/08/15 07:09:56]

Only the remoting_me2me_host target supports the CastExtension, so I thought
this was correct.

[Jamie, 2014/08/15 18:45:43]

I didn't realize that. I think it's correct in that case, but in principle
there's no reason why the IT2Me version couldn't also support it.

+    this.castExtensionHandler_ = new remoting.CastExtensionHandler(this);
+  }
+};
+