Fixed Windows system tray icon.

chrome/browser/background/background_mode_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/background/background_mode_manager.h"
 
 #include <algorithm>
 #include <string>
 #include <vector>
 
@@ skipping 31 matching lines @@
 #include "chrome/browser/ui/extensions/app_launch_params.h"
 #include "chrome/browser/ui/extensions/application_launch.h"
 #include "chrome/browser/ui/host_desktop.h"
 #include "chrome/browser/ui/user_manager.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/extensions/extension_constants.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/grit/chromium_strings.h"
 #include "chrome/grit/generated_resources.h"
+#include "content/public/browser/browser_thread.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/user_metrics.h"
 #include "extensions/browser/extension_system.h"
 #include "extensions/common/constants.h"
 #include "extensions/common/extension.h"
 #include "extensions/common/manifest_handlers/options_page_info.h"
 #include "extensions/common/one_shot_event.h"
 #include "extensions/common/permissions/permission_set.h"
 #include "grit/chrome_unscaled_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 
+#if defined(OS_WIN)
+#include "chrome/browser/app_icon_win.h"
+#endif
+
 using base::UserMetricsAction;
 using extensions::Extension;
 
 namespace {
 
 // Enum for recording menu item clicks in UMA.
 // NOTE: Do not renumber these as that would confuse interpretation of
 // previously logged data. When making changes, also update histograms.xml.
 enum MenuItem {
   MENU_ITEM_ABOUT = 0,
@@ skipping 673 matching lines @@
   background_mode_suspended_ = false;
   UpdateKeepAliveAndTrayIcon();
 }
 
 void BackgroundModeManager::UpdateKeepAliveAndTrayIcon() {
   if (in_background_mode_ && !background_mode_suspended_) {
     if (!keeping_alive_) {
       keeping_alive_ = true;
       chrome::IncrementKeepAliveCount();
     }
+
     CreateStatusTrayIcon();
     return;
   }
 
   RemoveStatusTrayIcon();
   if (keeping_alive_) {
     keeping_alive_ = false;
     chrome::DecrementKeepAliveCount();
   }
 }
@@ skipping 82 matching lines @@
 
   // Ensure we have a tray icon (needed so we can display the app-installed
   // notification below).
   EnableBackgroundMode();
   ResumeBackgroundMode();
 
   // Notify the user that a background client has been installed.
   DisplayClientInstalledNotification(name);
 }
 
+// Gets the image for the status tray icon, at the correct size for the current
+// platform and display settings.
+gfx::ImageSkia GetStatusTrayIcon() {
+#if defined(OS_WIN)
+  // On Windows, use GetSmallAppIconSize to get the correct image size. The
+  // user's "text size" setting in Windows determines how large the system tray
+  // icon should be.
+  gfx::Size size = GetSmallAppIconSize();
+
+  // This loads all of the icon images, which is a bit wasteful because we're
+  // going to pick one and throw the rest away, but that is the price of using
+  // the ImageFamily abstraction. Note: We could just use the LoadImage function
+  // from the Windows API, but that does a *terrible* job scaling images.
+  // Therefore, we fetch the images and do our own high-quality scaling.
+  scoped_ptr<gfx::ImageFamily> family = GetAppIconImageFamily();
+  DCHECK(family);
+  if (!family)
+    return gfx::ImageSkia();
+
+  return family->CreateExact(size).AsImageSkia();
+#else
+  // On other platforms, just get a static resource image.
+  return *ui::ResourceBundle::GetSharedInstance().GetImageSkiaNamed(
+      IDR_STATUS_TRAY_ICON);
+#endif
+}
+
 void BackgroundModeManager::CreateStatusTrayIcon() {
+  // Creating the status tray icon can take time (as it has to load and
+  // potentially scale the icon resource), so this task should not block
+  // startup time.
+  content::BrowserThread::PostAfterStartupTask(

[Andrew T Wilson (Slow), 2015/11/23 11:28:11]

This seems incorrect, because it's possible that someone may have called
RemoveStatusTrayIcon() while this task was queued (for example, if we are no
longer in background mode because an extension has been uninstalled, etc).

If we can't take the time during startup to scale an icon, can we instead just
use a static resource image immediately, then queue up a task to replace that
image with a scaled one later via StatusIcon::SetImage()?

[Matt Giuca, 2015/11/24 07:07:46]

That's a good point. But we can work around it by having a "pending" Boolean
which is set to true by calling CreateStatusTrayIcon and false by
RemoveStatusTrayIcon, then CreateStatusTrayIconTask checks that the Boolean is
still set to true.
Hmm, the reason I am doing this is because the static resource is extremely ugly
(because Windows scales it to a size that we can't control for). So I think that
will be a weird experience to see an ugly icon, then have it snap to a nice one.
I'd rather not.

+      FROM_HERE, content::BrowserThread::GetMessageLoopProxyForThread(
+                     content::BrowserThread::UI),
+      base::Bind(&BackgroundModeManager::CreateStatusTrayIconTask,
+                 weak_factory_.GetWeakPtr()));
+}
+
+void BackgroundModeManager::CreateStatusTrayIconTask() {
   // Only need status icons on windows/linux. ChromeOS doesn't allow exiting
   // Chrome and Mac can use the dock icon instead.
 
   // Since there are multiple profiles which share the status tray, we now
   // use the browser process to keep track of it.
 #if !defined(OS_MACOSX) && !defined(OS_CHROMEOS)
   if (!status_tray_)
     status_tray_ = g_browser_process->status_tray();
 #endif
 
   // If the platform doesn't support status icons, or we've already created
   // our status icon, just return.
   if (!status_tray_ || status_icon_)
     return;
 
-  gfx::ImageSkia* image_skia = ui::ResourceBundle::GetSharedInstance().
-      GetImageSkiaNamed(IDR_STATUS_TRAY_ICON);
-
   status_icon_ = status_tray_->CreateStatusIcon(
-      StatusTray::BACKGROUND_MODE_ICON,
-      *image_skia,
+      StatusTray::BACKGROUND_MODE_ICON, GetStatusTrayIcon(),
       l10n_util::GetStringUTF16(IDS_PRODUCT_NAME));
   if (!status_icon_)
     return;
   UpdateStatusTrayIconContextMenu();
 }
 
 void BackgroundModeManager::UpdateStatusTrayIconContextMenu() {
   // Ensure we have a tray icon if appropriate.
   UpdateKeepAliveAndTrayIcon();
 
@@ skipping 101 matching lines @@
     }
   }
   return profile_it;
 }
 
 bool BackgroundModeManager::IsBackgroundModePrefEnabled() const {
   PrefService* service = g_browser_process->local_state();
   DCHECK(service);
   return service->GetBoolean(prefs::kBackgroundModeEnabled);
 }