remoting/webapp/crd/js/desktop_remoting.js

   1 // Copyright 2014 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  * This class implements the functionality that is specific to desktop
   8  * remoting ("Chromoting" or CRD).
   9  */
  10
  11 'use strict';
  12
  13 /** @suppress {duplicate} */
  14 var remoting = remoting || {};
  15
  16 /**
  17  * @constructor
  18  * @implements {remoting.ApplicationInterface}
  19  * @extends {remoting.Application}
  20  */
  21 remoting.DesktopRemoting = function() {
  22   base.inherits(this, remoting.Application);
  23
  24   // Save recent errors for inclusion in user feedback.
  25   remoting.ConsoleWrapper.getInstance().activate(
  26       5,
  27       remoting.ConsoleWrapper.LogType.ERROR,
  28       remoting.ConsoleWrapper.LogType.ASSERT);
  29
  30   /** @protected {remoting.DesktopRemoting.Mode} */
  31   this.connectionMode_ = remoting.DesktopRemoting.Mode.ME2ME;
  32
  33   /** @private {remoting.Activity} */
  34   this.activity_ = null;
  35 };
  36
  37 /**
  38  * The current desktop remoting mode (IT2Me or Me2Me).
  39  *
  40  * @enum {number}
  41  */
  42 remoting.DesktopRemoting.Mode = {
  43   IT2ME: 0,
  44   ME2ME: 1
  45 };
  46
  47 /**
  48  * Get the connection mode (Me2Me or IT2Me).
  49  *
  50  * @return {remoting.DesktopRemoting.Mode}
  51  */
  52 remoting.DesktopRemoting.prototype.getConnectionMode = function() {
  53   return this.connectionMode_;
  54 };
  55
  56 /**
  57  * @return {string} Application Id.
  58  * @override {remoting.ApplicationInterface}
  59  */
  60 remoting.DesktopRemoting.prototype.getApplicationId = function() {
  61   // Application IDs are not used in desktop remoting.
  62   return '';
  63 };
  64
  65 /**
  66  * @return {string} Application product name to be used in UI.
  67  * @override {remoting.ApplicationInterface}
  68  */
  69 remoting.DesktopRemoting.prototype.getApplicationName = function() {
  70   return chrome.i18n.getMessage(/*i18n-content*/'PRODUCT_NAME');
  71 };
  72
  73 /**
  74  * @param {!remoting.Error} error The failure reason.
  75  * @override {remoting.ApplicationInterface}
  76  */
  77 remoting.DesktopRemoting.prototype.signInFailed_ = function(error) {
  78   remoting.showErrorMessage(error);
  79 };
  80
  81 /**
  82  * @override {remoting.ApplicationInterface}
  83  */
  84 remoting.DesktopRemoting.prototype.initApplication_ = function() {
  85   remoting.initElementEventHandlers();
  86
  87   if (remoting.platformIsWindows()) {
  88     document.body.classList.add('os-windows');
  89   } else if (remoting.platformIsMac()) {
  90     document.body.classList.add('os-mac');
  91   } else if (remoting.platformIsChromeOS()) {
  92     document.body.classList.add('os-chromeos');
  93   } else if (remoting.platformIsLinux()) {
  94     document.body.classList.add('os-linux');
  95   }
  96
  97   if (base.isAppsV2()) {
  98     remoting.windowFrame = new remoting.WindowFrame(
  99         document.getElementById('title-bar'), this.disconnect_.bind(this));
 100     remoting.optionsMenu = remoting.windowFrame.createOptionsMenu();
 101
 102     var START_FULLSCREEN = 'start-fullscreen';
 103     remoting.fullscreen = new remoting.FullscreenAppsV2();
 104     remoting.fullscreen.addListener(function(isFullscreen) {
 105       chrome.storage.local.set({START_FULLSCREEN: isFullscreen});
 106     });
 107     // TODO(jamiewalch): This should be handled by the background page when the
 108     // window is created, but due to crbug.com/51587 it needs to be done here.
 109     // Remove this hack once that bug is fixed.
 110     chrome.storage.local.get(
 111         START_FULLSCREEN,
 112         /** @param {Object} values */
 113         function(values) {
 114           if (values[START_FULLSCREEN]) {
 115             remoting.fullscreen.activate(true);
 116           }
 117         }
 118     );
 119
 120   } else {
 121     remoting.fullscreen = new remoting.FullscreenAppsV1();
 122     remoting.toolbar = new remoting.Toolbar(
 123         document.getElementById('session-toolbar'),
 124         this.disconnect_.bind(this));
 125     remoting.optionsMenu = remoting.toolbar.createOptionsMenu();
 126
 127     window.addEventListener('beforeunload',
 128                             this.promptClose_.bind(this), false);
 129     window.addEventListener('unload', this.disconnect_.bind(this), false);
 130   }
 131
 132   remoting.initHostlist_(this.connectMe2Me_.bind(this));
 133   document.getElementById('access-mode-button').addEventListener(
 134       'click', this.connectIt2Me_.bind(this), false);
 135
 136   remoting.manageHelpAndFeedback(
 137       document.getElementById('title-bar'));
 138
 139   remoting.showOrHideIT2MeUi();
 140   remoting.showOrHideMe2MeUi();
 141
 142   // For Apps v1, check the tab type to warn the user if they are not getting
 143   // the best keyboard experience.
 144   if (!base.isAppsV2() && !remoting.platformIsMac()) {
 145     /** @param {boolean} isWindowed */
 146     var onIsWindowed = function(isWindowed) {
 147       if (!isWindowed) {
 148         document.getElementById('startup-mode-box-me2me').hidden = false;
 149         document.getElementById('startup-mode-box-it2me').hidden = false;
 150       }
 151     };
 152     this.isWindowed_(onIsWindowed);
 153   }
 154
 155   remoting.ClientPlugin.factory.preloadPlugin();
 156 };
 157
 158 /**
 159  * @param {string} token An OAuth access token.
 160  * @override {remoting.ApplicationInterface}
 161  */
 162 remoting.DesktopRemoting.prototype.startApplication_ = function(token) {
 163   remoting.identity.getEmail().then(
 164       function(/** string */ email) {
 165         document.getElementById('current-email').innerText = email;
 166         document.getElementById('get-started-it2me').disabled = false;
 167         document.getElementById('get-started-me2me').disabled = false;
 168       });
 169 };
 170
 171 /** @override {remoting.ApplicationInterface} */
 172 remoting.DesktopRemoting.prototype.exitApplication_ = function() {
 173   this.disconnect_();
 174   this.closeMainWindow_();
 175 };
 176
 177 /**
 178  * Determine whether or not the app is running in a window.
 179  * @param {function(boolean):void} callback Callback to receive whether or not
 180  *     the current tab is running in windowed mode.
 181  * @private
 182  */
 183 remoting.DesktopRemoting.prototype.isWindowed_ = function(callback) {
 184   var windowCallback = function(/** ChromeWindow  */ win) {
 185     callback(win.type == 'popup');
 186   };
 187   /** @param {Tab=} tab */
 188   var tabCallback = function(tab) {
 189     if (tab.pinned) {
 190       callback(false);
 191     } else {
 192       chrome.windows.get(tab.windowId, null, windowCallback);
 193     }
 194   };
 195   if (chrome.tabs) {
 196     chrome.tabs.getCurrent(tabCallback);
 197   } else {
 198     console.error('chome.tabs is not available.');
 199   }
 200 }
 201
 202 /**
 203  * If an IT2Me client or host is active then prompt the user before closing.
 204  * If a Me2Me client is active then don't bother, since closing the window is
 205  * the more intuitive way to end a Me2Me session, and re-connecting is easy.
 206  * @private
 207  */
 208 remoting.DesktopRemoting.prototype.promptClose_ = function() {
 209   if (this.getConnectionMode() === remoting.DesktopRemoting.Mode.IT2ME) {
 210     switch (remoting.currentMode) {
 211       case remoting.AppMode.CLIENT_CONNECTING:
 212       case remoting.AppMode.HOST_WAITING_FOR_CODE:
 213       case remoting.AppMode.HOST_WAITING_FOR_CONNECTION:
 214       case remoting.AppMode.HOST_SHARED:
 215       case remoting.AppMode.IN_SESSION:
 216         return chrome.i18n.getMessage(/*i18n-content*/'CLOSE_PROMPT');
 217       default:
 218         return null;
 219     }
 220   }
 221 };
 222
 223 /** @returns {remoting.DesktopConnectedView} */
 224 remoting.DesktopRemoting.prototype.getConnectedViewForTesting = function() {
 225   var activity = /** @type {remoting.Me2MeActivity} */ (this.activity_);
 226   return activity.getDesktopActivity().getConnectedView();
 227 };
 228
 229 remoting.DesktopRemoting.prototype.getActivity = function() {
 230   return this.activity_;
 231 };
 232
 233 remoting.DesktopRemoting.prototype.disconnect_ = function() {
 234   if (this.activity_) {
 235     this.activity_.stop();
 236   }
 237 };
 238
 239 /**
 240  * Entry-point for Me2Me connections.
 241  *
 242  * @param {string} hostId The unique id of the host.
 243  * @return {void} Nothing.
 244  * @private
 245  */
 246 remoting.DesktopRemoting.prototype.connectMe2Me_ = function(hostId) {
 247   var host = remoting.hostList.getHostForId(hostId);
 248   base.dispose(this.activity_);
 249   this.activity_ = new remoting.Me2MeActivity(host, remoting.hostList);
 250   this.activity_.start();
 251   this.connectionMode_ = remoting.DesktopRemoting.Mode.ME2ME;
 252 };
 253
 254 /**
 255  * Entry-point for It2Me connections.
 256  *
 257  * @private
 258  */
 259 remoting.DesktopRemoting.prototype.connectIt2Me_ = function() {
 260   base.dispose(this.activity_);
 261   this.activity_ = new remoting.It2MeActivity();
 262   this.activity_.start();
 263   this.connectionMode_ = remoting.DesktopRemoting.Mode.IT2ME;
 264 };