Add support to process favicons from Web Manifests

components/favicon/content/content_favicon_driver.cc

 // Copyright 2015 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/content/content_favicon_driver.h"
 
 #include "base/bind.h"
 #include "base/memory/ptr_util.h"
 #include "components/favicon/content/favicon_url_util.h"
 #include "components/favicon/core/favicon_service.h"
 #include "components/favicon/core/favicon_url.h"
 #include "components/history/core/browser/history_service.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/favicon_status.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/navigation_details.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/navigation_handle.h"
 #include "content/public/common/favicon_url.h"
+#include "content/public/common/manifest.h"
 #include "ui/gfx/image/image.h"
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(favicon::ContentFaviconDriver);
 
 namespace favicon {
+namespace {
+
+void ExtractManifestIcons(
+    ContentFaviconDriver::ManifestDownloadCallback callback,
+    const GURL& manifest_url,
+    const content::Manifest& manifest) {
+  std::vector<FaviconURL> candidates;
+  for (const content::Manifest::Icon& icon : manifest.icons) {
+    candidates.emplace_back(icon.src, favicon_base::FAVICON, icon.sizes);
+  }
+  callback.Run(candidates);
+}
+
+}  // namespace

[pkotwicz, 2017/05/12 06:13:28]

Nit: "namespace" -> "anonymous namespace"

[mastiz, 2017/05/12 13:31:32]

Code search (//\ namespace$) says otherwise (21K vs 1K), and besides the term
anonymous is not accurate, should be unnamed.

[pkotwicz, 2017/05/12 15:37:41]

Fair enough

 
 // static
 void ContentFaviconDriver::CreateForWebContents(
     content::WebContents* web_contents,
     FaviconService* favicon_service,
     history::HistoryService* history_service,
     bookmarks::BookmarkModel* bookmark_model) {
   if (FromWebContents(web_contents))
     return;
 
@@ skipping 76 matching lines @@
 int ContentFaviconDriver::DownloadImage(const GURL& url,
                                         int max_image_size,
                                         ImageDownloadCallback callback) {
   bool bypass_cache = (bypass_cache_page_url_ == GetActiveURL());
   bypass_cache_page_url_ = GURL();
 
   return web_contents()->DownloadImage(url, true, max_image_size, bypass_cache,
                                        callback);
 }
 
+void ContentFaviconDriver::DownloadManifest(const GURL& url,
+                                            ManifestDownloadCallback callback) {
+  web_contents()->GetManifest(base::Bind(&ExtractManifestIcons, callback));
+}
+
 bool ContentFaviconDriver::IsOffTheRecord() {
   DCHECK(web_contents());
   return web_contents()->GetBrowserContext()->IsOffTheRecord();
 }
 
 void ContentFaviconDriver::OnFaviconUpdated(
     const GURL& page_url,
     FaviconDriverObserver::NotificationIconType notification_icon_type,
     const GURL& icon_url,
     bool icon_url_changed,
@@ skipping 18 matching lines @@
   DCHECK(!candidates.empty());
 
   // Ignore the update if there is no last committed navigation entry. This can
   // occur when loading an initially blank page.
   content::NavigationEntry* entry =
       web_contents()->GetController().GetLastCommittedEntry();
   if (!entry)
     return;
 
   favicon_urls_ = candidates;
+
   OnUpdateCandidates(entry->GetURL(),
-                     FaviconURLsFromContentFaviconURLs(candidates));
+                     FaviconURLsFromContentFaviconURLs(candidates),
+                     manifest_url_);
+}
+
+void ContentFaviconDriver::DidUpdateWebManifestURL(
+    const base::Optional<GURL>& manifest_url) {
+  // Ignore the update if there is no last committed navigation entry. This can
+  // occur when loading an initially blank page.
+  content::NavigationEntry* entry =
+      web_contents()->GetController().GetLastCommittedEntry();
+  if (!entry)
+    return;
+
+  manifest_url_ = manifest_url;
+
+  // On regular page loads, DidUpdateManifestURL() is guaranteed to be called
+  // before DidUpdateFaviconURL(). However, a page can update the favicons via
+  // javascript.
+  if (favicon_urls_.has_value()) {
+    OnUpdateCandidates(entry->GetURL(),
+                       FaviconURLsFromContentFaviconURLs(*favicon_urls_),
+                       manifest_url);
+  }
 }
 
 void ContentFaviconDriver::DidStartNavigation(
     content::NavigationHandle* navigation_handle) {
   if (!navigation_handle->IsInMainFrame())
     return;
 
+  favicon_urls_.reset();
+  manifest_url_.reset();

[pkotwicz, 2017/05/12 06:13:28]

Can this code be in DidFinishNavigation() instead?

I am wondering whether we can move all of the code from DidStartNavigation() to
DidFinishNavigation() (in a separate CL). The reason for the split is that
originally only ContentFaviconDriver::DidStartNavigation() had access to the
reload type. See ContentFaviconDriver::DidStartNavigationToPendingEntry() in
https://chromium.googlesource.com/chromium/src/+blame/0df1d3a01bed974dfa51c33...

[mastiz, 2017/05/12 13:31:32]

I assume a navigation can be interrupted and hence no DidFinishNavigation called
in that case. Hence, we need to reset this in DidStartNavigation.

[pkotwicz, 2017/05/12 15:37:41]

My understanding is that DidFinishNavigation() should preceed calls to
DidUpdateFaviconURL() and DidUpdateWebManifestURL()

DidFinishNavigation() is called really early in the navigation. I think that it
is called when the renderer gets the initial data for the page (prior to the web
page having finished parsing and prior to window.onload() being called)

[mastiz, 2017/05/15 14:06:59]

The question is whether it's guaranteed to be called. I think the code is more
robust by handling the reset during start, and I don't see an immediate upside.

+
   content::ReloadType reload_type = navigation_handle->GetReloadType();
   if (reload_type == content::ReloadType::NONE || IsOffTheRecord())
     return;
 
   bypass_cache_page_url_ = navigation_handle->GetURL();
   SetFaviconOutOfDateForPage(
       navigation_handle->GetURL(),
       reload_type == content::ReloadType::BYPASSING_CACHE);
 }
 
 void ContentFaviconDriver::DidFinishNavigation(
     content::NavigationHandle* navigation_handle) {
   if (!navigation_handle->IsInMainFrame() ||
       !navigation_handle->HasCommitted() ||
       navigation_handle->IsErrorPage()) {
     return;
   }
 
-  favicon_urls_.clear();
-
   // Wait till the user navigates to a new URL to start checking the cache
   // again. The cache may be ignored for non-reload navigations (e.g.
   // history.replace() in-page navigation). This is allowed to increase the
   // likelihood that "reloading a page ignoring the cache" redownloads the
   // favicon. In particular, a page may do an in-page navigation before
   // FaviconHandler has the time to determine that the favicon needs to be
   // redownloaded.
   GURL url = navigation_handle->GetURL();
   if (url != bypass_cache_page_url_)
     bypass_cache_page_url_ = GURL();
 
   // Get the favicon, either from history or request it from the net.
   FetchFavicon(url);
 }
 
 }  // namespace favicon