Support removing windows from locked fullscreen state

Continuation of work from crrev.com/c/723422. Previous CL enabled creation of a
locked fullscreen window, and updating a window to locked fullscreen, but it
didn't support removing locked fullscreen from a window.

Design doc @ go/locked-fullscreen-mode

Bug: chromium:755696
Change-Id: Ie9cd6c5944620d260c1f42d327af47b9ac569465
Reviewed-on: https://chromium-review.googlesource.com/769029
Commit-Queue: Ivan Šandrk <isandrk@chromium.org>
Reviewed-by: Istiaque Ahmed <lazyboy@chromium.org>
Cr-Commit-Position: refs/heads/master@{#517090}

chrome/browser/extensions/api/tabs/tabs_api.cc

@@ -254,18 +254,28 @@ bool IsValidStateForWindowsCreateFunction(
   return true;
 }
 
-bool HasLockedFullscreenPermissionIfNeeded(const Extension* extension,
-                                           windows::WindowState state) {
 #if defined(OS_CHROMEOS)
-  if (state == windows::WINDOW_STATE_LOCKED_FULLSCREEN &&
-      !extension->permissions_data()->HasAPIPermission(
-          APIPermission::kLockWindowFullscreenPrivate)) {
-    return false;
-  }
-#endif
-  return true;
+bool IsWindowTrustedPinned(ui::BaseWindow* base_window) {
+  aura::Window* window = base_window->GetNativeWindow();
+  ash::mojom::WindowPinType type = window->GetProperty(ash::kWindowPinTypeKey);
+  return type == ash::mojom::WindowPinType::TRUSTED_PINNED;
 }
 
+void SetWindowTrustedPinned(ui::BaseWindow* base_window, bool trusted_pinned) {
+  aura::Window* window = base_window->GetNativeWindow();
+  // TRUSTED_PINNED is used here because that one locks the window fullscreen
+  // without allowing the user to exit (as opposed to regular PINNED).
+  window->SetProperty(ash::kWindowPinTypeKey,
+                      trusted_pinned ? ash::mojom::WindowPinType::TRUSTED_PINNED
+                                     : ash::mojom::WindowPinType::NONE);
+}
+
+bool ExtensionHasLockedFullscreenPermission(const Extension* extension) {
+  return extension->permissions_data()->HasAPIPermission(
+      APIPermission::kLockWindowFullscreenPrivate);
+}
+#endif  // defined(OS_CHROMEOS)
+
 }  // namespace
 
 void ZoomModeToZoomSettings(ZoomController::ZoomMode zoom_mode,
@@ -580,11 +590,13 @@ ExtensionFunction::ResponseAction WindowsCreateFunction::Run() {
   }
   create_params.initial_show_state = ui::SHOW_STATE_NORMAL;
   if (create_data && create_data->state) {
-    if (!HasLockedFullscreenPermissionIfNeeded(extension(),
-                                               create_data->state)) {
+#if defined(OS_CHROMEOS)
+    if (create_data->state == windows::WINDOW_STATE_LOCKED_FULLSCREEN &&
+        !ExtensionHasLockedFullscreenPermission(extension())) {
       return RespondNow(
           Error(keys::kMissingLockWindowFullscreenPrivatePermission));
     }
+#endif
     create_params.initial_show_state =
         ConvertToWindowShowState(create_data->state);
   }
@@ -594,11 +606,7 @@ ExtensionFunction::ResponseAction WindowsCreateFunction::Run() {
 #if defined(OS_CHROMEOS)
   if (create_data &&
       create_data->state == windows::WINDOW_STATE_LOCKED_FULLSCREEN) {
-    aura::Window* window = new_window->window()->GetNativeWindow();
-    // TRUSTED_PINNED is used here because that one locks the window fullscreen
-    // without allowing the user to exit (as opposed to regular PINNED).
-    window->SetProperty(ash::kWindowPinTypeKey,
-                        ash::mojom::WindowPinType::TRUSTED_PINNED);
+    SetWindowTrustedPinned(new_window->window(), true);
   }
 #endif
 
@@ -676,11 +684,30 @@ ExtensionFunction::ResponseAction WindowsUpdateFunction::Run() {
   // state (crbug.com/703733).
   ReportRequestedWindowState(params->update_info.state);
 
-  if (!HasLockedFullscreenPermissionIfNeeded(extension(),
-                                             params->update_info.state)) {
+#if defined(OS_CHROMEOS)
+  const bool is_window_trusted_pinned =
+      IsWindowTrustedPinned(controller->window());
+  // Don't allow locked fullscreen operations on a window without the proper
+  // permission (also don't allow any operations on a locked window if the
+  // extension doesn't have the permission).
+  if ((is_window_trusted_pinned ||
+       params->update_info.state == windows::WINDOW_STATE_LOCKED_FULLSCREEN) &&
+      !ExtensionHasLockedFullscreenPermission(extension())) {
     return RespondNow(
         Error(keys::kMissingLockWindowFullscreenPrivatePermission));
   }
+  // state will be WINDOW_STATE_NONE if the state parameter wasn't passed from
+  // the JS side, and in that case we don't want to change the locked state.
+  if (is_window_trusted_pinned &&
+      params->update_info.state != windows::WINDOW_STATE_LOCKED_FULLSCREEN &&
+      params->update_info.state != windows::WINDOW_STATE_NONE) {
+    SetWindowTrustedPinned(controller->window(), false);
+  } else if (!is_window_trusted_pinned &&
+             params->update_info.state ==
+                 windows::WINDOW_STATE_LOCKED_FULLSCREEN) {
+    SetWindowTrustedPinned(controller->window(), true);
+  }
+#endif
 
   ui::WindowShowState show_state =
       ConvertToWindowShowState(params->update_info.state);
@@ -700,15 +727,6 @@ ExtensionFunction::ResponseAction WindowsUpdateFunction::Run() {
       if (controller->window()->IsMinimized() ||
           controller->window()->IsMaximized())
         controller->window()->Restore();
-#if defined(OS_CHROMEOS)
-      if (params->update_info.state ==
-          windows::WINDOW_STATE_LOCKED_FULLSCREEN) {
-        aura::Window* window = controller->window()->GetNativeWindow();
-        window->SetProperty(ash::kWindowPinTypeKey,
-                            ash::mojom::WindowPinType::TRUSTED_PINNED);
-        break;
-      }
-#endif
       controller->SetFullscreenMode(true, extension()->url());
       break;
     case ui::SHOW_STATE_NORMAL:
@@ -791,11 +809,8 @@ ExtensionFunction::ResponseAction WindowsRemoveFunction::Run() {
   }
 
 #if defined(OS_CHROMEOS)
-  aura::Window* window = controller->window()->GetNativeWindow();
-  ash::mojom::WindowPinType type = window->GetProperty(ash::kWindowPinTypeKey);
-  if (type == ash::mojom::WindowPinType::TRUSTED_PINNED &&
-      !extension()->permissions_data()->HasAPIPermission(
-          APIPermission::kLockWindowFullscreenPrivate)) {
+  if (IsWindowTrustedPinned(controller->window()) &&
+      !ExtensionHasLockedFullscreenPermission(extension())) {
     return RespondNow(
         Error(keys::kMissingLockWindowFullscreenPrivatePermission));
   }

chrome/browser/extensions/window_open_apitest.cc

@@ -387,7 +387,7 @@ IN_PROC_BROWSER_TEST_F(ExtensionBrowserTest,
 
 namespace {
 
-ash::mojom::WindowPinType GetCurrentWindowPinType() {
+aura::Window* GetCurrentWindow() {
   extensions::WindowController* controller = nullptr;
   for (auto* iter :
        extensions::WindowControllerList::GetInstance()->windows()) {
@@ -397,11 +397,19 @@ ash::mojom::WindowPinType GetCurrentWindowPinType() {
     }
   }
   EXPECT_TRUE(controller);
-  aura::Window* window = controller->window()->GetNativeWindow();
-  ash::mojom::WindowPinType type = window->GetProperty(ash::kWindowPinTypeKey);
+  return controller->window()->GetNativeWindow();
+}
+
+ash::mojom::WindowPinType GetCurrentWindowPinType() {
+  ash::mojom::WindowPinType type =
+      GetCurrentWindow()->GetProperty(ash::kWindowPinTypeKey);
   return type;
 }
 
+void SetCurrentWindowPinType(ash::mojom::WindowPinType type) {
+  GetCurrentWindow()->SetProperty(ash::kWindowPinTypeKey, type);
+}
+
 }  // namespace
 
 IN_PROC_BROWSER_TEST_F(WindowOpenApiTest, OpenLockedFullscreenWindow) {
@@ -425,6 +433,17 @@ IN_PROC_BROWSER_TEST_F(WindowOpenApiTest, UpdateWindowToLockedFullscreen) {
             GetCurrentWindowPinType());
 }
 
+IN_PROC_BROWSER_TEST_F(WindowOpenApiTest, RemoveLockedFullscreenFromWindow) {
+  SetCurrentWindowPinType(ash::mojom::WindowPinType::TRUSTED_PINNED);
+
+  ASSERT_TRUE(RunExtensionTestWithArg("locked_fullscreen/with_permission",
+                                      "removeLockedFullscreenFromWindow"))
+      << message_;
+
+  // Make sure the current window is removed from locked-fullscreen state.
+  EXPECT_EQ(ash::mojom::WindowPinType::NONE, GetCurrentWindowPinType());
+}
+
 IN_PROC_BROWSER_TEST_F(WindowOpenApiTest,
                        OpenLockedFullscreenWindowWithoutPermission) {
   ASSERT_TRUE(RunExtensionTestWithArg("locked_fullscreen/without_permission",
@@ -446,7 +465,19 @@ IN_PROC_BROWSER_TEST_F(WindowOpenApiTest,
 
   // chrome.windows.update call fails since this extension doesn't have the
   // correct permission and hence the current window has NONE as WindowPinType.
-  EXPECT_EQ(ash::mojom::WindowPinType::NONE,
+  EXPECT_EQ(ash::mojom::WindowPinType::NONE, GetCurrentWindowPinType());
+}
+
+IN_PROC_BROWSER_TEST_F(WindowOpenApiTest,
+                       RemoveLockedFullscreenFromWindowWithoutPermission) {
+  SetCurrentWindowPinType(ash::mojom::WindowPinType::TRUSTED_PINNED);
+
+  ASSERT_TRUE(RunExtensionTestWithArg("locked_fullscreen/without_permission",
+                                      "removeLockedFullscreenFromWindow"))
+      << message_;
+
+  // The current window is still locked-fullscreen.
+  EXPECT_EQ(ash::mojom::WindowPinType::TRUSTED_PINNED,
             GetCurrentWindowPinType());
 }
 #endif  // defined(OS_CHROMEOS)

chrome/test/data/extensions/api_test/locked_fullscreen/with_permission/manifest.json

@@ -3,7 +3,7 @@
   "key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAm/SnG89efu11DRvktEcYekVYV2rMCSsl2pkEODRls9nfce/TKobKSDosTnDUdoTabGe39SXpTdXIzwdBxSc8PWj0xX3O3IIwJkj2YBorI/Gs1Kxm0r+kHwEtC6mLbAntlZIJhVWEezvUABq64b0IBPF+wjZpQZvAdBAdVDJIRgMXI3EAmUJHNVf7veUlzltguNnoDeKPT1Lb4xK37L049eo/aYrinFSiWoOfpEk4gpVJMpjAMq1iyLYNLZ6MCccIhKee8dpXDCd2pQEToBEM6DPsqZAn2XBmrmaLlDntPV7N4sN9IwXOH1g91hAR0VRKWIgNpA6Fkk3P9OrtN1du6QIDAQAB",
   "version": "0.1",
   "manifest_version": 2,
-  "description": "Tests the chrome.windows.* with WindowState = locked (with permission).",
+  "description": "Tests the chrome.windows.* with WindowState = locked-fullscreen (with permission).",
   "background": {
     "scripts": ["test.js"]
   },

chrome/test/data/extensions/api_test/locked_fullscreen/with_permission/test.js

@@ -23,9 +23,19 @@ updateWindowToLockedFullscreen = function() {
   }))});
 };
 
+removeLockedFullscreenFromWindow = function() {
+  chrome.windows.getCurrent(null, function(window) {
+    chrome.windows.update(window.id, {state: 'fullscreen'},
+      chrome.test.callbackPass(function(window) {
+        chrome.test.assertEq('fullscreen', window.state);
+    }));
+  });
+};
+
 const tests = {
   openLockedFullscreenWindow: openLockedFullscreenWindow,
   updateWindowToLockedFullscreen: updateWindowToLockedFullscreen,
+  removeLockedFullscreenFromWindow: removeLockedFullscreenFromWindow,
 };
 
 window.onload = function() {

chrome/test/data/extensions/api_test/locked_fullscreen/without_permission/manifest.json

@@ -3,7 +3,7 @@
   "key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAm/SnG89efu11DRvktEcYekVYV2rMCSsl2pkEODRls9nfce/TKobKSDosTnDUdoTabGe39SXpTdXIzwdBxSc8PWj0xX3O3IIwJkj2YBorI/Gs1Kxm0r+kHwEtC6mLbAntlZIJhVWEezvUABq64b0IBPF+wjZpQZvAdBAdVDJIRgMXI3EAmUJHNVf7veUlzltguNnoDeKPT1Lb4xK37L049eo/aYrinFSiWoOfpEk4gpVJMpjAMq1iyLYNLZ6MCccIhKee8dpXDCd2pQEToBEM6DPsqZAn2XBmrmaLlDntPV7N4sN9IwXOH1g91hAR0VRKWIgNpA6Fkk3P9OrtN1du6QIDAQAB",
   "version": "0.1",
   "manifest_version": 2,
-  "description": "Tests the chrome.windows.* with WindowState = locked (without permission).",
+  "description": "Tests the chrome.windows.* with WindowState = locked-fullscreen (without permission).",
   "background": {
     "scripts": ["test.js"]
   },

chrome/test/data/extensions/api_test/locked_fullscreen/without_permission/test.js

@@ -17,9 +17,17 @@ updateWindowToLockedFullscreen = function() {
       chrome.test.callbackFail(error_msg))});
 };
 
+removeLockedFullscreenFromWindow = function() {
+  chrome.windows.getCurrent(null, function(window) {
+    chrome.windows.update(window.id, {state: 'fullscreen'},
+      chrome.test.callbackFail(error_msg));
+  });
+};
+
 const tests = {
   openLockedFullscreenWindow: openLockedFullscreenWindow,
   updateWindowToLockedFullscreen: updateWindowToLockedFullscreen,
+  removeLockedFullscreenFromWindow: removeLockedFullscreenFromWindow,
 };
 
 window.onload = function() {