content / browser / browsing_topics / browsing_topics_site_data_storage.cc [blame]

// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "content/browser/browsing_topics/browsing_topics_site_data_storage.h"

#include "base/files/file_util.h"
#include "base/metrics/histogram_functions.h"
#include "sql/database.h"
#include "sql/recovery.h"
#include "sql/statement.h"
#include "sql/transaction.h"
#include "third_party/blink/public/common/features.h"

namespace content {

namespace {

// Version number of the database.
const int kCurrentVersionNumber = 1;

void RecordInitializationStatus(bool successful) {
  base::UmaHistogramBoolean("BrowsingTopics.SiteDataStorage.InitStatus",
                            successful);
}

}  // namespace

BrowsingTopicsSiteDataStorage::BrowsingTopicsSiteDataStorage(
    const base::FilePath& path_to_database)
    : path_to_database_(path_to_database) {
  DETACH_FROM_SEQUENCE(sequence_checker_);
}

BrowsingTopicsSiteDataStorage::~BrowsingTopicsSiteDataStorage() {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
}

void BrowsingTopicsSiteDataStorage::ExpireDataBefore(base::Time end_time) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);

  if (!LazyInit()) {
    return;
  }

  sql::Transaction transaction(db_.get());
  if (!transaction.Begin()) {
    return;
  }

  static constexpr char kDeleteApiUsageSql[] =
      // clang-format off
      "DELETE FROM browsing_topics_api_usages "
          "WHERE last_usage_time < ?";
  // clang-format on

  sql::Statement delete_api_usage_statement(
      db_->GetCachedStatement(SQL_FROM_HERE, kDeleteApiUsageSql));
  delete_api_usage_statement.BindTime(0, end_time);
  delete_api_usage_statement.Run();

  static constexpr char kDeleteUnusedDomainsSql[] =
      // clang-format off
      "DELETE FROM browsing_topics_api_hashed_to_unhashed_domain "
          "WHERE hashed_context_domain NOT IN ("
              "SELECT DISTINCT hashed_context_domain "
              "FROM browsing_topics_api_usages "
          ")";
  // clang-format on
  sql::Statement delete_unused_domains_sql(
      db_->GetCachedStatement(SQL_FROM_HERE, kDeleteUnusedDomainsSql));
  delete_unused_domains_sql.Run();

  transaction.Commit();
}

void BrowsingTopicsSiteDataStorage::ClearContextDomain(
    const browsing_topics::HashedDomain& hashed_context_domain) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);

  if (!LazyInit())
    return;

  sql::Transaction transaction(db_.get());
  if (!transaction.Begin()) {
    return;
  }

  static constexpr char kDeleteContextDomainSql[] =
      // clang-format off
      "DELETE FROM browsing_topics_api_usages "
          "WHERE hashed_context_domain = ?";
  // clang-format on

  sql::Statement delete_context_domain_statement(
      db_->GetCachedStatement(SQL_FROM_HERE, kDeleteContextDomainSql));
  delete_context_domain_statement.BindInt64(0, hashed_context_domain.value());

  delete_context_domain_statement.Run();

  static constexpr char kDeleteUnhashedContextDomainSQL[] =
      // clang-format off
      "DELETE FROM browsing_topics_api_hashed_to_unhashed_domain "
          "WHERE hashed_context_domain = ?";
  // clang-format on
  sql::Statement delete_unhashed_context_domain_statement(
      db_->GetCachedStatement(SQL_FROM_HERE, kDeleteUnhashedContextDomainSQL));
  delete_unhashed_context_domain_statement.BindInt64(
      0, hashed_context_domain.value());

  delete_unhashed_context_domain_statement.Run();

  transaction.Commit();
}

browsing_topics::ApiUsageContextQueryResult
BrowsingTopicsSiteDataStorage::GetBrowsingTopicsApiUsage(base::Time begin_time,
                                                         base::Time end_time) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);

  if (!LazyInit())
    return {};

  static constexpr char kGetApiUsageSql[] =
      // clang-format off
      "SELECT hashed_context_domain,hashed_main_frame_host,last_usage_time "
          "FROM browsing_topics_api_usages "
          "WHERE last_usage_time>=? AND last_usage_time<? "
          "ORDER BY last_usage_time DESC "
          "LIMIT ?";
  // clang-format on

  sql::Statement statement(
      db_->GetCachedStatement(SQL_FROM_HERE, kGetApiUsageSql));

  statement.BindTime(0, begin_time);
  statement.BindTime(1, end_time);
  statement.BindInt(
      2,
      blink::features::
          kBrowsingTopicsMaxNumberOfApiUsageContextEntriesToLoadPerEpoch.Get());

  std::vector<browsing_topics::ApiUsageContext> contexts;
  while (statement.Step()) {
    browsing_topics::ApiUsageContext usage_context;
    usage_context.hashed_context_domain =
        browsing_topics::HashedDomain(statement.ColumnInt64(0));
    usage_context.hashed_main_frame_host =
        browsing_topics::HashedHost(statement.ColumnInt64(1));
    usage_context.time = statement.ColumnTime(2);

    contexts.push_back(std::move(usage_context));
  }

  if (!statement.Succeeded())
    return {};

  return browsing_topics::ApiUsageContextQueryResult(std::move(contexts));
}

void BrowsingTopicsSiteDataStorage::OnBrowsingTopicsApiUsed(
    const browsing_topics::HashedHost& hashed_main_frame_host,
    const browsing_topics::HashedDomain& hashed_context_domain,
    const std::string& context_domain,
    base::Time time) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);

  if (!LazyInit())
    return;

  sql::Transaction transaction(db_.get());
  if (!transaction.Begin())
    return;

  static constexpr char kInsertApiUsageSql[] =
      // clang-format off
      "INSERT OR REPLACE INTO browsing_topics_api_usages "
          "(hashed_context_domain,hashed_main_frame_host,last_usage_time) "
          "VALUES (?,?,?)";
  // clang-format on

  sql::Statement insert_api_usage_statement(
      db_->GetCachedStatement(SQL_FROM_HERE, kInsertApiUsageSql));
  insert_api_usage_statement.BindInt64(0, hashed_context_domain.value());
  insert_api_usage_statement.BindInt64(1, hashed_main_frame_host.value());
  insert_api_usage_statement.BindTime(2, time);

  if (!insert_api_usage_statement.Run()) {
    return;
  }

  static constexpr char kInsertUnhashedDomainSql[] =
      // clang-format off
      "INSERT OR REPLACE INTO browsing_topics_api_hashed_to_unhashed_domain "
          "(hashed_context_domain,context_domain) "
          "VALUES (?,?)";
  // clang-format on
  sql::Statement insert_unhashed_domain_statement(
      db_->GetCachedStatement(SQL_FROM_HERE, kInsertUnhashedDomainSql));
  insert_unhashed_domain_statement.BindInt64(0, hashed_context_domain.value());
  insert_unhashed_domain_statement.BindString(1, context_domain);

  if (!insert_unhashed_domain_statement.Run()) {
    return;
  }

  transaction.Commit();
}

std::map<browsing_topics::HashedDomain, std::string>
BrowsingTopicsSiteDataStorage::GetContextDomainsFromHashedContextDomains(
    const std::set<browsing_topics::HashedDomain>& hashed_context_domains) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);

  std::map<browsing_topics::HashedDomain, std::string> context_domains;
  static constexpr char kGetContextDomainSql[] =
      // clang-format off
      "SELECT context_domain "
          "FROM browsing_topics_api_hashed_to_unhashed_domain "
          "WHERE hashed_context_domain = ?";
  // clang-format on
  for (const browsing_topics::HashedDomain& hashed_domain :
       hashed_context_domains) {
    sql::Statement select_unhashed_domain_statement(
        db_->GetCachedStatement(SQL_FROM_HERE, kGetContextDomainSql));
    select_unhashed_domain_statement.BindInt64(0, hashed_domain.value());
    if (select_unhashed_domain_statement.Step()) {
      context_domains[hashed_domain] =
          select_unhashed_domain_statement.ColumnString(0);
    }
  }
  return context_domains;
}

bool BrowsingTopicsSiteDataStorage::LazyInit() {
  if (db_init_status_ != InitStatus::kUnattempted)
    return db_init_status_ == InitStatus::kSuccess;

  db_ = std::make_unique<sql::Database>(
      sql::DatabaseOptions{.page_size = 4096, .cache_size = 32});
  db_->set_histogram_tag("BrowsingTopics");

  // base::Unretained is safe here because this BrowsingTopicsSiteDataStorage
  // owns the sql::Database instance that stores and uses the callback. So,
  // `this` is guaranteed to outlive the callback.
  db_->set_error_callback(
      base::BindRepeating(&BrowsingTopicsSiteDataStorage::DatabaseErrorCallback,
                          base::Unretained(this)));

  if (!db_->Open(path_to_database_)) {
    HandleInitializationFailure();
    return false;
  }

  if (!InitializeTables()) {
    HandleInitializationFailure();
    return false;
  }

  std::optional<int64_t> file_size = base::GetFileSize(path_to_database_);
  if (file_size.has_value()) {
    int64_t file_size_kb = file_size.value() / 1024;
    base::UmaHistogramCounts1M("BrowsingTopics.SiteDataStorage.FileSize.KB",
                               file_size_kb);
  }

  db_init_status_ = InitStatus::kSuccess;
  RecordInitializationStatus(true);
  return true;
}

bool BrowsingTopicsSiteDataStorage::InitializeTables() {
  sql::Transaction transaction(db_.get());
  if (!transaction.Begin())
    return false;

  if (!meta_table_.Init(db_.get(), kCurrentVersionNumber,
                        kCurrentVersionNumber)) {
    return false;
  }

  if (!CreateSchema())
    return false;

  // This is the first code version. No database version is expected to be
  // smaller. Fail when this happens.
  if (meta_table_.GetVersionNumber() < kCurrentVersionNumber)
    return false;

  if (!transaction.Commit())
    return false;

  // This is possible with code reverts. The DB will never work until Chrome
  // is re-upgraded. Assume the user will continue using this Chrome version
  // and raze the DB to get the feature working.
  if (meta_table_.GetVersionNumber() > kCurrentVersionNumber) {
    db_->Raze();
    meta_table_.Reset();
    return InitializeTables();
  }

  return true;
}

bool BrowsingTopicsSiteDataStorage::CreateSchema() {
  static constexpr char kBrowsingTopicsApiUsagesTableSql[] =
      // clang-format off
      "CREATE TABLE IF NOT EXISTS browsing_topics_api_usages("
          "hashed_context_domain INTEGER NOT NULL,"
          "hashed_main_frame_host INTEGER NOT NULL,"
          "last_usage_time INTEGER NOT NULL,"
          "PRIMARY KEY (hashed_context_domain,hashed_main_frame_host))";
  // clang-format on
  if (!db_->Execute(kBrowsingTopicsApiUsagesTableSql))
    return false;

  static constexpr char kLastUsageTimeIndexSql[] =
      // clang-format off
      "CREATE INDEX IF NOT EXISTS last_usage_time_idx "
          "ON browsing_topics_api_usages(last_usage_time)";
  // clang-format on
  if (!db_->Execute(kLastUsageTimeIndexSql))
    return false;

  static constexpr char kHashedToUnhashedDomainSql[] =
      // clang-format off
      "CREATE TABLE IF NOT EXISTS "
          "browsing_topics_api_hashed_to_unhashed_domain("
          "hashed_context_domain INTEGER PRIMARY KEY,"
          "context_domain TEXT NOT NULL)";
  // clang-format on
  if (!db_->Execute(kHashedToUnhashedDomainSql)) {
    return false;
  }

  return true;
}

void BrowsingTopicsSiteDataStorage::HandleInitializationFailure() {
  db_.reset();
  db_init_status_ = InitStatus::kFailure;
  RecordInitializationStatus(false);
}

void BrowsingTopicsSiteDataStorage::DatabaseErrorCallback(
    int extended_error,
    sql::Statement* stmt) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  // Attempt to recover a corrupt database, if it is eligible to be recovered.
  if (sql::Recovery::RecoverIfPossible(
          db_.get(), extended_error,
          sql::Recovery::Strategy::kRecoverWithMetaVersionOrRaze)) {
    // Recovery was attempted. The database handle has been poisoned and the
    // error callback has been reset.

    // Signal the test-expectation framework that the error was handled.
    std::ignore = sql::Database::IsExpectedSqliteError(extended_error);
    return;
  }

  // The default handling is to assert on debug and to ignore on release.
  if (!sql::Database::IsExpectedSqliteError(extended_error))
    DLOG(FATAL) << db_->GetErrorMessage();

  // Consider the database closed if we did not attempt to recover so we did not
  // produce further errors.
  db_init_status_ = InitStatus::kFailure;
}

}  // namespace content