src/remoting/host/client_session.cc

   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 #include "remoting/host/client_session.h"
   6
   7 #include <algorithm>
   8
   9 #include "base/message_loop/message_loop_proxy.h"
  10 #include "remoting/base/capabilities.h"
  11 #include "remoting/base/logging.h"
  12 #include "remoting/codec/audio_encoder.h"
  13 #include "remoting/codec/audio_encoder_opus.h"
  14 #include "remoting/codec/audio_encoder_verbatim.h"
  15 #include "remoting/codec/video_encoder.h"
  16 #include "remoting/codec/video_encoder_verbatim.h"
  17 #include "remoting/codec/video_encoder_vpx.h"
  18 #include "remoting/host/audio_capturer.h"
  19 #include "remoting/host/audio_scheduler.h"
  20 #include "remoting/host/desktop_environment.h"
  21 #include "remoting/host/input_injector.h"
  22 #include "remoting/host/screen_controls.h"
  23 #include "remoting/host/screen_resolution.h"
  24 #include "remoting/host/video_scheduler.h"
  25 #include "remoting/proto/control.pb.h"
  26 #include "remoting/proto/event.pb.h"
  27 #include "remoting/protocol/client_stub.h"
  28 #include "remoting/protocol/clipboard_thread_proxy.h"
  29 #include "remoting/protocol/pairing_registry.h"
  30 #include "third_party/webrtc/modules/desktop_capture/screen_capturer.h"
  31
  32 // Default DPI to assume for old clients that use notifyClientDimensions.
  33 const int kDefaultDPI = 96;
  34
  35 namespace remoting {
  36
  37 ClientSession::ClientSession(
  38     EventHandler* event_handler,
  39     scoped_refptr<base::SingleThreadTaskRunner> audio_task_runner,
  40     scoped_refptr<base::SingleThreadTaskRunner> input_task_runner,
  41     scoped_refptr<base::SingleThreadTaskRunner> video_capture_task_runner,
  42     scoped_refptr<base::SingleThreadTaskRunner> video_encode_task_runner,
  43     scoped_refptr<base::SingleThreadTaskRunner> network_task_runner,
  44     scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
  45     scoped_ptr<protocol::ConnectionToClient> connection,
  46     DesktopEnvironmentFactory* desktop_environment_factory,
  47     const base::TimeDelta& max_duration,
  48     scoped_refptr<protocol::PairingRegistry> pairing_registry)
  49     : event_handler_(event_handler),
  50       connection_(connection.Pass()),
  51       client_jid_(connection_->session()->jid()),
  52       control_factory_(this),
  53       desktop_environment_factory_(desktop_environment_factory),
  54       input_tracker_(&host_input_filter_),
  55       remote_input_filter_(&input_tracker_),
  56       mouse_clamping_filter_(&remote_input_filter_),
  57       disable_input_filter_(mouse_clamping_filter_.input_filter()),
  58       disable_clipboard_filter_(clipboard_echo_filter_.host_filter()),
  59       auth_input_filter_(&disable_input_filter_),
  60       auth_clipboard_filter_(&disable_clipboard_filter_),
  61       client_clipboard_factory_(clipboard_echo_filter_.client_filter()),
  62       max_duration_(max_duration),
  63       audio_task_runner_(audio_task_runner),
  64       input_task_runner_(input_task_runner),
  65       video_capture_task_runner_(video_capture_task_runner),
  66       video_encode_task_runner_(video_encode_task_runner),
  67       network_task_runner_(network_task_runner),
  68       ui_task_runner_(ui_task_runner),
  69       pairing_registry_(pairing_registry) {
  70   connection_->SetEventHandler(this);
  71
  72   // TODO(sergeyu): Currently ConnectionToClient expects stubs to be
  73   // set before channels are connected. Make it possible to set stubs
  74   // later and set them only when connection is authenticated.
  75   connection_->set_clipboard_stub(&auth_clipboard_filter_);
  76   connection_->set_host_stub(this);
  77   connection_->set_input_stub(&auth_input_filter_);
  78
  79   // |auth_*_filter_|'s states reflect whether the session is authenticated.
  80   auth_input_filter_.set_enabled(false);
  81   auth_clipboard_filter_.set_enabled(false);
  82
  83 #if defined(OS_WIN)
  84   // LocalInputMonitorWin filters out an echo of the injected input before it
  85   // reaches |remote_input_filter_|.
  86   remote_input_filter_.SetExpectLocalEcho(false);
  87 #endif  // defined(OS_WIN)
  88 }
  89
  90 ClientSession::~ClientSession() {
  91   DCHECK(CalledOnValidThread());
  92   DCHECK(!audio_scheduler_.get());
  93   DCHECK(!desktop_environment_);
  94   DCHECK(!input_injector_);
  95   DCHECK(!screen_controls_);
  96   DCHECK(!video_scheduler_.get());
  97
  98   connection_.reset();
  99 }
 100
 101 void ClientSession::NotifyClientResolution(
 102     const protocol::ClientResolution& resolution) {
 103   DCHECK(CalledOnValidThread());
 104
 105   // TODO(sergeyu): Move these checks to protocol layer.
 106   if (!resolution.has_dips_width() || !resolution.has_dips_height() ||
 107       resolution.dips_width() < 0 || resolution.dips_height() < 0 ||
 108       resolution.width() <= 0 || resolution.height() <= 0) {
 109     LOG(ERROR) << "Received invalid ClientResolution message.";
 110     return;
 111   }
 112
 113   VLOG(1) << "Received ClientResolution (dips_width="
 114           << resolution.dips_width() << ", dips_height="
 115           << resolution.dips_height() << ")";
 116
 117   if (!screen_controls_)
 118     return;
 119
 120   ScreenResolution client_resolution(
 121       webrtc::DesktopSize(resolution.dips_width(), resolution.dips_height()),
 122       webrtc::DesktopVector(kDefaultDPI, kDefaultDPI));
 123
 124   // Try to match the client's resolution.
 125   screen_controls_->SetScreenResolution(client_resolution);
 126 }
 127
 128 void ClientSession::ControlVideo(const protocol::VideoControl& video_control) {
 129   DCHECK(CalledOnValidThread());
 130
 131   if (video_control.has_enable()) {
 132     VLOG(1) << "Received VideoControl (enable="
 133             << video_control.enable() << ")";
 134     video_scheduler_->Pause(!video_control.enable());
 135   }
 136 }
 137
 138 void ClientSession::ControlAudio(const protocol::AudioControl& audio_control) {
 139   DCHECK(CalledOnValidThread());
 140
 141   if (audio_control.has_enable()) {
 142     VLOG(1) << "Received AudioControl (enable="
 143             << audio_control.enable() << ")";
 144     if (audio_scheduler_.get())
 145       audio_scheduler_->Pause(!audio_control.enable());
 146   }
 147 }
 148
 149 void ClientSession::SetCapabilities(
 150     const protocol::Capabilities& capabilities) {
 151   DCHECK(CalledOnValidThread());
 152
 153   // The client should not send protocol::Capabilities if it is not supported by
 154   // the config channel.
 155   if (!connection_->session()->config().SupportsCapabilities()) {
 156     LOG(ERROR) << "Unexpected protocol::Capabilities has been received.";
 157     return;
 158   }
 159
 160   // Ignore all the messages but the 1st one.
 161   if (client_capabilities_) {
 162     LOG(WARNING) << "protocol::Capabilities has been received already.";
 163     return;
 164   }
 165
 166   client_capabilities_ = make_scoped_ptr(new std::string());
 167   if (capabilities.has_capabilities())
 168     *client_capabilities_ = capabilities.capabilities();
 169
 170   VLOG(1) << "Client capabilities: " << *client_capabilities_;
 171
 172   // Calculate the set of capabilities enabled by both client and host and
 173   // pass it to the desktop environment if it is available.
 174   desktop_environment_->SetCapabilities(
 175       IntersectCapabilities(*client_capabilities_, host_capabilities_));
 176 }
 177
 178 void ClientSession::RequestPairing(
 179     const protocol::PairingRequest& pairing_request) {
 180   if (pairing_registry_ && pairing_request.has_client_name()) {
 181     protocol::PairingRegistry::Pairing pairing =
 182         pairing_registry_->CreatePairing(pairing_request.client_name());
 183     protocol::PairingResponse pairing_response;
 184     pairing_response.set_client_id(pairing.client_id());
 185     pairing_response.set_shared_secret(pairing.shared_secret());
 186     connection_->client_stub()->SetPairingResponse(pairing_response);
 187   }
 188 }
 189
 190 void ClientSession::DeliverClientMessage(
 191     const protocol::ExtensionMessage& message) {
 192   if (message.has_type()) {
 193     if (message.type() == "test-echo") {
 194       protocol::ExtensionMessage reply;
 195       reply.set_type("test-echo-reply");
 196       if (message.has_data())
 197         reply.set_data(message.data().substr(0, 16));
 198       connection_->client_stub()->DeliverHostMessage(reply);
 199       return;
 200     } else if (message.type() == "gnubby-auth") {
 201       if (gnubby_auth_handler_) {
 202         gnubby_auth_handler_->DeliverClientMessage(message.data());
 203       } else {
 204         HOST_LOG << "gnubby auth is not enabled";
 205       }
 206       return;
 207     }
 208   }
 209   HOST_LOG << "Unexpected message received: "
 210             << message.type() << ": " << message.data();
 211 }
 212
 213 void ClientSession::OnConnectionAuthenticated(
 214     protocol::ConnectionToClient* connection) {
 215   DCHECK(CalledOnValidThread());
 216   DCHECK_EQ(connection_.get(), connection);
 217   DCHECK(!audio_scheduler_.get());
 218   DCHECK(!desktop_environment_);
 219   DCHECK(!input_injector_);
 220   DCHECK(!screen_controls_);
 221   DCHECK(!video_scheduler_.get());
 222
 223   auth_input_filter_.set_enabled(true);
 224   auth_clipboard_filter_.set_enabled(true);
 225
 226   clipboard_echo_filter_.set_client_stub(connection_->client_stub());
 227   mouse_clamping_filter_.set_video_stub(connection_->video_stub());
 228
 229   if (max_duration_ > base::TimeDelta()) {
 230     // TODO(simonmorris): Let Disconnect() tell the client that the
 231     // disconnection was caused by the session exceeding its maximum duration.
 232     max_duration_timer_.Start(FROM_HERE, max_duration_,
 233                               this, &ClientSession::DisconnectSession);
 234   }
 235
 236   // Disconnect the session if the connection was rejected by the host.
 237   if (!event_handler_->OnSessionAuthenticated(this)) {
 238     DisconnectSession();
 239     return;
 240   }
 241
 242   // Create the desktop environment. Drop the connection if it could not be
 243   // created for any reason (for instance the curtain could not initialize).
 244   desktop_environment_ =
 245       desktop_environment_factory_->Create(control_factory_.GetWeakPtr());
 246   if (!desktop_environment_) {
 247     DisconnectSession();
 248     return;
 249   }
 250
 251   host_capabilities_ = desktop_environment_->GetCapabilities();
 252
 253   // Ignore protocol::Capabilities messages from the client if it does not
 254   // support any capabilities.
 255   if (!connection_->session()->config().SupportsCapabilities()) {
 256     VLOG(1) << "The client does not support any capabilities.";
 257
 258     client_capabilities_ = make_scoped_ptr(new std::string());
 259     desktop_environment_->SetCapabilities(*client_capabilities_);
 260   }
 261
 262   // Create the object that controls the screen resolution.
 263   screen_controls_ = desktop_environment_->CreateScreenControls();
 264
 265   // Create the event executor.
 266   input_injector_ = desktop_environment_->CreateInputInjector();
 267
 268   // Connect the host clipboard and input stubs.
 269   host_input_filter_.set_input_stub(input_injector_.get());
 270   clipboard_echo_filter_.set_host_stub(input_injector_.get());
 271
 272   // Create a VideoEncoder based on the session's video channel configuration.
 273   scoped_ptr<VideoEncoder> video_encoder =
 274       CreateVideoEncoder(connection_->session()->config());
 275
 276   // Create a VideoScheduler to pump frames from the capturer to the client.
 277   video_scheduler_ = new VideoScheduler(
 278       video_capture_task_runner_,
 279       video_encode_task_runner_,
 280       network_task_runner_,
 281       desktop_environment_->CreateVideoCapturer(),
 282       video_encoder.Pass(),
 283       connection_->client_stub(),
 284       &mouse_clamping_filter_);
 285
 286   // Create an AudioScheduler if audio is enabled, to pump audio samples.
 287   if (connection_->session()->config().is_audio_enabled()) {
 288     scoped_ptr<AudioEncoder> audio_encoder =
 289         CreateAudioEncoder(connection_->session()->config());
 290     audio_scheduler_ = new AudioScheduler(
 291         audio_task_runner_,
 292         network_task_runner_,
 293         desktop_environment_->CreateAudioCapturer(),
 294         audio_encoder.Pass(),
 295         connection_->audio_stub());
 296   }
 297
 298   // Create a GnubbyAuthHandler to proxy gnubbyd messages.
 299   gnubby_auth_handler_ = desktop_environment_->CreateGnubbyAuthHandler(
 300       connection_->client_stub());
 301 }
 302
 303 void ClientSession::OnConnectionChannelsConnected(
 304     protocol::ConnectionToClient* connection) {
 305   DCHECK(CalledOnValidThread());
 306   DCHECK_EQ(connection_.get(), connection);
 307
 308   // Negotiate capabilities with the client.
 309   if (connection_->session()->config().SupportsCapabilities()) {
 310     VLOG(1) << "Host capabilities: " << host_capabilities_;
 311
 312     protocol::Capabilities capabilities;
 313     capabilities.set_capabilities(host_capabilities_);
 314     connection_->client_stub()->SetCapabilities(capabilities);
 315   }
 316
 317   // Start the event executor.
 318   input_injector_->Start(CreateClipboardProxy());
 319   SetDisableInputs(false);
 320
 321   // Start capturing the screen.
 322   video_scheduler_->Start();
 323
 324   // Start recording audio.
 325   if (connection_->session()->config().is_audio_enabled())
 326     audio_scheduler_->Start();
 327
 328   // Notify the event handler that all our channels are now connected.
 329   event_handler_->OnSessionChannelsConnected(this);
 330 }
 331
 332 void ClientSession::OnConnectionClosed(
 333     protocol::ConnectionToClient* connection,
 334     protocol::ErrorCode error) {
 335   DCHECK(CalledOnValidThread());
 336   DCHECK_EQ(connection_.get(), connection);
 337
 338   // Ignore any further callbacks.
 339   control_factory_.InvalidateWeakPtrs();
 340
 341   // If the client never authenticated then the session failed.
 342   if (!auth_input_filter_.enabled())
 343     event_handler_->OnSessionAuthenticationFailed(this);
 344
 345   // Block any further input events from the client.
 346   // TODO(wez): Fix ChromotingHost::OnSessionClosed not to check our
 347   // is_authenticated(), so that we can disable |auth_*_filter_| here.
 348   disable_input_filter_.set_enabled(false);
 349   disable_clipboard_filter_.set_enabled(false);
 350
 351   // Ensure that any pressed keys or buttons are released.
 352   input_tracker_.ReleaseAll();
 353
 354   // Stop components access the client, audio or video stubs, which are no
 355   // longer valid once ConnectionToClient calls OnConnectionClosed().
 356   if (audio_scheduler_.get()) {
 357     audio_scheduler_->Stop();
 358     audio_scheduler_ = NULL;
 359   }
 360   if (video_scheduler_.get()) {
 361     video_scheduler_->Stop();
 362     video_scheduler_ = NULL;
 363   }
 364
 365   client_clipboard_factory_.InvalidateWeakPtrs();
 366   input_injector_.reset();
 367   screen_controls_.reset();
 368   desktop_environment_.reset();
 369
 370   // Notify the ChromotingHost that this client is disconnected.
 371   // TODO(sergeyu): Log failure reason?
 372   event_handler_->OnSessionClosed(this);
 373 }
 374
 375 void ClientSession::OnSequenceNumberUpdated(
 376     protocol::ConnectionToClient* connection, int64 sequence_number) {
 377   DCHECK(CalledOnValidThread());
 378   DCHECK_EQ(connection_.get(), connection);
 379
 380   if (video_scheduler_.get())
 381     video_scheduler_->UpdateSequenceNumber(sequence_number);
 382
 383   event_handler_->OnSessionSequenceNumber(this, sequence_number);
 384 }
 385
 386 void ClientSession::OnRouteChange(
 387     protocol::ConnectionToClient* connection,
 388     const std::string& channel_name,
 389     const protocol::TransportRoute& route) {
 390   DCHECK(CalledOnValidThread());
 391   DCHECK_EQ(connection_.get(), connection);
 392   event_handler_->OnSessionRouteChange(this, channel_name, route);
 393 }
 394
 395 const std::string& ClientSession::client_jid() const {
 396   return client_jid_;
 397 }
 398
 399 void ClientSession::DisconnectSession() {
 400   DCHECK(CalledOnValidThread());
 401   DCHECK(connection_.get());
 402
 403   max_duration_timer_.Stop();
 404
 405   // This triggers OnConnectionClosed(), and the session may be destroyed
 406   // as the result, so this call must be the last in this method.
 407   connection_->Disconnect();
 408 }
 409
 410 void ClientSession::OnLocalMouseMoved(const webrtc::DesktopVector& position) {
 411   DCHECK(CalledOnValidThread());
 412   remote_input_filter_.LocalMouseMoved(position);
 413 }
 414
 415 void ClientSession::SetDisableInputs(bool disable_inputs) {
 416   DCHECK(CalledOnValidThread());
 417
 418   if (disable_inputs)
 419     input_tracker_.ReleaseAll();
 420
 421   disable_input_filter_.set_enabled(!disable_inputs);
 422   disable_clipboard_filter_.set_enabled(!disable_inputs);
 423 }
 424
 425 void ClientSession::SetGnubbyAuthHandlerForTesting(
 426     GnubbyAuthHandler* gnubby_auth_handler) {
 427   gnubby_auth_handler_.reset(gnubby_auth_handler);
 428 }
 429
 430 scoped_ptr<protocol::ClipboardStub> ClientSession::CreateClipboardProxy() {
 431   DCHECK(CalledOnValidThread());
 432
 433   return scoped_ptr<protocol::ClipboardStub>(
 434       new protocol::ClipboardThreadProxy(
 435           client_clipboard_factory_.GetWeakPtr(),
 436           base::MessageLoopProxy::current()));
 437 }
 438
 439 // TODO(sergeyu): Move this to SessionManager?
 440 // static
 441 scoped_ptr<VideoEncoder> ClientSession::CreateVideoEncoder(
 442     const protocol::SessionConfig& config) {
 443   const protocol::ChannelConfig& video_config = config.video_config();
 444
 445   if (video_config.codec == protocol::ChannelConfig::CODEC_VP8) {
 446     return remoting::VideoEncoderVpx::CreateForVP8().PassAs<VideoEncoder>();
 447   }
 448
 449   NOTREACHED();
 450   return scoped_ptr<VideoEncoder>();
 451 }
 452
 453 // static
 454 scoped_ptr<AudioEncoder> ClientSession::CreateAudioEncoder(
 455     const protocol::SessionConfig& config) {
 456   const protocol::ChannelConfig& audio_config = config.audio_config();
 457
 458   if (audio_config.codec == protocol::ChannelConfig::CODEC_VERBATIM) {
 459     return scoped_ptr<AudioEncoder>(new AudioEncoderVerbatim());
 460   } else if (audio_config.codec == protocol::ChannelConfig::CODEC_OPUS) {
 461     return scoped_ptr<AudioEncoder>(new AudioEncoderOpus());
 462   }
 463
 464   NOTREACHED();
 465   return scoped_ptr<AudioEncoder>();
 466 }
 467
 468 }  // namespace remoting