blob: 2b4a16cfdbeb741a0e4a912c2067665b7d68dcfc [file] [log] [blame]
// Copyright 2014 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 <stddef.h>
#include <stdint.h>
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/timer/timer.h"
#include "components/search_engines/keyword_table.h"
#include "components/search_engines/template_url_id.h"
#include "components/webdata/common/web_data_service_base.h"
#include "components/webdata/common/web_database.h"
namespace base {
class SingleThreadTaskRunner;
class WebDatabaseService;
struct TemplateURLData;
struct WDKeywordsResult {
WDKeywordsResult(const WDKeywordsResult&);
WDKeywordsResult& operator=(const WDKeywordsResult&);
KeywordTable::Keywords keywords;
// Identifies the ID of the TemplateURL that is the default search. A value of
// 0 indicates there is no default search provider.
int64_t default_search_provider_id = 0;
// Version of the built-in keywords. A value of 0 indicates a first run.
int builtin_keyword_version = 0;
class WebDataServiceConsumer;
class KeywordWebDataService : public WebDataServiceBase {
// Instantiate this to turn on batch mode on the provided |service|
// until the scoper is destroyed. When batch mode is on, calls to any of the
// three keyword table modification functions below will result in locally
// queueing the operation; on setting this back to false, after a short delay,
// all the modifications will be performed at once. This is a performance
// optimization; see comments on KeywordTable::PerformOperations().
// If multiple scopers are in-scope simultaneously, batch mode will only be
// exited when all are destroyed. If |service| is NULL, the object will do
// nothing.
class BatchModeScoper {
explicit BatchModeScoper(KeywordWebDataService* service);
KeywordWebDataService* service_;
scoped_refptr<WebDatabaseService> wdbs,
scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
const ProfileErrorCallback& callback);
// As the database processes requests at a later date, all deletion is done on
// the background sequence.
// Many of the keyword related methods do not return a handle. This is because
// the caller (TemplateURLService) does not need to know when the request is
// done.
void AddKeyword(const TemplateURLData& data);
void RemoveKeyword(TemplateURLID id);
void UpdateKeyword(const TemplateURLData& data);
// Fetches the keywords.
// On success, consumer is notified with WDResult<KeywordTable::Keywords>.
Handle GetKeywords(WebDataServiceConsumer* consumer);
// Sets the ID of the default search provider.
void SetDefaultSearchProviderID(TemplateURLID id);
// Sets the version of the builtin keywords.
void SetBuiltinKeywordVersion(int version);
~KeywordWebDataService() override;
// Called by the BatchModeScoper (see comments there).
void AdjustBatchModeLevel(bool entering_batch_mode);
// Schedules a task to commit any |queued_keyword_operations_| immediately.
void CommitQueuedOperations();
size_t batch_mode_level_ = 0;
KeywordTable::Operations queued_keyword_operations_;
base::RetainingOneShotTimer timer_; // Used to commit updates no more often
// than every five seconds.