Make the About box display existing pending operations instead of firing off a new update check

chrome/browser/cocoa/about_window_controller.mm

 // 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 "app/l10n_util_mac.h"
 #include "app/resource_bundle.h"
 #include "base/logging.h"
 #include "base/mac_util.h"
 #include "base/string_util.h"
 #include "base/sys_string_conversions.h"
@@ skipping 123 matching lines @@
   NSRect oldLegalRect = [legalBlock_ frame];
   [legalText_ sizeToFit];
   NSRect newRect = oldLegalRect;
   newRect.size.height = [legalText_ frame].size.height;
   [legalBlock_ setFrame:newRect];
   CGFloat legalShift = newRect.size.height - oldLegalRect.size.height;
 
   KeystoneGlue* keystoneGlue = [KeystoneGlue defaultKeystoneGlue];
   CGFloat updateShift;
   if (keystoneGlue) {
-    NSNotification* recentNotification = [keystoneGlue recentNotification];
-    NSDictionary* recentDictionary = [recentNotification userInfo];
-    AutoupdateStatus recentStatus = static_cast<AutoupdateStatus>(
-        [[recentDictionary objectForKey:kAutoupdateStatusStatus] intValue]);
-    if (recentStatus == kAutoupdateInstallFailed) {
-      // A previous update attempt was unsuccessful, but no About box was
-      // around to report status.  Use the saved notification to set up the
-      // About box with the error message, and to allow another chance to
+    if ([keystoneGlue asyncOperationPending] ||
+        [keystoneGlue recentStatus] == kAutoupdateInstallFailed) {
+      // If an asynchronous update operation is currently pending, such as a
+      // check for updates or an update installation attempt, set the status
+      // up correspondingly without launching a new update check.
+      //
+      // If a previous update attempt was unsuccessful but no About box was
+      // around to report the error, show it now, and allow another chance to
       // install the update.
-      [self updateStatus:recentNotification];
+      [self updateStatus:[keystoneGlue recentNotification]];
     } else {
+      // Launch a new update check, even if one was already completed, because
+      // a new update may be available or a new update may have been installed
+      // in the background since the last time an About box was displayed.
       [self checkForUpdate];
     }
 
     updateShift = 0.0;
   } else {
     // Hide all the update UI
     [updateBlock_ setHidden:YES];
 
     // Figure out the amount being removed by taking out the update block
     // and its spacing.
@@ skipping 36 matching lines @@
   ResourceBundle& rb = ResourceBundle::GetSharedInstance();
   NSImage* statusImage = rb.GetNSImageNamed(imageID);
   DCHECK(statusImage);
   [updateStatusIndicator_ setImage:statusImage];
   [updateStatusIndicator_ setHidden:NO];
 
   [updateText_ setStringValue:message];
 }
 
 - (void)checkForUpdate {
-  [self setUpdateThrobberMessage:
-      l10n_util::GetNSStringWithFixup(IDS_UPGRADE_CHECK_STARTED)];
   [[KeystoneGlue defaultKeystoneGlue] checkForUpdate];
 
+  // Immediately, kAutoupdateStatusNotification will be posted, and
+  // -updateStatus: will be called with status kAutoupdateChecking.
+  //
   // Upon completion, kAutoupdateStatusNotification will be posted, and
-  // -updateStatus: will be called.
+  // -updateStatus: will be called with a status indicating the result of the
+  // check.
 }
 
 - (IBAction)updateNow:(id)sender {
   updateTriggered_ = YES;
 
-  // Don't let someone click "Update Now" twice!
-  [updateNowButton_ setEnabled:NO];
-  [self setUpdateThrobberMessage:
-      l10n_util::GetNSStringWithFixup(IDS_UPGRADE_STARTED)];
   [[KeystoneGlue defaultKeystoneGlue] installUpdate];
 
+  // Immediately, kAutoupdateStatusNotification will be posted, and
+  // -updateStatus: will be called with status kAutoupdateInstalling.
+  //
   // Upon completion, kAutoupdateStatusNotification will be posted, and
-  // -updateStatus: will be called.
+  // -updateStatus: will be called with a status indicating the result of the
+  // installation attempt.
 }
 
 - (void)updateStatus:(NSNotification*)notification {
   NSDictionary* dictionary = [notification userInfo];
   AutoupdateStatus status = static_cast<AutoupdateStatus>(
       [[dictionary objectForKey:kAutoupdateStatusStatus] intValue]);
 
   // Don't assume |version| is a real string.  It may be nil.
   NSString* version = [dictionary objectForKey:kAutoupdateStatusVersion];
 
-  int imageID;
+  bool throbber = false;
+  int imageID = 0;
   NSString* message;
 
   switch (status) {
+    case kAutoupdateChecking:
+      throbber = true;
+      message = l10n_util::GetNSStringWithFixup(IDS_UPGRADE_CHECK_STARTED);
+
+      break;
+
     case kAutoupdateCurrent:
       imageID = IDR_UPDATE_UPTODATE;
       message = l10n_util::GetNSStringFWithFixup(
           IDS_UPGRADE_ALREADY_UP_TO_DATE,
           l10n_util::GetStringUTF16(IDS_PRODUCT_NAME),
           base::SysNSStringToUTF16(version));
 
       break;
 
     case kAutoupdateAvailable:
       imageID = IDR_UPDATE_AVAILABLE;
       message = l10n_util::GetNSStringFWithFixup(
           IDS_UPGRADE_AVAILABLE, l10n_util::GetStringUTF16(IDS_PRODUCT_NAME));
       [updateNowButton_ setEnabled:YES];
 
       break;
 
+    case kAutoupdateInstalling:
+      // Don't let someone click "Update Now" twice.
+      [updateNowButton_ setEnabled:NO];
+
+      throbber = true;
+      message = l10n_util::GetNSStringWithFixup(IDS_UPGRADE_STARTED);
+
+      break;
+
     case kAutoupdateInstalled:
       {
         imageID = IDR_UPDATE_UPTODATE;
         string16 productName = l10n_util::GetStringUTF16(IDS_PRODUCT_NAME);
         if (version) {
           message = l10n_util::GetNSStringFWithFixup(
               IDS_UPGRADE_SUCCESSFUL,
               productName,
               base::SysNSStringToUTF16(version));
         } else {
           message = l10n_util::GetNSStringFWithFixup(
               IDS_UPGRADE_SUCCESSFUL_NOVERSION, productName);
         }
 
         // TODO(mark): Turn the button in the dialog into a restart button
         // instead of springing this sheet or dialog.
         NSWindow* window = [self window];
         NSWindow* restartDialogParent = [window isVisible] ? window : nil;
         restart_browser::RequestRestart(restartDialogParent);
       }
 
       break;
 
     case kAutoupdateInstallFailed:
+      // Since the installation failure will now be displayed in an About box,
+      // the saved state can be cleared.  If the About box is closed and then
+      // reopened, this will let it start out with a clean slate and not be
+      // affected by past failures.
+      [[KeystoneGlue defaultKeystoneGlue] clearRecentNotification];
+
       // Allow another chance.
       [updateNowButton_ setEnabled:YES];
 
       // Fall through.
 
     case kAutoupdateCheckFailed:
       // TODO(mark): Keystone doesn't currently indicate when a check for
       // updates failed.  Fix that.
       imageID = IDR_UPDATE_FAIL;
       message = l10n_util::GetNSStringFWithFixup(IDS_UPGRADE_ERROR,
                                                  IntToString16(status));
 
       break;
 
     default:
       NOTREACHED();
       return;
   }
 
-  [self setUpdateImage:imageID message:message];
-
-  // Since the update status is now displayed in an About box, the saved state
-  // can be cleared.  If the About box is closed and then reopened, this will
-  // let it start out with a clean slate and not be affected by past failures.
-  [[KeystoneGlue defaultKeystoneGlue] clearRecentNotification];
+  if (throbber) {
+    [self setUpdateThrobberMessage:message];
+  } else {
+    DCHECK_NE(imageID, 0);
+    [self setUpdateImage:imageID message:message];
+  }
 }
 
 - (BOOL)textView:(NSTextView *)aTextView
    clickedOnLink:(id)link
          atIndex:(NSUInteger)charIndex {
   // We always create a new window, so there's no need to try to re-use
   // an existing one just to pass in the NEW_WINDOW disposition.
   Browser* browser = Browser::Create(profile_);
   if (browser) {
     browser->OpenURL(GURL([link UTF8String]), GURL(), NEW_WINDOW,
@@ skipping 41 matching lines @@
 
   // Now fetch the license string and deal with the markers
 
   NSString* license =
       l10n_util::GetNSStringWithFixup(IDS_ABOUT_VERSION_LICENSE);
 
   NSRange begin_chr = [license rangeOfString:kBeginLinkChr];
   NSRange begin_oss = [license rangeOfString:kBeginLinkOss];
   NSRange end_chr = [license rangeOfString:kEndLinkChr];
   NSRange end_oss = [license rangeOfString:kEndLinkOss];
-  DCHECK(begin_chr.location != NSNotFound);
-  DCHECK(begin_oss.location != NSNotFound);
-  DCHECK(end_chr.location != NSNotFound);
-  DCHECK(end_oss.location != NSNotFound);
+  DCHECK_NE(begin_chr.location, NSNotFound);
+  DCHECK_NE(begin_oss.location, NSNotFound);
+  DCHECK_NE(end_chr.location, NSNotFound);
+  DCHECK_NE(end_oss.location, NSNotFound);
 
   // We don't know which link will come first, so we have to deal with things
   // like this:
   //   [text][begin][text][end][text][start][text][end][text]
 
   bool chromium_link_first = begin_chr.location < begin_oss.location;
 
   NSRange* begin1 = &begin_chr;
   NSRange* begin2 = &begin_oss;
   NSRange* end1 = &end_chr;
@@ skipping 62 matching lines @@
   NSRange string_range = NSMakeRange(0, [legal_block length]);
   [legal_block addAttribute:NSFontAttributeName
                       value:[NSFont labelFontOfSize:11]
                       range:string_range];
 
   [legal_block endEditing];
   return legal_block;
 }
 
 @end  // @implementation AboutWindowController