chrome/browser/extensions/favicon_downloader.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/extensions/favicon_downloader.h"
   6
   7 #include "base/bind.h"
   8 #include "components/favicon/content/content_favicon_driver.h"
   9 #include "content/public/browser/web_contents.h"
  10 #include "content/public/common/favicon_url.h"
  11 #include "third_party/skia/include/core/SkBitmap.h"
  12 #include "ui/gfx/geometry/size.h"
  13
  14 FaviconDownloader::FaviconDownloader(
  15   content::WebContents* web_contents,
  16   const std::vector<GURL>& extra_favicon_urls,
  17   FaviconDownloaderCallback callback)
  18   : content::WebContentsObserver(web_contents),
  19     need_favicon_urls_(true),
  20     extra_favicon_urls_(extra_favicon_urls),
  21     callback_(callback),
  22     weak_ptr_factory_(this) {
  23 }
  24
  25 FaviconDownloader::~FaviconDownloader() {
  26 }
  27
  28 void FaviconDownloader::SkipPageFavicons() {
  29   need_favicon_urls_ = false;
  30 }
  31
  32 void FaviconDownloader::Start() {
  33   FetchIcons(extra_favicon_urls_);
  34   // If the candidates aren't loaded, icons will be fetched when
  35   // DidUpdateFaviconURL() is called.
  36
  37   if (need_favicon_urls_) {
  38     std::vector<content::FaviconURL> favicon_tab_helper_urls =
  39         GetFaviconURLsFromWebContents();
  40     if (!favicon_tab_helper_urls.empty()) {
  41       need_favicon_urls_ = false;
  42       FetchIcons(favicon_tab_helper_urls);
  43     }
  44   }
  45 }
  46
  47 int FaviconDownloader::DownloadImage(const GURL& url) {
  48   return web_contents()->DownloadImage(
  49       url,
  50       true,  // is_favicon
  51       0,     // no max size
  52       false,  // normal cache policy
  53       base::Bind(&FaviconDownloader::DidDownloadFavicon,
  54                  weak_ptr_factory_.GetWeakPtr()));
  55 }
  56
  57 std::vector<content::FaviconURL>
  58     FaviconDownloader::GetFaviconURLsFromWebContents() {
  59   favicon::ContentFaviconDriver* content_favicon_driver =
  60       web_contents()
  61           ? favicon::ContentFaviconDriver::FromWebContents(web_contents())
  62           : nullptr;
  63   // If favicon_urls() is empty, we are guaranteed that DidUpdateFaviconURLs has
  64   // not yet been called for the current page's navigation.
  65   return content_favicon_driver ? content_favicon_driver->favicon_urls()
  66                                 : std::vector<content::FaviconURL>();
  67 }
  68
  69 void FaviconDownloader::FetchIcons(
  70     const std::vector<content::FaviconURL>& favicon_urls) {
  71   std::vector<GURL> urls;
  72   for (std::vector<content::FaviconURL>::const_iterator it =
  73            favicon_urls.begin();
  74        it != favicon_urls.end(); ++it) {
  75     if (it->icon_type != content::FaviconURL::INVALID_ICON)
  76       urls.push_back(it->icon_url);
  77   }
  78   FetchIcons(urls);
  79 }
  80
  81 void FaviconDownloader::FetchIcons(const std::vector<GURL>& urls) {
  82   // Download icons; put their download ids into |in_progress_requests_| and
  83   // their urls into |processed_urls_|.
  84   for (std::vector<GURL>::const_iterator it = urls.begin();
  85        it != urls.end(); ++it) {
  86     // Only start the download if the url hasn't been processed before.
  87     if (processed_urls_.insert(*it).second)
  88       in_progress_requests_.insert(DownloadImage(*it));
  89   }
  90
  91   // If no downloads were initiated, we can proceed directly to running the
  92   // callback.
  93   if (in_progress_requests_.empty() && !need_favicon_urls_)
  94     callback_.Run(true, favicon_map_);
  95 }
  96
  97 void FaviconDownloader::DidDownloadFavicon(
  98     int id,
  99     int http_status_code,
 100     const GURL& image_url,
 101     const std::vector<SkBitmap>& bitmaps,
 102     const std::vector<gfx::Size>& original_bitmap_sizes) {
 103   // Request may have been canceled by DidNavigateMainFrame().
 104   if (in_progress_requests_.erase(id) == 0)
 105     return;
 106
 107   favicon_map_[image_url] = bitmaps;
 108
 109   // Once all requests have been resolved, perform post-download tasks.
 110   if (in_progress_requests_.empty() && !need_favicon_urls_)
 111     callback_.Run(true, favicon_map_);
 112 }
 113
 114 // content::WebContentsObserver overrides:
 115 void FaviconDownloader::DidNavigateMainFrame(
 116     const content::LoadCommittedDetails& details,
 117     const content::FrameNavigateParams& params) {
 118   // Clear all pending requests.
 119   in_progress_requests_.clear();
 120   favicon_map_.clear();
 121   callback_.Run(false, favicon_map_);
 122 }
 123
 124 void FaviconDownloader::DidUpdateFaviconURL(
 125     const std::vector<content::FaviconURL>& candidates) {
 126   // Only consider the first candidates we are given. This prevents pages that
 127   // change their favicon from spamming us.
 128   if (!need_favicon_urls_)
 129     return;
 130
 131   need_favicon_urls_ = false;
 132   FetchIcons(candidates);
 133 }