Adds support for saving favicon size into history database.

chrome/browser/history/history_backend.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_BACKEND_H_
 #define CHROME_BROWSER_HISTORY_HISTORY_BACKEND_H_
 
 #include <string>
 #include <utility>
 
 #include "base/file_path.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/mru_cache.h"
 #include "base/memory/scoped_ptr.h"
 #include "chrome/browser/cancelable_request.h"
 #include "chrome/browser/history/archived_database.h"
 #include "chrome/browser/history/expire_history_backend.h"
 #include "chrome/browser/history/history_database.h"
 #include "chrome/browser/history/history_marshaling.h"
 #include "chrome/browser/history/history_types.h"
 #include "chrome/browser/history/text_database_manager.h"
 #include "chrome/browser/history/thumbnail_database.h"
 #include "chrome/browser/history/visit_tracker.h"
 #include "chrome/browser/search_engines/template_url_id.h"
 #include "sql/init_status.h"
+#include "ui/base/layout.h"
 
 class BookmarkService;
 class TestingProfile;
 struct ThumbnailScore;
 
 namespace content {
 struct DownloadPersistentStoreInfo;
 }
 
 namespace history {
@@ skipping 206 matching lines @@
   // Exposed for testing reasons.
   void GetPageThumbnailDirectly(
       const GURL& page_url,
       scoped_refptr<base::RefCountedBytes>* data);
 
   void MigrateThumbnailsDatabase();
 
   // Favicon -------------------------------------------------------------------
 
   void GetFavicon(scoped_refptr<GetFaviconRequest> request,
-                  const GURL& icon_url,
-                  int icon_types);
+                   const std::vector<GURL>& icon_urls,
+                   int icon_types,
+                   const gfx::Size& desired_dip_size,
+                   const std::vector<ui::ScaleFactor>& desired_scale_factors);
 
-  void GetFaviconForURL(scoped_refptr<GetFaviconRequest> request,
-                        const GURL& page_url,
-                        int icon_types);
+  void GetFaviconForURL(
+      scoped_refptr<GetFaviconRequest> request,
+      const GURL& page_url,
+      int icon_types,
+      const gfx::Size& desired_dip_size,
+      const std::vector<ui::ScaleFactor>& desired_scale_factors);
 
-  void GetFaviconForID(scoped_refptr<GetFaviconRequest> request, FaviconID id);
+  void UpdateFaviconMappingsAndFetch(
+      scoped_refptr<GetFaviconRequest> request,
+      const GURL& page_url,
+      const std::vector<GURL>& icon_urls,
+      IconType icon_type,
+      const gfx::Size& desired_dip_size,
+      const std::vector<ui::ScaleFactor>& desired_scale_factors);
 
-  void SetFavicon(const GURL& page_url,
-                  const GURL& icon_url,
-                  scoped_refptr<base::RefCountedMemory> data,
-                  IconType icon_type);
+  void AddFavicons(const GURL& page_url,
+                   const GURL& icon_url,
+                   IconType icon_type,
+                   const std::vector<FaviconBitmapData>& favicon_bitmaps);
 
-  void UpdateFaviconMappingAndFetch(scoped_refptr<GetFaviconRequest> request,
-                                    const GURL& page_url,
-                                    const GURL& icon_url,
-                                    IconType icon_type);
+  void SetFavicons(const GURL& page_url,
+                   const GURL& icon_url,
+                   IconType icon_type,
+                   const std::vector<FaviconBitmapData>& favicon_bitmaps,
+                   const IconURLSizesMap& icon_url_sizes);
 
-  void SetFaviconOutOfDateForPage(const GURL& page_url);
+  void SetFaviconsOutOfDateForPage(const GURL& page_url);
 
-  void CloneFavicon(const GURL& old_page_url, const GURL& new_page_url);
+  void CloneFavicons(const GURL& old_page_url, const GURL& new_page_url);
 
   void SetImportedFavicons(
       const std::vector<ImportedFaviconUsage>& favicon_usage);
 
   // Downloads -----------------------------------------------------------------
 
   void GetNextDownloadId(scoped_refptr<DownloadNextIdRequest> request);
   void QueryDownloads(scoped_refptr<DownloadQueryRequest> request);
   void CleanUpInProgressEntries();
   void UpdateDownload(const content::DownloadPersistentStoreInfo& data);
@@ skipping 151 matching lines @@
 #if defined(UNIT_TEST)
   HistoryDatabase* db() const { return db_.get(); }
 
   ExpireHistoryBackend* expire_backend() { return &expirer_; }
 #endif
 
   // Returns true if the passed visit time is already expired (used by the sync
   // code to avoid syncing visits that would immediately be expired).
   virtual bool IsExpiredVisitTime(const base::Time& time);
 
+  // Set whether HistoryBackend::SetFavicon is cripled such that it can only be
+  // used to set favicon bitmaps of size 0 0 for a single URL.
+  // TODO(pkotwicz): Remove this restriction.
+  void set_single_favicon_bitmap_per_icon_type(
+      bool single_favicon_bitmap_per_icon_type) {
+    single_favicon_bitmap_per_icon_type_ = single_favicon_bitmap_per_icon_type;
+  }
+
  protected:
   virtual ~HistoryBackend();
 
  private:
   friend class base::RefCountedThreadSafe<HistoryBackend>;
   friend class CommitLaterTask;  // The commit task needs to call Commit().
   friend class HistoryBackendTest;
   friend class HistoryTest;  // So the unit tests can poke our innards.
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, DeleteAll);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, DeleteAllThenAddData);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, ImportedFaviconsTest);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, URLsNoLongerBookmarked);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, StripUsernamePasswordTest);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, DeleteThumbnailsDatabaseTest);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, AddPageVisitSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, AddPageArgsSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, AddVisitsSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, RemoveVisitsSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, RemoveVisitsTransitions);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MigrationVisitSource);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MigrationIconMapping);
-  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFaviconMapping);
-  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, AddOrUpdateIconMapping);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
+                           SetFaviconMappingsForPageAndRedirects);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
+                           SetFaviconMappingsForPageDuplicates);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFavicons);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFaviconsDeleteBitmaps);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, SetFaviconsReplaceBitmapData);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetMostRecentVisits);
-  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetFaviconForURL);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetFaviconsFromDB);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetFaviconsFromDBExpired);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetFaviconsFromDBIconType);
+  FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, GetFaviconsFromDBEmpty);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest,
                            CloneFaviconIsRestrictedToSameDomain);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, QueryFilteredURLs);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, UpdateVisitDuration);
 
   friend class ::TestingProfile;
 
   // Computes the name of the specified database on disk.
   FilePath GetThumbnailFileName() const;
 
@@ skipping 91 matching lines @@
   // Update the segment information. This is called internally when a page is
   // added. Return the segment id of the segment that has been updated.
   SegmentID UpdateSegments(const GURL& url,
                            VisitID from_visit,
                            VisitID visit_id,
                            content::PageTransition transition_type,
                            const base::Time ts);
 
   // Favicons ------------------------------------------------------------------
 
-  // Used by both UpdateFaviconMappingAndFetch and GetFavicon.
-  // If page_url is non-null and SetFavicon has previously been invoked for
-  // icon_url the favicon url for page_url (and all redirects) is set to
-  // icon_url.
+  // Used by both UpdateFaviconMappingsAndFetch and GetFavicons.
+  // If |page_url| is non-null, the icon urls for |page_url| (and all
+  // redirects) are set to the subset of |icon_urls| for which icons are
+  // already stored in the database.
   // Only a single type can be given in icon_type when page_url is specified.
-  void UpdateFaviconMappingAndFetchImpl(
+  void UpdateFaviconMappingsAndFetchImpl(
       const GURL* page_url,
-      const GURL& icon_url,
+      const std::vector<GURL>& icon_urls,
       scoped_refptr<GetFaviconRequest> request,
-      int icon_type);
+      int icon_types,
+      const gfx::Size& desired_dip_size,
+      const std::vector<ui::ScaleFactor> desired_scale_factors);
 
-  // Sets the favicon url id for page_url to id. This will also broadcast
-  // notifications as necessary.
-  void SetFaviconMapping(const GURL& page_url,
-                         FaviconID id,
-                         IconType icon_type);
+  // Set the favicon bitmaps for the favicon at |icon_id|.
+  void SetFaviconBitmaps(
+      FaviconID icon_id,
+      const std::vector<FaviconBitmapData>& favicon_bitmaps);
 
-  // Updates the FaviconID associated with the url of a page. If there is an
-  // existing mapping between |page_url| and |id| this does nothing and returns
-  // false. If the mapping needs to be added or updated, true is returned. If
-  // there is an existing mapping but it does not map to |id|, then the |id| of
-  // the replaced FaviconID is set in |replaced_icon_id|.
-  bool AddOrUpdateIconMapping(const GURL& page_url,
-                              FaviconID id,
-                              IconType icon_type,
-                              FaviconID* replaced_icon_id);
+  // Returns true if |elements| and |icon_url_sizes| passed to SetFavicons
+  // are valid.
+  bool ValidateSetFaviconsParams(
+      const std::vector<FaviconBitmapData>& favicon_bitmaps,
+      const IconURLSizesMap& icon_url_sizes) const;
+
+  // Sets the sizes that the thumbnail database knows that the favicon at
+  // |icon_id| is available at from the web. See history_types for a more
+  // in depth discussion about FaviconSizes.
+  void SetFaviconSizes(FaviconID icon_id,
+                       const std::vector<gfx::Size>& sizes);
+
+  // Returns true if there are favicons for |page_url| and one of the types in
+  // |icon_types|.
+  // |favicon_data| is set to the favicon bitmaps which most closely match
+  // |desired_dip_size| and |desired_scale_factors|. See the comment for
+  // GetFaviconDataForBestMatch() for more details on how FaviconData is
+  // constructed.
+  // |mapped_icon_urls| is set to all of the icon URLs which are mapped to
+  // |page_url| with one of the types in |icon_types|. If |icon_types| contains
+  // multiple icon types and there are several matched icon types in the
+  // database, icon URLs of a only single type will be in |mapped_icon_urls|
+  // in the priority of TOUCH_PRECOMPOSED_ICON, TOUCH_ICON, and FAVICON.
+  bool GetFaviconFromDB(
+      const GURL& page_url,
+      int icon_types,
+      const gfx::Size& desired_dip_size,
+      const std::vector<ui::ScaleFactor>& desired_scale_factors,
+      FaviconData* favicon_data,
+      std::vector<GURL>* mapped_icon_urls);
+
+  // Construct a FaviconData object from the favicon bitmaps which most closely
+  // match |desired_dip_size| and |desired_scale_factors|.
+  // Goodness is computed on a per favicon id basis, thus all of
+  // FaviconData::bitmaps are guaranteed to be for the same FaviconID.
+  // FaviconData::bitmaps may not contain all the favicon bitmaps for FaviconID
+  // which are in the database. Returns true on success.
+  bool GetFaviconDataForBestMatch(
+      const std::vector<FaviconID>& candidate_favicon_ids,
+      const gfx::Size& desired_dip_size,
+      const std::vector<ui::ScaleFactor>& desired_scale_factors,
+      FaviconData* favicon_data);
+
+  // Define type used solely in SetFaviconMappingsForPageAndRedirects.
+  typedef std::map<GURL, FaviconID> IconURLFaviconIDMap;
+
+  // Maps the favicon ids in |icon_url_id_map| to |page_url| (and all
+  // redirects) for |icon_type|. This will also broadcast notifications as
+  // necessary.
+  void SetFaviconMappingsForPageAndRedirects(
+      const GURL& page_url,
+      const IconType icon_type,
+      const IconURLFaviconIDMap& icon_url_id_map);
+
+  // Maps the favicon ids in |icon_url_id_map| to |page_url| for |icon_type|.
+  bool SetFaviconMappingsForPage(const GURL& page_url,
+                                 IconType icon_type,
+                                 const IconURLFaviconIDMap& icon_url_id_map);
 
   // Generic stuff -------------------------------------------------------------
 
   // Processes the next scheduled HistoryDBTask, scheduling this method
   // to be invoked again if there are more tasks that need to run.
   void ProcessDBTaskImpl();
 
   // Release all tasks in history_db_tasks_ and clears it.
   void ReleaseDBTasks();
 
@@ skipping 23 matching lines @@
   // set of URLs in the URL table (these should correspond to the bookmarked
   // URLs).
   //
   // The IDs of the URLs may change.
   bool ClearAllMainHistory(const URLRows& kept_urls);
 
   // Returns the BookmarkService, blocking until it is loaded. This may return
   // NULL during testing.
   BookmarkService* GetBookmarkService();
 
-  // If there is a favicon for |page_url| and one of the types in |icon_types|,
-  // |favicon| is set appropriately and true is returned.
-  bool GetFaviconFromDB(const GURL& page_url,
-                        int icon_types,
-                        FaviconData* favicon_data);
-
-  // Get favicon by the given |favicon_id|, the |favicon| is set appropriately
-  // and true if returned on success, otherwise false is returned.
-  bool GetFaviconFromDB(FaviconID favicon_id, FaviconData* favicon_data);
-
   // Notify any observers of an addition to the visit database.
   void NotifyVisitObservers(const VisitRow& visit);
 
   // Data ----------------------------------------------------------------------
 
   // Delegate. See the class definition above for more information. This will
   // be NULL before Init is called and after Cleanup, but is guaranteed
   // non-NULL in between.
   scoped_ptr<Delegate> delegate_;
 
@@ skipping 79 matching lines @@
 
   // Publishes the history to all indexers which are registered to receive
   // history data from us. Can be NULL if there are no listeners.
   scoped_ptr<HistoryPublisher> history_publisher_;
 
 #if defined(OS_ANDROID)
   // Used to provide the Android ContentProvider APIs.
   scoped_ptr<AndroidProviderBackend> android_provider_backend_;
 #endif
 
+  // If true HistoryBackend::SetFavicons is cripled such that it can only be
+  // used to set favicon bitmapas for a single URL and 0 0 bitmap size.
+  bool single_favicon_bitmap_per_icon_type_;
+
   DISALLOW_COPY_AND_ASSIGN(HistoryBackend);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_HISTORY_BACKEND_H_