Changes favicon database to support storing bitmaps of different sizes for the same icon_url

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();
 
   // Favicons ------------------------------------------------------------------
 
-  // Sets the bits for a favicon. This should be png encoded data.
+  // Add a favicon frame. A favicon frame represents a bitmap component for a
+  // particular size in an image file. Only favicons representing a .ico file
+  // should have multiple favicon frames 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.
-  bool SetFavicon(FaviconID icon_id,
-                  scoped_refptr<base::RefCountedMemory> icon_data,
-                  base::Time time);
+  bool AddFaviconFrame(FaviconID icon_id,

[sky, 2012/08/02 19:50:31]

Can you use Image or Bitmap instead of Frame in all of these? Including the
table name -> favicon_images.

This function needs to take a gfx::Size for the size of the image.

+                       scoped_refptr<base::RefCountedMemory> icon_data,
+                       base::Time time);
 
-  // Sets the time the favicon was last updated.
-  bool SetFaviconLastUpdateTime(FaviconID icon_id, base::Time time);
+  // Sets the the favicon as out of date. This will set |last_updated| for all
+  // of the frames 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.
   // 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.
   bool GetFavicon(FaviconID icon_id,
                   base::Time* last_updated,
                   std::vector<unsigned char>* png_icon_data,
                   GURL* icon_url,
                   IconType* icon_type);
 
+  // Gets the png encoded favicon and last updated time for the specified
+  // favicon id.
+  bool GetFaviconFrame(FaviconID icon_id,

[sky, 2012/08/02 19:50:31]

Won't this need to take something that returns a vector of png_icon_data and
sizes and probably the sizes string?

+                       base::Time* last_updated,
+                       std::vector<unsigned char>* png_icon_data);
+
   // Adds the favicon URL and icon type to the favicon db, returning its id.
   FaviconID AddFavicon(const GURL& icon_url, IconType icon_type);
 
   // 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.
@@ skipping 90 matching lines @@
   }
 
   // Copies the given favicon from the "main" favicon table to the temporary
   // one. This is only valid in between calls to InitTemporaryFaviconsTable()
   // and CommitTemporaryFaviconTable().
   //
   // The ID of the favicon will change when this copy takes place. The new ID
   // is returned, or 0 on failure.
   FaviconID CopyToTemporaryFaviconTable(FaviconID source);
 
-  // Replaces the main URL table with the temporary table created by
+  // Replaces the main favicon table with the temporary table created by
   // InitTemporaryFaviconsTable(). This will mean all favicons not copied over
   // will be deleted. Returns true on success.
   bool CommitTemporaryFaviconTable();
 
+  // Create a temporary table to store the favicon frames. Favicon frames will
+  // be copied to this table by CopyToTemporaryFaviconFramesTable() and then the
+  // original table will be dropped, leaving only the copied favicons
+  // remaining.
+  bool InitTemporaryFaviconFramesTable() {
+    return InitFaviconFramesTable(&db_, true);
+  }
+
+  // Copies the frames corresponding to |icon_id| from the "main" favicon table
+  // to the temporary one. This is only valid in between calls to
+  // InitTemporaryFaviconFramesTable()
+  // and CommitTemporaryFaviconFrameTable().
+  void CopyToTemporaryFaviconFramesTable(FaviconID icon_id);
+
+  // Replaces the main favicon frame table with the temporary table created by
+  // InitTemporaryFaviconFramesTable(). This means that all favicon frames not
+  // copied over will be deleted. Returns true on success.
+  bool CommitTemporaryFaviconFrameTable();
+
   // Returns true iff the thumbnails table exists.
   // Migrating to TopSites is dropping the thumbnails table.
   bool NeedsMigrationToTopSites();
 
   // Renames the database file and drops the Thumbnails table.
   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(HistoryBackendTest, MigrationIconMapping);
 
   // Creates the thumbnail table, returning true if the table already exists
   // or was successfully created.
   bool InitThumbnailTable();
 
-  // Creates the favicon table, returning true if the table already exists,
-  // or was successfully created. |is_temporary| will be false when generating
-  // the "regular" favicons table. The expirer sets this to true to generate the
-  // temporary table, which will have a different name but the same schema.
-  // |db| is the connection to use for initializing the table.
-  // A different connection is used in RenameAndDropThumbnails, when we
-  // need to copy the favicons between two database files.
-  bool InitFaviconsTable(sql::Connection* db, bool is_temporary);
-
   // Helper function to handle cleanup on upgrade failures.
   sql::InitStatus CantUpgradeToVersion(int cur_version);
 
   // Adds support for the new metadata on web page thumbnails.
   bool UpgradeToVersion3();
 
   // Adds support for the icon_type in favicon table.
   bool UpgradeToVersion4();
 
   // Adds support for sizes in favicon table.
   bool UpgradeToVersion5();
 
+  // Adds support for size in favicons table and removes sizes column.
+  bool UpgradeToVersion6();
+
   // Migrates the icon mapping data from URL database to Thumbnail database.
   // Return whether the migration succeeds.
   bool MigrateIconMappingData(URLDatabase* url_db);
 
+  // Creates the favicon table, returning true if the table already exists,
+  // or was successfully created. |is_temporary| will be false when generating
+  // the "regular" favicons table. The expirer sets this to true to generate the
+  // temporary table, which will have a different name but the same schema.
+  // |db| is the connection to use for initializing the table.
+  // A different connection is used in RenameAndDropThumbnails, when we
+  // need to copy the favicons between two database files.
+  bool InitFaviconsTable(sql::Connection* db, bool is_temporary);
+
   // Creates the index over the favicon table. This will be called during
   // initialization after the table is created. This is a separate function
   // because it is used by SwapFaviconTables to create an index over the
   // newly-renamed favicons table (formerly the temporary table with no index).
   bool InitFaviconsIndex();
 
+  // Creates the favicon_frames table, return true if the table already exists
+  // or was successfully created.
+  bool InitFaviconFramesTable(sql::Connection* db, bool is_temporary);
+
+  // Creates the index over the favicon_frames table. This will be called
+  // during initialization after the table is created. This is a separate
+  // function because it is used by CommitTemporaryFaviconFrameTable to create
+  // an index over the newly-renamed favicon_frames table (formerly the
+  // temporary table with no index).
+  bool InitFaviconFramesIndex();
+
   // Creates the icon_map table, return true if the table already exists or was
   // successfully created.
   bool InitIconMappingTable(sql::Connection* db, bool is_temporary);
 
   // Creates the index over the icon_mapping table, This will be called during
   // initialization after the table is created. This is a separate function
   // because it is used by CommitTemporaryIconMappingTable to create an index
   // over the newly-renamed icon_mapping table (formerly the temporary table
   // with no index).
   bool InitIconMappingIndex();
@@ skipping 18 matching lines @@
   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_