Implement QM::GetOriginsModifiedSince for browser data deleter support

webkit/quota/quota_database.cc

 // Copyright (c) 2011 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 "webkit/quota/quota_database.h"
 
 #include <string>
 
 #include "app/sql/connection.h"
 #include "app/sql/diagnostic_error_delegate.h"
 #include "app/sql/meta_table.h"
 #include "app/sql/statement.h"
 #include "app/sql/transaction.h"
 #include "base/auto_reset.h"
+#include "base/bind.h"
 #include "base/file_util.h"
 #include "base/time.h"
 #include "googleurl/src/gurl.h"
 #include "webkit/quota/special_storage_policy.h"
 
+namespace quota {
 namespace {
 
 // Definitions for database schema.
 
-const int kCurrentVersion = 2;
+const int kCurrentVersion = 3;
 const int kCompatibleVersion = 2;
 
-const char kOriginsTable[] = "Origins";
 const char kHostQuotaTable[] = "HostQuotaTable";
-const char kOriginLastAccessTable[] = "OriginLastAccessTable";
+const char kOriginInfoTable[] = "OriginInfoTable";
 const char kGlobalQuotaKeyPrefix[] = "GlobalQuota-";
 const char kIsOriginTableBootstrapped[] = "IsOriginTableBootstrapped";
 
-const struct {
-  const char* table_name;
-  const char* columns;
-} kTables[] = {
-  { kHostQuotaTable,
-    "(host TEXT NOT NULL,"
-    " type INTEGER NOT NULL,"
-    " quota INTEGER,"
-    " UNIQUE(host, type))" },
-  { kOriginLastAccessTable,
-    "(origin TEXT NOT NULL,"
-    " type INTEGER NOT NULL,"
-    " used_count INTEGER,"
-    " last_access_time INTEGER,"
-    " UNIQUE(origin, type))" },
-};
-
-const struct {
-  const char* index_name;
-  const char* table_name;
-  const char* columns;
-  bool unique;
-} kIndexes[] = {
-  { "HostIndex",
-    kHostQuotaTable,
-    "(host)",
-    false },
-  { "OriginLastAccessIndex",
-    kOriginLastAccessTable,
-    "(origin, last_access_time)",
-    false },
-};
-
-const int kTableCount = ARRAYSIZE_UNSAFE(kTables);
-const int kIndexCount = ARRAYSIZE_UNSAFE(kIndexes);
-
 class HistogramUniquifier {
  public:
   static const char* name() { return "Sqlite.Quota.Error"; }
 };
 
 bool PrepareCachedStatement(
     sql::Connection* db, const sql::StatementID& id,
     const char* sql, sql::Statement* statement) {
   DCHECK(db && sql && statement);
   statement->Assign(db->GetCachedStatement(id, sql));
@@ skipping 10 matching lines @@
   else if (type == quota::kStorageTypePersistent)
     return std::string(kGlobalQuotaKeyPrefix) + "persistent";
   NOTREACHED() << "Unknown storage type " << type;
   return std::string();
 }
 
 const int kCommitIntervalMs = 30000;
 
 }  // anonymous namespace
 
-namespace quota {
+// static
+const QuotaDatabase::TableSchema QuotaDatabase::kTables[] = {
+  { kHostQuotaTable,
+    "(host TEXT NOT NULL,"
+    " type INTEGER NOT NULL,"
+    " quota INTEGER DEFAULT 0,"
+    " UNIQUE(host, type))" },
+  { kOriginInfoTable,
+    "(origin TEXT NOT NULL,"
+    " type INTEGER NOT NULL,"
+    " used_count INTEGER DEFAULT 0,"
+    " last_access_time INTEGER DEFAULT 0,"
+    " last_modified_time INTEGER DEFAULT 0,"
+    " UNIQUE(origin, type))" },
+};
+
+// static
+const QuotaDatabase::IndexSchema QuotaDatabase::kIndexes[] = {
+  { "HostIndex",
+    kHostQuotaTable,
+    "(host)",
+    false },
+  { "OriginInfoIndex",
+    kOriginInfoTable,
+    "(origin)",
+    false },
+  { "OriginLastAccessTimeIndex",
+    kOriginInfoTable,
+    "(last_access_time)",
+    false },
+  { "OriginLastModifiedTimeIndex",
+    kOriginInfoTable,
+    "(last_modified_time)",
+    false },
+};
+
+struct QuotaDatabase::QuotaTableImporter {
+  bool Append(const QuotaTableEntry& entry) {
+    entries.push_back(entry);
+    return true;
+  }
+  std::vector<QuotaTableEntry> entries;
+};
 
 QuotaDatabase::QuotaDatabase(const FilePath& path)
     : db_file_path_(path),
       is_recreating_(false),
       is_disabled_(false) {
 }
 
 QuotaDatabase::~QuotaDatabase() {
   if (db_.get()) {
     db_->CommitTransaction();
@@ skipping 29 matching lines @@
   return true;
 }
 
 bool QuotaDatabase::SetHostQuota(
     const std::string& host, StorageType type, int64 quota) {
   DCHECK_GE(quota, 0);
   if (!LazyOpen(true))
     return false;
 
   sql::Statement statement;
-
-  int64 dummy;
-  if (GetHostQuota(host, type, &dummy)) {
-    const char* kSql =
-        "UPDATE HostQuotaTable"
-        " SET quota = ?"
-        " WHERE host = ? AND type = ?";
-    if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
-      return false;
-  } else {
-    const char* kSql =
-        "INSERT INTO HostQuotaTable"
-        " (quota, host, type)"
-        " VALUES (?, ?, ?)";
-    if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
-      return false;
-  }
+  const char* kSql =
+      "INSERT OR REPLACE INTO HostQuotaTable"
+      " (quota, host, type)"
+      " VALUES (?, ?, ?)";
+  if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
+    return false;
 
   statement.BindInt64(0, quota);
   statement.BindString(1, host);
   statement.BindInt(2, static_cast<int>(type));
   if (!statement.Run())
     return false;
 
   ScheduleCommit();
   return true;
 }
 
 bool QuotaDatabase::SetOriginLastAccessTime(
     const GURL& origin, StorageType type, base::Time last_access_time) {
   if (!LazyOpen(true))
     return false;
 
   sql::Statement statement;
 
   int used_count = 1;
   if (FindOriginUsedCount(origin, type, &used_count)) {
     ++used_count;
     const char* kSql =
-        "UPDATE OriginLastAccessTable"
+        "UPDATE OriginInfoTable"
         " SET used_count = ?, last_access_time = ?"
         " WHERE origin = ? AND type = ?";
     if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
       return false;
   } else  {
     const char* kSql =
-        "INSERT INTO OriginLastAccessTable"
+        "INSERT INTO OriginInfoTable"
         " (used_count, last_access_time, origin, type)"
         " VALUES (?, ?, ?, ?)";
     if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
       return false;
   }
 
   statement.BindInt(0, used_count);
   statement.BindInt64(1, last_access_time.ToInternalValue());
   statement.BindString(2, origin.spec());
   statement.BindInt(3, static_cast<int>(type));
   if (!statement.Run())
     return false;
 
   ScheduleCommit();
   return true;
 }
 
-bool QuotaDatabase::RegisterOrigins(const std::set<GURL>& origins,
-                                    StorageType type,
-                                    base::Time last_access_time) {
+bool QuotaDatabase::SetOriginLastModifiedTime(
+    const GURL& origin, StorageType type, base::Time last_modified_time) {
   if (!LazyOpen(true))
     return false;
 
+  sql::Statement statement;
+
+  int dummy;
+  if (FindOriginUsedCount(origin, type, &dummy)) {
+    const char* kSql =
+        "UPDATE OriginInfoTable"
+        " SET last_modified_time = ?"
+        " WHERE origin = ? AND type = ?";
+    if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
+      return false;
+  } else {
+    const char* kSql =
+        "INSERT INTO OriginInfoTable"
+        " (last_modified_time, origin, type)  VALUES (?, ?, ?)";
+    if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
+      return false;
+  }
+
+  statement.BindInt64(0, last_modified_time.ToInternalValue());
+  statement.BindString(1, origin.spec());
+  statement.BindInt(2, static_cast<int>(type));
+  if (!statement.Run())
+    return false;
+
+  ScheduleCommit();
+  return true;
+}
+
+bool QuotaDatabase::RegisterInitialOriginInfo(
+    const std::set<GURL>& origins, StorageType type) {
+  if (!LazyOpen(true))
+    return false;
+
   typedef std::set<GURL>::const_iterator itr_type;
   for (itr_type itr = origins.begin(), end = origins.end();
        itr != end; ++itr) {
     const char* kSql =
-        "INSERT OR IGNORE INTO OriginLastAccessTable"
-        " (used_count, last_access_time, origin, type)"
-        " VALUES (?, ?, ?, ?)";
+        "INSERT OR IGNORE INTO OriginInfoTable"
+        " (origin, type) VALUES (?, ?)";
     sql::Statement statement;
     if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
       return false;
 
-    statement.BindInt(0, 0);  // used_count
-    statement.BindInt64(1, last_access_time.ToInternalValue());
-    statement.BindString(2, itr->spec());
-    statement.BindInt(3, static_cast<int>(type));
+    statement.BindString(0, itr->spec());
+    statement.BindInt(1, static_cast<int>(type));
     if (!statement.Run())
       return false;
   }
 
   ScheduleCommit();
   return true;
 }
 
 bool QuotaDatabase::DeleteHostQuota(
     const std::string& host, StorageType type) {
@@ skipping 10 matching lines @@
 
   statement.BindString(0, host);
   statement.BindInt(1, static_cast<int>(type));
   if (!statement.Run())
     return false;
 
   ScheduleCommit();
   return true;
 }
 
-bool QuotaDatabase::DeleteOriginLastAccessTime(
+bool QuotaDatabase::DeleteOriginInfo(
     const GURL& origin, StorageType type) {
   if (!LazyOpen(false))
     return false;
 
   const char* kSql =
-      "DELETE FROM OriginLastAccessTable"
+      "DELETE FROM OriginInfoTable"
       " WHERE origin = ? AND type = ?";
 
   sql::Statement statement;
   if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
     return false;
 
   statement.BindString(0, origin.spec());
   statement.BindInt(1, static_cast<int>(type));
   if (!statement.Run())
     return false;
@@ skipping 16 matching lines @@
 
 bool QuotaDatabase::GetLRUOrigin(
     StorageType type,
     const std::set<GURL>& exceptions,
     SpecialStoragePolicy* special_storage_policy,
     GURL* origin) {
   DCHECK(origin);
   if (!LazyOpen(false))
     return false;
 
-  const char* kSql = "SELECT origin FROM OriginLastAccessTable"
+  const char* kSql = "SELECT origin FROM OriginInfoTable"
                      " WHERE type = ?"
                      " ORDER BY last_access_time ASC";
 
   sql::Statement statement;
   if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
     return false;
   statement.BindInt(0, static_cast<int>(type));
 
   while (statement.Step()) {
     GURL url(statement.ColumnString(0));
     if (exceptions.find(url) != exceptions.end())
       continue;
     if (special_storage_policy &&
         special_storage_policy->IsStorageUnlimited(url))
       continue;
     *origin = url;
     return true;
   }
 
   *origin = GURL();
   return statement.Succeeded();
 }
 
+bool QuotaDatabase::GetOriginsModifiedSince(
+    StorageType type, std::set<GURL>* origins, base::Time modified_since) {
+  DCHECK(origins);
+  if (!LazyOpen(false))
+    return false;
+
+  const char* kSql = "SELECT origin FROM OriginInfoTable"
+                     " WHERE type = ? AND last_modified_time > ?";
+
+  sql::Statement statement;
+  if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
+    return false;
+  statement.BindInt(0, static_cast<int>(type));
+  statement.BindInt64(1, modified_since.ToInternalValue());
+
+  origins->clear();
+  while (statement.Step())
+    origins->insert(GURL(statement.ColumnString(0)));
+
+  return statement.Succeeded();
+}
+
 bool QuotaDatabase::IsOriginDatabaseBootstrapped() {
   if (!LazyOpen(true))
     return false;
 
   int flag = 0;
   return meta_table_->GetValue(kIsOriginTableBootstrapped, &flag) && flag;
 }
 
 bool QuotaDatabase::SetOriginDatabaseBootstrapped(bool bootstrap_flag) {
   if (!LazyOpen(true))
     return false;
 
   return meta_table_->SetValue(kIsOriginTableBootstrapped, bootstrap_flag);
 }
 
 void QuotaDatabase::Commit() {
   if (!db_.get())
     return;
 
-  // Note: for now this will be called only by ScheduleCommit, but when it
-  // becomes untrue we should call timer_.Stop() here.
-  DCHECK(!timer_.IsRunning());
+  if (timer_.IsRunning())
+    timer_.Stop();
 
   db_->CommitTransaction();
   db_->BeginTransaction();
 }
 
 void QuotaDatabase::ScheduleCommit() {
   if (timer_.IsRunning())
     return;
   timer_.Start(base::TimeDelta::FromMilliseconds(kCommitIntervalMs), this,
                &QuotaDatabase::Commit);
 }
 
 bool QuotaDatabase::FindOriginUsedCount(
     const GURL& origin, StorageType type, int* used_count) {
   DCHECK(used_count);
   if (!LazyOpen(false))
     return false;
 
   const char* kSql =
-      "SELECT used_count FROM OriginLastAccessTable"
+      "SELECT used_count FROM OriginInfoTable"
       " WHERE origin = ? AND type = ?";
 
   sql::Statement statement;
   if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
     return false;
 
   statement.BindString(0, origin.spec());
   statement.BindInt(1, static_cast<int>(type));
   if (!statement.Step() || !statement.Succeeded())
     return false;
@@ skipping 39 matching lines @@
     return false;
   }
 
   // Start a long-running transaction.
   db_->BeginTransaction();
 
   return true;
 }
 
 bool QuotaDatabase::EnsureDatabaseVersion() {
+  static const size_t kTableCount = ARRAYSIZE_UNSAFE(kTables);
+  static const size_t kIndexCount = ARRAYSIZE_UNSAFE(kIndexes);
   if (!sql::MetaTable::DoesTableExist(db_.get()))
-    return CreateSchema();
+    return CreateSchema(db_.get(), meta_table_.get(),
+                        kCurrentVersion, kCompatibleVersion,
+                        kTables, kTableCount,
+                        kIndexes, kIndexCount);
 
   if (!meta_table_->Init(db_.get(), kCurrentVersion, kCompatibleVersion))
     return false;
 
   if (meta_table_->GetCompatibleVersionNumber() > kCurrentVersion) {
     LOG(WARNING) << "Quota database is too new.";
     return false;
   }
 
   if (meta_table_->GetVersionNumber() < kCurrentVersion) {
-    // TODO(kinuko): Support schema upgrade.
-    return ResetSchema();
+    if (!UpgradeSchema(meta_table_->GetVersionNumber()))
+      return ResetSchema();
   }
 
 #ifndef NDEBUG
   DCHECK(sql::MetaTable::DoesTableExist(db_.get()));
-  for (int i = 0; i < kTableCount; ++i) {
+  for (size_t i = 0; i < kTableCount; ++i) {
     DCHECK(db_->DoesTableExist(kTables[i].table_name));
   }
 #endif
 
   return true;
 }
 
-bool QuotaDatabase::CreateSchema() {
+// static
+bool QuotaDatabase::CreateSchema(
+    sql::Connection* database,
+    sql::MetaTable* meta_table,
+    int schema_version, int compatible_version,
+    const TableSchema* tables, size_t tables_size,
+    const IndexSchema* indexes, size_t indexes_size) {
   // TODO(kinuko): Factor out the common code to create databases.
-  sql::Transaction transaction(db_.get());
+  sql::Transaction transaction(database);
   if (!transaction.Begin())
     return false;
 
-  if (!meta_table_->Init(db_.get(), kCurrentVersion, kCompatibleVersion))
+  if (!meta_table->Init(database, schema_version, compatible_version))
     return false;
 
-  for (int i = 0; i < kTableCount; ++i) {
+  for (size_t i = 0; i < tables_size; ++i) {
     std::string sql("CREATE TABLE ");
-    sql += kTables[i].table_name;
-    sql += kTables[i].columns;
-    if (!db_->Execute(sql.c_str())) {
+    sql += tables[i].table_name;
+    sql += tables[i].columns;
+    if (!database->Execute(sql.c_str())) {
       VLOG(1) << "Failed to execute " << sql;
       return false;
     }
   }
 
-  for (int i = 0; i < kIndexCount; ++i) {
+  for (size_t i = 0; i < indexes_size; ++i) {
     std::string sql;
-    if (kIndexes[i].unique)
+    if (indexes[i].unique)
       sql += "CREATE UNIQUE INDEX ";
     else
       sql += "CREATE INDEX ";
-    sql += kIndexes[i].index_name;
+    sql += indexes[i].index_name;
     sql += " ON ";
-    sql += kIndexes[i].table_name;
-    sql += kIndexes[i].columns;
-    if (!db_->Execute(sql.c_str())) {
+    sql += indexes[i].table_name;
+    sql += indexes[i].columns;
+    if (!database->Execute(sql.c_str())) {
       VLOG(1) << "Failed to execute " << sql;
       return false;
     }
   }
 
   return transaction.Commit();
 }
 
 bool QuotaDatabase::ResetSchema() {
   DCHECK(!db_file_path_.empty());
@@ skipping 11 matching lines @@
     return false;
 
   // So we can't go recursive.
   if (is_recreating_)
     return false;
 
   AutoReset<bool> auto_reset(&is_recreating_, true);
   return LazyOpen(true);
 }
 
+bool QuotaDatabase::UpgradeSchema(int current_version) {
+  if (current_version == 2) {
+    QuotaTableImporter importer;
+    typedef std::vector<QuotaTableEntry> QuotaTableEntries;
+    if (!DumpQuotaTable(new QuotaTableCallback(base::Bind(
+        &QuotaTableImporter::Append, base::Unretained(&importer)))))
+      return false;
+    ResetSchema();
+    for (QuotaTableEntries::const_iterator iter = importer.entries.begin();
+         iter != importer.entries.end(); ++iter) {
+      if (!SetHostQuota(iter->host, iter->type, iter->quota))
+        return false;
+    }
+    Commit();
+    return true;
+  }
+  return false;
+}
+
 bool QuotaDatabase::DumpQuotaTable(QuotaTableCallback* callback) {
   scoped_ptr<QuotaTableCallback> callback_deleter(callback);
   if (!LazyOpen(true))
     return false;
 
   const char* kSql = "SELECT * FROM HostQuotaTable";
   sql::Statement statement;
   if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
     return false;
 
   while (statement.Step()) {
     QuotaTableEntry entry = {
       statement.ColumnString(0),
       static_cast<StorageType>(statement.ColumnInt(1)),
       statement.ColumnInt64(2)
     };
 
     if (!callback->Run(entry))
       return true;
   }
 
   return statement.Succeeded();
 }
 
-bool QuotaDatabase::DumpLastAccessTimeTable(
-    LastAccessTimeTableCallback* callback) {
-  scoped_ptr<LastAccessTimeTableCallback> callback_deleter(callback);
+bool QuotaDatabase::DumpOriginInfoTable(
+    OriginInfoTableCallback* callback) {
+  scoped_ptr<OriginInfoTableCallback> callback_deleter(callback);
 
   if (!LazyOpen(true))
     return false;
 
-  const char* kSql = "SELECT * FROM OriginLastAccessTable";
+  const char* kSql = "SELECT * FROM OriginInfoTable";
   sql::Statement statement;
   if (!PrepareCachedStatement(db_.get(), SQL_FROM_HERE, kSql, &statement))
     return false;
 
   while (statement.Step()) {
-    LastAccessTimeTableEntry entry = {
+    OriginInfoTableEntry entry = {
       GURL(statement.ColumnString(0)),
       static_cast<StorageType>(statement.ColumnInt(1)),
       statement.ColumnInt(2),
-      base::Time::FromInternalValue(statement.ColumnInt64(3))
+      base::Time::FromInternalValue(statement.ColumnInt64(3)),
+      base::Time::FromInternalValue(statement.ColumnInt64(4))
     };
 
     if (!callback->Run(entry))
       return true;
   }
 
   return statement.Succeeded();
 }
 
 bool operator<(const QuotaDatabase::QuotaTableEntry& lhs,
                const QuotaDatabase::QuotaTableEntry& rhs) {
   if (lhs.host < rhs.host) return true;
   if (rhs.host < lhs.host) return false;
   if (lhs.type < rhs.type) return true;
   if (rhs.type < lhs.type) return false;
   return lhs.quota < rhs.quota;
 }
 
-bool operator<(const QuotaDatabase::LastAccessTimeTableEntry& lhs,
-               const QuotaDatabase::LastAccessTimeTableEntry& rhs) {
+bool operator<(const QuotaDatabase::OriginInfoTableEntry& lhs,
+               const QuotaDatabase::OriginInfoTableEntry& rhs) {
   if (lhs.origin < rhs.origin) return true;
   if (rhs.origin < lhs.origin) return false;
   if (lhs.type < rhs.type) return true;
   if (rhs.type < lhs.type) return false;
   if (lhs.used_count < rhs.used_count) return true;
   if (rhs.used_count < lhs.used_count) return false;
   return lhs.last_access_time < rhs.last_access_time;
 }
+
 }  // quota namespace