Embed Flash Fullscreen widget within browser window.

chrome/browser/ui/fullscreen/fullscreen_controller.h

 // 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.
 
 #ifndef CHROME_BROWSER_UI_FULLSCREEN_FULLSCREEN_CONTROLLER_H_
 #define CHROME_BROWSER_UI_FULLSCREEN_FULLSCREEN_CONTROLLER_H_
 
 #include "base/basictypes.h"
 #include "base/memory/weak_ptr.h"
 #include "chrome/browser/ui/fullscreen/fullscreen_exit_bubble_type.h"
 #include "chrome/common/content_settings.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 
 class Browser;
 class BrowserWindow;
 class GURL;
 class Profile;
 
 namespace content {
 class WebContents;
 }
 
 // There are two different kinds of fullscreen mode - "tab fullscreen" and
-// "browser fullscreen". "Tab fullscreen" refers to when a tab enters
-// fullscreen mode via the JS fullscreen API, and "browser fullscreen" refers
-// to the user putting the browser itself into fullscreen mode from the UI. The
-// difference is that tab fullscreen has implications for how the contents of
-// the tab render (eg: a video element may grow to consume the whole tab),
-// whereas browser fullscreen mode doesn't. Therefore if a user forces an exit
-// from tab fullscreen, we need to notify the tab so it can stop rendering in
-// its fullscreen mode.
+// "browser fullscreen". "Tab fullscreen" refers to a renderer-initiated
+// fullscreen mode (eg: from a Flash plugin or via the JS fullscreen API),
+// whereas "browser fullscreen" refers to the user putting the browser itself
+// into fullscreen mode from the UI. The difference is that tab fullscreen has
+// implications for how the contents of the tab render (eg: a video element may
+// grow to consume the whole tab), whereas browser fullscreen mode doesn't.
+// Therefore if a user forces an exit from tab fullscreen, we need to notify the
+// tab so it can stop rendering in its fullscreen mode.
+//
+// For Flash, FullscreenController will auto-accept all permission requests for
+// fullscreen and/or mouse lock, since the assumption is that the plugin handles
+// this for us.
 
 // This class implements fullscreen and mouselock behaviour.
 class FullscreenController : public content::NotificationObserver {
  public:
   explicit FullscreenController(Browser* browser);
   virtual ~FullscreenController();
 
   // Browser/User Fullscreen ///////////////////////////////////////////////////
 
   // Returns true if the window is currently fullscreen and was initially
   // transitioned to fullscreen by a browser (vs tab) mode transition.
   bool IsFullscreenForBrowser() const;
 
   void ToggleFullscreenMode();
 
-  // Tab/HTML Fullscreen ///////////////////////////////////////////////////////
+  // Tab/HTML/Flash Fullscreen /////////////////////////////////////////////////
 
   // Returns true if fullscreen has been caused by a tab.
   // The window may still be transitioning, and window_->IsFullscreen()
   // may still return false.
   bool IsFullscreenForTabOrPending() const;
   bool IsFullscreenForTabOrPending(
       const content::WebContents* web_contents) const;
   // True if fullscreen was entered because of tab fullscreen (was not
   // previously in browser fullscreen).
   bool IsFullscreenCausedByTab() const;
@@ skipping 56 matching lines @@
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
   // Bubble Content ////////////////////////////////////////////////////////////
 
   GURL GetFullscreenExitBubbleURL() const;
   FullscreenExitBubbleType GetFullscreenExitBubbleType() const;
 
  private:
+  friend class FullscreenControllerTest;
+
   enum MouseLockState {
     MOUSELOCK_NOT_REQUESTED,
     // The page requests to lock the mouse and the user hasn't responded to the
     // request.
     MOUSELOCK_REQUESTED,
     // Mouse lock has been allowed by the user.
     MOUSELOCK_ACCEPTED,
     // Mouse lock has been silently accepted, no notification to user.
     MOUSELOCK_ACCEPTED_SILENTLY
   };
@@ skipping 23 matching lines @@
   void SetFullscreenedTab(content::WebContents* tab);
   void SetMouseLockTab(content::WebContents* tab);
 
   // Make the current tab exit fullscreen mode or mouse lock if it is in it.
   void ExitTabFullscreenOrMouseLockIfNecessary();
   void UpdateFullscreenExitBubbleContent();
 
   ContentSetting GetFullscreenSetting(const GURL& url) const;
   ContentSetting GetMouseLockSetting(const GURL& url) const;
 
+  bool IsPrivilegedFullscreenForTab() const;
+  void SetPrivilegedFullscreenForTesting(bool is_privileged);
+  void UnlockMouse();
+
   base::WeakPtrFactory<FullscreenController> ptr_factory_;
 
-  Browser* browser_;
-  BrowserWindow* window_;
-  Profile* profile_;
+  Browser* const browser_;
+  BrowserWindow* const window_;
+  Profile* const profile_;
 
   // If there is currently a tab in fullscreen mode (entered via
   // webkitRequestFullScreen), this is its WebContents.
   // Assign using SetFullscreenedTab().
   content::WebContents* fullscreened_tab_;
 
   // The URL of the extension which trigerred "browser fullscreen" mode.
   GURL extension_caused_fullscreen_;
 
   enum PriorFullscreenState {
@@ skipping 19 matching lines @@
   content::WebContents* mouse_lock_tab_;
 
   MouseLockState mouse_lock_state_;
 
   content::NotificationRegistrar registrar_;
 
   // Used to verify that calls we expect to reenter by calling
   // WindowFullscreenStateChanged do so.
   bool reentrant_window_state_change_call_check_;
 
+  // Used in testing to confirm proper behavior for specific, privileged
+  // fullscreen cases.
+  bool is_privileged_fullscreen_for_testing_;
+
   DISALLOW_COPY_AND_ASSIGN(FullscreenController);
 };
 
 #endif  // CHROME_BROWSER_UI_FULLSCREEN_FULLSCREEN_CONTROLLER_H_