predictor_database.cc revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/predictors/predictor_database.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind.h"
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/file_util.h"
92a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/files/file_path.h"
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/metrics/histogram.h"
12868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/stringprintf.h"
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/predictors/autocomplete_action_predictor_table.h"
14c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "chrome/browser/predictors/logged_in_predictor_table.h"
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/prerender/prerender_field_trial.h"
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/profiles/profile.h"
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/browser_thread.h"
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sql/connection.h"
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sql/statement.h"
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)using content::BrowserThread;
222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace {
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TODO(shishir): This should move to a more generic name.
262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const base::FilePath::CharType kPredictorDatabaseName[] =
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    FILE_PATH_LITERAL("Network Action Predictor");
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace predictors {
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Refcounted as it is created, initialized and destroyed on a different thread
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to the DB thread that is required for all methods performing database access.
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PredictorDatabaseInternal
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : public base::RefCountedThreadSafe<PredictorDatabaseInternal> {
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private:
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  friend class base::RefCountedThreadSafe<PredictorDatabaseInternal>;
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  friend class PredictorDatabase;
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  explicit PredictorDatabaseInternal(Profile* profile);
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  virtual ~PredictorDatabaseInternal();
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Opens the database file from the profile path. Separated from the
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // constructor to ease construction/destruction of this object on one thread
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // but database access on the DB thread.
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void Initialize();
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void LogDatabaseStats();  //  DB Thread.
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Cancels pending DB transactions. Should only be called on the UI thread.
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void SetCancelled();
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  base::FilePath db_path_;
542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  scoped_ptr<sql::Connection> db_;
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // TODO(shishir): These tables may not need to be refcounted. Maybe move them
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // to using a WeakPtr instead.
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  scoped_refptr<AutocompleteActionPredictorTable> autocomplete_table_;
59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  scoped_refptr<LoggedInPredictorTable> logged_in_table_;
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DISALLOW_COPY_AND_ASSIGN(PredictorDatabaseInternal);
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)};
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PredictorDatabaseInternal::PredictorDatabaseInternal(Profile* profile)
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : db_path_(profile->GetPath().Append(kPredictorDatabaseName)),
672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)      db_(new sql::Connection()),
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      autocomplete_table_(new AutocompleteActionPredictorTable()),
695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)      logged_in_table_(new LoggedInPredictorTable()) {
70eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch  db_->set_histogram_tag("Predictor");
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PredictorDatabaseInternal::~PredictorDatabaseInternal() {
742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // The connection pointer needs to be deleted on the DB thread since there
752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // might be a task in progress on the DB thread which uses this connection.
765d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  if (BrowserThread::IsMessageLoopValid(BrowserThread::DB))
775d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)    BrowserThread::DeleteSoon(BrowserThread::DB, FROM_HERE, db_.release());
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PredictorDatabaseInternal::Initialize() {
81a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  CHECK(BrowserThread::CurrentlyOn(BrowserThread::DB) ||
82a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)        !BrowserThread::IsMessageLoopValid(BrowserThread::DB));
83c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  // TODO(tburkard): figure out if we need this.
84c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  //  db_->set_exclusive_locking();
852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  bool success = db_->Open(db_path_);
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!success)
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return;
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  autocomplete_table_->Initialize(db_.get());
91c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  logged_in_table_->Initialize(db_.get());
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  LogDatabaseStats();
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PredictorDatabaseInternal::SetCancelled() {
97a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  CHECK(BrowserThread::CurrentlyOn(BrowserThread::UI) ||
98a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)        !BrowserThread::IsMessageLoopValid(BrowserThread::UI));
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  autocomplete_table_->SetCancelled();
101c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  logged_in_table_->SetCancelled();
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PredictorDatabaseInternal::LogDatabaseStats() {
105a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  CHECK(BrowserThread::CurrentlyOn(BrowserThread::DB) ||
106a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)        !BrowserThread::IsMessageLoopValid(BrowserThread::DB));
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int64 db_size;
109a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)  bool success = base::GetFileSize(db_path_, &db_size);
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DCHECK(success) << "Failed to get file size for " << db_path_.value();
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  UMA_HISTOGRAM_MEMORY_KB("PredictorDatabase.DatabaseSizeKB",
1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                          static_cast<int>(db_size / 1024));
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  autocomplete_table_->LogDatabaseStats();
115c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  logged_in_table_->LogDatabaseStats();
1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PredictorDatabase::PredictorDatabase(Profile* profile)
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    : db_(new PredictorDatabaseInternal(profile)) {
1202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      base::Bind(&PredictorDatabaseInternal::Initialize, db_));
1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PredictorDatabase::~PredictorDatabase() {
1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PredictorDatabase::Shutdown() {
1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  db_->SetCancelled();
1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)scoped_refptr<AutocompleteActionPredictorTable>
1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    PredictorDatabase::autocomplete_table() {
1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return db_->autocomplete_table_;
1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
136c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)scoped_refptr<LoggedInPredictorTable>
137c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)    PredictorDatabase::logged_in_table() {
138c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)  return db_->logged_in_table_;
139c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}
140c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)
1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)sql::Connection* PredictorDatabase::GetDatabase() {
1422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  return db_->db_.get();
1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace predictors
146