Add FullscreenController::ToggleFullscreenModeWithExtension

chrome/browser/ui/fullscreen_controller.cc

Index: chrome/browser/ui/fullscreen_controller.cc
diff --git a/chrome/browser/ui/fullscreen_controller.cc b/chrome/browser/ui/fullscreen_controller.cc
index c1636ad58f83297aa5fbec936199438f218ecde4..aa223d632b5e75b1af09ad0657adc74e083bd93c 100644
--- a/chrome/browser/ui/fullscreen_controller.cc
+++ b/chrome/browser/ui/fullscreen_controller.cc
@@ -15,6 +15,7 @@
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/chrome_switches.h"
+#include "chrome/common/extensions/extension.h"
 #include "content/browser/renderer_host/render_view_host.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/user_metrics.h"
@@ -110,9 +111,9 @@ void FullscreenController::ToggleFullscreenModeForTab(WebContents* tab,
     if (!in_browser_or_tab_fullscreen_mode) {
       tab_caused_fullscreen_ = true;
 #if defined(OS_MACOSX)
-      TogglePresentationMode(true);
+      TogglePresentationModeInternal(true);
 #else
-      ToggleFullscreenMode(true);
+      ToggleFullscreenModeInternal(true);
 #endif
     } else {
       // We need to update the fullscreen exit bubble, e.g., going from browser
@@ -128,9 +129,9 @@ void FullscreenController::ToggleFullscreenModeForTab(WebContents* tab,
     if (in_browser_or_tab_fullscreen_mode) {
       if (tab_caused_fullscreen_) {
 #if defined(OS_MACOSX)
-        TogglePresentationMode(true);
+        TogglePresentationModeInternal(true);
 #else
-        ToggleFullscreenMode(true);
+        ToggleFullscreenModeInternal(true);
 #endif
       } else {
         // If currently there is a tab in "tab fullscreen" mode and fullscreen
@@ -145,57 +146,20 @@ void FullscreenController::ToggleFullscreenModeForTab(WebContents* tab,
 }
 
 #if defined(OS_MACOSX)
-void FullscreenController::TogglePresentationMode(bool for_tab) {
-  bool entering_fullscreen = !window_->InPresentationMode();
-  GURL url;
-  if (for_tab) {
-    url = browser_->GetSelectedWebContents()->GetURL();
-    tab_fullscreen_accepted_ = entering_fullscreen &&
-        GetFullscreenSetting(url) == CONTENT_SETTING_ALLOW;
-  }
-  if (entering_fullscreen)
-    window_->EnterPresentationMode(url, GetFullscreenExitBubbleType());
-  else
-    window_->ExitPresentationMode();
-  WindowFullscreenStateChanged();
+void FullscreenController::TogglePresentationMode() {
+  TogglePresentationModeInternal(false);
 }
 #endif
 
-// TODO(koz): Change |for_tab| to an enum.
-void FullscreenController::ToggleFullscreenMode(bool for_tab) {
-  bool entering_fullscreen = !window_->IsFullscreen();
-
-#if !defined(OS_MACOSX)
-  // In kiosk mode, we always want to be fullscreen. When the browser first
-  // starts we're not yet fullscreen, so let the initial toggle go through.
-  if (CommandLine::ForCurrentProcess()->HasSwitch(switches::kKioskMode) &&
-      window_->IsFullscreen())
-    return;
-#endif
-
-  GURL url;
-  if (for_tab) {
-    url = browser_->GetSelectedWebContents()->GetURL();
-    tab_fullscreen_accepted_ = entering_fullscreen &&
-        GetFullscreenSetting(url) == CONTENT_SETTING_ALLOW;
-  } else {
-    content::RecordAction(UserMetricsAction("ToggleFullscreen"));
-  }
-  if (entering_fullscreen)
-    window_->EnterFullscreen(url, GetFullscreenExitBubbleType());
-  else
-    window_->ExitFullscreen();
-
-  // Once the window has become fullscreen it'll call back to
-  // WindowFullscreenStateChanged(). We don't do this immediately as
-  // BrowserWindow::EnterFullscreen() asks for bookmark_bar_state_, so we let
-  // the BrowserWindow invoke WindowFullscreenStateChanged when appropriate.
+void FullscreenController::ToggleFullscreenMode() {
+  extension_caused_fullscreen_ = NULL;
+  ToggleFullscreenModeInternal(false);
+}
 
-  // TODO: convert mac to invoke WindowFullscreenStateChanged once it updates
-  // the necessary state of the frame.
-#if defined(OS_MACOSX)
-  WindowFullscreenStateChanged();
-#endif
+void FullscreenController::ToggleFullscreenModeWithExtension(
+    const Extension& extension) {
+  extension_caused_fullscreen_ = &extension;

[yzshen1, 2012/02/10 21:24:49]

[nit, optional]
Please comment that if this causes fullscreen to exit, we will reset
extension_caused_fullscreen_ to NULL in ToggleFullscreenModeInternal().

[hashimoto, 2012/02/13 07:43:44]

Done.

+  ToggleFullscreenModeInternal(false);
 }
 
 void FullscreenController::LostMouseLock() {
@@ -314,7 +278,7 @@ void FullscreenController::NotifyTabOfFullscreenExitIfNecessary() {
 
 void FullscreenController::ExitTabbedFullscreenModeIfNecessary() {
   if (tab_caused_fullscreen_)
-    ToggleFullscreenMode(false);
+    ToggleFullscreenMode();
   else
     NotifyTabOfFullscreenExitIfNecessary();
 }
@@ -323,6 +287,8 @@ void FullscreenController::UpdateFullscreenExitBubbleContent() {
   GURL url;
   if (fullscreened_tab_)
     url = fullscreened_tab_->web_contents()->GetURL();
+  else if (extension_caused_fullscreen_)
+    url = extension_caused_fullscreen_->url();

[yzshen1, 2012/02/10 21:24:49]

What is the lifespan of extension_caused_fullscreen_? Can we guarantee that it
won't die while FullscreenController holds a pointer to it?

[hashimoto, 2012/02/13 07:43:44]

Good point, thank you for pointing this out.
If the user uninstalls an extension when the browser is in fullscreen caused by
the extension, it crashes on UpdateFullscreenExitBubbleContent.

To avoid crash, I changed the type of |extension_caused_fullscreen_| from
Extension* to GURL.
By doing this, "<Extension ID> triggered full screen" is shown when the
extension is already uninstalled. (<Extension ID> is a string like
"lcigcdppmkbhecgefjelmcfkcgfonkdk")

Showing cryptic message is not a good thing, but I think this is acceptable
because this use case will not be so common.
If this is not OK, maybe we should show something like "You are still in full
screen" after exiting from tab-fullscreen?

[yzshen1, 2012/02/13 18:38:48]

It seems fine to me.

Just out of curiosity: According to your description, if the extension doesn't
get uninstalled while in the fullscreen mode, the text displayed __won't__ be
"<Extension ID> triggered full screen". Is that what you mean? But I cannot tell
from the code why the text displayed will be different. Am I missing anything?

 
   window_->UpdateFullscreenExitBubbleContent(url,
                                              GetFullscreenExitBubbleType());
@@ -335,11 +301,13 @@ void FullscreenController::NotifyFullscreenChange() {
       content::NotificationService::NoDetails());
 }
 
-FullscreenExitBubbleType
-    FullscreenController::GetFullscreenExitBubbleType() const {
+FullscreenExitBubbleType FullscreenController::GetFullscreenExitBubbleType()
+    const {
   if (!fullscreened_tab_) {
     DCHECK_EQ(MOUSELOCK_NOT_REQUESTED, mouse_lock_state_);
-    return FEB_TYPE_BROWSER_FULLSCREEN_EXIT_INSTRUCTION;
+    return extension_caused_fullscreen_ ?
+        FEB_TYPE_BROWSER_EXTENSION_FULLSCREEN_EXIT_INSTRUCTION :
+        FEB_TYPE_BROWSER_FULLSCREEN_EXIT_INSTRUCTION;
   }
   if (fullscreened_tab_ && !tab_fullscreen_accepted_) {
     DCHECK_NE(MOUSELOCK_ACCEPTED, mouse_lock_state_);
@@ -372,3 +340,61 @@ ContentSetting
   return settings_map->GetContentSetting(url, url,
       CONTENT_SETTINGS_TYPE_MOUSELOCK, std::string());
 }
+
+#if defined(OS_MACOSX)
+void FullscreenController::TogglePresentationModeInternal(bool for_tab) {
+  bool entering_fullscreen = !window_->InPresentationMode();
+  GURL url;
+  if (for_tab) {
+    url = browser_->GetSelectedWebContents()->GetURL();
+    tab_fullscreen_accepted_ = entering_fullscreen &&
+        GetFullscreenSetting(url) == CONTENT_SETTING_ALLOW;
+  }
+  if (entering_fullscreen)
+    window_->EnterPresentationMode(url, GetFullscreenExitBubbleType());
+  else
+    window_->ExitPresentationMode();
+  WindowFullscreenStateChanged();
+}
+#endif
+
+// TODO(koz): Change |for_tab| to an enum.
+void FullscreenController::ToggleFullscreenModeInternal(bool for_tab) {
+  bool entering_fullscreen = !window_->IsFullscreen();
+
+#if !defined(OS_MACOSX)
+  // In kiosk mode, we always want to be fullscreen. When the browser first
+  // starts we're not yet fullscreen, so let the initial toggle go through.
+  if (CommandLine::ForCurrentProcess()->HasSwitch(switches::kKioskMode) &&
+      window_->IsFullscreen())
+    return;
+#endif
+
+  GURL url;
+  if (for_tab) {
+    url = browser_->GetSelectedWebContents()->GetURL();
+    tab_fullscreen_accepted_ = entering_fullscreen &&
+        GetFullscreenSetting(url) == CONTENT_SETTING_ALLOW;
+  } else {
+    if (extension_caused_fullscreen_)
+      url = extension_caused_fullscreen_->url();
+    content::RecordAction(UserMetricsAction("ToggleFullscreen"));
+  }
+  if (entering_fullscreen) {
+    window_->EnterFullscreen(url, GetFullscreenExitBubbleType());
+  } else {
+    window_->ExitFullscreen();
+    extension_caused_fullscreen_ = NULL;
+  }
+
+  // Once the window has become fullscreen it'll call back to
+  // WindowFullscreenStateChanged(). We don't do this immediately as
+  // BrowserWindow::EnterFullscreen() asks for bookmark_bar_state_, so we let
+  // the BrowserWindow invoke WindowFullscreenStateChanged when appropriate.
+
+  // TODO: convert mac to invoke WindowFullscreenStateChanged once it updates
+  // the necessary state of the frame.
+#if defined(OS_MACOSX)
+  WindowFullscreenStateChanged();
+#endif
+}