Adds support for saving favicon size into history database.

chrome/browser/history/thumbnail_database.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_THUMBNAIL_DATABASE_H_
 #define CHROME_BROWSER_HISTORY_THUMBNAIL_DATABASE_H_
 
 #include <vector>
 
 #include "base/gtest_prod_util.h"
@@ skipping 81 matching lines @@
   // current thumbnail score and places it in |score| and returns
   // true. Returns false otherwise.
   bool ThumbnailScoreForId(URLID id, ThumbnailScore* score);
 
   // Called by the to delete all old thumbnails and make a clean table.
   // Returns true on success.
   bool RecreateThumbnailTable();
 
   // Favicon Bitmaps -----------------------------------------------------------
 
+  // Returns true if there are favicon bitmaps for |icon_id|. If
+  // |bitmap_size_listing| is non NULL, sets it to a listing of the favicon
+  // bitmap ids and their associated pixel sizes for the favicon with
+  // |icon_id|.
+  bool GetFaviconBitmapIDSizeList(
+      FaviconID icon_id,
+      std::vector<FaviconBitmapIDSize>* bitmap_id_size_list);
+
   // Returns true if there are any matched bitmaps for the given |icon_id|. All
   // matched results are returned if |favicon_bitmaps| is not NULL.
   bool GetFaviconBitmaps(FaviconID icon_id,
                          std::vector<FaviconBitmap>* favicon_bitmaps);
 
+  // Gets the favicon id, last updated time, bitmap data, and pixel size of the
+  // favicon bitmap at |bitmap_id|.
+  // Returns true if successful.
+  bool GetFaviconBitmap(FaviconBitmapID bitmap_id,
+                        base::Time* last_updated,
+                        scoped_refptr<base::RefCountedMemory>* png_icon_data,
+                        gfx::Size* pixel_size);
+
+  // Sets the bitmap data and the last updated time for the favicon bitmap at
+  // |bitmap_id|. Returns true if successful.
+  bool SetFaviconBitmap(FaviconBitmapID bitmap_id,
+                        scoped_refptr<base::RefCountedMemory> icon_data,
+                        base::Time time);
+
   // Adds a bitmap component at |pixel_size| for the favicon with |icon_id|.
   // Only favicons representing a .ico file should have multiple favicon bitmaps
   // per favicon.
   // |icon_data| is the png encoded data.
   // The |time| indicates the access time, and is used to detect when the
   // favicon should be refreshed.
   // |pixel_size| is the pixel dimensions of |icon_data|.
   // Returns the id of the added bitmap or 0 if unsuccessful.
   FaviconBitmapID AddFaviconBitmap(
       FaviconID icon_id,
       const scoped_refptr<base::RefCountedMemory>& icon_data,
       base::Time time,
       const gfx::Size& pixel_size);
 
-  // Deletes the favicon bitmaps for the favicon with with |icon_id|.
-  // Returns true if successful.
-  bool DeleteFaviconBitmapsForFavicon(FaviconID icon_id);
+  // Deletes the favicon bitmap with |bitmap_id|. Returns true if successful.
+  bool DeleteFaviconBitmap(FaviconBitmapID bitmap_id);
 
   // Favicons ------------------------------------------------------------------
 
-  // Updates the sizes associated with a favicon to |sizes|. See the comment
-  // at the top of the .cc file for the format of the |sizes| parameter.
-  bool SetFaviconSizes(FaviconID icon_id, const std::string& sizes);
+  // Updates the sizes associated with a favicon to |sizes|. See comment at
+  // top of the .ccc file for description of |sizes|.
+  bool SetFaviconSizes(FaviconID icon_id, const FaviconSizes& sizes);
 
   // Sets the the favicon as out of date. This will set |last_updated| for all
   // of the bitmaps for |icon_id| to be out of date.
   bool SetFaviconOutOfDate(FaviconID icon_id);
 
   // Returns the id of the entry in the favicon database with the specified url
   // and icon type. If |required_icon_type| contains multiple icon types and
   // there are more than one matched icon in database, only one icon will be
   // returned in the priority of TOUCH_PRECOMPOSED_ICON, TOUCH_ICON, and
-  // FAVICON, and the icon type is returned in icon_type parameter if it is not
-  // NULL.
+  // FAVICON.
   // Returns 0 if no entry exists for the specified url.
   FaviconID GetFaviconIDForFaviconURL(const GURL& icon_url,
-                                      int required_icon_type,
-                                      IconType* icon_type);
-
-  // Gets the png encoded favicon, last updated time, icon_url and icon_type for
-  // the specified favicon id.
-  // TODO(pkotwicz): Remove this function.
-  bool GetFavicon(FaviconID icon_id,
-                  base::Time* last_updated,
-                  scoped_refptr<base::RefCountedMemory>* png_icon_data,
-                  GURL* icon_url,
-                  IconType* icon_type);
+                                      int required_icon_type);
 
   // Gets the icon_url, icon_type and sizes for the specified |icon_id|.
   bool GetFaviconHeader(FaviconID icon_id,
                         GURL* icon_url,
                         IconType* icon_type,
-                        std::string* sizes);
+                        FaviconSizes* sizes);
 
-  // Adds the favicon URL and icon type to the favicon db, returning its id.
+  // Adds favicon with |icon_url| and |icon_type| to the favicon db, returning
+  // its id.
   FaviconID AddFavicon(const GURL& icon_url, IconType icon_type);
 
   // Adds a favicon with a single bitmap. This call is equivalent to calling
   // AddFavicon, SetFaviconSizes, and AddFaviconBitmap.
   FaviconID AddFavicon(const GURL& icon_url,
                        IconType icon_type,
-                       const std::string& sizes,
+                       const FaviconSizes& sizes,
                        const scoped_refptr<base::RefCountedMemory>& icon_data,
                        base::Time time,
                        const gfx::Size& pixel_size);
 
   // Delete the favicon with the provided id. Returns false on failure
   bool DeleteFavicon(FaviconID id);
 
   // Icon Mapping --------------------------------------------------------------
   //
   // Returns true if there is a matched icon mapping for the given page and
   // icon type.
   // The matched icon mapping is returned in the icon_mapping parameter if it is
   // not NULL.
-  bool GetIconMappingForPageURL(const GURL& page_url,
-                                IconType required_icon_type,
-                                IconMapping* icon_mapping);
+
+  // Returns true if there are icon mappings for the given page and icon type.
+  // If |required_icon_types| contains multiple icon types and there is more
+  // than one matched icon type in the database, icons of only a single type
+  // will be returned in the priority of TOUCH_PRECOMPOSED_ICON, TOUCH_ICON,
+  // and FAVICON.
+  // The matched icon mappings are returned in the |icon_mappings| parameter if
+  // it is not NULL.
+  bool GetIconMappingsForPageURL(const GURL& page_url,
+                                 int required_icon_types,
+                                 std::vector<IconMapping>* mapping_data);
 
   // Returns true if there is any matched icon mapping for the given page.
   // All matched icon mappings are returned in descent order of IconType if
   // mapping_data is not NULL.
   bool GetIconMappingsForPageURL(const GURL& page_url,
                                  std::vector<IconMapping>* mapping_data);
 
   // Adds a mapping between the given page_url and icon_id.
   // Returns the new mapping id if the adding succeeds, otherwise 0 is returned.
   IconMappingID AddIconMapping(const GURL& page_url, FaviconID icon_id);
 
   // Updates the page and icon mapping for the given mapping_id with the given
   // icon_id.
   // Returns true if the update succeeded.
   bool UpdateIconMapping(IconMappingID mapping_id, FaviconID icon_id);
 
   // Deletes the icon mapping entries for the given page url.
   // Returns true if the deletion succeeded.
   bool DeleteIconMappings(const GURL& page_url);
 
+  // Deletes the icon mapping with |mapping_id|.
+  // Returns true if the deletion succeeded.
+  bool DeleteIconMapping(IconMappingID mapping_id);
+
   // Checks whether a favicon is used by any URLs in the database.
   bool HasMappingFor(FaviconID id);
 
   // Clones the existing mappings from |old_page_url| if |new_page_url| has no
   // mappings. Otherwise, will leave mappings alone.
-  bool CloneIconMapping(const GURL& old_page_url, const GURL& new_page_url);
+  bool CloneIconMappings(const GURL& old_page_url, const GURL& new_page_url);
 
   // The class to enumerate icon mappings. Use InitIconMappingEnumerator to
   // initialize.
   class IconMappingEnumerator {
    public:
     IconMappingEnumerator();
     ~IconMappingEnumerator();
 
     // Get the next icon mapping, return false if no more are available.
     bool GetNextIconMapping(IconMapping* icon_mapping);
@@ skipping 51 matching lines @@
   bool RenameAndDropThumbnails(const FilePath& old_db_file,
                                const FilePath& new_db_file);
 
  private:
   friend class ExpireHistoryBackend;
   FRIEND_TEST_ALL_PREFIXES(ThumbnailDatabaseTest,
                            GetFaviconAfterMigrationToTopSites);
   FRIEND_TEST_ALL_PREFIXES(ThumbnailDatabaseTest, UpgradeToVersion4);
   FRIEND_TEST_ALL_PREFIXES(ThumbnailDatabaseTest, UpgradeToVersion5);
   FRIEND_TEST_ALL_PREFIXES(ThumbnailDatabaseTest, UpgradeToVersion6);
+  FRIEND_TEST_ALL_PREFIXES(ThumbnailDatabaseTest, FaviconSizesToAndFromString);
   FRIEND_TEST_ALL_PREFIXES(HistoryBackendTest, MigrationIconMapping);
 
   // Creates the thumbnail table, returning true if the table already exists
   // or was successfully created.
   bool InitThumbnailTable();
 
   // Helper function to handle cleanup on upgrade failures.
   sql::InitStatus CantUpgradeToVersion(int cur_version);
 
   // Adds support for the new metadata on web page thumbnails.
@@ skipping 52 matching lines @@
   // Adds a mapping between the given page_url and icon_id; The mapping will be
   // added to temp_icon_mapping table if is_temporary is true.
   // Returns the new mapping id if the adding succeeds, otherwise 0 is returned.
   IconMappingID AddIconMapping(const GURL& page_url,
                                FaviconID icon_id,
                                bool is_temporary);
 
   // Returns True if the current database is latest.
   bool IsLatestVersion();
 
+  // Converts the vector representation of sizes as passed into SetFaviconSizes
+  // to a string to store in the |favicons| database table.
+  // Format:
+  //   Each widthxheight pair is separated by a space.
+  //   Width and height are separated by a space.
+  // For instance, if sizes contains pixel sizes (16x16, 32x32), the
+  // string representation is "16 16 32 32".
+  static void FaviconSizesToDatabaseString(const FaviconSizes& sizes,
+                                           std::string* sizes_string);
+
+  // Converts the string representation of sizes as stored in the |favicons|
+  // database table to a vector.
+  // Returns true if there were no errors.
+  static bool DatabaseStringToFaviconSizes(const std::string sizes_string,
+                                           FaviconSizes* sizes);
+
   sql::Connection db_;
   sql::MetaTable meta_table_;
 
   // This object is created and managed by the history backend. We maintain an
   // opaque pointer to the object for our use.
   // This can be NULL if there are no indexers registered to receive indexing
   // data from us.
   const HistoryPublisher* history_publisher_;
 
   // True if migration to TopSites has been done and the thumbnails
   // table should not be used.
   bool use_top_sites_;
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_THUMBNAIL_DATABASE_H_