This is the first of probably several patches trying to clean up the BlockedPopupContainer into something that can be cross-platform.

- BlokedPopupContainers are no longer ConstrainedWindows.
- There is now a cross platform base class that contains most of the model/controller logic. The view now inherits from it. This is an improvement.

Review URL: http://codereview.chromium.org/119006

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@17483 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 258 insertions, 0 deletions

diff --git a/chrome/browser/blocked_popup_container.h b/chrome/browser/blocked_popup_container.h
new file mode 100644
index 0000000..f9b5d14
--- /dev/null
+++ b/chrome/browser/blocked_popup_container.h
@@ -0,0 +1,258 @@
+// Copyright (c) 2009 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.
+
+// Defines the public interface for the blocked popup notifications. This
+// interface should only be used by TabContents. Users and subclasses of
+// TabContents should use the appropriate methods on TabContents to access
+// information about blocked popups.
+
+#ifndef CHROME_BROWSER_BLOCKED_POPUP_CONTAINER_H_
+#define CHROME_BROWSER_BLOCKED_POPUP_CONTAINER_H_
+
+#include <map>
+#include <set>
+
+#include "base/gfx/native_widget_types.h"
+#include "base/gfx/rect.h"
+#include "chrome/browser/tab_contents/constrained_window.h"
+#include "chrome/browser/tab_contents/tab_contents_delegate.h"
+#include "chrome/common/notification_registrar.h"
+
+class BlockedPopupContainerImpl;
+class PrefService;
+class Profile;
+class TabContents;
+
+// Takes ownership of TabContents that are unrequested popup windows and
+// presents an interface to the user for launching them. (Or never showing them
+// again). This class contains all the cross-platform bits that can be used in
+// all ports.
+//
+// Currently, BlockedPopupContainer only exists as a cross platform model
+// extracted from browser/views/blocked_popup_container.cc. This is what it
+// used to look like before:
+//
+// +- BlockedPopupContainer -------------------------------+
+// | <views::WidgetWin>                                    |
+// | All model logic.                                      |
+// | All views code.                                       |
+// +-------------------------------------------------------+
+//
+// As of now, it looks like this:
+//
+// +- BlockedPopupContainer -------------------------------+
+// | All model logic                                       |
+// +-------------------------------------------------------+
+//                         ^
+//                         |
+// +- BlockedPopupContainerImpl ---------------------------+
+// | views::WidgetWin                                      |
+// | All views code.                                       |
+// |                                                       |
+// +-------------------------------------------------------+
+//
+// TODO(erg): While it is not in this state yet, I want it to look like this:
+//
+// +- BlockedPopupContainer ---+         +- BlockedPopupContainerView -----+
+// | All model logic           |    +--->| Abstract cross platform         |
+// |                           |    |    | interface                       |
+// |                           |    |    |                                 |
+// | Owns a platform view_     +----+    |                                 |
+// +---------------------------+         +---------------------------------+
+//                                                  ^
+//                                                  |
+//                  +-------------------------------+-----------+
+//                  |                                           |
+//  +- BPCViewGtk -----------+     +- BPCViewWin ----------------------+
+//  | Gtk UI                 |     | Views UI                          |
+//  |                        |     |                                   |
+//  +------------------------+     +-----------------------------------+
+//
+// Getting here will take multiple patches.
+class BlockedPopupContainer : public TabContentsDelegate,
+                              public NotificationObserver {
+ public:
+  // Creates a BlockedPopupContainer, anchoring the container to the lower
+  // right corner.
+  static BlockedPopupContainer* Create(
+      TabContents* owner, Profile* profile, const gfx::Point& initial_anchor);
+
+  static void RegisterUserPrefs(PrefService* prefs);
+
+  // Adds a popup to this container. |bounds| are the window bounds requested by
+  // the popup window.
+  void AddTabContents(TabContents* tab_contents,
+                      const gfx::Rect& bounds,
+                      const std::string& host);
+
+  // Shows the blocked popup at index |index|.
+  void LaunchPopupAtIndex(size_t index);
+
+  // Returns the number of blocked popups
+  size_t GetBlockedPopupCount() const;
+
+  // Returns true if host |index| is whitelisted.  Returns false if |index| is
+  // invalid.
+  bool IsHostWhitelisted(size_t index) const;
+
+  // If host |index| is currently whitelisted, un-whitelists it.  Otherwise,
+  // whitelists it and opens all blocked popups from it.
+  void ToggleWhitelistingForHost(size_t index);
+
+  // Deletes all popups and hides the interface parts.
+  void CloseAll();
+
+  // Sets this object up to delete itself.
+  virtual void Destroy() = 0;
+
+  // Message called when a BlockedPopupContainer should move itself to the
+  // bottom right corner of |view|.
+  virtual void RepositionBlockedPopupContainer(gfx::NativeView view) = 0;
+
+  // Called to force this container to never show itself again.
+  void set_dismissed() { has_been_dismissed_ = true; }
+
+  // Overridden from TabContentsDelegate:
+
+  // Forwards OpenURLFromTab to our |owner_|.
+  virtual void OpenURLFromTab(TabContents* source,
+                              const GURL& url, const GURL& referrer,
+                              WindowOpenDisposition disposition,
+                              PageTransition::Type transition);
+
+  // Ignored; BlockedPopupContainer doesn't display a throbber.
+  virtual void NavigationStateChanged(const TabContents* source,
+                                      unsigned changed_flags) { }
+
+  // Forwards AddNewContents to our |owner_|.
+  virtual void AddNewContents(TabContents* source,
+                              TabContents* new_contents,
+                              WindowOpenDisposition disposition,
+                              const gfx::Rect& initial_position,
+                              bool user_gesture);
+
+  // Ignore activation requests from the TabContents we're blocking.
+  virtual void ActivateContents(TabContents* contents) { }
+
+  // Ignored; BlockedPopupContainer doesn't display a throbber.
+  virtual void LoadingStateChanged(TabContents* source) { }
+
+  // Removes |source| from our internal list of blocked popups.
+  virtual void CloseContents(TabContents* source);
+
+  // Changes the opening rectangle associated with |source|.
+  virtual void MoveContents(TabContents* source, const gfx::Rect& new_bounds);
+
+  // Always returns true.
+  virtual bool IsPopup(TabContents* source);
+
+  // Returns our |owner_|.
+  virtual TabContents* GetConstrainingContents(TabContents* source);
+
+  // Ignored; BlockedPopupContainer doesn't display a toolbar.
+  virtual void ToolbarSizeChanged(TabContents* source, bool is_animating) { }
+
+  // Ignored; BlockedPopupContainer doesn't display a bookmarking star.
+  virtual void URLStarredChanged(TabContents* source, bool starred) { }
+
+  // Ignored; BlockedPopupContainer doesn't display a URL bar.
+  virtual void UpdateTargetURL(TabContents* source, const GURL& url) { }
+
+  // Creates an ExtensionFunctionDispatcher that has no browser
+  virtual ExtensionFunctionDispatcher* CreateExtensionFunctionDispatcher(
+      RenderViewHost* render_view_host,
+      const std::string& extension_id);
+
+  // A number larger than the internal popup count on the Renderer; meant for
+  // preventing a compromised renderer from exhausting GDI memory by spawning
+  // infinite windows.
+  static const size_t kImpossibleNumberOfPopups = 30;
+
+ protected:
+  struct BlockedPopup {
+    BlockedPopup(TabContents* tab_contents,
+                 const gfx::Rect& bounds,
+                 const std::string& host)
+        : tab_contents(tab_contents), bounds(bounds), host(host) {
+    }
+
+    TabContents* tab_contents;
+    gfx::Rect bounds;
+    std::string host;
+  };
+  typedef std::vector<BlockedPopup> BlockedPopups;
+
+  // TabContents is the popup contents.  string is opener hostname.
+  typedef std::map<TabContents*, std::string> UnblockedPopups;
+
+  // string is hostname.  bool is whitelisted status.
+  typedef std::map<std::string, bool> PopupHosts;
+
+  // Shows the UI.
+  virtual void ShowSelf() = 0;
+
+  // Hides the UI portion of the container.
+  virtual void HideSelf();
+
+  // Updates the text on the label on the notification.
+  virtual void UpdateLabel() = 0;
+
+  // Deletes all local state.
+  virtual void ClearData();
+
+  // Helper function to convert a host index (which the view uses) into an
+  // iterator into |popup_hosts_|.  Returns popup_hosts_.end() if |index| is
+  // invalid.
+  PopupHosts::const_iterator ConvertHostIndexToIterator(size_t index) const;
+
+  // Removes the popup at |i| from the blocked popup list.  If this popup's host
+  // is not otherwised referenced on either popup list, removes the host from
+  // the host list.  Updates the view's label to match the new state.
+  void EraseDataForPopupAndUpdateUI(BlockedPopups::iterator i);
+
+  // Same as above, but works on the unblocked popup list.
+  void EraseDataForPopupAndUpdateUI(UnblockedPopups::iterator i);
+
+ private:
+  friend class BlockedPopupContainerImpl;
+
+  // string is hostname.
+  typedef std::set<std::string> Whitelist;
+
+  // Creates a container for a certain TabContents:
+  BlockedPopupContainer(TabContents* owner, PrefService* prefs);
+
+  // Overridden from notificationObserver:
+  virtual void Observe(NotificationType type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+
+  // The TabContents that owns and constrains this BlockedPopupContainer.
+  TabContents* owner_;
+
+  // The PrefService we can query to find out what's on the whitelist.
+  PrefService* prefs_;
+
+  // Once the container is hidden, this is set to prevent it from reappearing.
+  bool has_been_dismissed_;
+
+  // Registrar to handle notifications we care about.
+  NotificationRegistrar registrar_;
+
+  // The whitelisted hosts, which we allow to open popups directly.
+  Whitelist whitelist_;
+
+  // Information about all blocked popups.
+  BlockedPopups blocked_popups_;
+
+  // Information about all unblocked popups.
+  UnblockedPopups unblocked_popups_;
+
+  // Information about all popup hosts.
+  PopupHosts popup_hosts_;
+
+  DISALLOW_IMPLICIT_CONSTRUCTORS(BlockedPopupContainer);
+};
+
+#endif  // CHROME_BROWSER_BLOCKED_POPUP_CONTAINER_H_