[Win] Add a fast profile switcher to the Windows taskbar item.

chrome/browser/jumplist_win.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/jumplist_win.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
 #include "base/files/file_util.h"
 #include "base/path_service.h"
 #include "base/prefs/pref_change_registrar.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread.h"
+#include "chrome/browser/browser_process.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/favicon/favicon_service.h"
 #include "chrome/browser/favicon/favicon_service_factory.h"
 #include "chrome/browser/history/history_service.h"
 #include "chrome/browser/history/top_sites.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/profiles/profile_avatar_icon_util.h"
+#include "chrome/browser/profiles/profile_info_cache.h"
+#include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/sessions/session_types.h"
 #include "chrome/browser/sessions/tab_restore_service.h"
 #include "chrome/browser/sessions/tab_restore_service_factory.h"
 #include "chrome/browser/shell_integration.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/url_constants.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/favicon_base/favicon_types.h"
@@ skipping 88 matching lines @@
     items.push_back(incognito);
   }
 
   return jumplist_updater->AddTasks(items);
 }
 
 // Updates the application JumpList.
 bool UpdateJumpList(const wchar_t* app_id,
                     const ShellLinkItemList& most_visited_pages,
                     const ShellLinkItemList& recently_closed_pages,
+                    const ShellLinkItemList& profile_switcher,
                     IncognitoModePrefs::Availability incognito_availability) {
   // JumpList is implemented only on Windows 7 or later.
   // So, we should return now when this function is called on earlier versions
   // of Windows.
   if (!JumpListUpdater::IsEnabled())
     return true;
 
   JumpListUpdater jumplist_updater(app_id);
   if (!jumplist_updater.BeginUpdate())
     return false;
 
   // We allocate 60% of the given JumpList slots to "most-visited" items
   // and 40% to "recently-closed" items, respectively.
   // Nevertheless, if there are not so many items in |recently_closed_pages|,
   // we give the remaining slots to "most-visited" items.
   const int kMostVisited = 60;
   const int kRecentlyClosed = 40;
   const int kTotal = kMostVisited + kRecentlyClosed;
   size_t most_visited_items =
       MulDiv(jumplist_updater.user_max_items(), kMostVisited, kTotal);

[tapted, 2014/11/04 23:10:48]

I think you'll need to update these values - maxing out the most visted/recently
closed will probably omit profiles (and tasks) below when trying to add them as
well. And.. it might get a bit tricky. Probably something like

// If a user has many profiles, don't clobber all the sites, and if
user_max_items has been set to be very small, don't underflow.
const int kTotalSites = kMostVisited + kRecentlyClosed;
const int kMaxProfiles = 5;
size_t shown_profile_count = std::min(jumplist_updater.user_max_items(),
                std::min(kMaxProfiles, profile_switcher.size()));
size_t available_slots = jumplist_updater.user_max_items() -
shown_profile_count;
size_t most_visited_items = MulDiv(available_slots, kMostVisited, kTotalSites);
...
size_t recently_closed_items = available_slots - most_visited_items;

It's a tricky algorithm - maybe check with a PM what a good distribution is.

(note: apparently the default limit is 10, but it's user-configurable -
http://msdn.microsoft.com/en-us/library/windows/desktop/dd378398(v=vs.85).aspx,
there's also a limit of 4 section headers, which I think we've hit now)

[noms (inactive), 2014/11/10 21:46:08]

Annnnnd this went down a crazy alley and now there's a Finch experiment to see
if we should replace Most Visited with Profiles (PMs and UI are in favour of
this)

   size_t recently_closed_items =
       jumplist_updater.user_max_items() - most_visited_items;
   if (recently_closed_pages.size() < recently_closed_items) {
     most_visited_items += recently_closed_items - recently_closed_pages.size();
     recently_closed_items = recently_closed_pages.size();
   }
 
   // Update the "Most Visited" category of the JumpList.
   // This update request is applied into the JumpList when we commit this
   // transaction.
   if (!jumplist_updater.AddCustomCategory(
           base::UTF16ToWide(
               l10n_util::GetStringUTF16(IDS_NEW_TAB_MOST_VISITED)),
           most_visited_pages, most_visited_items)) {
     return false;
   }
 
   // Update the "Recently Closed" category of the JumpList.
   if (!jumplist_updater.AddCustomCategory(
           base::UTF16ToWide(
               l10n_util::GetStringUTF16(IDS_NEW_TAB_RECENTLY_CLOSED)),
           recently_closed_pages, recently_closed_items)) {
     return false;
   }
 
+  // Update the "Profiles" category of the JumpList.

[tapted, 2014/11/04 23:10:48]

nit: Profiles -> People?

(and super-nit: should the comment in generated_resources.grd be updated? It's
currently "The name of the sync group in the options dialog when using the new
Profiles UI." but I guess the section on chrome://settings is now the old
Profile UI, and it should probably say something about being used for OS Menu
taskbar switchers.)

[noms (inactive), 2014/11/10 21:46:08]

Done re: the comment.
Chrome://settings is still part of the "new" profiles UI. By "old" UI we mean
the old avatar button/bubble, and using "Users" instead of "People". There will
be a giant cleanup bug when this thing actually lands for more than a
release....

+  if (!jumplist_updater.AddCustomCategory(
+          l10n_util::GetStringUTF16(IDS_PROFILES_OPTIONS_GROUP_NAME),
+          profile_switcher, profile_switcher.size())) {
+    return false;
+  }
+
   // Update the "Tasks" category of the JumpList.
   if (!UpdateTaskCategory(&jumplist_updater, incognito_availability))
     return false;
 
   // Commit this transaction and send the updated JumpList to Windows.
   if (!jumplist_updater.CommitUpdate())
     return false;
 
   return true;
 }
@@ skipping 32 matching lines @@
     // observers are detatched at that time.
     registrar_->Add(this, chrome::NOTIFICATION_PROFILE_DESTROYED,
                     content::Source<Profile>(profile_));
   }
   tab_restore_service->AddObserver(this);
   pref_change_registrar_.reset(new PrefChangeRegistrar);
   pref_change_registrar_->Init(profile_->GetPrefs());
   pref_change_registrar_->Add(
       prefs::kIncognitoModeAvailability,
       base::Bind(&JumpList::OnIncognitoAvailabilityChanged, this));
+
+  ProfileManager* profile_manager = g_browser_process->profile_manager();
+  DCHECK(profile_manager);
+  avatar_menu_.reset(new AvatarMenu(
+      &profile_manager->GetProfileInfoCache(), this, NULL));
+  avatar_menu_->RebuildMenu();
+  UpdateProfileSwitcher();
 }
 
 JumpList::~JumpList() {
   Terminate();
 }
 
 // static
 bool JumpList::Enabled() {
   return JumpListUpdater::IsEnabled();
 }
@@ skipping 106 matching lines @@
     recently_closed_pages_ = temp_list;
   }
 
   // Send a query that retrieves the first favicon.
   StartLoadingFavicon();
 }
 
 void JumpList::TabRestoreServiceDestroyed(TabRestoreService* service) {
 }
 
+void JumpList::OnAvatarMenuChanged(AvatarMenu* avatar_menu) {
+  UpdateProfileSwitcher();
+  PostRunUpdate();
+}
+
 bool JumpList::AddTab(const TabRestoreService::Tab* tab,
                       ShellLinkItemList* list,
                       size_t max_items) {
   // This code adds the URL and the title strings of the given tab to the
   // specified list.
   if (list->size() >= max_items)
     return false;
 
   scoped_refptr<ShellLinkItem> link = CreateShellLink();
   const sessions::SerializedNavigationEntry& current_navigation =
@@ skipping 27 matching lines @@
     waiting_for_icons = !icon_urls_.empty();
     if (waiting_for_icons) {
       // Ask FaviconService if it has a favicon of a URL.
       // When FaviconService has one, it will call OnFaviconDataAvailable().
       url = GURL(icon_urls_.front().first);
     }
   }
 
   if (!waiting_for_icons) {
     // No more favicons are needed by the application JumpList. Schedule a
-    // RunUpdate call.
+    // RunUpdateOnFileThread call.
     PostRunUpdate();
     return;
   }
 
   FaviconService* favicon_service =
       FaviconServiceFactory::GetForProfile(profile_, Profile::EXPLICIT_ACCESS);
   task_id_ = favicon_service->GetFaviconImageForPageURL(
       url,
       base::Bind(&JumpList::OnFaviconDataAvailable, base::Unretained(this)),
       &cancelable_task_tracker_);
 }
 
 void JumpList::OnFaviconDataAvailable(
     const favicon_base::FaviconImageResult& image_result) {
   // If there is currently a favicon request in progress, it is now outdated,
   // as we have received another, so nullify the handle from the old request.
   task_id_ = base::CancelableTaskTracker::kBadTaskId;
-  // lock the list to set icon data and pop the url
+  // Lock the list to set icon data and pop the url.
   {
     base::AutoLock auto_lock(list_lock_);
     // Attach the received data to the ShellLinkItem object.
-    // This data will be decoded by the RunUpdate method.
+    // This data will be decoded by the RunUpdateOnFileThread method.
     if (!image_result.image.IsEmpty()) {
       if (!icon_urls_.empty() && icon_urls_.front().second)
         icon_urls_.front().second->set_icon_data(image_result.image.AsBitmap());
     }
 
     if (!icon_urls_.empty())
       icon_urls_.pop_front();
   }
   // Check whether we need to load more favicons.
   StartLoadingFavicon();
@@ skipping 12 matching lines @@
 }
 
 void JumpList::PostRunUpdate() {
   // Check if incognito windows (or normal windows) are disabled by policy.
   IncognitoModePrefs::Availability incognito_availability =
       profile_ ? IncognitoModePrefs::GetAvailability(profile_->GetPrefs())
                : IncognitoModePrefs::ENABLED;
 
   BrowserThread::PostTask(
       BrowserThread::FILE, FROM_HERE,
-      base::Bind(&JumpList::RunUpdate, this, incognito_availability));
+      base::Bind(&JumpList::RunUpdateOnFileThread,
+                 this,
+                 incognito_availability));
 }
 
-void JumpList::RunUpdate(
+void JumpList::RunUpdateOnFileThread(
     IncognitoModePrefs::Availability incognito_availability) {
   ShellLinkItemList local_most_visited_pages;
   ShellLinkItemList local_recently_closed_pages;
+  ShellLinkItemList local_profile_switcher;
 
   {
     base::AutoLock auto_lock(list_lock_);
     // Make sure we are not out of date: if icon_urls_ is not empty, then
     // another notification has been received since we processed this one
     if (!icon_urls_.empty())
       return;
 
     // Make local copies of lists so we can release the lock.
     local_most_visited_pages = most_visited_pages_;
     local_recently_closed_pages = recently_closed_pages_;
+    local_profile_switcher = profile_switcher_;
   }
 
   // Delete the directory which contains old icon files, rename the current
   // icon directory, and create a new directory which contains new JumpList
   // icon files.
   base::FilePath icon_dir_old(icon_dir_.value() + L"Old");
   if (base::PathExists(icon_dir_old))
     base::DeleteFile(icon_dir_old, true);
   base::Move(icon_dir_, icon_dir_old);
   base::CreateDirectory(icon_dir_);
 
   // Create temporary icon files for shortcuts in the "Most Visited" category.
   CreateIconFiles(local_most_visited_pages);
 
   // Create temporary icon files for shortcuts in the "Recently Closed"
   // category.
   CreateIconFiles(local_recently_closed_pages);
 
+  // Create temporary icon files for the profile avatars in the "Profiles"
+  // category.
+  CreateIconFiles(local_profile_switcher);
+
   // We finished collecting all resources needed for updating an application
   // JumpList. So, create a new JumpList and replace the current JumpList
   // with it.
-  UpdateJumpList(app_id_.c_str(), local_most_visited_pages,
-                 local_recently_closed_pages, incognito_availability);
+  UpdateJumpList(app_id_.c_str(),
+                 local_most_visited_pages,
+                 local_recently_closed_pages,
+                 local_profile_switcher,
+                 incognito_availability);
 }
 
 void JumpList::CreateIconFiles(const ShellLinkItemList& item_list) {
   for (ShellLinkItemList::const_iterator item = item_list.begin();
       item != item_list.end(); ++item) {
     base::FilePath icon_path;
     if (CreateIconFile((*item)->icon_data(), icon_dir_, &icon_path))
       (*item)->set_icon(icon_path.value(), 0);
   }
 }
+
+void JumpList::UpdateProfileSwitcher() {
+  {
+    base::AutoLock auto_lock(list_lock_);
+    profile_switcher_.clear();
+    for (size_t i = 0; i < avatar_menu_->GetNumberOfItems(); ++i) {
+      scoped_refptr<ShellLinkItem> link = CreateShellLink();
+      const AvatarMenu::Item& item = avatar_menu_->GetItemAt(i);
+
+      link->set_title(item.name);
+      link->GetCommandLine()->AppendSwitchPath(
+          switches::kProfileDirectory, item.profile_path.BaseName());
+      link->GetCommandLine()->AppendSwitch(
+          switches::kActivateExistingProfileBrowser);
+
+      gfx::Image avatar;
+      bool is_rectangle;
+      profiles::GetTransparentBackgroundProfileAvatar(
+          item.profile_path, &avatar, &is_rectangle);
+      link->set_icon_data(avatar.AsBitmap());
+      profile_switcher_.push_back(link);
+    }
+  }

[tapted, 2014/11/04 23:10:48]

This is a bit nitty, but it's typically good to avoid calling "unknown" code
(i.e. calling out to functions in other interfaces) while holding a lock. I'd
probably do something like

ShellLinkItemList new_profile_switcher;
for (size_t ... ) {
..
}
{
  base::AutoLock auto_lock(list_lock_);
  new_profile_switcher.swap(profile_switcher_);
}


(doing .swap also means you don't call out to malloc/free while holding the
lock)

[noms (inactive), 2014/11/10 21:46:08]

Done.

+}