| OLD | NEW |
|---|
| (Empty) |
| 1 // Copyright (c) 2011 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/favicon_helper.h" | |
| 6 | |
| 7 #include "build/build_config.h" | |
| 8 | |
| 9 #include <vector> | |
| 10 | |
| 11 #include "base/callback.h" | |
| 12 #include "base/memory/ref_counted_memory.h" | |
| 13 #include "chrome/browser/bookmarks/bookmark_model.h" | |
| 14 #include "chrome/browser/profiles/profile.h" | |
| 15 #include "chrome/common/render_messages.h" | |
| 16 #include "content/browser/renderer_host/render_view_host.h" | |
| 17 #include "content/browser/tab_contents/navigation_controller.h" | |
| 18 #include "content/browser/tab_contents/navigation_entry.h" | |
| 19 #include "content/browser/tab_contents/tab_contents_delegate.h" | |
| 20 #include "content/browser/tab_contents/tab_contents.h" | |
| 21 #include "skia/ext/image_operations.h" | |
| 22 #include "ui/gfx/codec/png_codec.h" | |
| 23 #include "ui/gfx/favicon_size.h" | |
| 24 | |
| 25 FaviconHelper::FaviconHelper(TabContents* tab_contents) | |
| 26 : TabContentsObserver(tab_contents), | |
| 27 got_favicon_url_(false), | |
| 28 got_favicon_from_history_(false), | |
| 29 favicon_expired_(false) { | |
| 30 } | |
| 31 | |
| 32 FaviconHelper::~FaviconHelper() { | |
| 33 SkBitmap empty_image; | |
| 34 | |
| 35 // Call pending download callbacks with error to allow caller to clean up. | |
| 36 for (DownloadRequests::iterator i = download_requests_.begin(); | |
| 37 i != download_requests_.end(); ++i) { | |
| 38 if (i->second.callback) { | |
| 39 i->second.callback->Run(i->first, true, empty_image); | |
| 40 } | |
| 41 } | |
| 42 } | |
| 43 | |
| 44 void FaviconHelper::FetchFavicon(const GURL& url) { | |
| 45 cancelable_consumer_.CancelAllRequests(); | |
| 46 | |
| 47 url_ = url; | |
| 48 | |
| 49 favicon_expired_ = got_favicon_from_history_ = got_favicon_url_ = false; | |
| 50 | |
| 51 // Request the favicon from the history service. In parallel to this the | |
| 52 // renderer is going to notify us (well TabContents) when the favicon url is | |
| 53 // available. | |
| 54 if (GetFaviconService()) { | |
| 55 GetFaviconService()->GetFaviconForURL(url_, history::FAVICON, | |
| 56 &cancelable_consumer_, | |
| 57 NewCallback(this, &FaviconHelper::OnFaviconDataForInitialURL)); | |
| 58 } | |
| 59 } | |
| 60 | |
| 61 int FaviconHelper::DownloadImage(const GURL& image_url, | |
| 62 int image_size, | |
| 63 ImageDownloadCallback* callback) { | |
| 64 DCHECK(callback); // Must provide a callback. | |
| 65 return ScheduleDownload(GURL(), image_url, image_size, callback); | |
| 66 } | |
| 67 | |
| 68 Profile* FaviconHelper::profile() { | |
| 69 return tab_contents()->profile(); | |
| 70 } | |
| 71 | |
| 72 FaviconService* FaviconHelper::GetFaviconService() { | |
| 73 return profile()->GetFaviconService(Profile::EXPLICIT_ACCESS); | |
| 74 } | |
| 75 | |
| 76 void FaviconHelper::SetFavicon( | |
| 77 const GURL& url, | |
| 78 const GURL& image_url, | |
| 79 const SkBitmap& image) { | |
| 80 const SkBitmap& sized_image = | |
| 81 (image.width() == kFaviconSize && image.height() == kFaviconSize) | |
| 82 ? image : ConvertToFaviconSize(image); | |
| 83 | |
| 84 if (GetFaviconService() && ShouldSaveFavicon(url)) { | |
| 85 std::vector<unsigned char> image_data; | |
| 86 gfx::PNGCodec::EncodeBGRASkBitmap(sized_image, false, &image_data); | |
| 87 GetFaviconService()->SetFavicon(url, image_url, image_data, | |
| 88 history::FAVICON); | |
| 89 } | |
| 90 | |
| 91 if (url == url_) { | |
| 92 NavigationEntry* entry = GetEntry(); | |
| 93 if (entry) | |
| 94 UpdateFavicon(entry, sized_image); | |
| 95 } | |
| 96 } | |
| 97 | |
| 98 void FaviconHelper::UpdateFavicon(NavigationEntry* entry, | |
| 99 scoped_refptr<RefCountedMemory> data) { | |
| 100 SkBitmap image; | |
| 101 gfx::PNGCodec::Decode(data->front(), data->size(), &image); | |
| 102 UpdateFavicon(entry, image); | |
| 103 } | |
| 104 | |
| 105 void FaviconHelper::UpdateFavicon(NavigationEntry* entry, | |
| 106 const SkBitmap& image) { | |
| 107 // No matter what happens, we need to mark the favicon as being set. | |
| 108 entry->favicon().set_is_valid(true); | |
| 109 | |
| 110 if (image.empty()) | |
| 111 return; | |
| 112 | |
| 113 entry->favicon().set_bitmap(image); | |
| 114 tab_contents()->NotifyNavigationStateChanged(TabContents::INVALIDATE_TAB); | |
| 115 } | |
| 116 | |
| 117 void FaviconHelper::OnUpdateFaviconURL(int32 page_id, const GURL& icon_url) { | |
| 118 // TODO(davemoore) Should clear on empty url. Currently we ignore it. | |
| 119 // This appears to be what FF does as well. | |
| 120 if (icon_url.is_empty()) | |
| 121 return; | |
| 122 | |
| 123 NavigationEntry* entry = GetEntry(); | |
| 124 if (!entry) | |
| 125 return; | |
| 126 | |
| 127 got_favicon_url_ = true; | |
| 128 | |
| 129 if (!GetFaviconService()) | |
| 130 return; | |
| 131 | |
| 132 if (!favicon_expired_ && entry->favicon().is_valid() && | |
| 133 entry->favicon().url() == icon_url) { | |
| 134 // We already have the icon, no need to proceed. | |
| 135 return; | |
| 136 } | |
| 137 | |
| 138 entry->favicon().set_url(icon_url); | |
| 139 | |
| 140 if (got_favicon_from_history_) | |
| 141 DownloadFaviconOrAskHistory(entry); | |
| 142 } | |
| 143 | |
| 144 bool FaviconHelper::OnMessageReceived(const IPC::Message& message) { | |
| 145 bool handled = true; | |
| 146 IPC_BEGIN_MESSAGE_MAP(FaviconHelper, message) | |
| 147 IPC_MESSAGE_HANDLER(ViewHostMsg_UpdateFaviconURL, OnUpdateFaviconURL) | |
| 148 IPC_MESSAGE_HANDLER(ViewHostMsg_DidDownloadFavicon, OnDidDownloadFavicon) | |
| 149 IPC_MESSAGE_UNHANDLED(handled = false) | |
| 150 IPC_END_MESSAGE_MAP() | |
| 151 return handled; | |
| 152 } | |
| 153 | |
| 154 void FaviconHelper::OnDidDownloadFavicon(int id, | |
| 155 const GURL& image_url, | |
| 156 bool errored, | |
| 157 const SkBitmap& image) { | |
| 158 DownloadRequests::iterator i = download_requests_.find(id); | |
| 159 if (i == download_requests_.end()) { | |
| 160 // Currently TabContents notifies us of ANY downloads so that it is | |
| 161 // possible to get here. | |
| 162 return; | |
| 163 } | |
| 164 | |
| 165 if (i->second.callback) { | |
| 166 i->second.callback->Run(id, errored, image); | |
| 167 } else if (!errored) { | |
| 168 SetFavicon(i->second.url, image_url, image); | |
| 169 } | |
| 170 | |
| 171 download_requests_.erase(i); | |
| 172 } | |
| 173 | |
| 174 NavigationEntry* FaviconHelper::GetEntry() { | |
| 175 NavigationEntry* entry = tab_contents()->controller().GetActiveEntry(); | |
| 176 if (entry && entry->url() == url_ && | |
| 177 tab_contents()->IsActiveEntry(entry->page_id())) { | |
| 178 return entry; | |
| 179 } | |
| 180 // If the URL has changed out from under us (as will happen with redirects) | |
| 181 // return NULL. | |
| 182 return NULL; | |
| 183 } | |
| 184 | |
| 185 void FaviconHelper::OnFaviconDataForInitialURL( | |
| 186 FaviconService::Handle handle, | |
| 187 history::FaviconData favicon) { | |
| 188 NavigationEntry* entry = GetEntry(); | |
| 189 if (!entry) | |
| 190 return; | |
| 191 | |
| 192 got_favicon_from_history_ = true; | |
| 193 | |
| 194 favicon_expired_ = (favicon.known_icon && favicon.expired); | |
| 195 | |
| 196 if (favicon.known_icon && !entry->favicon().is_valid() && | |
| 197 (!got_favicon_url_ || entry->favicon().url() == favicon.icon_url)) { | |
| 198 // The db knows the favicon (although it may be out of date) and the entry | |
| 199 // doesn't have an icon. Set the favicon now, and if the favicon turns out | |
| 200 // to be expired (or the wrong url) we'll fetch later on. This way the | |
| 201 // user doesn't see a flash of the default favicon. | |
| 202 entry->favicon().set_url(favicon.icon_url); | |
| 203 if (favicon.is_valid()) | |
| 204 UpdateFavicon(entry, favicon.image_data); | |
| 205 entry->favicon().set_is_valid(true); | |
| 206 } | |
| 207 | |
| 208 if (favicon.known_icon && !favicon.expired) { | |
| 209 if (got_favicon_url_ && entry->favicon().url() != favicon.icon_url) { | |
| 210 // Mapping in the database is wrong. DownloadFaviconOrAskHistory will | |
| 211 // update the mapping for this url and download the favicon if we don't | |
| 212 // already have it. | |
| 213 DownloadFaviconOrAskHistory(entry); | |
| 214 } | |
| 215 } else if (got_favicon_url_) { | |
| 216 // We know the official url for the favicon, by either don't have the | |
| 217 // favicon or its expired. Continue on to DownloadFaviconOrAskHistory to | |
| 218 // either download or check history again. | |
| 219 DownloadFaviconOrAskHistory(entry); | |
| 220 } | |
| 221 // else we haven't got the icon url. When we get it we'll ask the | |
| 222 // renderer to download the icon. | |
| 223 } | |
| 224 | |
| 225 void FaviconHelper::DownloadFaviconOrAskHistory(NavigationEntry* entry) { | |
| 226 DCHECK(entry); // We should only get here if entry is valid. | |
| 227 if (favicon_expired_) { | |
| 228 // We have the mapping, but the favicon is out of date. Download it now. | |
| 229 ScheduleDownload(entry->url(), entry->favicon().url(), kFaviconSize, NULL); | |
| 230 } else if (GetFaviconService()) { | |
| 231 // We don't know the favicon, but we may have previously downloaded the | |
| 232 // favicon for another page that shares the same favicon. Ask for the | |
| 233 // favicon given the favicon URL. | |
| 234 if (profile()->IsOffTheRecord()) { | |
| 235 GetFaviconService()->GetFavicon( | |
| 236 entry->favicon().url(), | |
| 237 history::FAVICON, | |
| 238 &cancelable_consumer_, | |
| 239 NewCallback(this, &FaviconHelper::OnFaviconData)); | |
| 240 } else { | |
| 241 // Ask the history service for the icon. This does two things: | |
| 242 // 1. Attempts to fetch the favicon data from the database. | |
| 243 // 2. If the favicon exists in the database, this updates the database to | |
| 244 // include the mapping between the page url and the favicon url. | |
| 245 // This is asynchronous. The history service will call back when done. | |
| 246 // Issue the request and associate the current page ID with it. | |
| 247 GetFaviconService()->UpdateFaviconMappingAndFetch( | |
| 248 entry->url(), | |
| 249 entry->favicon().url(), | |
| 250 history::FAVICON, | |
| 251 &cancelable_consumer_, | |
| 252 NewCallback(this, &FaviconHelper::OnFaviconData)); | |
| 253 } | |
| 254 } | |
| 255 } | |
| 256 | |
| 257 void FaviconHelper::OnFaviconData( | |
| 258 FaviconService::Handle handle, | |
| 259 history::FaviconData favicon) { | |
| 260 NavigationEntry* entry = GetEntry(); | |
| 261 if (!entry) | |
| 262 return; | |
| 263 | |
| 264 // No need to update the favicon url. By the time we get here | |
| 265 // UpdateFaviconURL will have set the favicon url. | |
| 266 | |
| 267 if (favicon.is_valid()) { | |
| 268 // There is a favicon, set it now. If expired we'll download the current | |
| 269 // one again, but at least the user will get some icon instead of the | |
| 270 // default and most likely the current one is fine anyway. | |
| 271 UpdateFavicon(entry, favicon.image_data); | |
| 272 } | |
| 273 | |
| 274 if (!favicon.known_icon || favicon.expired) { | |
| 275 // We don't know the favicon, or it is out of date. Request the current one. | |
| 276 ScheduleDownload(entry->url(), entry->favicon().url(), kFaviconSize, NULL); | |
| 277 } | |
| 278 } | |
| 279 | |
| 280 int FaviconHelper::ScheduleDownload(const GURL& url, | |
| 281 const GURL& image_url, | |
| 282 int image_size, | |
| 283 ImageDownloadCallback* callback) { | |
| 284 const int download_id = tab_contents()->render_view_host()->DownloadFavicon( | |
| 285 image_url, image_size); | |
| 286 | |
| 287 if (download_id) { | |
| 288 // Download ids should be unique. | |
| 289 DCHECK(download_requests_.find(download_id) == download_requests_.end()); | |
| 290 download_requests_[download_id] = DownloadRequest(url, image_url, callback); | |
| 291 } | |
| 292 | |
| 293 return download_id; | |
| 294 } | |
| 295 | |
| 296 SkBitmap FaviconHelper::ConvertToFaviconSize(const SkBitmap& image) { | |
| 297 int width = image.width(); | |
| 298 int height = image.height(); | |
| 299 if (width > 0 && height > 0) { | |
| 300 calc_favicon_target_size(&width, &height); | |
| 301 return skia::ImageOperations::Resize( | |
| 302 image, skia::ImageOperations::RESIZE_LANCZOS3, | |
| 303 width, height); | |
| 304 } | |
| 305 return image; | |
| 306 } | |
| 307 | |
| 308 bool FaviconHelper::ShouldSaveFavicon(const GURL& url) { | |
| 309 if (!profile()->IsOffTheRecord()) | |
| 310 return true; | |
| 311 | |
| 312 // Otherwise store the favicon if the page is bookmarked. | |
| 313 BookmarkModel* bookmark_model = profile()->GetBookmarkModel(); | |
| 314 return bookmark_model && bookmark_model->IsBookmarked(url); | |
| 315 } | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 6735042:
Move favicon from TabContents to TabContentsWrapper. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src