Adds support for saving favicon size into history database.

chrome/browser/history/history.h

 // 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.
 
 #ifndef CHROME_BROWSER_HISTORY_HISTORY_H_
 #define CHROME_BROWSER_HISTORY_HISTORY_H_
 
 #include <set>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/file_path.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list_threadsafe.h"
 #include "base/string16.h"
 #include "chrome/browser/cancelable_request.h"
 #include "chrome/browser/favicon/favicon_service.h"
 #include "chrome/browser/history/history_types.h"
 #include "chrome/browser/profiles/refcounted_profile_keyed_service.h"
 #include "chrome/browser/search_engines/template_url_id.h"
 #include "chrome/common/ref_counted_util.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/common/page_transition_types.h"
 #include "sql/init_status.h"
+#include "ui/base/layout.h"
 
 #if defined(OS_ANDROID)
 #include "chrome/browser/history/android/android_history_provider_service.h"
 #endif
 
 class BookmarkService;
 class FilePath;
 class GURL;
 class HistoryURLProvider;
 struct HistoryURLProviderParams;
@@ skipping 644 matching lines @@
   // Notification from the backend that it has finished loading. Sends
   // notification (NOTIFY_HISTORY_LOADED) and sets backend_loaded_ to true.
   void OnDBLoaded(int backend_id);
 
   // Favicon -------------------------------------------------------------------
 
   // These favicon methods are exposed to the FaviconService. Instead of calling
   // these methods directly you should call the respective method on the
   // FaviconService.
 
-  // Used by the FaviconService to get a favicon from the history backend.
-  void GetFavicon(FaviconService::GetFaviconRequest* request,
-                  const GURL& icon_url,
-                  history::IconType icon_type);
+  // Used by FaviconService to get all the favicon bitmaps from the history
+  // backend for the favicons at |icon_urls|.
+  void GetFavicons(FaviconService::GetFaviconRequest* request,
+                   const std::vector<GURL>& icon_urls,
+                   int icon_types,
+                   int desired_size_in_dip,
+                   const std::vector<ui::ScaleFactor>& desired_scale_factors);
 
-  // Used by the FaviconService to update the favicon mappings on the history
-  // backend.
-  void UpdateFaviconMappingAndFetch(FaviconService::GetFaviconRequest* request,
-                                    const GURL& page_url,
-                                    const GURL& icon_url,
-                                    history::IconType icon_type);
-
-  // Used by the FaviconService to get a favicon from the history backend.
-  void GetFaviconForURL(FaviconService::GetFaviconRequest* request,
-                        const GURL& page_url,
-                        int icon_types);
+  // Used by the FaviconService to get all the favicons mapped to |page_url|
+  // from the history backend.

[michaelbai, 2012/09/04 21:18:53]

From the comments it is not clear to me that, how *all* favicon mappings could
be gotten?

Why did icon_typs, desired_size_in_dip and desired_scale_factors exist if I
could get all favicon mappings from this method?

[pkotwicz, 2012/09/04 22:40:54]

You cannot get all of the favicon bitmaps from this method. I have updated the
comments in this file in patch set #13.

+  void GetFaviconsForURL(
+      FaviconService::GetFaviconRequest* request,
+      const GURL& page_url,
+      int icon_types,
+      int desired_size_in_dip,
+      const std::vector<ui::ScaleFactor>& desired_scale_factors);
 
   // Used by the FaviconService to get a favicon from the history backend.
   void GetFaviconForID(FaviconService::GetFaviconRequest* request,
-                       history::FaviconID id);
+                       history::FaviconID id,
+                       int desired_size_in_dip,
+                       ui::ScaleFactor desired_scale_facot);
+
+  // Used by the FaviconService to update the favicon mappings on the history
+  // backend for favicons of type FAVICON.
+  // |icon_urls| is a list of all the favicon URLs known for |page_url|. It is
+  // important for this list to be complete as any favicons mapped to
+  // |page_url| whose icon URL is not in |icon_urls| will be deleted.

[michaelbai, 2012/09/04 21:18:53]

The comment didn't say how the parameters icon_types and desired_size_in_dip
will be used?

[pkotwicz, 2012/09/04 22:40:54]

I have updated the comments in this file in patch set #13

+  void UpdateFaviconMappingsAndFetch(
+      FaviconService::GetFaviconRequest* request,
+      const GURL& page_url,
+      const std::vector<GURL>& icon_urls,
+      int icon_types,
+      int desired_size_in_dip,
+      const std::vector<ui::ScaleFactor>& desired_scale_factors);
+
+  // Used by the FaviconService to add favicons for a page on the history
+  // backend. This method queries for the IconURLSizesMap from |page_url|. If
+  // unavailable, a guess at what IconURLSizesMap should be is used. This
+  // function is inefficient. Do not use if at all possible.
+  // TODO(pkotwicz): Remove this function once it is no longer required by
+  // sync.
+  void MergeFavicon(
+      const GURL& page_url,
+      const GURL& icon_url,
+      history::IconType icon_type,
+      scoped_refptr<base::RefCountedMemory> bitmap_data,
+      const gfx::Size& pixel_size);
+
+  // Used by the FaviconService to set the favicons for a page on the history
+  // backend.
+  // |elements| is a listing of additional favicon bitmaps to store for

[michaelbai, 2012/09/04 21:18:53]

There is no elements argument in method's definition.

+  // |page_url|.
+  // |icon_url_sizes| is a mapping of all the icon urls of favicons available
+  // for |page_url| to the sizes that those favicons are available at from the
+  // web. |elements| does not need to have entries for all the icon urls or
+  // sizes listed in |icon_url_sizes|. However, the icon urls and sizes in
+  // |elements| must be a subset of |icon_url_sizes|. It is important that
+  // |icon_url_sizes| be complete as mappings to favicons whose icon url or
+  // pixel size is not in |icon_url_sizes| will be deleted.
+  void SetFavicons(
+      const GURL& page_url,
+      history::IconType icon_type,
+      const std::vector<history::FaviconBitmapData>& favicon_bitmap_data,
+      const history::IconURLSizesMap& icon_url_sizes);
 
   // Used by the FaviconService to mark the favicon for the page as being out
   // of date.
-  void SetFaviconOutOfDateForPage(const GURL& page_url);
+  void SetFaviconsOutOfDateForPage(const GURL& page_url);
 
   // Used by the FaviconService to clone favicons from one page to another,
   // provided that other page does not already have favicons.
-  void CloneFavicon(const GURL& old_page_url, const GURL& new_page_url);
+  void CloneFavicons(const GURL& old_page_url, const GURL& new_page_url);
 
   // Used by the FaviconService for importing many favicons for many pages at
   // once. The pages must exist, any favicon sets for unknown pages will be
   // discarded. Existing favicons will not be overwritten.
   void SetImportedFavicons(
       const std::vector<history::ImportedFaviconUsage>& favicon_usage);
 
-  // Used by the FaviconService to set the favicon for a page on the history
-  // backend.
-  void SetFavicon(const GURL& page_url,
-                  const GURL& icon_url,
-                  const std::vector<unsigned char>& image_data,
-                  history::IconType icon_type);
-
-
   // Sets the in-memory URL database. This is called by the backend once the
   // database is loaded to make it available.
   void SetInMemoryBackend(int backend_id,
                           history::InMemoryHistoryBackend* mem_backend);
 
   // Called by our BackendDelegate when there is a problem reading the database.
   void NotifyProfileError(int backend_id, sql::InitStatus init_status);
 
   // Call to schedule a given task for running on the history thread with the
   // specified priority. The task will have ownership taken.
@@ skipping 96 matching lines @@
     LoadBackendIfNecessary();
     if (consumer)
       AddRequest(request, consumer);
     ScheduleTask(priority,
                  base::Bind(func, history_backend_.get(),
                                    scoped_refptr<RequestType>(request),
                                    a, b, c, d));
     return request->handle();
   }
 
+  template<typename BackendFunc,
+           class RequestType,  // Descendant of CancelableRequstBase.
+           typename ArgA,
+           typename ArgB,
+           typename ArgC,
+           typename ArgD,
+           typename ArgE>
+  Handle Schedule(SchedulePriority priority,
+                  BackendFunc func,  // Function to call on the HistoryBackend.
+                  CancelableRequestConsumerBase* consumer,
+                  RequestType* request,
+                  const ArgA& a,
+                  const ArgB& b,
+                  const ArgC& c,
+                  const ArgD& d,
+                  const ArgE& e) {
+    DCHECK(thread_) << "History service being called after cleanup";
+    LoadBackendIfNecessary();
+    if (consumer)
+      AddRequest(request, consumer);
+    ScheduleTask(priority,
+                 base::Bind(func, history_backend_.get(),
+                                   scoped_refptr<RequestType>(request),
+                                   a, b, c, d, e));
+    return request->handle();
+  }
+
   // ScheduleAndForget ---------------------------------------------------------
   //
   // Functions for scheduling operations on the history thread that do not need
   // any callbacks and are not cancelable.
 
   template<typename BackendFunc>
   void ScheduleAndForget(SchedulePriority priority,
                          BackendFunc func) {  // Function to call on backend.
     DCHECK(thread_) << "History service being called after cleanup";
     LoadBackendIfNecessary();
@@ skipping 40 matching lines @@
                          const ArgA& a,
                          const ArgB& b,
                          const ArgC& c,
                          const ArgD& d) {
     DCHECK(thread_) << "History service being called after cleanup";
     LoadBackendIfNecessary();
     ScheduleTask(priority, base::Bind(func, history_backend_.get(),
                                       a, b, c, d));
   }
 
+  template<typename BackendFunc,
+           typename ArgA,
+           typename ArgB,
+           typename ArgC,
+           typename ArgD,
+           typename ArgE>
+  void ScheduleAndForget(SchedulePriority priority,
+                         BackendFunc func,  // Function to call on backend.
+                         const ArgA& a,
+                         const ArgB& b,
+                         const ArgC& c,
+                         const ArgD& d,
+                         const ArgE& e) {
+    DCHECK(thread_) << "History service being called after cleanup";
+    LoadBackendIfNecessary();
+    ScheduleTask(priority, base::Bind(func, history_backend_.get(),
+                                      a, b, c, d, e));
+  }
+
   content::NotificationRegistrar registrar_;
 
   // Some void primitives require some internal processing in the main thread
   // when done. We use this internal consumer for this purpose.
   CancelableRequestConsumer internal_consumer_;
 
   // The thread used by the history service to run complicated operations.
   // |thread_| is NULL once |Cleanup| is NULL.
   base::Thread* thread_;
 
@@ skipping 32 matching lines @@
   // The index used for quick history lookups.
   scoped_ptr<history::InMemoryURLIndex> in_memory_url_index_;
 
   scoped_refptr<ObserverListThreadSafe<history::VisitDatabaseObserver> >
       visit_database_observers_;
 
   DISALLOW_COPY_AND_ASSIGN(HistoryService);
 };
 
 #endif  // CHROME_BROWSER_HISTORY_HISTORY_H_