Save large icons to a new LARGE_ICON type

components/favicon/core/favicon_handler.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 "components/favicon/core/favicon_handler.h"
 
 #include <algorithm>
 #include <cmath>
 #include <vector>
 
@@ skipping 207 matching lines @@
 
 FaviconHandler::~FaviconHandler() {
 }
 
 // static
 int FaviconHandler::GetIconTypesFromHandlerType(
     FaviconHandler::Type handler_type) {
   switch (handler_type) {
     case FAVICON:
       return favicon_base::FAVICON;
-    case TOUCH:  // Falls through.
+    case TOUCH:
+      return favicon_base::TOUCH_ICON | favicon_base::TOUCH_PRECOMPOSED_ICON;
     case LARGE:
-      return favicon_base::TOUCH_ICON | favicon_base::TOUCH_PRECOMPOSED_ICON;
+      return favicon_base::FAVICON | favicon_base::TOUCH_ICON |
+          favicon_base::TOUCH_PRECOMPOSED_ICON;
     default:
       NOTREACHED();
   }
   return 0;
 }
 
 void FaviconHandler::FetchFavicon(const GURL& url) {
   cancelable_task_tracker_.TryCancelAll();
 
   url_ = url;
@@ skipping 110 matching lines @@
 
   // TODO(davemoore) Should clear on empty url. Currently we ignore it.
   // This appears to be what FF does as well.
   if (!image_urls_.empty())
     ProcessCurrentUrl();
 }
 
 void FaviconHandler::ProcessCurrentUrl() {
   DCHECK(!image_urls_.empty());
 
+  // TODO(rogerm): To use fetch on demand for large icons: just add the Favicon
+  //     record and update the url mappings here, instead of downloading.
+  //     i.e., if (handler_type_ == LARGE) { Save(image_urls[0]); return; }
+
   // current_candidate() may return NULL if download_largest_icon_ is true and
   // all the sizes are larger than the max.
   if (PageChangedSinceFaviconWasRequested() || !current_candidate())
     return;
 
   if (current_candidate()->icon_type == favicon_base::FAVICON &&
       !download_largest_icon_) {
     if (!favicon_expired_or_incomplete_ &&
         driver_->GetActiveFaviconValidity() &&
         DoUrlAndIconMatch(*current_candidate(),
@@ skipping 69 matching lines @@
     }
   }
 
   if (request_next_icon && image_urls_.size() > 1) {
     // Remove the first member of image_urls_ and process the remaining.
     image_urls_.erase(image_urls_.begin());
     ProcessCurrentUrl();
   } else {
     // We have either found the ideal candidate or run out of candidates.
     if (best_favicon_candidate_.icon_type != favicon_base::INVALID_ICON) {
       // No more icons to request, set the favicon from the candidate.

[beaudoin, 2015/05/05 00:54:00]

Augment the comment to indicate what save_type means?

[Roger McFarlane (Chromium), 2015/05/05 15:09:47]

Done.

+      favicon_base::IconType saved_type = handler_type_ == LARGE ?
+          favicon_base::LARGE_ICON : best_favicon_candidate_.icon_type;
       SetFavicon(best_favicon_candidate_.url, best_favicon_candidate_.image_url,
-                 best_favicon_candidate_.image,
-                 best_favicon_candidate_.icon_type);
+                 best_favicon_candidate_.image, saved_type);
     }
     // Clear download related state.
     image_urls_.clear();
     download_requests_.clear();
     best_favicon_candidate_ = FaviconCandidate();
   }
 }
 
 bool FaviconHandler::HasPendingTasksForTest() {
   return !download_requests_.empty() ||
@@ skipping 69 matching lines @@
 
 bool FaviconHandler::ShouldSaveFavicon(const GURL& url) {
   if (!driver_->IsOffTheRecord())
     return true;
 
   // Always save favicon if the page is bookmarked.
   return driver_->IsBookmarked(url);
 }
 
 int FaviconHandler::GetMaximalIconSize(favicon_base::IconType icon_type) {
+  if (handler_type_ == FaviconHandler::LARGE) {
+    return icon_type == favicon_base::INVALID_ICON ? 0 : 192;

[beaudoin, 2015/05/05 00:54:00]

Comment to explain this logic?

[Roger McFarlane (Chromium), 2015/05/05 15:09:47]

Done.

+  }
+
   switch (icon_type) {
     case favicon_base::FAVICON:
 #if defined(OS_ANDROID)
       return 192;
 #else
       return gfx::ImageSkia::GetMaxSupportedScale() * gfx::kFaviconSize;
 #endif
     case favicon_base::TOUCH_ICON:
     case favicon_base::TOUCH_PRECOMPOSED_ICON:
       return kTouchIconSize;
+    case favicon_base::LARGE_ICON:
+      NOTREACHED();  // This is a virtual icon type.
+      return 192;

[beaudoin, 2015/05/05 00:54:00]

Strange to return such a specific value behind a NOTREACHED()...

[Roger McFarlane (Chromium), 2015/05/05 15:09:47]

We don't expect that GetMaximalIconSize will be called with LARGE_ICON because
this method is used to determine the size of a "real" icon to be downloaded;
hence the NOTREACHED.

But, the correct value to return, should this ever occur is 192.

So, I've set up the code to do the "right" thing, and added an assertion so that
we're alerted if this every unexpectedly called in this way.

[beaudoin, 2015/05/05 19:47:52]

Acknowledged, although a quick comment to explain this might save a WTF moment
to a future reader.

[Roger McFarlane (Chromium), 2015/05/06 16:06:16]

Done.

     case favicon_base::INVALID_ICON:
       return 0;
   }
   NOTREACHED();
   return 0;
 }
 
 void FaviconHandler::OnFaviconDataForInitialURLFromFaviconService(
     const std::vector<favicon_base::FaviconRawBitmapResult>&
         favicon_bitmap_results) {
@@ skipping 143 matching lines @@
     gfx::Size largest =
         image_url.icon_sizes[GetLargestSizeIndex(image_url.icon_sizes)];
     image_url.icon_sizes.clear();
     image_url.icon_sizes.push_back(largest);
   }
   std::stable_sort(image_urls_.begin(), image_urls_.end(),
                    CompareIconSize);
 }
 
 }  // namespace favicon