remoting/webapp/crd/js/remoting.js

   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 'use strict';
   6
   7 /** @suppress {duplicate} */
   8 var remoting = remoting || {};
   9
  10 /**
  11  * @type {base.EventSourceImpl} An event source object for handling global
  12  *    events. This is an interim hack.  Eventually, we should move
  13  *    functionalities away from the remoting namespace and into smaller objects.
  14  */
  15 remoting.testEvents;
  16
  17 /**
  18  * Initialization tasks that are common to all remoting apps.
  19  */
  20 remoting.initGlobalObjects = function() {
  21   if (base.isAppsV2()) {
  22     var htmlNode = /** @type {HTMLElement} */ (document.body.parentNode);
  23     htmlNode.classList.add('apps-v2');
  24   }
  25
  26   console.log(remoting.getExtensionInfo());
  27   l10n.localize();
  28
  29   remoting.stats = new remoting.ConnectionStats(
  30       document.getElementById('statistics'));
  31   remoting.formatIq = new remoting.FormatIq();
  32
  33   remoting.clipboard = new remoting.Clipboard();
  34   var sandbox =
  35       /** @type {HTMLIFrameElement} */ (document.getElementById('wcs-sandbox'));
  36   remoting.wcsSandbox = new remoting.WcsSandboxContainer(sandbox.contentWindow);
  37
  38   // The plugin's onFocus handler sends a paste command to |window|, because
  39   // it can't send one to the plugin element itself.
  40   window.addEventListener('paste', pluginGotPaste_, false);
  41   window.addEventListener('copy', pluginGotCopy_, false);
  42
  43   remoting.initModalDialogs();
  44
  45   remoting.testEvents = new base.EventSourceImpl();
  46   /** @enum {string} */
  47   remoting.testEvents.Names = {
  48     uiModeChanged: 'uiModeChanged'
  49   };
  50   remoting.testEvents.defineEvents(base.values(remoting.testEvents.Names));
  51 }
  52
  53 /**
  54  * Returns true if the current platform is fully supported. It's only used when
  55  * we detect that host native messaging components are not installed. In that
  56  * case the result of this function determines if the webapp should show the
  57  * controls that allow to install and enable Me2Me host.
  58  *
  59  * @return {boolean}
  60  */
  61 remoting.isMe2MeInstallable = function() {
  62   // The chromoting host is currently not installable on ChromeOS.
  63   // For Linux, we have a install package for Ubuntu but not other distros.
  64   // Since we cannot tell from javascript alone the Linux distro the client is
  65   // on, we don't show the daemon-control UI for Linux unless the host is
  66   // installed.
  67   return remoting.platformIsWindows() || remoting.platformIsMac();
  68 }
  69
  70 /**
  71  * @return {string} Information about the current extension.
  72  */
  73 remoting.getExtensionInfo = function() {
  74   var v2OrLegacy = base.isAppsV2() ? " (v2)" : " (legacy)";
  75   var manifest = chrome.runtime.getManifest();
  76   if (manifest && manifest.version) {
  77     var name = remoting.app.getApplicationName();
  78     return name + ' version: ' + manifest.version + v2OrLegacy;
  79   } else {
  80     return 'Failed to get product version. Corrupt manifest?';
  81   }
  82 };
  83
  84 /**
  85  * If an IT2Me client or host is active then prompt the user before closing.
  86  * If a Me2Me client is active then don't bother, since closing the window is
  87  * the more intuitive way to end a Me2Me session, and re-connecting is easy.
  88  */
  89 remoting.promptClose = function() {
  90   if (remoting.desktopConnectedView &&
  91       remoting.desktopConnectedView.getMode() ==
  92           remoting.DesktopConnectedView.Mode.IT2ME) {
  93     switch (remoting.currentMode) {
  94       case remoting.AppMode.CLIENT_CONNECTING:
  95       case remoting.AppMode.HOST_WAITING_FOR_CODE:
  96       case remoting.AppMode.HOST_WAITING_FOR_CONNECTION:
  97       case remoting.AppMode.HOST_SHARED:
  98       case remoting.AppMode.IN_SESSION:
  99         return chrome.i18n.getMessage(/*i18n-content*/'CLOSE_PROMPT');
 100       default:
 101         return null;
 102     }
 103   }
 104 };
 105
 106 /**
 107  * Sign the user out of Chromoting by clearing (and revoking, if possible) the
 108  * OAuth refresh token.
 109  *
 110  * Also clear all local storage, to avoid leaking information.
 111  */
 112 remoting.signOut = function() {
 113   remoting.oauth2.removeCachedAuthToken().then(function(){
 114     chrome.storage.local.clear();
 115     remoting.setMode(remoting.AppMode.HOME);
 116     window.location.reload();
 117   });
 118 };
 119
 120 /**
 121  * Callback function called when the browser window gets a paste operation.
 122  *
 123  * @param {Event} event
 124  * @return {void} Nothing.
 125  */
 126 function pluginGotPaste_(event) {
 127   if (event && event.clipboardData) {
 128     remoting.clipboard.toHost(event.clipboardData);
 129   }
 130 }
 131
 132 /**
 133  * Callback function called when the browser window gets a copy operation.
 134  *
 135  * @param {Event} event
 136  * @return {void} Nothing.
 137  */
 138 function pluginGotCopy_(event) {
 139   if (event && event.clipboardData) {
 140     if (remoting.clipboard.toOs(event.clipboardData)) {
 141       // The default action may overwrite items that we added to clipboardData.
 142       event.preventDefault();
 143     }
 144   }
 145 }
 146
 147 /**
 148  * Return the current time as a formatted string suitable for logging.
 149  *
 150  * @return {string} The current time, formatted as [mmdd/hhmmss.xyz]
 151  */
 152 remoting.timestamp = function() {
 153   /**
 154    * @param {number} num A number.
 155    * @param {number} len The required length of the answer.
 156    * @return {string} The number, formatted as a string of the specified length
 157    *     by prepending zeroes as necessary.
 158    */
 159   var pad = function(num, len) {
 160     var result = num.toString();
 161     if (result.length < len) {
 162       result = new Array(len - result.length + 1).join('0') + result;
 163     }
 164     return result;
 165   };
 166   var now = new Date();
 167   var timestamp = pad(now.getMonth() + 1, 2) + pad(now.getDate(), 2) + '/' +
 168       pad(now.getHours(), 2) + pad(now.getMinutes(), 2) +
 169       pad(now.getSeconds(), 2) + '.' + pad(now.getMilliseconds(), 3);
 170   return '[' + timestamp + ']';
 171 };
 172
 173 /**
 174  * Show an error message, optionally including a short-cut for signing in to
 175  * Chromoting again.
 176  *
 177  * @param {remoting.Error} error
 178  * @return {void} Nothing.
 179  */
 180 remoting.showErrorMessage = function(error) {
 181   l10n.localizeElementFromTag(
 182       document.getElementById('token-refresh-error-message'),
 183       error);
 184   var auth_failed = (error == remoting.Error.AUTHENTICATION_FAILED);
 185   if (base.isAppsV2()) {
 186     remoting.handleAuthFailureAndRelaunch();
 187   } else {
 188     document.getElementById('token-refresh-auth-failed').hidden = !auth_failed;
 189     document.getElementById('token-refresh-other-error').hidden = auth_failed;
 190     remoting.setMode(remoting.AppMode.TOKEN_REFRESH_FAILED);
 191   }
 192 };
 193
 194 /**
 195  * Determine whether or not the app is running in a window.
 196  * @param {function(boolean):void} callback Callback to receive whether or not
 197  *     the current tab is running in windowed mode.
 198  */
 199 function isWindowed_(callback) {
 200   /** @param {chrome.Window} win The current window. */
 201   var windowCallback = function(win) {
 202     callback(win.type == 'popup');
 203   };
 204   /** @param {chrome.Tab} tab The current tab. */
 205   var tabCallback = function(tab) {
 206     if (tab.pinned) {
 207       callback(false);
 208     } else {
 209       chrome.windows.get(tab.windowId, null, windowCallback);
 210     }
 211   };
 212   if (chrome.tabs) {
 213     chrome.tabs.getCurrent(tabCallback);
 214   } else {
 215     console.error('chome.tabs is not available.');
 216   }
 217 }