keyword_web_data_service.cc 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "components/search_engines/keyword_web_data_service.h"
  5. #include "base/bind.h"
  6. #include "base/location.h"
  7. #include "base/task/single_thread_task_runner.h"
  8. #include "build/build_config.h"
  9. #include "components/search_engines/keyword_table.h"
  10. #include "components/search_engines/template_url_data.h"
  11. #include "components/webdata/common/web_data_results.h"
  12. #include "components/webdata/common/web_database_service.h"
  13. namespace {
  14. WebDatabase::State PerformKeywordOperationsImpl(
  15. const KeywordTable::Operations& operations,
  16. WebDatabase* db) {
  17. return KeywordTable::FromWebDatabase(db)->PerformOperations(operations)
  18. ? WebDatabase::COMMIT_NEEDED
  19. : WebDatabase::COMMIT_NOT_NEEDED;
  20. }
  21. std::unique_ptr<WDTypedResult> GetKeywordsImpl(WebDatabase* db) {
  22. KeywordTable* const keyword_table = KeywordTable::FromWebDatabase(db);
  23. WDKeywordsResult result;
  24. if (!keyword_table->GetKeywords(&result.keywords))
  25. return nullptr;
  26. result.default_search_provider_id =
  27. keyword_table->GetDefaultSearchProviderID();
  28. result.builtin_keyword_version = keyword_table->GetBuiltinKeywordVersion();
  29. result.starter_pack_version = keyword_table->GetStarterPackKeywordVersion();
  30. return std::make_unique<WDResult<WDKeywordsResult>>(KEYWORDS_RESULT, result);
  31. }
  32. WebDatabase::State SetDefaultSearchProviderIDImpl(TemplateURLID id,
  33. WebDatabase* db) {
  34. return KeywordTable::FromWebDatabase(db)->SetDefaultSearchProviderID(id)
  35. ? WebDatabase::COMMIT_NEEDED
  36. : WebDatabase::COMMIT_NOT_NEEDED;
  37. }
  38. WebDatabase::State SetBuiltinKeywordVersionImpl(int version, WebDatabase* db) {
  39. return KeywordTable::FromWebDatabase(db)->SetBuiltinKeywordVersion(version)
  40. ? WebDatabase::COMMIT_NEEDED
  41. : WebDatabase::COMMIT_NOT_NEEDED;
  42. }
  43. WebDatabase::State SetStarterPackKeywordVersionImpl(int version,
  44. WebDatabase* db) {
  45. return KeywordTable::FromWebDatabase(db)->SetStarterPackKeywordVersion(
  46. version)
  47. ? WebDatabase::COMMIT_NEEDED
  48. : WebDatabase::COMMIT_NOT_NEEDED;
  49. }
  50. } // namespace
  51. WDKeywordsResult::WDKeywordsResult() = default;
  52. WDKeywordsResult::WDKeywordsResult(const WDKeywordsResult&) = default;
  53. WDKeywordsResult& WDKeywordsResult::operator=(const WDKeywordsResult&) =
  54. default;
  55. WDKeywordsResult::~WDKeywordsResult() = default;
  56. KeywordWebDataService::BatchModeScoper::BatchModeScoper(
  57. KeywordWebDataService* service)
  58. : service_(service) {
  59. if (service_)
  60. service_->AdjustBatchModeLevel(true);
  61. }
  62. KeywordWebDataService::BatchModeScoper::~BatchModeScoper() {
  63. if (service_)
  64. service_->AdjustBatchModeLevel(false);
  65. }
  66. KeywordWebDataService::KeywordWebDataService(
  67. scoped_refptr<WebDatabaseService> wdbs,
  68. scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner)
  69. : WebDataServiceBase(std::move(wdbs), std::move(ui_task_runner)),
  70. timer_(FROM_HERE,
  71. base::Seconds(5),
  72. base::BindRepeating(&KeywordWebDataService::CommitQueuedOperations,
  73. base::Unretained(this))) {}
  74. void KeywordWebDataService::AddKeyword(const TemplateURLData& data) {
  75. if (batch_mode_level_) {
  76. queued_keyword_operations_.push_back(
  77. KeywordTable::Operation(KeywordTable::ADD, data));
  78. } else {
  79. AdjustBatchModeLevel(true);
  80. AddKeyword(data);
  81. AdjustBatchModeLevel(false);
  82. }
  83. }
  84. void KeywordWebDataService::RemoveKeyword(TemplateURLID id) {
  85. if (batch_mode_level_) {
  86. TemplateURLData data;
  87. data.id = id;
  88. queued_keyword_operations_.push_back(
  89. KeywordTable::Operation(KeywordTable::REMOVE, data));
  90. } else {
  91. AdjustBatchModeLevel(true);
  92. RemoveKeyword(id);
  93. AdjustBatchModeLevel(false);
  94. }
  95. }
  96. void KeywordWebDataService::UpdateKeyword(const TemplateURLData& data) {
  97. if (batch_mode_level_) {
  98. queued_keyword_operations_.push_back(
  99. KeywordTable::Operation(KeywordTable::UPDATE, data));
  100. } else {
  101. AdjustBatchModeLevel(true);
  102. UpdateKeyword(data);
  103. AdjustBatchModeLevel(false);
  104. }
  105. }
  106. WebDataServiceBase::Handle KeywordWebDataService::GetKeywords(
  107. WebDataServiceConsumer* consumer) {
  108. // Force pending changes to be visible immediately so the results of this call
  109. // won't be out of date.
  110. CommitQueuedOperations();
  111. return wdbs_->ScheduleDBTaskWithResult(
  112. FROM_HERE, base::BindOnce(&GetKeywordsImpl), consumer);
  113. }
  114. void KeywordWebDataService::SetDefaultSearchProviderID(TemplateURLID id) {
  115. wdbs_->ScheduleDBTask(FROM_HERE,
  116. base::BindOnce(&SetDefaultSearchProviderIDImpl, id));
  117. }
  118. void KeywordWebDataService::SetBuiltinKeywordVersion(int version) {
  119. wdbs_->ScheduleDBTask(FROM_HERE,
  120. base::BindOnce(&SetBuiltinKeywordVersionImpl, version));
  121. }
  122. void KeywordWebDataService::SetStarterPackKeywordVersion(int version) {
  123. wdbs_->ScheduleDBTask(
  124. FROM_HERE, base::BindOnce(&SetStarterPackKeywordVersionImpl, version));
  125. }
  126. void KeywordWebDataService::ShutdownOnUISequence() {
  127. CommitQueuedOperations();
  128. WebDataServiceBase::ShutdownOnUISequence();
  129. }
  130. KeywordWebDataService::~KeywordWebDataService() {
  131. DCHECK(!batch_mode_level_);
  132. DCHECK(queued_keyword_operations_.empty());
  133. }
  134. void KeywordWebDataService::AdjustBatchModeLevel(bool entering_batch_mode) {
  135. if (entering_batch_mode) {
  136. ++batch_mode_level_;
  137. } else {
  138. DCHECK(batch_mode_level_);
  139. --batch_mode_level_;
  140. if (!batch_mode_level_ && !queued_keyword_operations_.empty() &&
  141. !timer_.IsRunning()) {
  142. // When killing an app on Android/iOS, shutdown isn't guaranteed to be
  143. // called. Finishing this task immediately ensures the table is fully
  144. // populated even if the app is killed before the timer expires.
  145. #if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
  146. CommitQueuedOperations();
  147. #else
  148. timer_.Reset();
  149. #endif
  150. }
  151. }
  152. }
  153. void KeywordWebDataService::CommitQueuedOperations() {
  154. if (!queued_keyword_operations_.empty()) {
  155. wdbs_->ScheduleDBTask(FROM_HERE,
  156. base::BindOnce(&PerformKeywordOperationsImpl,
  157. queued_keyword_operations_));
  158. queued_keyword_operations_.clear();
  159. }
  160. timer_.Stop();
  161. }