Allow component IME extensions use app.window and add 'ime' boolean in...

Allow component IME extensions use app.window and add 'ime' boolean in CreateWindowOptions for app window

To create an IME window, an IME must be whitelisted, must have app.window.ime permission and must use set 'ime' and 'frame' this way:
chrome.app.window.create(url, {
  'ime': true,
  'frame': 'none
}, function() {})
Note only whitelisted component IME extensions can use this boolean parameter. See doc here: https://docs.google.com/a/google.com/document/d/1JQHpLu_RjN8C1Yi0i_eApS5SZtPoMDqvlq06YOwXCFU/edit

BUG=401984

Review URL: https://codereview.chromium.org/503383002

Cr-Commit-Position: refs/heads/master@{#297163}

ash/root_window_controller.cc

@@ -641,8 +641,7 @@ void RootWindowController::ActivateKeyboard(
   keyboard_controller->AddObserver(docked_layout_manager_);
   keyboard_controller->AddObserver(workspace_controller_->layout_manager());
   Shell::GetInstance()->delegate()->VirtualKeyboardActivated(true);
-  aura::Window* parent = GetContainer(
-      kShellWindowId_VirtualKeyboardParentContainer);
+  aura::Window* parent = GetContainer(kShellWindowId_ImeWindowParentContainer);
   DCHECK(parent);
   aura::Window* keyboard_container =
       keyboard_controller->GetContainerWindow();
@@ -662,8 +661,8 @@ void RootWindowController::DeactivateKeyboard(
   aura::Window* keyboard_container =
       keyboard_controller->GetContainerWindow();
   if (keyboard_container->GetRootWindow() == GetRootWindow()) {
-    aura::Window* parent = GetContainer(
-        kShellWindowId_VirtualKeyboardParentContainer);
+    aura::Window* parent =
+        GetContainer(kShellWindowId_ImeWindowParentContainer);
     DCHECK(parent);
     parent->RemoveChild(keyboard_container);
     // Virtual keyboard may be deactivated while still showing, notify all
@@ -679,8 +678,7 @@ void RootWindowController::DeactivateKeyboard(
 }
 
 bool RootWindowController::IsVirtualKeyboardWindow(aura::Window* window) {
-  aura::Window* parent = GetContainer(
-      kShellWindowId_VirtualKeyboardParentContainer);
+  aura::Window* parent = GetContainer(kShellWindowId_ImeWindowParentContainer);
   return parent ? parent->Contains(window) : false;
 }
 
@@ -1002,7 +1000,7 @@ void RootWindowController::CreateContainersInRootWindow(
   DescendantShouldStayInSameRootWindow(settings_bubble_container);
 
   aura::Window* virtual_keyboard_parent_container =
-      CreateContainer(kShellWindowId_VirtualKeyboardParentContainer,
+      CreateContainer(kShellWindowId_ImeWindowParentContainer,
                       "VirtualKeyboardParentContainer",
                       lock_screen_related_containers);
   wm::SetSnapsChildrenToPhysicalPixelBoundary(

ash/shell_unittest.cc

@@ -81,8 +81,8 @@ void ExpectAllContainers() {
       Shell::GetContainer(root_window, kShellWindowId_SettingBubbleContainer));
   EXPECT_TRUE(
       Shell::GetContainer(root_window, kShellWindowId_OverlayContainer));
-  EXPECT_TRUE(Shell::GetContainer(
-      root_window, kShellWindowId_VirtualKeyboardParentContainer));
+  EXPECT_TRUE(Shell::GetContainer(root_window,
+                                  kShellWindowId_ImeWindowParentContainer));
 #if defined(OS_CHROMEOS)
   EXPECT_TRUE(
       Shell::GetContainer(root_window, kShellWindowId_MouseCursorContainer));

ash/shell_window_ids.h

@@ -73,10 +73,10 @@ const int kShellWindowId_LockSystemModalContainer = 16;
 // The container for the status area.
 const int kShellWindowId_StatusContainer = 17;
 
-// A parent container that holds the virtual keyboard container. This is to
-// ensure that the virtual keyboard is stacked above most containers but below
-// the mouse cursor, context menus and the power off animation.
-const int kShellWindowId_VirtualKeyboardParentContainer = 18;
+// A parent container that holds the virtual keyboard container and ime windows
+// if any. This is to ensure that the virtual keyboard or ime window is stacked
+// above most containers but below the mouse cursor and the power off animation.
+const int kShellWindowId_ImeWindowParentContainer = 18;
 
 // The container for menus.
 const int kShellWindowId_MenuContainer = 19;

chrome/browser/resources/chromeos/input_method/google_xkb_manifest.json

@@ -6,6 +6,7 @@
   "incognito": "split",
   "key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC7C0oB6YTnf69uhWnVTZl5TB/psHrJXgIPLYchFb0whlVCG8fqMo9lW/oxBmZXZ3N8T7zZrdYI/SUjoc9I5R/dMVVD2q4iKox+x7xlTbqSdVeOb6b9ZVJ24pLbO1L7feSNSBgR0t61jrC2eY/gf78h7w58UEQBPFT2mUxhhwodyQIDAQAB",
   "permissions": [
+    "app.window.ime",
     "input",
     "inputMethodPrivate",
     "virtualKeyboardPrivate",

chrome/browser/resources/chromeos/input_method/xkb_manifest.json

@@ -5,6 +5,7 @@
   "description": "Chrome OS XKB",
   "default_locale": "en",
   "permissions": [
+    "app.window.ime",
     "input",
     "metricsPrivate",
     "accessibilityFeatures.read"

chrome/browser/ui/views/apps/chrome_native_app_window_views.cc

@@ -52,6 +52,10 @@
 #include "ui/aura/window_observer.h"
 #endif
 
+#if defined(OS_CHROMEOS)
+#include "ash/shell_window_ids.h"
+#endif
+
 using extensions::AppWindow;
 
 namespace {
@@ -229,6 +233,14 @@ void ChromeNativeAppWindowViews::InitializeDefaultWindow(
 #endif
 
   OnBeforeWidgetInit(&init_params, widget());
+#if defined(OS_CHROMEOS)
+  if (create_params.is_ime_window) {
+    // Puts ime windows into ime window container.
+    init_params.parent =
+        ash::Shell::GetContainer(ash::Shell::GetPrimaryRootWindow(),
+                                 ash::kShellWindowId_ImeWindowParentContainer);
+  }
+#endif
   widget()->Init(init_params);
 
   // The frame insets are required to resolve the bounds specifications
@@ -257,6 +269,11 @@ void ChromeNativeAppWindowViews::InitializeDefaultWindow(
     wm::SetShadowType(widget()->GetNativeWindow(), wm::SHADOW_TYPE_NONE);
   }
 
+#if defined(OS_CHROMEOS)
+  if (create_params.is_ime_window)
+    return;
+#endif
+
   // Register accelarators supported by app windows.
   // TODO(jeremya/stevenjb): should these be registered for panels too?
   views::FocusManager* focus_manager = GetFocusManager();

chrome/common/extensions/api/_api_features.json

@@ -42,7 +42,9 @@
     "blacklist": [
       "2FC374607C2DF285634B67C64A2E356C607091C3",  // Quickoffice
       "3727DD3E564B6055387425027AD74C58784ACC15",  // Quickoffice internal
-      "12E618C3C6E97495AAECF2AC12DEB082353241C6"   // QO component extension
+      "12E618C3C6E97495AAECF2AC12DEB082353241C6",  // QO component extension
+      "06BE211D5F014BAB34BC22D9DDA09C63A81D828E",  // Official xkb extension
+      "F94EE6AB36D6C6588670B2B01EB65212D9C64E33"   // Open source xkb extension
     ],
     "channel": "stable",
     "extension_types": ["hosted_app", "extension", "legacy_packaged_app"],

chrome/common/extensions/permissions/permission_set_unittest.cc

@@ -655,6 +655,7 @@ TEST(PermissionsTest, PermissionMessages) {
   skip.insert(APIPermission::kFullscreen);
   skip.insert(APIPermission::kGcm);
   skip.insert(APIPermission::kIdle);
+  skip.insert(APIPermission::kImeWindowEnabled);
   skip.insert(APIPermission::kIdltest);
   skip.insert(APIPermission::kLogPrivate);
   skip.insert(APIPermission::kNotifications);

chrome/test/data/extensions/platform_apps/windows_api_ime/has_permissions_platform_app/background.js

+// Copyright 2014 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.
+
+var error = "The \"ime\" option is not supported for platform app.";
+
+function testImeEnabled(setOption, opt_setValue) {
+  var createOptions = { frame: 'none' };
+  if (setOption) {
+    createOptions.ime = opt_setValue;
+    chrome.app.window.create('index.html',
+                             createOptions,
+                             chrome.test.callbackFail(error));
+  } else {
+    chrome.app.window.create('index.html',
+                             createOptions,
+                             chrome.test.callbackPass(function(win){
+    }));
+  }
+}
+
+// All these tests are run with app.window.ime permission set and on a system
+// with ime window support.
+chrome.app.runtime.onLaunched.addListener(function() {
+  chrome.test.runTests([
+    // Window is created with ime explicitly set by platform app.
+    // Expect fail.
+    function testImeEnabledPermissionWithPlatformApp() {
+      testImeEnabled(true, true);
+      testImeEnabled(true, false);
+    },
+
+    // Window is created with ime not explicitly set.
+    // Expect pass.
+    function testImeEnabledPermissionImeNoInit() {
+      testImeEnabled(false);
+    }
+  ]);
+});

chrome/test/data/extensions/platform_apps/windows_api_ime/has_permissions_platform_app/index.html

+<!-- empty -->

chrome/test/data/extensions/platform_apps/windows_api_ime/has_permissions_platform_app/manifest.json

+{
+  "name": "Windows API - ime (Has Permissions)",
+  "version": "1",
+  "manifest_version": 2,
+  "app": {
+    "background": {
+      "scripts": ["background.js"]
+    }
+  },
+  "permissions": ["app.window.ime"]
+}

chrome/test/data/extensions/platform_apps/windows_api_ime/has_permissions_whitelisted/background.js

+// Copyright 2014 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.
+
+var error = "IME extensions must create window with \"ime: true\" and " +
+"\"frame: 'none'\".";
+
+function testImeEnabled(createOptions) {
+  if (createOptions.frame == 'none' && createOptions.ime) {
+    chrome.app.window.create('index.html',
+                             createOptions,
+                             chrome.test.callbackPass(function(win) {}));
+  } else {
+    chrome.app.window.create('index.html',
+                             createOptions,
+                             chrome.test.callbackFail(error));
+  }
+}
+
+// All these tests are run with app.window.ime permission set and on a system
+// with ime window support.
+chrome.test.runTests([
+
+  // Window is created with ime set to true and frame set to none.
+  // Expect pass.
+  function testImeEnabledPermissionImeTrueFrameNone() {
+    testImeEnabled({ ime: true, frame: 'none' });
+  },
+
+  // Window is created with ime set to false or frame not set.
+  // Expect fail.
+  function testImeEnabledPermissionImeInitFalse() {
+    testImeEnabled({ ime: false, frame: 'none' });
+    testImeEnabled({ ime: false });
+    testImeEnabled({ ime: true });
+  },
+
+  // Window is created with ime not explicitly set.
+  // Expect fail.
+  function testImeEnabledPermissonImeNoInit() {
+    testImeEnabled({ frame: 'none' });
+    testImeEnabled({});
+  }
+
+]);

chrome/test/data/extensions/platform_apps/windows_api_ime/has_permissions_whitelisted/index.html

+<!-- empty -->

chrome/test/data/extensions/platform_apps/windows_api_ime/has_permissions_whitelisted/manifest.json

+{
+  "name": "Windows API - ime (Has Permissions)",
+  "key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC7C0oB6YTnf69uhWnVTZl5TB/psHrJXgIPLYchFb0whlVCG8fqMo9lW/oxBmZXZ3N8T7zZrdYI/SUjoc9I5R/dMVVD2q4iKox+x7xlTbqSdVeOb6b9ZVJ24pLbO1L7feSNSBgR0t61jrC2eY/gf78h7w58UEQBPFT2mUxhhwodyQIDAQAB",
+  "version": "1",
+  "manifest_version": 2,
+  "background": {
+    "scripts": ["background.js"]
+  },
+  "permissions": ["app.window.ime"]
+}

chrome/test/data/extensions/platform_apps/windows_api_ime/no_permissions_platform_app/background.js

+// Copyright 2014 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.
+
+var error = "The \"ime\" option is not supported for platform app.";
+
+function testImeEnabled(setOption, opt_setValue) {
+  var createOptions = { frame: 'none' };
+  if (setOption) {
+    createOptions.ime = opt_setValue;
+    chrome.app.window.create('index.html',
+                             createOptions,
+                             chrome.test.callbackFail(error));
+  } else {
+    chrome.app.window.create('index.html',
+                             createOptions,
+                             chrome.test.callbackPass(function(win){}));
+  }
+}
+
+// All these tests are run without app.window.ime permission set and on a system
+// with ime window support.
+chrome.app.runtime.onLaunched.addListener(function() {
+  chrome.test.runTests([
+    // Window is created with ime explicitly set by platform app.
+    // Expect fail.
+    function testImeNoPermissionImeInitTrue() {
+      testImeEnabled(true, true);
+      testImeEnabled(true, false);
+    },
+
+    // Window is created with ime not explicitly set.
+    function testImeNoPermissionImeNoInit() {
+      testImeEnabled(false);
+    }
+  ]);
+});

chrome/test/data/extensions/platform_apps/windows_api_ime/no_permissions_platform_app/index.html

+<!-- empty -->

chrome/test/data/extensions/platform_apps/windows_api_ime/no_permissions_platform_app/manifest.json

+{
+  "name": "Windows API - ime (Has Permissions)",
+  "version": "1",
+  "manifest_version": 2,
+  "app": {
+    "background": {
+      "scripts": ["background.js"]
+    }
+  }
+}

chrome/test/data/extensions/platform_apps/windows_api_ime/no_permissions_whitelisted/background.js

+// Copyright 2014 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.
+
+var error =
+    "Extensions require the \"app.window.ime\" permission to create windows.";
+
+function testImeEnabled(imeValue) {
+  var createOptions = { frame: 'none' };
+  createOptions.ime = imeValue;
+
+  chrome.app.window.create('index.html',
+                           createOptions,
+                           chrome.test.callbackFail(error));
+}
+
+// All these tests are run without app.window.ime permission set and on a system
+// with ime window support.
+chrome.test.runTests([
+
+  // Window is created with ime set to true.
+  // Expect fail.
+  function testImeNoPermissionImeInitTrue() {
+    testImeEnabled(true);
+  },
+
+  // Window is created with ime set to false.
+  // Expect fail.
+  function testImeNoPermissionImeInitFalse() {
+    testImeEnabled(false);
+  }
+
+]);

chrome/test/data/extensions/platform_apps/windows_api_ime/no_permissions_whitelisted/index.html

+<!-- empty -->

chrome/test/data/extensions/platform_apps/windows_api_ime/no_permissions_whitelisted/manifest.json

+{
+  "name": "Windows API - ime (Has Permissions)",
+  "key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC7C0oB6YTnf69uhWnVTZl5TB/psHrJXgIPLYchFb0whlVCG8fqMo9lW/oxBmZXZ3N8T7zZrdYI/SUjoc9I5R/dMVVD2q4iKox+x7xlTbqSdVeOb6b9ZVJ24pLbO1L7feSNSBgR0t61jrC2eY/gf78h7w58UEQBPFT2mUxhhwodyQIDAQAB",
+  "version": "1",
+  "manifest_version": 2,
+  "background": {
+    "scripts": ["background.js"]
+  }
+}

extensions/browser/api/app_window/app_window_api.cc

@@ -24,6 +24,7 @@
 #include "extensions/browser/image_util.h"
 #include "extensions/common/api/app_window.h"
 #include "extensions/common/features/simple_feature.h"
+#include "extensions/common/manifest.h"
 #include "extensions/common/permissions/permissions_data.h"
 #include "extensions/common/switches.h"
 #include "third_party/skia/include/core/SkColor.h"
@@ -58,6 +59,18 @@ const char kAlphaEnabledNeedsFrameNone[] =
     "The alphaEnabled option can only be used with \"frame: 'none'\".";
 const char kVisibleOnAllWorkspacesWrongChannel[] =
     "The visibleOnAllWorkspaces option requires dev channel or newer.";
+const char kImeWindowMissingPermission[] =
+    "Extensions require the \"app.window.ime\" permission to create windows.";
+const char kImeOptionIsNotSupported[] =
+    "The \"ime\" option is not supported for platform app.";
+#if !defined(OS_CHROMEOS)
+const char kImeWindowUnsupportedPlatform[] =
+    "The \"ime\" option can only be used on ChromeOS.";
+#else
+const char kImeOptionMustBeTrueAndNeedsFrameNone[] =
+    "IME extensions must create window with \"ime: true\" and "
+    "\"frame: 'none'\".";
+#endif
 }  // namespace app_window_constants
 
 const char kNoneFrameOption[] = "none";
@@ -204,6 +217,35 @@ bool AppWindowCreateFunction::RunAsync() {
     if (!GetFrameOptions(*options, &create_params))
       return false;
 
+    if (extension()->GetType() == extensions::Manifest::TYPE_EXTENSION) {
+      // Whitelisted IME extensions are allowed to use this API to create IME
+      // specific windows to show accented characters or suggestions.
+      if (!extension()->permissions_data()->HasAPIPermission(
+              APIPermission::kImeWindowEnabled)) {
+        error_ = app_window_constants::kImeWindowMissingPermission;
+        return false;
+      }
+
+#if !defined(OS_CHROMEOS)
+      // IME window is only supported on ChromeOS.
+      error_ = app_window_constants::kImeWindowUnsupportedPlatform;
+      return false;
+#else
+      // IME extensions must create window with "ime: true" and "frame: none".
+      if (!options->ime.get() || !*options->ime.get() ||
+          create_params.frame != AppWindow::FRAME_NONE) {
+        error_ = app_window_constants::kImeOptionMustBeTrueAndNeedsFrameNone;
+        return false;
+      }
+      create_params.is_ime_window = true;
+#endif  // OS_CHROMEOS
+    } else {
+      if (options->ime.get()) {
+        error_ = app_window_constants::kImeOptionIsNotSupported;
+        return false;
+      }
+    }
+
     if (options->alpha_enabled.get()) {
       const char* whitelist[] = {
 #if defined(OS_CHROMEOS)

extensions/browser/api/app_window/app_window_apitest.cc

@@ -168,4 +168,29 @@ IN_PROC_BROWSER_TEST_F(PlatformAppBrowserTest,
       << message_;
 }
 
+#if defined(OS_CHROMEOS)
+IN_PROC_BROWSER_TEST_F(PlatformAppBrowserTest,
+                       WindowsApiImeWindowHasPermissions) {
+  EXPECT_TRUE(RunComponentExtensionTest(
+      "platform_apps/windows_api_ime/has_permissions_whitelisted"))
+      << message_;
+
+  EXPECT_TRUE(RunPlatformAppTestWithFlags(
+      "platform_apps/windows_api_ime/has_permissions_platform_app",
+      kFlagIgnoreManifestWarnings))
+      << message_;
+}
+
+IN_PROC_BROWSER_TEST_F(PlatformAppBrowserTest,
+                       WindowsApiImeWindowNoPermissions) {
+  EXPECT_TRUE(RunComponentExtensionTest(
+      "platform_apps/windows_api_ime/no_permissions_whitelisted"))
+      << message_;
+
+  EXPECT_TRUE(RunPlatformAppTest(
+      "platform_apps/windows_api_ime/no_permissions_platform_app"))
+      << message_;
+}
+#endif  // OS_CHROMEOS
+
 }  // namespace extensions

extensions/browser/app_window/app_window.cc

@@ -152,6 +152,7 @@ AppWindow::CreateParams::CreateParams()
       active_frame_color(SK_ColorBLACK),
       inactive_frame_color(SK_ColorBLACK),
       alpha_enabled(false),
+      is_ime_window(false),
       creator_process_id(0),
       state(ui::SHOW_STATE_DEFAULT),
       hidden(false),

extensions/browser/app_window/app_window.h

@@ -150,6 +150,7 @@ class AppWindow : public content::WebContentsDelegate,
     SkColor active_frame_color;
     SkColor inactive_frame_color;
     bool alpha_enabled;
+    bool is_ime_window;
 
     // The initial content/inner bounds specification (excluding any window
     // decorations).

extensions/common/api/_api_features.json

@@ -36,15 +36,29 @@
       "12E618C3C6E97495AAECF2AC12DEB082353241C6"   // QO component extension
     ]
   }],
-  "app.window": {
+  "app.window": [{
     "channel": "stable",
     "contexts": ["blessed_extension"],
     "extension_types": ["platform_app"],
     "noparent": true
-  },
-  "app.window.canSetVisibleOnAllWorkspaces": {
+  }, {
+    "channel": "stable",
+    "contexts": ["blessed_extension"],
+    "extension_types": ["extension"],
+    "noparent": true,
+    "component_extensions_auto_granted": false,
+    "whitelist": [
+      "06BE211D5F014BAB34BC22D9DDA09C63A81D828E",  // Official xkb extension
+      "F94EE6AB36D6C6588670B2B01EB65212D9C64E33"   // Open source xkb extension
+    ]
+  }],
+  // This does not need to be a complex feature if we could set "noparent" here.
+  // But set "noparent" makes this feature available on stable channel. The
+  // issue is tracked in crbug.com/415750.
+  "app.window.canSetVisibleOnAllWorkspaces": [{
+    "contexts": ["blessed_extension"],
     "channel": "dev"
-  },
+  }],
   "app.currentWindowInternal": {
     "noparent": true,
     "internal": true,

extensions/common/api/_permission_features.json

@@ -58,6 +58,17 @@
     "channel": "stable",
     "extension_types": ["platform_app"]
   },
+  "app.window.ime": [
+    {
+       "channel": "stable",
+       "extension_types": ["extension"],
+       "platforms": ["chromeos"],
+       "whitelist": [
+         "06BE211D5F014BAB34BC22D9DDA09C63A81D828E",
+         "F94EE6AB36D6C6588670B2B01EB65212D9C64E33"
+       ]
+    }
+  ],
   "audioCapture": [
     {
       "channel": "stable",

extensions/common/api/app_window.idl

@@ -215,6 +215,12 @@ namespace app.window {
     // Type of window to create.
     [nodoc] WindowType? type;
 
+    // Creates a special ime window. This window is not focusable and can be
+    // stacked above virtual keyboard window. This is restriced to component ime
+    // extensions.
+    // Requires app.window.ime API permission.
+    [nodoc] boolean? ime;
+
     // Frame type: <code>none</code> or <code>chrome</code> (defaults to
     // <code>chrome</code>). For <code>none</code>, the
     // <code>-webkit-app-region</code> CSS property can be used to apply

extensions/common/permissions/api_permission.h

@@ -113,6 +113,7 @@ class APIPermission {
     kIdentityPrivate,
     kIdltest,
     kIdle,
+    kImeWindowEnabled,
     kInfobars,
     kInput,
     kInputMethodPrivate,

extensions/common/permissions/extensions_api_permissions.cc

@@ -80,6 +80,7 @@ std::vector<APIPermissionInfo*> ExtensionsAPIPermissions::GetAllPermissions()
       {APIPermission::kWebView, "webview",
        APIPermissionInfo::kFlagCannotBeOptional},
       {APIPermission::kWindowShape, "app.window.shape"},
+      {APIPermission::kImeWindowEnabled, "app.window.ime"},
   };
 
   std::vector<APIPermissionInfo*> permissions;

extensions/renderer/resources/app_window_custom_bindings.js

@@ -402,4 +402,4 @@ function updateSizeConstraints(boundsType, constraints) {
 exports.binding = appWindow.generate();
 exports.onAppWindowClosed = onAppWindowClosed;
 exports.updateAppWindowProperties = updateAppWindowProperties;
-exports.appWindowShownForTests = onAppWindowShownForTests;
+exports.appWindowShownForTests = onAppWindowShownForTests;
\ No newline at end of file