This source file includes following definitions.
- ColumnsForVersion
- BindURLToStatement
- GetKey
- FromWebDatabase
- GetTypeKey
- CreateTablesIfNecessary
- IsSyncable
- MigrateToVersion
- PerformOperations
- GetKeywords
- SetDefaultSearchProviderID
- GetDefaultSearchProviderID
- SetBuiltinKeywordVersion
- GetBuiltinKeywordVersion
- GetKeywordColumns
- MigrateToVersion21AutoGenerateKeywordColumn
- MigrateToVersion25AddLogoIDColumn
- MigrateToVersion26AddCreatedByPolicyColumn
- MigrateToVersion28SupportsInstantColumn
- MigrateToVersion29InstantURLToSupportsInstant
- MigrateToVersion38AddLastModifiedColumn
- MigrateToVersion39AddSyncGUIDColumn
- MigrateToVersion44AddDefaultSearchProviderBackup
- MigrateToVersion45RemoveLogoIDAndAutogenerateColumns
- MigrateToVersion47AddAlternateURLsColumn
- MigrateToVersion48RemoveKeywordsBackup
- MigrateToVersion49AddSearchTermsReplacementKeyColumn
- MigrateToVersion52AddImageSearchAndPOSTSupport
- MigrateToVersion53AddNewTabURLColumn
- GetKeywordDataFromStatement
- AddKeyword
- RemoveKeyword
- UpdateKeyword
- GetKeywordAsString
- MigrateKeywordsTableForVersion45
#include "chrome/browser/webdata/keyword_table.h"
#include <set>
#include "base/json/json_reader.h"
#include "base/json/json_writer.h"
#include "base/logging.h"
#include "base/memory/scoped_ptr.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/values.h"
#include "chrome/browser/history/history_database.h"
#include "chrome/browser/search_engines/search_terms_data.h"
#include "chrome/browser/search_engines/template_url.h"
#include "chrome/browser/search_engines/template_url_service.h"
#include "components/webdata/common/web_database.h"
#include "sql/statement.h"
#include "sql/transaction.h"
#include "url/gurl.h"
using base::Time;
const char KeywordTable::kDefaultSearchProviderKey[] =
"Default Search Provider ID";
namespace {
const char kBuiltinKeywordVersion[] = "Builtin Keyword Version";
const std::string ColumnsForVersion(int version, bool concatenated) {
std::vector<std::string> columns;
columns.push_back("id");
columns.push_back("short_name");
columns.push_back("keyword");
columns.push_back("favicon_url");
columns.push_back("url");
columns.push_back("safe_for_autoreplace");
columns.push_back("originating_url");
columns.push_back("date_created");
columns.push_back("usage_count");
columns.push_back("input_encodings");
columns.push_back("show_in_default_list");
columns.push_back("suggest_url");
columns.push_back("prepopulate_id");
if (version <= 44) {
columns.push_back("autogenerate_keyword");
columns.push_back("logo_id");
}
columns.push_back("created_by_policy");
columns.push_back("instant_url");
columns.push_back("last_modified");
columns.push_back("sync_guid");
if (version >= 47) {
columns.push_back("alternate_urls");
}
if (version >= 49) {
columns.push_back("search_terms_replacement_key");
}
if (version >= 52) {
columns.push_back("image_url");
columns.push_back("search_url_post_params");
columns.push_back("suggest_url_post_params");
columns.push_back("instant_url_post_params");
columns.push_back("image_url_post_params");
}
if (version >= 53) {
columns.push_back("new_tab_url");
}
return JoinString(columns, std::string(concatenated ? " || " : ", "));
}
void BindURLToStatement(const TemplateURLData& data,
sql::Statement* s,
int id_column,
int starting_column) {
base::ListValue alternate_urls_value;
for (size_t i = 0; i < data.alternate_urls.size(); ++i)
alternate_urls_value.AppendString(data.alternate_urls[i]);
std::string alternate_urls;
base::JSONWriter::Write(&alternate_urls_value, &alternate_urls);
s->BindInt64(id_column, data.id);
s->BindString16(starting_column, data.short_name);
s->BindString16(starting_column + 1, data.keyword());
s->BindString(starting_column + 2, data.favicon_url.is_valid() ?
history::HistoryDatabase::GURLToDatabaseURL(data.favicon_url) :
std::string());
s->BindString(starting_column + 3, data.url());
s->BindBool(starting_column + 4, data.safe_for_autoreplace);
s->BindString(starting_column + 5, data.originating_url.is_valid() ?
history::HistoryDatabase::GURLToDatabaseURL(data.originating_url) :
std::string());
s->BindInt64(starting_column + 6, data.date_created.ToTimeT());
s->BindInt(starting_column + 7, data.usage_count);
s->BindString(starting_column + 8, JoinString(data.input_encodings, ';'));
s->BindBool(starting_column + 9, data.show_in_default_list);
s->BindString(starting_column + 10, data.suggestions_url);
s->BindInt(starting_column + 11, data.prepopulate_id);
s->BindBool(starting_column + 12, data.created_by_policy);
s->BindString(starting_column + 13, data.instant_url);
s->BindInt64(starting_column + 14, data.last_modified.ToTimeT());
s->BindString(starting_column + 15, data.sync_guid);
s->BindString(starting_column + 16, alternate_urls);
s->BindString(starting_column + 17, data.search_terms_replacement_key);
s->BindString(starting_column + 18, data.image_url);
s->BindString(starting_column + 19, data.search_url_post_params);
s->BindString(starting_column + 20, data.suggestions_url_post_params);
s->BindString(starting_column + 21, data.instant_url_post_params);
s->BindString(starting_column + 22, data.image_url_post_params);
s->BindString(starting_column + 23, data.new_tab_url);
}
WebDatabaseTable::TypeKey GetKey() {
static int table_key = 0;
return reinterpret_cast<void*>(&table_key);
}
}
KeywordTable::KeywordTable() {
}
KeywordTable::~KeywordTable() {}
KeywordTable* KeywordTable::FromWebDatabase(WebDatabase* db) {
return static_cast<KeywordTable*>(db->GetTable(GetKey()));
}
WebDatabaseTable::TypeKey KeywordTable::GetTypeKey() const {
return GetKey();
}
bool KeywordTable::CreateTablesIfNecessary() {
return db_->DoesTableExist("keywords") ||
db_->Execute("CREATE TABLE keywords ("
"id INTEGER PRIMARY KEY,"
"short_name VARCHAR NOT NULL,"
"keyword VARCHAR NOT NULL,"
"favicon_url VARCHAR NOT NULL,"
"url VARCHAR NOT NULL,"
"safe_for_autoreplace INTEGER,"
"originating_url VARCHAR,"
"date_created INTEGER DEFAULT 0,"
"usage_count INTEGER DEFAULT 0,"
"input_encodings VARCHAR,"
"show_in_default_list INTEGER,"
"suggest_url VARCHAR,"
"prepopulate_id INTEGER DEFAULT 0,"
"created_by_policy INTEGER DEFAULT 0,"
"instant_url VARCHAR,"
"last_modified INTEGER DEFAULT 0,"
"sync_guid VARCHAR,"
"alternate_urls VARCHAR,"
"search_terms_replacement_key VARCHAR,"
"image_url VARCHAR,"
"search_url_post_params VARCHAR,"
"suggest_url_post_params VARCHAR,"
"instant_url_post_params VARCHAR,"
"image_url_post_params VARCHAR,"
"new_tab_url VARCHAR)");
}
bool KeywordTable::IsSyncable() {
return true;
}
bool KeywordTable::MigrateToVersion(int version,
bool* update_compatible_version) {
switch (version) {
case 21:
*update_compatible_version = true;
return MigrateToVersion21AutoGenerateKeywordColumn();
case 25:
*update_compatible_version = true;
return MigrateToVersion25AddLogoIDColumn();
case 26:
*update_compatible_version = true;
return MigrateToVersion26AddCreatedByPolicyColumn();
case 28:
*update_compatible_version = true;
return MigrateToVersion28SupportsInstantColumn();
case 29:
*update_compatible_version = true;
return MigrateToVersion29InstantURLToSupportsInstant();
case 38:
*update_compatible_version = true;
return MigrateToVersion38AddLastModifiedColumn();
case 39:
*update_compatible_version = true;
return MigrateToVersion39AddSyncGUIDColumn();
case 44:
*update_compatible_version = true;
return MigrateToVersion44AddDefaultSearchProviderBackup();
case 45:
*update_compatible_version = true;
return MigrateToVersion45RemoveLogoIDAndAutogenerateColumns();
case 47:
*update_compatible_version = true;
return MigrateToVersion47AddAlternateURLsColumn();
case 48:
*update_compatible_version = true;
return MigrateToVersion48RemoveKeywordsBackup();
case 49:
*update_compatible_version = true;
return MigrateToVersion49AddSearchTermsReplacementKeyColumn();
case 52:
*update_compatible_version = true;
return MigrateToVersion52AddImageSearchAndPOSTSupport();
case 53:
*update_compatible_version = true;
return MigrateToVersion53AddNewTabURLColumn();
}
return true;
}
bool KeywordTable::PerformOperations(const Operations& operations) {
sql::Transaction transaction(db_);
if (!transaction.Begin())
return false;
for (Operations::const_iterator i(operations.begin()); i != operations.end();
++i) {
switch (i->first) {
case ADD:
if (!AddKeyword(i->second))
return false;
break;
case REMOVE:
if (!RemoveKeyword(i->second.id))
return false;
break;
case UPDATE:
if (!UpdateKeyword(i->second))
return false;
break;
}
}
return transaction.Commit();
}
bool KeywordTable::GetKeywords(Keywords* keywords) {
std::string query("SELECT " + GetKeywordColumns() +
" FROM keywords ORDER BY id ASC");
sql::Statement s(db_->GetUniqueStatement(query.c_str()));
std::set<TemplateURLID> bad_entries;
while (s.Step()) {
keywords->push_back(TemplateURLData());
if (!GetKeywordDataFromStatement(s, &keywords->back())) {
bad_entries.insert(s.ColumnInt64(0));
keywords->pop_back();
}
}
bool succeeded = s.Succeeded();
for (std::set<TemplateURLID>::const_iterator i(bad_entries.begin());
i != bad_entries.end(); ++i)
succeeded &= RemoveKeyword(*i);
return succeeded;
}
bool KeywordTable::SetDefaultSearchProviderID(int64 id) {
return meta_table_->SetValue(kDefaultSearchProviderKey, id);
}
int64 KeywordTable::GetDefaultSearchProviderID() {
int64 value = kInvalidTemplateURLID;
meta_table_->GetValue(kDefaultSearchProviderKey, &value);
return value;
}
bool KeywordTable::SetBuiltinKeywordVersion(int version) {
return meta_table_->SetValue(kBuiltinKeywordVersion, version);
}
int KeywordTable::GetBuiltinKeywordVersion() {
int version = 0;
return meta_table_->GetValue(kBuiltinKeywordVersion, &version) ? version : 0;
}
std::string KeywordTable::GetKeywordColumns() {
return ColumnsForVersion(WebDatabase::kCurrentVersionNumber, false);
}
bool KeywordTable::MigrateToVersion21AutoGenerateKeywordColumn() {
return db_->Execute("ALTER TABLE keywords ADD COLUMN autogenerate_keyword "
"INTEGER DEFAULT 0");
}
bool KeywordTable::MigrateToVersion25AddLogoIDColumn() {
return db_->Execute(
"ALTER TABLE keywords ADD COLUMN logo_id INTEGER DEFAULT 0");
}
bool KeywordTable::MigrateToVersion26AddCreatedByPolicyColumn() {
return db_->Execute("ALTER TABLE keywords ADD COLUMN created_by_policy "
"INTEGER DEFAULT 0");
}
bool KeywordTable::MigrateToVersion28SupportsInstantColumn() {
return db_->Execute("ALTER TABLE keywords ADD COLUMN supports_instant "
"INTEGER DEFAULT 0");
}
bool KeywordTable::MigrateToVersion29InstantURLToSupportsInstant() {
sql::Transaction transaction(db_);
return transaction.Begin() &&
db_->Execute("ALTER TABLE keywords ADD COLUMN instant_url VARCHAR") &&
db_->Execute("CREATE TABLE keywords_temp ("
"id INTEGER PRIMARY KEY,"
"short_name VARCHAR NOT NULL,"
"keyword VARCHAR NOT NULL,"
"favicon_url VARCHAR NOT NULL,"
"url VARCHAR NOT NULL,"
"safe_for_autoreplace INTEGER,"
"originating_url VARCHAR,"
"date_created INTEGER DEFAULT 0,"
"usage_count INTEGER DEFAULT 0,"
"input_encodings VARCHAR,"
"show_in_default_list INTEGER,"
"suggest_url VARCHAR,"
"prepopulate_id INTEGER DEFAULT 0,"
"autogenerate_keyword INTEGER DEFAULT 0,"
"logo_id INTEGER DEFAULT 0,"
"created_by_policy INTEGER DEFAULT 0,"
"instant_url VARCHAR)") &&
db_->Execute("INSERT INTO keywords_temp SELECT id, short_name, keyword, "
"favicon_url, url, safe_for_autoreplace, originating_url, "
"date_created, usage_count, input_encodings, "
"show_in_default_list, suggest_url, prepopulate_id, "
"autogenerate_keyword, logo_id, created_by_policy, "
"instant_url FROM keywords") &&
db_->Execute("DROP TABLE keywords") &&
db_->Execute("ALTER TABLE keywords_temp RENAME TO keywords") &&
transaction.Commit();
}
bool KeywordTable::MigrateToVersion38AddLastModifiedColumn() {
return db_->Execute(
"ALTER TABLE keywords ADD COLUMN last_modified INTEGER DEFAULT 0");
}
bool KeywordTable::MigrateToVersion39AddSyncGUIDColumn() {
return db_->Execute("ALTER TABLE keywords ADD COLUMN sync_guid VARCHAR");
}
bool KeywordTable::MigrateToVersion44AddDefaultSearchProviderBackup() {
std::string query("CREATE TABLE keywords_backup AS SELECT " +
ColumnsForVersion(44, false) + " FROM keywords ORDER BY id ASC");
sql::Transaction transaction(db_);
return transaction.Begin() &&
meta_table_->SetValue("Default Search Provider ID Backup",
GetDefaultSearchProviderID()) &&
(!db_->DoesTableExist("keywords_backup") ||
db_->Execute("DROP TABLE keywords_backup")) &&
db_->Execute(query.c_str()) &&
transaction.Commit();
}
bool KeywordTable::MigrateToVersion45RemoveLogoIDAndAutogenerateColumns() {
sql::Transaction transaction(db_);
if (!transaction.Begin())
return false;
meta_table_->DeleteKey("Default Search Provider Backup");
return MigrateKeywordsTableForVersion45("keywords") &&
MigrateKeywordsTableForVersion45("keywords_backup") &&
meta_table_->SetValue("Default Search Provider ID Backup Signature",
std::string()) &&
transaction.Commit();
}
bool KeywordTable::MigrateToVersion47AddAlternateURLsColumn() {
sql::Transaction transaction(db_);
return transaction.Begin() &&
db_->Execute("ALTER TABLE keywords ADD COLUMN "
"alternate_urls VARCHAR DEFAULT ''") &&
db_->Execute("ALTER TABLE keywords_backup ADD COLUMN "
"alternate_urls VARCHAR DEFAULT ''") &&
meta_table_->SetValue("Default Search Provider ID Backup Signature",
std::string()) &&
transaction.Commit();
}
bool KeywordTable::MigrateToVersion48RemoveKeywordsBackup() {
sql::Transaction transaction(db_);
return transaction.Begin() &&
meta_table_->DeleteKey("Default Search Provider ID Backup") &&
meta_table_->DeleteKey("Default Search Provider ID Backup Signature") &&
db_->Execute("DROP TABLE keywords_backup") &&
transaction.Commit();
}
bool KeywordTable::MigrateToVersion49AddSearchTermsReplacementKeyColumn() {
return db_->Execute("ALTER TABLE keywords ADD COLUMN "
"search_terms_replacement_key VARCHAR DEFAULT ''");
}
bool KeywordTable::MigrateToVersion52AddImageSearchAndPOSTSupport() {
sql::Transaction transaction(db_);
return transaction.Begin() &&
db_->Execute("ALTER TABLE keywords ADD COLUMN image_url "
"VARCHAR DEFAULT ''") &&
db_->Execute("ALTER TABLE keywords ADD COLUMN search_url_post_params "
"VARCHAR DEFAULT ''") &&
db_->Execute("ALTER TABLE keywords ADD COLUMN suggest_url_post_params "
"VARCHAR DEFAULT ''") &&
db_->Execute("ALTER TABLE keywords ADD COLUMN instant_url_post_params "
"VARCHAR DEFAULT ''") &&
db_->Execute("ALTER TABLE keywords ADD COLUMN image_url_post_params "
"VARCHAR DEFAULT ''") &&
transaction.Commit();
}
bool KeywordTable::MigrateToVersion53AddNewTabURLColumn() {
return db_->Execute("ALTER TABLE keywords ADD COLUMN new_tab_url "
"VARCHAR DEFAULT ''");
}
bool KeywordTable::GetKeywordDataFromStatement(const sql::Statement& s,
TemplateURLData* data) {
DCHECK(data);
data->short_name = s.ColumnString16(1);
data->SetKeyword(s.ColumnString16(2));
if (s.ColumnString(4).empty())
return false;
data->SetURL(s.ColumnString(4));
data->suggestions_url = s.ColumnString(11);
data->instant_url = s.ColumnString(14);
data->image_url = s.ColumnString(19);
data->new_tab_url = s.ColumnString(24);
data->search_url_post_params = s.ColumnString(20);
data->suggestions_url_post_params = s.ColumnString(21);
data->instant_url_post_params = s.ColumnString(22);
data->image_url_post_params = s.ColumnString(23);
data->favicon_url = GURL(s.ColumnString(3));
data->originating_url = GURL(s.ColumnString(6));
data->show_in_default_list = s.ColumnBool(10);
data->safe_for_autoreplace = s.ColumnBool(5);
base::SplitString(s.ColumnString(9), ';', &data->input_encodings);
data->id = s.ColumnInt64(0);
data->date_created = Time::FromTimeT(s.ColumnInt64(7));
data->last_modified = Time::FromTimeT(s.ColumnInt64(15));
data->created_by_policy = s.ColumnBool(13);
data->usage_count = s.ColumnInt(8);
data->prepopulate_id = s.ColumnInt(12);
data->sync_guid = s.ColumnString(16);
data->alternate_urls.clear();
base::JSONReader json_reader;
scoped_ptr<base::Value> value(json_reader.ReadToValue(s.ColumnString(17)));
base::ListValue* alternate_urls_value;
if (value.get() && value->GetAsList(&alternate_urls_value)) {
std::string alternate_url;
for (size_t i = 0; i < alternate_urls_value->GetSize(); ++i) {
if (alternate_urls_value->GetString(i, &alternate_url))
data->alternate_urls.push_back(alternate_url);
}
}
data->search_terms_replacement_key = s.ColumnString(18);
return true;
}
bool KeywordTable::AddKeyword(const TemplateURLData& data) {
DCHECK(data.id);
std::string query("INSERT INTO keywords (" + GetKeywordColumns() + ") "
"VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,"
" ?)");
sql::Statement s(db_->GetCachedStatement(SQL_FROM_HERE, query.c_str()));
BindURLToStatement(data, &s, 0, 1);
return s.Run();
}
bool KeywordTable::RemoveKeyword(TemplateURLID id) {
DCHECK(id);
sql::Statement s(db_->GetCachedStatement(
SQL_FROM_HERE, "DELETE FROM keywords WHERE id = ?"));
s.BindInt64(0, id);
return s.Run();
}
bool KeywordTable::UpdateKeyword(const TemplateURLData& data) {
DCHECK(data.id);
sql::Statement s(db_->GetCachedStatement(
SQL_FROM_HERE,
"UPDATE keywords SET short_name=?, keyword=?, favicon_url=?, url=?, "
"safe_for_autoreplace=?, originating_url=?, date_created=?, "
"usage_count=?, input_encodings=?, show_in_default_list=?, "
"suggest_url=?, prepopulate_id=?, created_by_policy=?, instant_url=?, "
"last_modified=?, sync_guid=?, alternate_urls=?, "
"search_terms_replacement_key=?, image_url=?, search_url_post_params=?, "
"suggest_url_post_params=?, instant_url_post_params=?, "
"image_url_post_params=?, new_tab_url=? WHERE id=?"));
BindURLToStatement(data, &s, 24, 0);
return s.Run();
}
bool KeywordTable::GetKeywordAsString(TemplateURLID id,
const std::string& table_name,
std::string* result) {
std::string query("SELECT " +
ColumnsForVersion(WebDatabase::kCurrentVersionNumber, true) +
" FROM " + table_name + " WHERE id=?");
sql::Statement s(db_->GetUniqueStatement(query.c_str()));
s.BindInt64(0, id);
if (!s.Step()) {
LOG_IF(WARNING, s.Succeeded()) << "No keyword with id: " << id
<< ", ignoring.";
return true;
}
if (!s.Succeeded())
return false;
*result = s.ColumnString(0);
return true;
}
bool KeywordTable::MigrateKeywordsTableForVersion45(const std::string& name) {
if (!db_->Execute("CREATE TABLE keywords_temp ("
"id INTEGER PRIMARY KEY,"
"short_name VARCHAR NOT NULL,"
"keyword VARCHAR NOT NULL,"
"favicon_url VARCHAR NOT NULL,"
"url VARCHAR NOT NULL,"
"safe_for_autoreplace INTEGER,"
"originating_url VARCHAR,"
"date_created INTEGER DEFAULT 0,"
"usage_count INTEGER DEFAULT 0,"
"input_encodings VARCHAR,"
"show_in_default_list INTEGER,"
"suggest_url VARCHAR,"
"prepopulate_id INTEGER DEFAULT 0,"
"created_by_policy INTEGER DEFAULT 0,"
"instant_url VARCHAR,"
"last_modified INTEGER DEFAULT 0,"
"sync_guid VARCHAR)"))
return false;
std::string sql("INSERT INTO keywords_temp SELECT " +
ColumnsForVersion(46, false) + " FROM " + name);
if (!db_->Execute(sql.c_str()))
return false;
sql = "SELECT id, keyword, url, autogenerate_keyword FROM " + name +
" ORDER BY id ASC";
sql::Statement s(db_->GetUniqueStatement(sql.c_str()));
base::string16 placeholder_keyword(base::ASCIIToUTF16("dummy"));
std::set<base::string16> keywords;
while (s.Step()) {
base::string16 keyword(s.ColumnString16(1));
bool generate_keyword = keyword.empty() || s.ColumnBool(3);
if (generate_keyword)
keyword = placeholder_keyword;
TemplateURLData data;
data.SetKeyword(keyword);
data.SetURL(s.ColumnString(2));
TemplateURL turl(NULL, data);
bool delete_entry = turl.GetType() == TemplateURL::OMNIBOX_API_EXTENSION;
if (!delete_entry && generate_keyword) {
SearchTermsData terms_data;
GURL url(TemplateURLService::GenerateSearchURLUsingTermsData(&turl,
terms_data));
if (!url.is_valid()) {
delete_entry = true;
} else {
keyword = TemplateURLService::GenerateKeyword(url);
while (keywords.count(keyword))
keyword.append(base::ASCIIToUTF16("_"));
sql::Statement u(db_->GetUniqueStatement(
"UPDATE keywords_temp SET keyword=? WHERE id=?"));
u.BindString16(0, keyword);
u.BindInt64(1, s.ColumnInt64(0));
if (!u.Run())
return false;
}
}
if (delete_entry) {
sql::Statement u(db_->GetUniqueStatement(
"DELETE FROM keywords_temp WHERE id=?"));
u.BindInt64(0, s.ColumnInt64(0));
if (!u.Run())
return false;
} else {
keywords.insert(keyword);
}
}
sql = "DROP TABLE " + name;
if (!db_->Execute(sql.c_str()))
return false;
sql = "ALTER TABLE keywords_temp RENAME TO " + name;
return db_->Execute(sql.c_str());
}