Allow component IME extension use app.window and add 'ime' window type for app window

chrome/browser/extensions/api/app_window/app_window_api.cc

 // 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.
 
 #include "chrome/browser/extensions/api/app_window/app_window_api.h"
 
 #include "base/command_line.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/time/time.h"
 #include "base/values.h"
 #include "chrome/common/extensions/api/app_window.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/url_constants.h"
 #include "extensions/browser/app_window/app_window.h"
 #include "extensions/browser/app_window/app_window_contents.h"
 #include "extensions/browser/app_window/app_window_registry.h"
 #include "extensions/browser/app_window/apps_client.h"
 #include "extensions/browser/app_window/native_app_window.h"
 #include "extensions/browser/extensions_browser_client.h"
 #include "extensions/browser/image_util.h"
+#include "extensions/common/manifest.h"
 #include "extensions/common/features/simple_feature.h"
 #include "extensions/common/permissions/permissions_data.h"
 #include "extensions/common/switches.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/base/ui_base_types.h"
 #include "ui/gfx/rect.h"
 #include "url/gurl.h"
 
 namespace app_window = extensions::api::app_window;
 namespace Create = app_window::Create;
@@ skipping 13 matching lines @@
 const char kAlwaysOnTopPermission[] =
     "The \"app.window.alwaysOnTop\" permission is required.";
 const char kInvalidUrlParameter[] =
     "The URL used for window creation must be local for security reasons.";
 const char kAlphaEnabledWrongChannel[] =
     "The alphaEnabled option requires dev channel or newer.";
 const char kAlphaEnabledMissingPermission[] =
     "The alphaEnabled option requires app.window.alpha permission.";
 const char kAlphaEnabledNeedsFrameNone[] =
     "The alphaEnabled option can only be used with \"frame: 'none'\".";
+const char kImeOptionIsRequired[] =
+    "The ime option must be set for non platform app.";
+const char kImeWindowMissingPermission[] =
+    "The ime option requires app.window.ime permission.";
+const char kImeWindowNeedsFrameNone[] =
+    "The ime option can only be used with \"frame: 'none'\".";
+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.";
+#endif
 }  // namespace app_window_constants
 
 const char kNoneFrameOption[] = "none";
   // TODO(benwells): Remove HTML titlebar injection.
 const char kHtmlFrameOption[] = "experimental-html";
 
 namespace {
 
 // If the same property is specified for the inner and outer bounds, raise an
 // error.
@@ skipping 127 matching lines @@
     if (!AppsClient::Get()->IsCurrentChannelOlderThanDev() ||
         extension()->location() == extensions::Manifest::COMPONENT) {
       if (options->type == extensions::api::app_window::WINDOW_TYPE_PANEL) {
         create_params.window_type = AppWindow::WINDOW_TYPE_PANEL;
       }
     }
 
     if (!GetFrameOptions(*options, &create_params))
       return false;
 
+    if (extension()->GetType() == extensions::Manifest::TYPE_PLATFORM_APP) {

[jackhou1, 2014/09/12 03:24:51]

Prior to this, this entire function assumed TYPE_PLATFORM_APP. It might be
clearer to check for TYPE_EXTENSION, and/or add a comment here about why the
type might be an extension.

[bshe, 2014/09/12 17:44:12]

Done.

+      if (options->ime.get()) {
+        error_ = app_window_constants::kImeOptionIsNotSupported;
+        return false;
+      }
+    } else {
+#if defined(OS_CHROMEOS)
+      if (!options->ime.get()) {

[jackhou1, 2014/09/12 03:24:51]

IIUC, extensions can only ever use chrome.app.window.create() if they are IME
extensions? If so, it might be better to order these checks like so:

1) Permission, since this identifies it as an IME extension. Since
kImeWindowMissingPermission is only shown to extensions, it could say something
like "chrome.app.window requires the app.window.ime permission".
2) Chrome OS.
3) ime: true, checking this after permission means we can give a better error
message in kImeOptionIsRequired, maybe something like "IME extensions must
create windows with \"ime: true\"."
4) frame: none.

[bshe, 2014/09/12 17:44:12]

Done.

+        error_ = app_window_constants::kImeOptionIsRequired;
+        return false;
+      }
+      if (!extension()->permissions_data()->HasAPIPermission(
+              APIPermission::kImeWindowEnabled)) {
+        error_ = app_window_constants::kImeWindowMissingPermission;
+        return false;
+      }
+      if (create_params.frame != AppWindow::FRAME_NONE) {
+        error_ = app_window_constants::kImeWindowNeedsFrameNone;
+        return false;
+      }
+      create_params.is_ime_window = *options->ime;
+#else
+     // IME window is only supported on ChromeOS.
+     error_ = app_window_constants::kImeWindowUnsupportedPlatform;
+     return false;
+#endif
+   }
+
     if (options->alpha_enabled.get()) {
       const char* whitelist[] = {
         "0F42756099D914A026DADFA182871C015735DD95",  // http://crbug.com/323773
         "2D22CDB6583FD0A13758AEBE8B15E45208B4E9A7",
         "E7E2461CE072DF036CF9592740196159E2D7C089",  // http://crbug.com/356200
         "A74A4D44C7CFCD8844830E6140C8D763E12DD8F3",
         "312745D9BF916161191143F6490085EEA0434997",
         "53041A2FA309EECED01FFC751E7399186E860B2C"
       };
       if (AppsClient::Get()->IsCurrentChannelOlderThanDev() &&
@@ skipping 272 matching lines @@
 
   if (options.frame->as_frame_options->inactive_color.get()) {
     error_ = app_window_constants::kInactiveColorWithoutColor;
     return false;
   }
 
   return true;
 }
 
 }  // namespace extensions