components/search_engines/keyword_web_data_service.cc

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

#include "components/search_engines/keyword_web_data_service.h"

#include "base/functional/bind.h"
#include "base/location.h"
#include "base/task/sequenced_task_runner.h"
#include "build/build_config.h"
#include "components/regional_capabilities/regional_capabilities_country_id.h"
#include "components/search_engines/keyword_table.h"
#include "components/search_engines/template_url_data.h"
#include "components/webdata/common/web_data_results.h"
#include "components/webdata/common/web_database.h"
#include "components/webdata/common/web_database_service.h"

using ::country_codes::CountryId;

namespace {

WebDatabase::State PerformKeywordOperationsImpl(
    const KeywordTable::Operations& operations,
    WebDatabase* db) {
  return KeywordTable::FromWebDatabase(db)->PerformOperations(operations)
             ? WebDatabase::COMMIT_NEEDED
             : WebDatabase::COMMIT_NOT_NEEDED;
}

std::unique_ptr<WDTypedResult> GetKeywordsImpl(WebDatabase* db) {
  KeywordTable* const keyword_table = KeywordTable::FromWebDatabase(db);
  WDKeywordsResult result;
  if (!keyword_table || !keyword_table->GetKeywords(&result.keywords)) {
    return nullptr;
  }

  WDKeywordsResult::Metadata metadata;
  metadata.builtin_keyword_data_version =
      keyword_table->GetBuiltinKeywordDataVersion();
  metadata.builtin_keyword_country = regional_capabilities::CountryIdHolder(
      keyword_table->GetBuiltinKeywordCountry());
  metadata.starter_pack_version = keyword_table->GetStarterPackKeywordVersion();

  result.metadata = metadata;
  return std::make_unique<WDResult<WDKeywordsResult>>(KEYWORDS_RESULT, result);
}

WebDatabase::State SetBuiltinKeywordDataVersionImpl(int version,
                                                    WebDatabase* db) {
  return KeywordTable::FromWebDatabase(db)->SetBuiltinKeywordDataVersion(
             version)
             ? WebDatabase::COMMIT_NEEDED
             : WebDatabase::COMMIT_NOT_NEEDED;
}

WebDatabase::State ClearBuiltinKeywordMilestoneImpl(WebDatabase* db) {
  return KeywordTable::FromWebDatabase(db)->ClearBuiltinKeywordMilestone()
             ? WebDatabase::COMMIT_NEEDED
             : WebDatabase::COMMIT_NOT_NEEDED;
}

WebDatabase::State SetBuiltinKeywordCountryImpl(CountryId country_id,
                                                WebDatabase* db) {
  return KeywordTable::FromWebDatabase(db)->SetBuiltinKeywordCountry(country_id)
             ? WebDatabase::COMMIT_NEEDED
             : WebDatabase::COMMIT_NOT_NEEDED;
}

WebDatabase::State SetStarterPackKeywordVersionImpl(int version,
                                                    WebDatabase* db) {
  return KeywordTable::FromWebDatabase(db)->SetStarterPackKeywordVersion(
             version)
             ? WebDatabase::COMMIT_NEEDED
             : WebDatabase::COMMIT_NOT_NEEDED;
}

}  // namespace

WDKeywordsResult::Metadata::Metadata() = default;

WDKeywordsResult::Metadata::Metadata(const WDKeywordsResult::Metadata&) =
    default;

WDKeywordsResult::Metadata& WDKeywordsResult::Metadata::operator=(
    const WDKeywordsResult::Metadata&) = default;

WDKeywordsResult::Metadata::~Metadata() = default;

WDKeywordsResult::WDKeywordsResult() = default;

WDKeywordsResult::WDKeywordsResult(const WDKeywordsResult&) = default;

WDKeywordsResult& WDKeywordsResult::operator=(const WDKeywordsResult&) =
    default;

WDKeywordsResult::~WDKeywordsResult() = default;

KeywordWebDataService::BatchModeScoper::BatchModeScoper(
    KeywordWebDataService* service)
    : service_(service) {
  if (service_)
    service_->AdjustBatchModeLevel(true);
}

KeywordWebDataService::BatchModeScoper::~BatchModeScoper() {
  if (service_)
    service_->AdjustBatchModeLevel(false);
}

KeywordWebDataService::KeywordWebDataService(
    scoped_refptr<WebDatabaseService> wdbs,
    scoped_refptr<base::SequencedTaskRunner> ui_task_runner)
    : WebDataServiceBase(std::move(wdbs), std::move(ui_task_runner)),
      timer_(FROM_HERE,
             base::Seconds(5),
             base::BindRepeating(&KeywordWebDataService::CommitQueuedOperations,
                                 base::Unretained(this))) {}

void KeywordWebDataService::AddKeyword(const TemplateURLData& data) {
  if (batch_mode_level_) {
    queued_keyword_operations_.push_back(
        KeywordTable::Operation(KeywordTable::ADD, data));
  } else {
    AdjustBatchModeLevel(true);
    AddKeyword(data);
    AdjustBatchModeLevel(false);
  }
}

void KeywordWebDataService::RemoveKeyword(TemplateURLID id) {
  if (batch_mode_level_) {
    TemplateURLData data;
    data.id = id;
    queued_keyword_operations_.push_back(
        KeywordTable::Operation(KeywordTable::REMOVE, data));
  } else {
    AdjustBatchModeLevel(true);
    RemoveKeyword(id);
    AdjustBatchModeLevel(false);
  }
}

void KeywordWebDataService::UpdateKeyword(const TemplateURLData& data) {
  if (batch_mode_level_) {
    queued_keyword_operations_.push_back(
        KeywordTable::Operation(KeywordTable::UPDATE, data));
  } else {
    AdjustBatchModeLevel(true);
    UpdateKeyword(data);
    AdjustBatchModeLevel(false);
  }
}

WebDataServiceBase::Handle KeywordWebDataService::GetKeywords(
    WebDataServiceConsumer* consumer) {
  // Force pending changes to be visible immediately so the results of this call
  // won't be out of date.
  CommitQueuedOperations();

  return wdbs_->ScheduleDBTaskWithResult(
      FROM_HERE, base::BindOnce(&GetKeywordsImpl), consumer);
}

void KeywordWebDataService::SetBuiltinKeywordDataVersion(int version) {
  wdbs_->ScheduleDBTask(
      FROM_HERE, base::BindOnce(&SetBuiltinKeywordDataVersionImpl, version));
}

void KeywordWebDataService::ClearBuiltinKeywordMilestone() {
  wdbs_->ScheduleDBTask(FROM_HERE,
                        base::BindOnce(&ClearBuiltinKeywordMilestoneImpl));
}

void KeywordWebDataService::SetBuiltinKeywordCountry(CountryId version) {
  wdbs_->ScheduleDBTask(FROM_HERE,
                        base::BindOnce(&SetBuiltinKeywordCountryImpl, version));
}

void KeywordWebDataService::SetStarterPackKeywordVersion(int version) {
  wdbs_->ScheduleDBTask(
      FROM_HERE, base::BindOnce(&SetStarterPackKeywordVersionImpl, version));
}

void KeywordWebDataService::ShutdownOnUISequence() {
  CommitQueuedOperations();
  WebDataServiceBase::ShutdownOnUISequence();
}

KeywordWebDataService::~KeywordWebDataService() {
  DCHECK(!batch_mode_level_);
  DCHECK(queued_keyword_operations_.empty());
}

void KeywordWebDataService::AdjustBatchModeLevel(bool entering_batch_mode) {
  if (entering_batch_mode) {
    ++batch_mode_level_;
  } else {
    DCHECK(batch_mode_level_);
    --batch_mode_level_;
    if (!batch_mode_level_ && !queued_keyword_operations_.empty() &&
        !timer_.IsRunning()) {
      // When killing an app on Android/iOS, shutdown isn't guaranteed to be
      // called. Finishing this task immediately ensures the table is fully
      // populated even if the app is killed before the timer expires.
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
      CommitQueuedOperations();
#else
      timer_.Reset();
#endif
    }
  }
}

void KeywordWebDataService::CommitQueuedOperations() {
  if (!queued_keyword_operations_.empty()) {
    wdbs_->ScheduleDBTask(FROM_HERE,
                          base::BindOnce(&PerformKeywordOperationsImpl,
                                         queued_keyword_operations_));
    queued_keyword_operations_.clear();
  }
  timer_.Stop();
}