Add Mac interface for installing bundles of extensions.

chrome/browser/ui/cocoa/extensions/extension_installed_bubble_controller.mm

 // 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.
 
 #import "chrome/browser/ui/cocoa/extensions/extension_installed_bubble_controller.h"
 
 #include "base/i18n/rtl.h"
 #include "base/mac/bundle_locations.h"
 #include "base/mac/mac_util.h"
 #include "base/sys_string_conversions.h"
 #include "base/utf_string_conversions.h"
+#include "chrome/browser/extensions/bundle_installer.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/cocoa/browser_window_cocoa.h"
 #include "chrome/browser/ui/cocoa/browser_window_controller.h"
 #include "chrome/browser/ui/cocoa/extensions/browser_actions_controller.h"
 #include "chrome/browser/ui/cocoa/hover_close_button.h"
 #include "chrome/browser/ui/cocoa/info_bubble_view.h"
 #include "chrome/browser/ui/cocoa/location_bar/location_bar_view_mac.h"
 #include "chrome/browser/ui/cocoa/toolbar/toolbar_controller.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/extensions/extension.h"
 #include "chrome/common/extensions/extension_action.h"
 #include "content/public/browser/notification_details.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_source.h"
 #include "grit/chromium_strings.h"
 #include "grit/generated_resources.h"
 #import "skia/ext/skia_utils_mac.h"
 #import "third_party/GTM/AppKit/GTMUILocalizerAndLayoutTweaker.h"
 #include "ui/base/l10n/l10n_util.h"
 
 using content::BrowserThread;
+using extensions::BundleInstaller;
 
 // C++ class that receives EXTENSION_LOADED notifications and proxies them back
 // to |controller|.
 class ExtensionLoadedNotificationObserver
     : public content::NotificationObserver {
  public:
   ExtensionLoadedNotificationObserver(
       ExtensionInstalledBubbleController* controller, Profile* profile)
           : controller_(controller) {
     registrar_.Add(this, chrome::NOTIFICATION_EXTENSION_LOADED,
@@ skipping 29 matching lines @@
     }
   }
 
   content::NotificationRegistrar registrar_;
   ExtensionInstalledBubbleController* controller_;  // weak, owns us
 };
 
 @implementation ExtensionInstalledBubbleController
 
 @synthesize extension = extension_;
+@synthesize bundle = bundle_;
 @synthesize pageActionRemoved = pageActionRemoved_;  // Exposed for unit test.
 
 - (id)initWithParentWindow:(NSWindow*)parentWindow
                  extension:(const Extension*)extension
+                    bundle:(const BundleInstaller*)bundle
                    browser:(Browser*)browser
                       icon:(SkBitmap)icon {
-  NSString* nibPath =
-      [base::mac::FrameworkBundle() pathForResource:@"ExtensionInstalledBubble"
-                                             ofType:@"nib"];
+  NSString* nibName = bundle ? @"ExtensionInstalledBubbleBundle" :
+                               @"ExtensionInstalledBubble";
+  NSString* nibPath = [base::mac::FrameworkBundle() pathForResource:nibName
+                                                             ofType:@"nib"];
   if ((self = [super initWithWindowNibPath:nibPath owner:self])) {
     DCHECK(parentWindow);
     parentWindow_ = parentWindow;
-    DCHECK(extension);
     extension_ = extension;
+    bundle_ = bundle;
     DCHECK(browser);
     browser_ = browser;
     icon_.reset([gfx::SkBitmapToNSImage(icon) retain]);
     pageActionRemoved_ = NO;
 
-    if (!extension->omnibox_keyword().empty()) {
+    if (bundle_) {
+      type_ = extension_installed_bubble::kBundle;
+    } else if (!extension->omnibox_keyword().empty()) {
       type_ = extension_installed_bubble::kOmniboxKeyword;
     } else if (extension->browser_action()) {
       type_ = extension_installed_bubble::kBrowserAction;
     } else if (extension->page_action() &&
                !extension->page_action()->default_icon_path().empty()) {
       type_ = extension_installed_bubble::kPageAction;
     } else {
       NOTREACHED();  // kGeneric installs handled in the extension_install_ui.
     }
 
-    // Start showing window only after extension has fully loaded.
-    extensionObserver_.reset(new ExtensionLoadedNotificationObserver(
-        self, browser->profile()));
+    if (type_ == extension_installed_bubble::kBundle) {
+      [self showWindow:self];
+    } else {
+      // Start showing window only after extension has fully loaded.
+      extensionObserver_.reset(new ExtensionLoadedNotificationObserver(
+          self, browser->profile()));
+    }
 
     // Watch to see if the parent window closes, and if so, close this one.
     NSNotificationCenter* center = [NSNotificationCenter defaultCenter];
     [center addObserver:self
                selector:@selector(parentWindowWillClose:)
                    name:NSWindowWillCloseNotification
                  object:parentWindow_];
   }
   return self;
 }
@@ skipping 91 matching lines @@
       // would ordinarily only be displayed on a page of the appropriate type.
       // We remove this preview when the extension installed bubble closes.
       locationBarView->SetPreviewEnabledPageAction(extension_->page_action(),
                                                    true);
 
       // Find the center of the bottom of the page action icon.
       arrowPoint =
           locationBarView->GetPageActionBubblePoint(extension_->page_action());
       break;
     }
+    case extension_installed_bubble::kBundle: {
+      NSView* wrenchButton =
+          [[window->cocoa_controller() toolbarController] wrenchButton];
+      const NSRect bounds = [wrenchButton bounds];
+      NSPoint anchor = NSMakePoint(NSMidX(bounds), NSMidY(bounds));
+      arrowPoint = [wrenchButton convertPoint:anchor toView:nil];
+      break;
+    }
     default: {
       NOTREACHED() << "Generic extension type not allowed in install bubble.";
     }
   }
   return arrowPoint;
 }
 
 // We want this to be a child of a browser window.  addChildWindow:
 // (called from this function) will bring the window on-screen;
 // unfortunately, [NSWindowController showWindow:] will also bring it
@@ skipping 40 matching lines @@
 // function is exposed for unit testing.
 - (NSWindow*)initializeWindow {
   NSWindow* window = [self window];  // completes nib load
 
   if (type_ == extension_installed_bubble::kOmniboxKeyword) {
     [infoBubbleView_ setArrowLocation:info_bubble::kTopLeft];
   } else {
     [infoBubbleView_ setArrowLocation:info_bubble::kTopRight];
   }
 
+  if (type_ == extension_installed_bubble::kBundle)
+    return window;
+
   // Set appropriate icon, resizing if necessary.
   if ([icon_ size].width > extension_installed_bubble::kIconSize) {
     [icon_ setSize:NSMakeSize(extension_installed_bubble::kIconSize,
                               extension_installed_bubble::kIconSize)];
   }
   [iconImage_ setImage:icon_];
   [iconImage_ setNeedsDisplay:YES];
   return window;
- }
+}
 
 // Calculate the height of each install message, resizing messages in their
 // frames to fit window width.  Return the new window height, based on the
 // total of all message heights.
 - (int)calculateWindowHeight {
   // Adjust the window height to reflect the sum height of all messages
   // and vertical padding.
   int newWindowHeight = 2 * extension_installed_bubble::kOuterVerticalMargin;
 
   // First part of extension installed message.
-  string16 extension_name = UTF8ToUTF16(extension_->name().c_str());
-  base::i18n::AdjustStringForLocaleDirection(&extension_name);
-  [extensionInstalledMsg_ setStringValue:l10n_util::GetNSStringF(
-      IDS_EXTENSION_INSTALLED_HEADING, extension_name)];
-  [GTMUILocalizerAndLayoutTweaker
+  if (type_ != extension_installed_bubble::kBundle) {
+    string16 extension_name = UTF8ToUTF16(extension_->name().c_str());
+    base::i18n::AdjustStringForLocaleDirection(&extension_name);
+    [extensionInstalledMsg_ setStringValue:l10n_util::GetNSStringF(
+        IDS_EXTENSION_INSTALLED_HEADING, extension_name)];
+    [GTMUILocalizerAndLayoutTweaker
       sizeToFitFixedWidthTextField:extensionInstalledMsg_];
-  newWindowHeight += [extensionInstalledMsg_ frame].size.height +
-      extension_installed_bubble::kInnerVerticalMargin;
+    newWindowHeight += [extensionInstalledMsg_ frame].size.height +
+        extension_installed_bubble::kInnerVerticalMargin;
+  }
 
   // If type is page action, include a special message about page actions.
   if (type_ == extension_installed_bubble::kPageAction) {
     [extraInfoMsg_ setHidden:NO];
     [[extraInfoMsg_ cell]
         setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
     [GTMUILocalizerAndLayoutTweaker
         sizeToFitFixedWidthTextField:extraInfoMsg_];
     newWindowHeight += [extraInfoMsg_ frame].size.height +
         extension_installed_bubble::kInnerVerticalMargin;
   }
 
   // If type is omnibox keyword, include a special message about the keyword.
   if (type_ == extension_installed_bubble::kOmniboxKeyword) {
     [extraInfoMsg_ setStringValue:l10n_util::GetNSStringF(
         IDS_EXTENSION_INSTALLED_OMNIBOX_KEYWORD_INFO,
         UTF8ToUTF16(extension_->omnibox_keyword()))];
     [extraInfoMsg_ setHidden:NO];
     [[extraInfoMsg_ cell]
         setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
     [GTMUILocalizerAndLayoutTweaker
         sizeToFitFixedWidthTextField:extraInfoMsg_];
     newWindowHeight += [extraInfoMsg_ frame].size.height +
         extension_installed_bubble::kInnerVerticalMargin;
   }
 
-  // Second part of extension installed message.
-  [[extensionInstalledInfoMsg_ cell]
-      setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
-  [GTMUILocalizerAndLayoutTweaker
-      sizeToFitFixedWidthTextField:extensionInstalledInfoMsg_];
-  newWindowHeight += [extensionInstalledInfoMsg_ frame].size.height;
+  // If type is bundle, list the extensions that were installed and those that
+  // failed.
+  if (type_ == extension_installed_bubble::kBundle) {
+    NSInteger installedListHeight =
+        [self addExtensionList:installedHeadingMsg_
+                      itemsMsg:installedItemsMsg_
+                         state:BundleInstaller::Item::STATE_INSTALLED];
+
+    NSInteger failedListHeight =
+        [self addExtensionList:failedHeadingMsg_
+                      itemsMsg:failedItemsMsg_
+                         state:BundleInstaller::Item::STATE_FAILED];
+
+    newWindowHeight += installedListHeight + failedListHeight;
+
+    // Put some space between the lists if both are present.
+    if (installedListHeight > 0 && failedListHeight > 0)
+      newWindowHeight += extension_installed_bubble::kInnerVerticalMargin;
+

[Robert Sesek, 2012/03/05 18:30:13]

nit: remove blank line

[jstritar, 2012/03/05 19:12:00]

Done.

+  } else {
+    // Second part of extension installed message.
+    [[extensionInstalledInfoMsg_ cell]
+        setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
+    [GTMUILocalizerAndLayoutTweaker
+        sizeToFitFixedWidthTextField:extensionInstalledInfoMsg_];
+    newWindowHeight += [extensionInstalledInfoMsg_ frame].size.height;
+  }
 
   return newWindowHeight;
 }
 
+- (int)addExtensionList:(NSTextField*)headingMsg

[Robert Sesek, 2012/03/05 18:30:13]

(NSInteger)

[jstritar, 2012/03/05 19:12:00]

Done.

+               itemsMsg:(NSTextField*)itemsMsg
+                  state:(BundleInstaller::Item::State)state {
+  string16 heading = bundle_->GetHeadingTextFor(state);
+  bool hidden = heading.empty();
+  [headingMsg setHidden:hidden];
+  [itemsMsg setHidden:hidden];
+  if (hidden)
+    return 0;
+
+  [headingMsg setStringValue:base::SysUTF16ToNSString(heading)];
+  [GTMUILocalizerAndLayoutTweaker sizeToFitFixedWidthTextField:headingMsg];
+
+  NSMutableString* joinedItems = [NSMutableString string];
+  BundleInstaller::ItemList items = bundle_->GetItemsWithState(state);
+  for (size_t i = 0; i < items.size(); ++i) {
+    if (i > 0)
+      [joinedItems appendString:@"\n"];
+    [joinedItems appendString:base::SysUTF16ToNSString(
+        items[i].GetNameForDisplay())];
+  }
+
+  [itemsMsg setStringValue:joinedItems];
+  [GTMUILocalizerAndLayoutTweaker sizeToFitFixedWidthTextField:itemsMsg];
+
+  return [headingMsg frame].size.height +
+      extension_installed_bubble::kInnerVerticalMargin +
+      [itemsMsg frame].size.height;
+}
+
 // Adjust y-position of messages to sit properly in new window height.
 - (void)setMessageFrames:(int)newWindowHeight {
-  // The extension messages will always be shown.
+  if (type_ == extension_installed_bubble::kBundle) {
+    // Layout the messages from the bottom up.
+    NSTextField* msgs[] = { failedItemsMsg_, failedHeadingMsg_,
+                            installedItemsMsg_, installedHeadingMsg_ };
+    int offsetFromBottom = 0;
+    BOOL is_first_visible = YES;

[Robert Sesek, 2012/03/05 18:30:13]

naming: isFirstVisible

[jstritar, 2012/03/05 19:12:00]

Done.

+    for (size_t i = 0; i < arraysize(msgs); ++i) {
+      if ([msgs[i] isHidden])
+        continue;
+
+      NSRect frame = [msgs[i] frame];
+      int margin = is_first_visible ?
+          extension_installed_bubble::kOuterVerticalMargin :
+          extension_installed_bubble::kInnerVerticalMargin;
+
+      frame.origin.y = offsetFromBottom + margin;
+      [msgs[i] setFrame:frame];
+      offsetFromBottom += frame.size.height + margin;
+
+      is_first_visible = NO;
+    }
+
+    // Move the close button a bit to vertically align it with the heading.
+    int closeButtonFudge = 1;
+    NSRect frame = [closeButton_ frame];
+    frame.origin.y = newWindowHeight - (frame.size.height + closeButtonFudge +
+         extension_installed_bubble::kOuterVerticalMargin);
+    [closeButton_ setFrame:frame];
+
+    return;
+  }
+
   NSRect extensionMessageFrame1 = [extensionInstalledMsg_ frame];
   NSRect extensionMessageFrame2 = [extensionInstalledInfoMsg_ frame];
 
   extensionMessageFrame1.origin.y = newWindowHeight - (
       extensionMessageFrame1.size.height +
       extension_installed_bubble::kOuterVerticalMargin);
   [extensionInstalledMsg_ setFrame:extensionMessageFrame1];
   if (type_ == extension_installed_bubble::kPageAction ||
       type_ == extension_installed_bubble::kOmniboxKeyword) {
     // The extra message is only shown when appropriate.
@@ skipping 24 matching lines @@
 
 - (NSRect)getExtensionInstalledInfoMsgFrame {
   return [extensionInstalledInfoMsg_ frame];
 }
 
 - (void)extensionUnloaded:(id)sender {
   extension_ = NULL;
 }
 
 @end