1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
|
// 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();
}
|