Refactor implementation of BrowserActions, and add support for

chrome/browser/views/browser_actions_container.cc

 // 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.
 
 #include "chrome/browser/views/browser_actions_container.h"
 
 #include "app/gfx/canvas.h"
 #include "app/resource_bundle.h"
 #include "base/stl_util-inl.h"
 #include "base/string_util.h"
 #include "chrome/browser/extensions/extension_browser_event_router.h"
 #include "chrome/browser/extensions/extensions_service.h"
 #include "chrome/browser/extensions/extension_tabs_module.h"
 #include "chrome/browser/profile.h"
 #include "chrome/browser/view_ids.h"
 #include "chrome/browser/views/extensions/extension_popup.h"
 #include "chrome/browser/views/toolbar_view.h"
 #include "chrome/common/extensions/extension_action.h"
+#include "chrome/common/extensions/extension_action2.h"
 #include "chrome/common/notification_source.h"
 #include "chrome/common/notification_type.h"
 #include "grit/app_resources.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "third_party/skia/include/core/SkTypeface.h"
 #include "third_party/skia/include/effects/SkGradientShader.h"
 #include "views/controls/button/text_button.h"
 
 // The size (both dimensions) of the buttons for page actions.
 static const int kButtonSize = 29;
 
 // The padding between the browser actions and the omnibox/page menu.
 static const int kHorizontalPadding = 4;
 
 // This is the same value from toolbar.cc. We position the browser actions
 // container flush with the edges of the toolbar as a special case so that we
 // can draw the badge outside the visual bounds of the container.
 static const int kControlVertOffset = 6;
 
 // The maximum of the minimum number of browser actions present when there is
 // not enough space to fit all the browser actions in the toolbar.
 static const int kMinimumNumberOfVisibleBrowserActions = 2;
 
 
 ////////////////////////////////////////////////////////////////////////////////
 // BrowserActionButton
 
-BrowserActionButton::BrowserActionButton(
-    ExtensionAction* browser_action, Extension* extension,
-    BrowserActionsContainer* panel)
+BrowserActionButton::BrowserActionButton(Extension* extension,
+                                         BrowserActionsContainer* panel)
     : MenuButton(this, L"", NULL, false),
-      browser_action_(browser_action),
-      browser_action_state_(extension->browser_action_state()),
+      browser_action_(extension->browser_action()),
+      extension_(extension),
       tracker_(NULL),
       panel_(panel) {
   set_alignment(TextButton::ALIGN_CENTER);
 
-  // Load the images this view needs asynchronously on the file thread. We'll
-  // get a call back into OnImageLoaded if the image loads successfully. If not,
-  // the ImageView will have no image and will not appear in the browser chrome.
-  if (!browser_action->icon_paths().empty()) {
-    const std::vector<std::string>& icon_paths = browser_action->icon_paths();
-    browser_action_icons_.resize(icon_paths.size());
-    tracker_ = new ImageLoadingTracker(this, icon_paths.size());
-    for (std::vector<std::string>::const_iterator iter = icon_paths.begin();
-         iter != icon_paths.end(); ++iter) {
-      tracker_->PostLoadImageTask(
-          extension->GetResource(*iter),
-          gfx::Size(Extension::kBrowserActionIconMaxSize,
-                    Extension::kBrowserActionIconMaxSize));
-    }
-  }
+  // No UpdateState() here because View heirarchy not setup yet. Our parent
+  // should call UpdateState() after creation.
 
   registrar_.Add(this, NotificationType::EXTENSION_BROWSER_ACTION_UPDATED,
-                 Source<ExtensionAction>(browser_action_));
+                 Source<ExtensionAction2>(browser_action_));
 }
 
 BrowserActionButton::~BrowserActionButton() {
   if (tracker_) {
     tracker_->StopTrackingImageLoad();
     tracker_ = NULL;  // The tracker object will be deleted when we return.
   }
 }
 
 gfx::Insets BrowserActionButton::GetInsets() const {
   static gfx::Insets zero_inset;
   return zero_inset;
 }
 
 void BrowserActionButton::ButtonPressed(
     views::Button* sender, const views::Event& event) {
   panel_->OnBrowserActionExecuted(this);
 }
 
-void BrowserActionButton::OnImageLoaded(SkBitmap* image, size_t index) {
-  DCHECK(index < browser_action_icons_.size());
-  browser_action_icons_[index] = image ? *image : SkBitmap();
-  if (index == browser_action_icons_.size() - 1) {
-    OnStateUpdated();
-    tracker_ = NULL;  // The tracker object will delete itself when we return.
-  }
+void BrowserActionButton::LoadImage() {
+  // Load the default image from the browser action asynchronously on the file
+  // thread. We'll get a call back into OnImageLoaded if the image loads
+  // successfully.
+  std::string relative_path = browser_action()->GetDefaultIconPath();
+  if (relative_path.empty())
+    return;
+
+  tracker_ = new ImageLoadingTracker(this, 1);
+  tracker_->PostLoadImageTask(
+      extension()->GetResource(relative_path),
+      gfx::Size(Extension::kBrowserActionIconMaxSize,
+                Extension::kBrowserActionIconMaxSize));
 }
 
-void BrowserActionButton::OnStateUpdated() {
-  SkBitmap* image = browser_action_state_->icon();
-  if (!image) {
-    if (static_cast<size_t>(browser_action_state_->icon_index()) <
-        browser_action_icons_.size()) {
-      image = &browser_action_icons_[browser_action_state_->icon_index()];
-    }
-  }
-
-  if (image)
-    SetIcon(*image);
-
-  SetTooltipText(ASCIIToWide(browser_action_state_->title()));
-  panel_->OnBrowserActionVisibilityChanged();
+void BrowserActionButton::OnImageLoaded(SkBitmap* image, size_t index) {
+  SetIcon(*image);
+  tracker_ = NULL;  // The tracker object will delete itself when we return.
   GetParent()->SchedulePaint();
 }
 
+void BrowserActionButton::UpdateState() {
+  int tab_id = panel_->GetCurrentTabId();
+  if (tab_id < 0)
+    return;
+
+  SkBitmap image = browser_action()->GetIcon(tab_id);
+  if (image.isNull())
+    LoadImage();
+  else
+    SetIcon(image);
+
+  SetTooltipText(ASCIIToWide(browser_action()->GetTitle(tab_id)));
+  GetParent()->SchedulePaint();
+}
+
 void BrowserActionButton::Observe(NotificationType type,
                                   const NotificationSource& source,
                                   const NotificationDetails& details) {
   if (type == NotificationType::EXTENSION_BROWSER_ACTION_UPDATED) {
-    OnStateUpdated();
+    UpdateState();
   } else {
     NOTREACHED() << L"Received unexpected notification";
   }
 }
 
 bool BrowserActionButton::IsPopup() {
-  return browser_action_->is_popup();
+  return browser_action_->has_popup();
 }
 
 bool BrowserActionButton::Activate() {
   if (IsPopup()) {
     panel_->OnBrowserActionExecuted(this);
 
     // TODO(erikkay): Run a nested modal loop while the mouse is down to
     // enable menu-like drag-select behavior.
 
     // The return value of this method is returned via OnMousePressed.
@@ skipping 42 matching lines @@
 
 void BrowserActionButton::PopupDidHide() {
   SetState(views::CustomButton::BS_NORMAL);
   menu_visible_ = false;
 }
 
 
 ////////////////////////////////////////////////////////////////////////////////
 // BrowserActionView
 
-BrowserActionView::BrowserActionView(ExtensionAction* browser_action,
-                                     Extension* extension,
-                                     BrowserActionsContainer* panel) {
-  button_ = new BrowserActionButton(browser_action, extension, panel);
+BrowserActionView::BrowserActionView(Extension* extension,
+                                     BrowserActionsContainer* panel)
+    : panel_(panel) {
+  button_ = new BrowserActionButton(extension, panel);
   AddChildView(button_);
+  button_->UpdateState();
 }
 
 void BrowserActionView::Layout() {
   button_->SetBounds(0, kControlVertOffset, width(), kButtonSize);
 }
 
 void BrowserActionView::PaintChildren(gfx::Canvas* canvas) {
   View::PaintChildren(canvas);
-  button_->browser_action_state()->PaintBadge(canvas,
-                                              gfx::Rect(width(), height()));
+  ExtensionAction2* action = button()->browser_action();
+  int tab_id = panel_->GetCurrentTabId();
+  if (tab_id < 0)
+    return;
+
+  ExtensionActionState::PaintBadge(
+    canvas, gfx::Rect(width(), height()),
+    action->GetBadgeText(tab_id),
+    action->GetBadgeTextColor(tab_id),
+    action->GetBadgeBackgroundColor(tab_id));
 }
 
 
 ////////////////////////////////////////////////////////////////////////////////
 // BrowserActionsContainer
 
 BrowserActionsContainer::BrowserActionsContainer(
     Profile* profile, ToolbarView* toolbar)
     : profile_(profile),
       toolbar_(toolbar),
       popup_(NULL),
       popup_button_(NULL),
       ALLOW_THIS_IN_INITIALIZER_LIST(task_factory_(this)) {
   ExtensionsService* extension_service = profile->GetExtensionsService();
+  if (!extension_service)  // The |extension_service| can be NULL in Incognito.
+    return;
+
   registrar_.Add(this, NotificationType::EXTENSION_LOADED,
                  Source<ExtensionsService>(extension_service));
   registrar_.Add(this, NotificationType::EXTENSION_UNLOADED,
                  Source<ExtensionsService>(extension_service));
   registrar_.Add(this, NotificationType::EXTENSION_UNLOADED_DISABLED,
                  Source<ExtensionsService>(extension_service));
   registrar_.Add(this, NotificationType::EXTENSION_HOST_VIEW_SHOULD_CLOSE,
                  Source<Profile>(profile_));
 
-  RefreshBrowserActionViews();
+  for (size_t i = 0; i < extension_service->extensions()->size(); ++i)
+    AddBrowserAction(extension_service->extensions()->at(i));
+
   SetID(VIEW_ID_BROWSER_ACTION_TOOLBAR);
 }
 
 BrowserActionsContainer::~BrowserActionsContainer() {
   HidePopup();
   DeleteBrowserActionViews();
 }
 
+int BrowserActionsContainer::GetCurrentTabId() {
+  TabContents* tab_contents = toolbar_->browser()->GetSelectedTabContents();
+  if (!tab_contents)
+    return -1;
+
+  return tab_contents->controller().session_id().id();
+}
+
 void BrowserActionsContainer::RefreshBrowserActionViews() {
-  ExtensionsService* extension_service = profile_->GetExtensionsService();
-  if (!extension_service)  // The |extension_service| can be NULL in Incognito.
+  for (size_t i = 0; i < browser_action_views_.size(); ++i)
+    browser_action_views_[i]->button()->UpdateState();
+}
+
+void BrowserActionsContainer::AddBrowserAction(Extension* extension) {
+#if defined(DEBUG)
+  for (size_t i = 0; i < browser_action_views_.size(); ++i) {
+    DCHECK(browser_action_views_[i]->button()->extension() != extension) <<
+           "Asked to add a browser action view for an extension that already "
+           "exists.";
+  }
+#endif
+  if (!extension->browser_action())
     return;
 
-  // Get all browser actions, including those with popups.
-  std::vector<ExtensionAction*> browser_actions;
-  browser_actions = extension_service->GetBrowserActions(true);
+  BrowserActionView* view = new BrowserActionView(extension, this);
+  browser_action_views_.push_back(view);
+  AddChildView(view);
+}
 
-  DeleteBrowserActionViews();
-  for (size_t i = 0; i < browser_actions.size(); ++i) {
-    Extension* extension = extension_service->GetExtensionById(
-        browser_actions[i]->extension_id());
-    DCHECK(extension);
+void BrowserActionsContainer::RemoveBrowserAction(Extension* extension) {
+  if (!extension->browser_action())
+    return;
 
-    BrowserActionView* view =
-        new BrowserActionView(browser_actions[i], extension, this);
-    browser_action_views_.push_back(view);
-    AddChildView(view);
+  for (std::vector<BrowserActionView*>::iterator iter =
+       browser_action_views_.begin(); iter != browser_action_views_.end();
+       ++iter) {
+    if ((*iter)->button()->extension() == extension) {
+      RemoveChildView(*iter);
+      browser_action_views_.erase(iter);
+      return;
+    }
   }
+
+   NOTREACHED() << "Asked to remove a browser action view that doesn't exist.";
 }
 
 void BrowserActionsContainer::DeleteBrowserActionViews() {
   if (!browser_action_views_.empty()) {
     for (size_t i = 0; i < browser_action_views_.size(); ++i)
       RemoveChildView(browser_action_views_[i]);
     STLDeleteContainerPointers(browser_action_views_.begin(),
                                browser_action_views_.end());
     browser_action_views_.clear();
   }
@@ skipping 24 matching lines @@
   }
 }
 
 void BrowserActionsContainer::TestExecuteBrowserAction(int index) {
   BrowserActionButton* button = browser_action_views_[index]->button();
   OnBrowserActionExecuted(button);
 }
 
 void BrowserActionsContainer::OnBrowserActionExecuted(
     BrowserActionButton* button) {
-  const ExtensionAction& browser_action = button->browser_action();
+  ExtensionAction2* browser_action = button->browser_action();
 
   // Popups just display.  No notification to the extension.
   // TODO(erikkay): should there be?
   if (button->IsPopup()) {
     // If we're showing the same popup, just hide it and return.
     bool same_showing = popup_ && button == popup_button_;
 
     // Always hide the current popup, even if it's not the same.
     // Only one popup should be visible at a time.
     HidePopup();
 
     if (same_showing)
       return;
 
     gfx::Point origin;
     View::ConvertPointToScreen(button, &origin);
     gfx::Rect rect = button->bounds();
     rect.set_x(origin.x());
     rect.set_y(origin.y());
-    popup_ = ExtensionPopup::Show(browser_action.popup_url(),
+    popup_ = ExtensionPopup::Show(browser_action->popup_url(),
                                   toolbar_->browser(),
                                   rect);
     popup_->set_delegate(this);
     popup_button_ = button;
     popup_button_->PopupDidShow();
     return;
   }
 
   // Otherwise, we send the action to the extension.
   ExtensionBrowserEventRouter::GetInstance()->BrowserActionExecuted(
-      profile_, browser_action.extension_id(), toolbar_->browser());
+      profile_, browser_action->extension_id(), toolbar_->browser());
 }
 
 gfx::Size BrowserActionsContainer::GetPreferredSize() {
   if (browser_action_views_.empty())
     return gfx::Size(0, 0);
   int width = kHorizontalPadding * 2 +
       browser_action_views_.size() * kButtonSize;
   return gfx::Size(width, kButtonSize);
 }
 
 void BrowserActionsContainer::Layout() {
   for (size_t i = 0; i < browser_action_views_.size(); ++i) {
     BrowserActionView* view = browser_action_views_[i];
     int x = kHorizontalPadding + i * kButtonSize;
     if (x + kButtonSize <= width()) {
       view->SetBounds(x, 0, kButtonSize, height());
       view->SetVisible(true);
     } else {
       view->SetVisible(false);
     }
   }
 }
 
 void BrowserActionsContainer::Observe(NotificationType type,
                                       const NotificationSource& source,
                                       const NotificationDetails& details) {
-  if (type == NotificationType::EXTENSION_LOADED ||
-      type == NotificationType::EXTENSION_UNLOADED ||
-      type == NotificationType::EXTENSION_UNLOADED_DISABLED) {
-    RefreshBrowserActionViews();
+  switch (type.value) {
+    case NotificationType::EXTENSION_LOADED:
+      AddBrowserAction(Details<Extension>(details).ptr());
+      OnBrowserActionVisibilityChanged();
+      break;
 
-    // All these actions may change visibility of BrowserActions.
-    OnBrowserActionVisibilityChanged();
-  } else if (type == NotificationType::EXTENSION_HOST_VIEW_SHOULD_CLOSE) {
-    if (Details<ExtensionHost>(popup_->host()) != details)
-      return;
+    case NotificationType::EXTENSION_UNLOADED:
+    case NotificationType::EXTENSION_UNLOADED_DISABLED:
+      RemoveBrowserAction(Details<Extension>(details).ptr());
+      OnBrowserActionVisibilityChanged();
+      break;
 
-    HidePopup();
-  } else {
-    NOTREACHED() << L"Received unexpected notification";
+    case NotificationType::EXTENSION_HOST_VIEW_SHOULD_CLOSE:
+      if (Details<ExtensionHost>(popup_->host()) != details)
+        return;
+
+      HidePopup();
+
+    default:
+      NOTREACHED() << L"Unexpected notification";
   }
 }
 
 void BrowserActionsContainer::BubbleBrowserWindowMoved(BrowserBubble* bubble) {
 }
 
 void BrowserActionsContainer::BubbleBrowserWindowClosing(
     BrowserBubble* bubble) {
   HidePopup();
 }
@@ skipping 22 matching lines @@
       std::min(static_cast<int>(browser_action_views_.size()),
                kMinimumNumberOfVisibleBrowserActions) * kButtonSize;
 
   // Even if available_width is <= 0, we still return at least the |min_width|.
   if (available_width <= 0)
     return min_width;
 
   return std::max(min_width, available_width - available_width % kButtonSize +
                   kHorizontalPadding * 2);
 }