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

chrome/browser/history/thumbnail_database.cc

 // 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.
 
 #include "chrome/browser/history/thumbnail_database.h"
 
 #include <algorithm>
 #include <string>
 
 #include "base/command_line.h"
 #include "base/file_util.h"
 #include "base/memory/ref_counted_memory.h"
 #include "base/string_util.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/diagnostics/sqlite_diagnostics.h"
 #include "chrome/browser/history/history_publisher.h"
 #include "chrome/browser/history/top_sites.h"
 #include "chrome/browser/history/url_database.h"
 #include "chrome/common/thumbnail_score.h"
 #include "sql/statement.h"
 #include "sql/transaction.h"
 #include "ui/gfx/image/image_util.h"
 
 #if defined(OS_MACOSX)
 #include "base/mac/mac_util.h"
 #endif
 
 static void FillIconMapping(const sql::Statement& statement,

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

Add a comment here detailing the tables that are created here and how they
relate. See chrome/browser/webdata/autofill_table.h for an example of what I'm
looking for.

                             const GURL& page_url,
                             history::IconMapping* icon_mapping) {
   icon_mapping->mapping_id = statement.ColumnInt64(0);
   icon_mapping->icon_id = statement.ColumnInt64(1);
   icon_mapping->icon_type =
       static_cast<history::IconType>(statement.ColumnInt(2));
   icon_mapping->page_url = page_url;
 }
 
 namespace history {
 
 // Version number of the database.
-static const int kCurrentVersionNumber = 5;
-static const int kCompatibleVersionNumber = 5;
+static const int kCurrentVersionNumber = 6;
+static const int kCompatibleVersionNumber = 6;
 
 // Use 90 quality (out of 100) which is pretty high, because we're very
 // sensitive to artifacts for these small sized, highly detailed images.
 static const int kImageQuality = 90;
 
 ThumbnailDatabase::IconMappingEnumerator::IconMappingEnumerator() {
 }
 
 ThumbnailDatabase::IconMappingEnumerator::~IconMappingEnumerator() {
 }
 
 bool ThumbnailDatabase::IconMappingEnumerator::GetNextIconMapping(
     IconMapping* icon_mapping) {
   if (!statement_.Step())
     return false;
   FillIconMapping(statement_, GURL(statement_.ColumnString(3)), icon_mapping);
   return true;
 }
 
 ThumbnailDatabase::ThumbnailDatabase()
     : history_publisher_(NULL),
       use_top_sites_(false) {
 }
 
 sql::InitStatus ThumbnailDatabase::CantUpgradeToVersion(int cur_version) {
-  LOG(WARNING) << "Unable to update to thumbnail database to version 4" <<
+  LOG(WARNING) << "Unable to update to thumbnail database to version " <<
                cur_version << ".";
   db_.Close();
   return sql::INIT_FAILURE;
 }
 
 ThumbnailDatabase::~ThumbnailDatabase() {
   // The DBCloseScoper will delete the DB and the cache.
 }
 
 sql::InitStatus ThumbnailDatabase::Init(
@@ skipping 11 matching lines @@
 
 #if defined(OS_MACOSX)
   // Exclude the thumbnails file from backups.
   base::mac::SetFileBackupExclusion(db_name);
 #endif
 
   // Create the tables.
   if (!meta_table_.Init(&db_, kCurrentVersionNumber,
                         kCompatibleVersionNumber) ||
       !InitThumbnailTable() ||
+      !InitFaviconFramesTable(&db_, false) ||
+      !InitFaviconFramesIndex() ||
       !InitFaviconsTable(&db_, false) ||
       !InitFaviconsIndex() ||
       !InitIconMappingTable(&db_, false) ||
       !InitIconMappingIndex()) {
     db_.Close();
     return sql::INIT_FAILURE;
   }
 
   // Version check. We should not encounter a database too old for us to handle
   // in the wild, so we try to continue in that case.
   if (meta_table_.GetCompatibleVersionNumber() > kCurrentVersionNumber) {
     LOG(WARNING) << "Thumbnail database is too new.";
     return sql::INIT_TOO_NEW;
   }
 
   int cur_version = meta_table_.GetVersionNumber();
   if (cur_version == 2) {
     ++cur_version;
     if (!UpgradeToVersion3())
       return CantUpgradeToVersion(cur_version);
   }
 
   if (cur_version == 3) {
     ++cur_version;
     if (!UpgradeToVersion4() || !MigrateIconMappingData(url_db))
       return CantUpgradeToVersion(cur_version);
   }
 
   if (cur_version == 4) {
+    ++cur_version;
     if (!UpgradeToVersion5())
       return CantUpgradeToVersion(cur_version);
   }
 
+  if (cur_version == 5) {
+    ++cur_version;
+    if (!UpgradeToVersion6())
+      return CantUpgradeToVersion(cur_version);
+  }
+
   LOG_IF(WARNING, cur_version < kCurrentVersionNumber) <<
       "Thumbnail database version " << cur_version << " is too old to handle.";
 
   // Initialization is complete.
   if (!transaction.Commit()) {
     db_.Close();
     return sql::INIT_FAILURE;
   }
 
   return sql::INIT_OK;
@@ skipping 69 matching lines @@
   // Note: if you update the schema, don't forget to update
   // CopyToTemporaryFaviconTable as well.
   const char* name = is_temporary ? "temp_favicons" : "favicons";
   if (!db->DoesTableExist(name)) {
     std::string sql;
     sql.append("CREATE TABLE ");
     sql.append(name);
     sql.append("("
                "id INTEGER PRIMARY KEY,"
                "url LONGVARCHAR NOT NULL,"
-               "last_updated INTEGER DEFAULT 0,"
-               "image_data BLOB,"
                // Set the default icon_type as FAVICON to be consistent with
                // table upgrade in UpgradeToVersion4().
                "icon_type INTEGER DEFAULT 1,"
                "sizes LONGVARCHAR)");
     if (!db->Execute(sql.c_str()))
       return false;
   }
   return true;
 }
 
 bool ThumbnailDatabase::InitFaviconsIndex() {
   // Add an index on the url column.
   return
       db_.Execute("CREATE INDEX IF NOT EXISTS favicons_url ON favicons(url)");
 }
 
+bool ThumbnailDatabase::InitFaviconFramesTable(sql::Connection* db,
+                                               bool is_temporary) {
+  // Note: if you update the schema, don't forget to update
+  // CopyToTemporaryFaviconFramesTable as well.
+  const char* name = is_temporary ? "temp_favicon_frames" : "favicon_frames";
+  if (!db->DoesTableExist(name)) {
+    std::string sql;
+    sql.append("CREATE TABLE ");
+    sql.append(name);
+    sql.append("("
+               "id INTEGER PRIMARY KEY,"
+               "icon_id INTEGER,"
+               "last_updated INTEGER DEFAULT 0,"
+               "image_data BLOB,"
+               "width INTEGER DEFAULT 0,"
+               "height INTEGER DEFAULT 0)");
+    if (!db->Execute(sql.c_str()))
+      return false;
+  }
+  return true;
+}
+
+bool ThumbnailDatabase::InitFaviconFramesIndex() {
+  // Add an index on the icon_id column.
+  return db_.Execute("CREATE INDEX IF NOT EXISTS favicon_frames_icon_id ON "
+                     "favicon_frames(icon_id)");
+}
+
 void ThumbnailDatabase::BeginTransaction() {
   db_.BeginTransaction();
 }
 
 void ThumbnailDatabase::CommitTransaction() {
   db_.CommitTransaction();
 }
 
 void ThumbnailDatabase::RollbackTransaction() {
   db_.RollbackTransaction();
@@ skipping 107 matching lines @@
   double current_boring_score = select_statement.ColumnDouble(0);
   bool current_clipping = select_statement.ColumnBool(1);
   bool current_at_top = select_statement.ColumnBool(2);
   base::Time last_updated =
       base::Time::FromTimeT(select_statement.ColumnInt64(3));
   *score = ThumbnailScore(current_boring_score, current_clipping,
                           current_at_top, last_updated);
   return true;
 }
 
-bool ThumbnailDatabase::SetFavicon(
+bool ThumbnailDatabase::AddFaviconFrame(
     URLID icon_id,
     scoped_refptr<base::RefCountedMemory> icon_data,
     base::Time time) {
   DCHECK(icon_id);
   sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
-      "UPDATE favicons SET image_data=?, last_updated=? WHERE id=?"));
+      "INSERT INTO favicon_frames (icon_id, image_data, last_updated) VALUES "
+      "(?, ?, ?)"));
+  statement.BindInt64(0, icon_id);
   if (icon_data->size()) {
-    statement.BindBlob(0, icon_data->front(),
+    statement.BindBlob(1, icon_data->front(),
                        static_cast<int>(icon_data->size()));
   } else {
-    statement.BindNull(0);
+    statement.BindNull(1);
   }
-  statement.BindInt64(1, time.ToTimeT());
-  statement.BindInt64(2, icon_id);
+  statement.BindInt64(2, time.ToTimeT());
 
   return statement.Run();
 }
 
-bool ThumbnailDatabase::SetFaviconLastUpdateTime(FaviconID icon_id,
-                                                 base::Time time) {
+bool ThumbnailDatabase::SetFaviconOutOfDate(FaviconID icon_id) {
   sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
-      "UPDATE favicons SET last_updated=? WHERE id=?"));
-  statement.BindInt64(0, time.ToTimeT());
+      "UPDATE favicon_frames SET last_updated=? WHERE icon_id=?"));
+  statement.BindInt64(0, 0);
   statement.BindInt64(1, icon_id);
 
   return statement.Run();
 }
 
 FaviconID ThumbnailDatabase::GetFaviconIDForFaviconURL(const GURL& icon_url,
                                                        int required_icon_type,
                                                        IconType* icon_type) {
   sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
       "SELECT id, icon_type FROM favicons WHERE url=? AND (icon_type & ? > 0) "
@@ skipping 10 matching lines @@
 }
 
 bool ThumbnailDatabase::GetFavicon(
     FaviconID icon_id,
     base::Time* last_updated,
     std::vector<unsigned char>* png_icon_data,
     GURL* icon_url,
     IconType* icon_type) {
   DCHECK(icon_id);
 
+  if (!GetFaviconFrame(icon_id, last_updated, png_icon_data))
+    return false;
+
+  if (icon_url || icon_type) {
+    sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
+        "SELECT url, icon_type FROM favicons WHERE id=?"));
+    statement.BindInt64(0, icon_id);
+
+    if (!statement.Step())
+      return false;  // No entry for the id.
+
+    if (icon_url)
+      *icon_url = GURL(statement.ColumnString(0));
+    if (icon_type)
+      *icon_type = static_cast<history::IconType>(statement.ColumnInt(1));
+  }
+
+  return true;
+}
+
+bool ThumbnailDatabase::GetFaviconFrame(
+    FaviconID icon_id,
+    base::Time* last_updated,
+    std::vector<unsigned char>* png_icon_data) {
+  DCHECK(icon_id);
   sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
-      "SELECT last_updated, image_data, url, icon_type "
-      "FROM favicons WHERE id=?"));
+      "SELECT last_updated, image_data FROM favicon_frames WHERE icon_id=?"));
   statement.BindInt64(0, icon_id);
 
   if (!statement.Step())
     return false;  // No entry for the id.
 
   if (last_updated)
     *last_updated = base::Time::FromTimeT(statement.ColumnInt64(0));
   if (statement.ColumnByteLength(1) > 0)
     statement.ColumnBlobAsVector(1, png_icon_data);
-  if (icon_url)
-    *icon_url = GURL(statement.ColumnString(2));
-  if (icon_type)
-    *icon_type = static_cast<history::IconType>(statement.ColumnInt(3));
-
   return true;
 }
 
 FaviconID ThumbnailDatabase::AddFavicon(const GURL& icon_url,
                                         IconType icon_type) {
 
   sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
       "INSERT INTO favicons (url, icon_type) VALUES (?, ?)"));
   statement.BindString(0, URLDatabase::GURLToDatabaseURL(icon_url));
   statement.BindInt(1, icon_type);
 
   if (!statement.Run())
     return 0;
   return db_.GetLastInsertRowId();
 }
 
 bool ThumbnailDatabase::DeleteFavicon(FaviconID id) {
-  sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
+  bool success = true;
+  sql::Statement statement;
+  statement.Assign(db_.GetCachedStatement(SQL_FROM_HERE,
       "DELETE FROM favicons WHERE id = ?"));
   statement.BindInt64(0, id);
+  success &= statement.Run();

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

If this fails, shouldn't this return?

 
-  return statement.Run();
+  statement.Assign(db_.GetCachedStatement(SQL_FROM_HERE,
+      "DELETE FROM favicon_frames WHERE icon_id = ?"));
+  statement.BindInt64(0, id);
+  success &= statement.Run();
+
+  return success;
 }
 
 bool ThumbnailDatabase::GetIconMappingForPageURL(const GURL& page_url,
                                                  IconType required_icon_type,
                                                  IconMapping* icon_mapping) {
   std::vector<IconMapping> icon_mappings;
   if (!GetIconMappingsForPageURL(page_url, &icon_mappings))
     return false;
 
   for (std::vector<IconMapping>::iterator m = icon_mappings.begin();
@@ skipping 130 matching lines @@
   // Rename the temporary one.
   if (!db_.Execute("ALTER TABLE temp_icon_mapping RENAME TO icon_mapping"))
     return false;
 
   // The renamed table needs the index (the temporary table doesn't have one).
   return InitIconMappingIndex();
 }
 
 FaviconID ThumbnailDatabase::CopyToTemporaryFaviconTable(FaviconID source) {
   sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
-      "INSERT INTO temp_favicons (url, last_updated, image_data, icon_type)"
-      "SELECT url, last_updated, image_data, icon_type "
-      "FROM favicons WHERE id = ?"));
+      "INSERT INTO temp_favicons (url, icon_type, sizes) "
+      "SELECT url, icon_type, sizes FROM favicons WHERE id = ?"));
   statement.BindInt64(0, source);
 
   if (!statement.Run())
     return 0;
 
   // We return the ID of the newly inserted favicon.
   return db_.GetLastInsertRowId();
 }
 
 bool ThumbnailDatabase::CommitTemporaryFaviconTable() {
   // Delete the old favicons table.
   if (!db_.Execute("DROP TABLE favicons"))
     return false;
 
   // Rename the temporary one.
   if (!db_.Execute("ALTER TABLE temp_favicons RENAME TO favicons"))
     return false;
 
   // The renamed table needs the index (the temporary table doesn't have one).
   return InitFaviconsIndex();
 }
 
+void ThumbnailDatabase::CopyToTemporaryFaviconFramesTable(
+    FaviconID source) {
+  sql::Statement statement(db_.GetCachedStatement(SQL_FROM_HERE,
+      "INSERT INTO temp_favicon_frames (icon_id, last_updated, image_data, "
+      "width, height) "
+      "SELECT icon_id, last_updated, image_data, width, height "

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

This is inserting the old id when it needs to insert the new id. Additionally
it's querying using 'id' when it should be using icon_id. Make sure you have
test coverage for this.

+      "FROM favicon_frames WHERE id = ?"));
+  statement.BindInt64(0, source);
+  statement.Run();
+}
+
+bool ThumbnailDatabase::CommitTemporaryFaviconFrameTable() {
+  // Delete the old favicon frames table.
+  if (!db_.Execute("DROP TABLE favicon_frames"))
+    return false;
+
+  // Rename the temporary one.
+  if (!db_.Execute("ALTER TABLE temp_favicon_frames RENAME TO favicon_frames"))
+    return false;
+
+  // The renamed table needs an index (the temporary table doesn't have one).
+  return InitFaviconFramesIndex();
+}
+
 bool ThumbnailDatabase::NeedsMigrationToTopSites() {
   return !use_top_sites_;
 }
 
 bool ThumbnailDatabase::RenameAndDropThumbnails(const FilePath& old_db_file,
                                                 const FilePath& new_db_file) {
   // Init favicons table - same schema as the thumbnails.

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

tables

   sql::Connection favicons;
   if (OpenDatabase(&favicons, new_db_file) != sql::INIT_OK)
     return false;
 
-  if (!InitFaviconsTable(&favicons, false) ||
+  if (!InitFaviconFramesTable(&favicons, false) ||
+      !InitFaviconsTable(&favicons, false) ||
       !InitIconMappingTable(&favicons, false)) {
     favicons.Close();
     return false;
   }
   favicons.Close();
 
   // Can't attach within a transaction.
   if (transaction_nesting())
     CommitTransaction();
 
@@ skipping 13 matching lines @@
 #else
     attach.BindString(0, WideToUTF8(new_db_file.value()));
 #endif
 
     if (!attach.Run()) {
       BeginTransaction();
       return false;
     }
   }
 
-  // Move favicons to the new DB.
-  if (!db_.Execute("INSERT OR REPLACE INTO new_favicons.favicons "
-                   "SELECT * FROM favicons")) {
-    DLOG(FATAL) << "Unable to copy favicons.";
+  // Move favicons and frame_frames to new DB.
+  bool successfully_moved_data =
+     db_.Execute("INSERT OR REPLACE INTO new_favicons.favicon_frames "
+                 "SELECT * FROM favicon_frames") &&
+     db_.Execute("INSERT OR REPLACE INTO new_favicons.favicons "
+                 "SELECT * FROM favicons");
+  if (!successfully_moved_data) {
+    DLOG(FATAL) << "Unable to copy favicons and frame_frames.";
     BeginTransaction();
     return false;
   }
 
   if (!db_.Execute("DETACH new_favicons")) {
     DLOG(FATAL) << "Unable to detach database.";
     BeginTransaction();
     return false;
   }
 
   db_.Close();
 
   // Reset the DB to point to new file.
   if (OpenDatabase(&db_, new_db_file) != sql::INIT_OK)
     return false;
 
   file_util::Delete(old_db_file, false);
 
   meta_table_.Reset();
   if (!meta_table_.Init(&db_, kCurrentVersionNumber, kCompatibleVersionNumber))
     return false;
 
-  if (!InitFaviconsIndex())
+  if (!InitFaviconFramesIndex() || !InitFaviconsIndex())
     return false;
 
   // Reopen the transaction.
   BeginTransaction();
   use_top_sites_ = true;
   return true;
 }
 
 bool ThumbnailDatabase::InitIconMappingTable(sql::Connection* db,
                                              bool is_temporary) {
@@ skipping 61 matching lines @@
 
 bool ThumbnailDatabase::UpgradeToVersion5() {
   if (!db_.Execute("ALTER TABLE favicons ADD sizes LONGVARCHAR")) {
     return false;
   }
   meta_table_.SetVersionNumber(5);
   meta_table_.SetCompatibleVersionNumber(std::min(5, kCompatibleVersionNumber));
   return true;
 }
 
+bool ThumbnailDatabase::UpgradeToVersion6() {
+  bool success =
+      db_.Execute("INSERT INTO favicon_frames (icon_id, last_updated, "
+                  "image_data)"
+                  "SELECT id, last_updated, image_data FROM favicons") &&

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

You need to update width/height here too.

+      db_.Execute("CREATE TABLE temp_favicons ("
+                  "id INTEGER PRIMARY KEY,"
+                  "url LONGVARCHAR NOT NULL,"
+                  "icon_type INTEGER DEFAULT 1,"
+                  "sizes LONGVARCHAR)") &&
+      db_.Execute("INSERT INTO temp_favicons (id, url, icon_type) "
+                  "SELECT id, url, icon_type FROM favicons") &&
+      db_.Execute("DROP TABLE favicons") &&
+      db_.Execute("ALTER TABLE temp_favicons RENAME TO favicons");
+
+  meta_table_.SetVersionNumber(6);
+  meta_table_.SetCompatibleVersionNumber(std::min(6, kCompatibleVersionNumber));
+  return success;
+}
+
 }  // namespace history