chrome/browser/ui/webui/favicon_source.cc

   1 // Copyright (c) 2012 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/ui/webui/favicon_source.h"
   6
   7 #include <cmath>
   8
   9 #include "base/bind.h"
  10 #include "base/bind_helpers.h"
  11 #include "base/strings/string_number_conversions.h"
  12 #include "chrome/browser/favicon/favicon_service_factory.h"
  13 #include "chrome/browser/history/top_sites_factory.h"
  14 #include "chrome/browser/profiles/profile.h"
  15 #include "chrome/browser/search/instant_io_context.h"
  16 #include "chrome/browser/sync/open_tabs_ui_delegate.h"
  17 #include "chrome/browser/sync/profile_sync_service.h"
  18 #include "chrome/browser/sync/profile_sync_service_factory.h"
  19 #include "chrome/common/favicon/favicon_url_parser.h"
  20 #include "chrome/common/url_constants.h"
  21 #include "chrome/grit/locale_settings.h"
  22 #include "components/history/core/browser/top_sites.h"
  23 #include "net/url_request/url_request.h"
  24 #include "ui/base/l10n/l10n_util.h"
  25 #include "ui/base/layout.h"
  26 #include "ui/base/resource/resource_bundle.h"
  27 #include "ui/base/webui/web_ui_util.h"
  28 #include "ui/resources/grit/ui_resources.h"
  29
  30 FaviconSource::IconRequest::IconRequest()
  31     : size_in_dip(gfx::kFaviconSize), device_scale_factor(1.0f) {
  32 }
  33
  34 FaviconSource::IconRequest::IconRequest(
  35     const content::URLDataSource::GotDataCallback& cb,
  36     const GURL& path,
  37     int size,
  38     float scale)
  39     : callback(cb),
  40       request_path(path),
  41       size_in_dip(size),
  42       device_scale_factor(scale) {
  43 }
  44
  45 FaviconSource::IconRequest::~IconRequest() {
  46 }
  47
  48 FaviconSource::FaviconSource(Profile* profile, IconType type)
  49     : profile_(profile->GetOriginalProfile()),
  50       icon_types_(type == FAVICON ? favicon_base::FAVICON
  51                                   : favicon_base::TOUCH_PRECOMPOSED_ICON |
  52                                         favicon_base::TOUCH_ICON |
  53                                         favicon_base::FAVICON) {}
  54
  55 FaviconSource::~FaviconSource() {
  56 }
  57
  58 std::string FaviconSource::GetSource() const {
  59   return icon_types_ == favicon_base::FAVICON ? chrome::kChromeUIFaviconHost
  60                                               : chrome::kChromeUITouchIconHost;
  61 }
  62
  63 void FaviconSource::StartDataRequest(
  64     const std::string& path,
  65     int render_process_id,
  66     int render_frame_id,
  67     const content::URLDataSource::GotDataCallback& callback) {
  68   FaviconService* favicon_service = FaviconServiceFactory::GetForProfile(
  69       profile_, ServiceAccessType::EXPLICIT_ACCESS);
  70   if (!favicon_service) {
  71     SendDefaultResponse(callback);
  72     return;
  73   }
  74
  75   chrome::ParsedFaviconPath parsed;
  76   bool success = chrome::ParseFaviconPath(path, icon_types_, &parsed);
  77   if (!success) {
  78     SendDefaultResponse(callback);
  79     return;
  80   }
  81
  82   GURL url(parsed.url);
  83   int desired_size_in_pixel =
  84       std::ceil(parsed.size_in_dip * parsed.device_scale_factor);
  85
  86   if (parsed.is_icon_url) {
  87     // TODO(michaelbai): Change GetRawFavicon to support combination of
  88     // IconType.
  89     favicon_service->GetRawFavicon(
  90         url,
  91         favicon_base::FAVICON,
  92         desired_size_in_pixel,
  93         base::Bind(
  94             &FaviconSource::OnFaviconDataAvailable,
  95             base::Unretained(this),
  96             IconRequest(
  97                 callback, url, parsed.size_in_dip, parsed.device_scale_factor)),
  98         &cancelable_task_tracker_);
  99   } else {
 100     // Intercept requests for prepopulated pages if TopSites exists.
 101     scoped_refptr<history::TopSites> top_sites =
 102         TopSitesFactory::GetForProfile(profile_);
 103     if (top_sites) {
 104       for (const auto& prepopulated_page : top_sites->GetPrepopulatedPages()) {
 105         if (url == prepopulated_page.most_visited.url) {
 106           ui::ScaleFactor resource_scale_factor =
 107               ui::GetSupportedScaleFactor(parsed.device_scale_factor);
 108           callback.Run(
 109               ResourceBundle::GetSharedInstance().LoadDataResourceBytesForScale(
 110                   prepopulated_page.favicon_id, resource_scale_factor));
 111           return;
 112         }
 113       }
 114     }
 115
 116     favicon_service->GetRawFaviconForPageURL(
 117         url,
 118         icon_types_,
 119         desired_size_in_pixel,
 120         base::Bind(
 121             &FaviconSource::OnFaviconDataAvailable,
 122             base::Unretained(this),
 123             IconRequest(
 124                 callback, url, parsed.size_in_dip, parsed.device_scale_factor)),
 125         &cancelable_task_tracker_);
 126   }
 127 }
 128
 129 std::string FaviconSource::GetMimeType(const std::string&) const {
 130   // We need to explicitly return a mime type, otherwise if the user tries to
 131   // drag the image they get no extension.
 132   return "image/png";
 133 }
 134
 135 bool FaviconSource::ShouldReplaceExistingSource() const {
 136   // Leave the existing DataSource in place, otherwise we'll drop any pending
 137   // requests on the floor.
 138   return false;
 139 }
 140
 141 bool FaviconSource::ShouldServiceRequest(const net::URLRequest* request) const {
 142   if (request->url().SchemeIs(chrome::kChromeSearchScheme))
 143     return InstantIOContext::ShouldServiceRequest(request);
 144   return URLDataSource::ShouldServiceRequest(request);
 145 }
 146
 147 bool FaviconSource::HandleMissingResource(const IconRequest& request) {
 148   // If the favicon is not available, try to use the synced favicon.
 149   ProfileSyncService* sync_service =
 150       ProfileSyncServiceFactory::GetInstance()->GetForProfile(profile_);
 151   browser_sync::OpenTabsUIDelegate* open_tabs = sync_service ?
 152       sync_service->GetOpenTabsUIDelegate() : NULL;
 153
 154   scoped_refptr<base::RefCountedMemory> response;
 155   if (open_tabs &&
 156       open_tabs->GetSyncedFaviconForPageURL(request.request_path.spec(),
 157                                             &response)) {
 158     request.callback.Run(response.get());
 159     return true;
 160   }
 161   return false;
 162 }
 163
 164 void FaviconSource::OnFaviconDataAvailable(
 165     const IconRequest& request,
 166     const favicon_base::FaviconRawBitmapResult& bitmap_result) {
 167   if (bitmap_result.is_valid()) {
 168     // Forward the data along to the networking system.
 169     request.callback.Run(bitmap_result.bitmap_data.get());
 170   } else if (!HandleMissingResource(request)) {
 171     SendDefaultResponse(request);
 172   }
 173 }
 174
 175 void FaviconSource::SendDefaultResponse(
 176     const content::URLDataSource::GotDataCallback& callback) {
 177   SendDefaultResponse(IconRequest(callback, GURL(), 16, 1.0f));
 178 }
 179
 180 void FaviconSource::SendDefaultResponse(const IconRequest& icon_request) {
 181   int favicon_index;
 182   int resource_id;
 183   switch (icon_request.size_in_dip) {
 184     case 64:
 185       favicon_index = SIZE_64;
 186       resource_id = IDR_DEFAULT_FAVICON_64;
 187       break;
 188     case 32:
 189       favicon_index = SIZE_32;
 190       resource_id = IDR_DEFAULT_FAVICON_32;
 191       break;
 192     default:
 193       favicon_index = SIZE_16;
 194       resource_id = IDR_DEFAULT_FAVICON;
 195       break;
 196   }
 197   base::RefCountedMemory* default_favicon =
 198       default_favicons_[favicon_index].get();
 199
 200   if (!default_favicon) {
 201     ui::ScaleFactor resource_scale_factor =
 202         ui::GetSupportedScaleFactor(icon_request.device_scale_factor);
 203     default_favicon =
 204         ResourceBundle::GetSharedInstance().LoadDataResourceBytesForScale(
 205             resource_id, resource_scale_factor);
 206     default_favicons_[favicon_index] = default_favicon;
 207   }
 208
 209   icon_request.callback.Run(default_favicon);
 210 }