Adds a first-run balloon to the Windows notification center.

chrome/browser/notifications/message_center_notification_manager.cc

 // 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.
 
 #include "chrome/browser/notifications/message_center_notification_manager.h"
 
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/prefs/pref_service.h"
 #include "chrome/browser/extensions/extension_info_map.h"
 #include "chrome/browser/extensions/extension_system.h"
 #include "chrome/browser/notifications/desktop_notification_service.h"
 #include "chrome/browser/notifications/desktop_notification_service_factory.h"
 #include "chrome/browser/notifications/message_center_settings_controller.h"
 #include "chrome/browser/notifications/notification.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/chrome_pages.h"
 #include "chrome/browser/ui/host_desktop.h"
 #include "chrome/common/extensions/extension_set.h"
 #include "chrome/common/pref_names.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/url_constants.h"
 #include "ui/message_center/message_center_style.h"
 #include "ui/message_center/message_center_tray.h"
 #include "ui/message_center/notifier_settings.h"
 
+namespace {
+

[Andrew T Wilson (Slow), 2013/06/19 06:28:57]

Remove blank line, and add a comment for what this is.

[dewittj, 2013/06/20 02:20:54]

Done.

+const int kIdleDelaySeconds = 1;
+}
+
 MessageCenterNotificationManager::MessageCenterNotificationManager(
-    message_center::MessageCenter* message_center)
+    message_center::MessageCenter* message_center,
+    PrefService* local_state)
     : message_center_(message_center),
       settings_controller_(new MessageCenterSettingsController) {
+  first_run_pref_.Init(prefs::kMessageCenterShowedFirstRunBalloon, local_state);
+
   message_center_->SetDelegate(this);
   message_center_->AddObserver(this);
 
 #if defined(OS_WIN) || defined(OS_MACOSX) \
   || (defined(USE_AURA) && !defined(USE_ASH))
   // On Windows, Linux and Mac, the notification manager owns the tray icon and
   // views.Other platforms have global ownership and Create will return NULL.
   tray_.reset(message_center::CreateMessageCenterTray());
 #endif
 }
 
 MessageCenterNotificationManager::~MessageCenterNotificationManager() {
   message_center_->RemoveObserver(this);
 }
 
+void MessageCenterNotificationManager::DisplayFirstRunBalloon() {
+#if !defined(OS_WIN)
+  // The first run balloon is only displayed on Windows, since the visibility of
+  // the tray icon is limited.
+  return;

[Andrew T Wilson (Slow), 2013/06/19 06:28:57]

I think it's better to make the entire method #if defined(OS_WIN) here and below
- no reason to include code that's never going to get executed.

[dewittj, 2013/06/20 02:20:54]

Done.

+#endif
+
+  if (!tray_)
+    return;
+
+  // Store for posterity the fact that we've shown the first-run balloon.
+  first_run_pref_.SetValue(true);
+  tray_->DisplayFirstRunBalloon();
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 // NotificationUIManager
 
 bool MessageCenterNotificationManager::DoesIdExist(const std::string& id) {
   if (NotificationUIManagerImpl::DoesIdExist(id))
     return true;
   NotificationMap::iterator iter = profile_notifications_.find(id);
   if (iter == profile_notifications_.end())
     return false;
@@ skipping 210 matching lines @@
 void MessageCenterNotificationManager::OnNotificationRemoved(
     const std::string& notification_id,
     bool by_user) {
   // Do not call FindProfileNotification(). Some tests create notifications
   // directly to MessageCenter, but this method will be called for the removals
   // of such notifications.
   NotificationMap::const_iterator iter =
       profile_notifications_.find(notification_id);
   if (iter != profile_notifications_.end())
     RemoveProfileNotification(iter->second, by_user);
+
+  CheckFirstRunTimer();
 }
 
 void MessageCenterNotificationManager::OnNotificationCenterClosed() {
   // When the center is open it halts all notifications, so we need to listen
   // for events indicating it's been closed.
   CheckAndShowNotifications();
+  CheckFirstRunTimer();
+}
+
+void MessageCenterNotificationManager::OnNotificationUpdated(
+    const std::string& notification_id) {
+  CheckFirstRunTimer();
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // ImageDownloads
 
 MessageCenterNotificationManager::ImageDownloads::ImageDownloads(
     message_center::MessageCenter* message_center,
     ImageDownloadsObserver* observer)
     : message_center_(message_center),
       pending_downloads_(0),
@@ skipping 196 matching lines @@
 
 MessageCenterNotificationManager::ProfileNotification*
     MessageCenterNotificationManager::FindProfileNotification(
         const std::string& id) const {
   NotificationMap::const_iterator iter = profile_notifications_.find(id);
   if (iter == profile_notifications_.end())
     return NULL;
 
   return (*iter).second;
 }
+
+void MessageCenterNotificationManager::CheckFirstRunTimer() {
+#if !defined(OS_WIN)
+  // The first run balloon is only used on Windows, since it is the platform
+  // that has the most issues with tray icon visibility.
+  return;
+#endif
+
+  // If there is no tray_, we can't display a balloon here anyway.
+  // Also, we only want to display the first run balloon once, so the pref will
+  // store the flag on disk based on whether we ever showed the balloon.
+  if (!tray_.get() || first_run_pref_.GetValue())

[Andrew T Wilson (Slow), 2013/06/19 06:28:57]

What's the case where tray_ is null? Can we ever *not* have a tray on windows?

[dewittj, 2013/06/20 02:20:54]

There is no case where tray_ is null.  I was just being extra cautious in case
that ever happens.

+    return;
+
+  // If there are popups, the message center is visible, or there are no more
+  // notifications, don't continue the timer since it will be annoying or
+  // useless.
+  if (message_center_->HasPopupNotifications() ||
+      message_center_->IsMessageCenterVisible() ||
+      0 == message_center_->NotificationCount()) {
+    first_run_balloon_timer_.Stop();
+    return;
+  }
+
+  // No need to restart the timer if it's already going.
+  if (first_run_balloon_timer_.IsRunning())
+    return;
+
+  first_run_balloon_timer_.Start(
+      FROM_HERE,
+      base::TimeDelta::FromSeconds(kIdleDelaySeconds),
+      base::Bind(&MessageCenterNotificationManager::DisplayFirstRunBalloon,
+                 AsWeakPtr()));
+}