Move InMemoryURLIndex Caching Operations to FILE Thread

chrome/browser/history/url_index_private_data.cc

 // Copyright (c) 2012 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 "chrome/browser/history/url_index_private_data.h"
 
 #include <algorithm>
 #include <functional>
 #include <iterator>
 #include <limits>
 #include <numeric>
 
 #include "base/file_util.h"
 #include "base/i18n/case_conversion.h"
 #include "base/metrics/histogram.h"
 #include "base/string_util.h"
-#include "base/threading/thread_restrictions.h"
+#include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/autocomplete/autocomplete.h"
 #include "chrome/browser/history/history_database.h"
+#include "chrome/browser/history/in_memory_url_index.h"
 #include "chrome/common/url_constants.h"
+#include "content/public/browser/notification_details.h"
+#include "content/public/browser/notification_service.h"
+#include "content/public/browser/notification_source.h"
 #include "net/base/net_util.h"
 #include "third_party/protobuf/src/google/protobuf/repeated_field.h"
 
 using google::protobuf::RepeatedField;
 using google::protobuf::RepeatedPtrField;
 using in_memory_url_index::InMemoryURLIndexCacheItem;
 
 namespace history {
 
 typedef imui::InMemoryURLIndexCacheItem_WordListItem WordListItem;
@@ skipping 15 matching lines @@
 const int kMaxTotalScore = 1425;
 
 // Score ranges used to get a 'base' score for each of the scoring factors
 // (such as recency of last visit, times visited, times the URL was typed,
 // and the quality of the string match). There is a matching value range for
 // each of these scores for each factor. Note that the top score is greater
 // than |kMaxTotalScore|. The score for each candidate will be capped in the
 // final calculation.
 const int kScoreRank[] = { 1450, 1200, 900, 400 };
 
+// RefCountedURLIndexPrivateDataPtr --------------------------------------------
+
+RefCountedURLIndexPrivateDataPtr::RefCountedURLIndexPrivateDataPtr() {}
+RefCountedURLIndexPrivateDataPtr::~RefCountedURLIndexPrivateDataPtr() {}
+
+URLIndexPrivateData* RefCountedURLIndexPrivateDataPtr::get() {
+  return data_.get();
+}
+URLIndexPrivateData* RefCountedURLIndexPrivateDataPtr::release() {
+  return data_.release();
+}
+void RefCountedURLIndexPrivateDataPtr::reset(URLIndexPrivateData* data) {
+  data_.reset(data);
+}
+
 // SearchTermCacheItem ---------------------------------------------------------
 
 URLIndexPrivateData::SearchTermCacheItem::SearchTermCacheItem(
     const WordIDSet& word_id_set,
     const HistoryIDSet& history_id_set)
     : word_id_set_(word_id_set),
       history_id_set_(history_id_set),
       used_(true) {}
 
 URLIndexPrivateData::SearchTermCacheItem::SearchTermCacheItem()
@@ skipping 59 matching lines @@
 void URLIndexPrivateData::Clear() {
   word_list_.clear();
   available_words_.clear();
   word_map_.clear();
   char_word_map_.clear();
   word_id_history_map_.clear();
   history_id_word_map_.clear();
   history_info_map_.clear();
 }
 
+bool URLIndexPrivateData::Empty() const {
+  return history_info_map_.empty();
+}
+
 // Cache Updating --------------------------------------------------------------
 
 bool URLIndexPrivateData::IndexRow(const URLRow& row) {
   const GURL& gurl(row.url());
 
   // Index only URLs with a whitelisted scheme.
   if (!URLIndexPrivateData::URLSchemeIsWhitelisted(gurl))
     return false;
 
   URLID row_id = row.id();
@@ skipping 749 matching lines @@
   whitelist->insert(std::string(chrome::kChromeUIScheme));
   whitelist->insert(std::string(chrome::kFileScheme));
   whitelist->insert(std::string(chrome::kFtpScheme));
   whitelist->insert(std::string(chrome::kHttpScheme));
   whitelist->insert(std::string(chrome::kHttpsScheme));
   whitelist->insert(std::string(chrome::kMailToScheme));
 }
 
 // Cache Saving ----------------------------------------------------------------
 
+// static
+void URLIndexPrivateData::WritePrivateDataToCacheFileTask(
+    scoped_ptr<URLIndexPrivateData> private_data,
+    const FilePath& file_path,
+    scoped_refptr<RefCountedBool> succeeded) {
+  DCHECK(private_data.get());
+  DCHECK(!file_path.empty());
+  succeeded->set_value(private_data->SaveToFile(file_path));
+}
+
 bool URLIndexPrivateData::SaveToFile(const FilePath& file_path) {
-  // TODO(mrossetti): Move File IO to another thread.
-  base::ThreadRestrictions::ScopedAllowIO allow_io;
   base::TimeTicks beginning_time = base::TimeTicks::Now();
   InMemoryURLIndexCacheItem index_cache;
   SavePrivateData(&index_cache);
   std::string data;
   if (!index_cache.SerializeToString(&data)) {
     LOG(WARNING) << "Failed to serialize the InMemoryURLIndex cache.";
     return false;
   }
 
   int size = data.size();
@@ skipping 97 matching lines @@
     map_entry->set_visit_count(url_row.visit_count());
     map_entry->set_typed_count(url_row.typed_count());
     map_entry->set_last_visit(url_row.last_visit().ToInternalValue());
     map_entry->set_url(url_row.url().spec());
     map_entry->set_title(UTF16ToUTF8(url_row.title()));
   }
 }
 
 // Cache Restoring -------------------------------------------------------------
 
-bool URLIndexPrivateData::RestoreFromFile(const FilePath& file_path) {
-  // TODO(mrossetti): Figure out how to determine if the cache is up-to-date.
-  // That is: ensure that the database has not been modified since the cache
-  // was last saved. DB file modification date is inadequate. There are no
-  // SQLite table checksums automatically stored.
-  Clear();  // Start with a clean slate.
+// static
+void URLIndexPrivateData::RestoreFromFileTask(
+    const FilePath& file_path,
+    scoped_refptr<RefCountedURLIndexPrivateDataPtr> private_data_ptr) {
+  private_data_ptr->reset(URLIndexPrivateData::RestoreFromFile(file_path));
+}
 
-  // FIXME(mrossetti): Move File IO to another thread.
-  base::ThreadRestrictions::ScopedAllowIO allow_io;
+// static
+URLIndexPrivateData* URLIndexPrivateData::RestoreFromFile(
+    const FilePath& file_path) {
   base::TimeTicks beginning_time = base::TimeTicks::Now();
   if (!file_util::PathExists(file_path))
-    return false;
+    return NULL;
   std::string data;
   // If there is no cache file then simply give up. This will cause us to
   // attempt to rebuild from the history database.
   if (!file_util::ReadFileToString(file_path, &data))
-    return false;
+    return NULL;
 
+  scoped_ptr<URLIndexPrivateData> restored_data(new URLIndexPrivateData);
   InMemoryURLIndexCacheItem index_cache;
   if (!index_cache.ParseFromArray(data.c_str(), data.size())) {
-    LOG(WARNING) << "Failed to parse InMemoryURLIndex cache data read from "
+    LOG(WARNING) << "Failed to parse URLIndexPrivateData cache data read from "
                  << file_path.value();
-    return false;
+    return restored_data.release();
   }
 
-  if (!RestorePrivateData(index_cache)) {
-    Clear();  // Back to square one -- must build from scratch.
-    return false;
+  if (!restored_data->RestorePrivateData(index_cache)) {
+    restored_data.reset();  // Back to square one -- must build from history DB.
+    return NULL;
   }
 
   UMA_HISTOGRAM_TIMES("History.InMemoryURLIndexRestoreCacheTime",
                       base::TimeTicks::Now() - beginning_time);
   UMA_HISTOGRAM_COUNTS("History.InMemoryURLHistoryItems",
-                       history_id_word_map_.size());
+                       restored_data->history_id_word_map_.size());
   UMA_HISTOGRAM_COUNTS("History.InMemoryURLCacheSize", data.size());
-  UMA_HISTOGRAM_COUNTS_10000("History.InMemoryURLWords", word_map_.size());
-  UMA_HISTOGRAM_COUNTS_10000("History.InMemoryURLChars", char_word_map_.size());
-  return true;
+  UMA_HISTOGRAM_COUNTS_10000("History.InMemoryURLWords",
+                             restored_data->word_map_.size());
+  UMA_HISTOGRAM_COUNTS_10000("History.InMemoryURLChars",
+                             restored_data->char_word_map_.size());
+  if (restored_data->Empty())
+    restored_data.reset();  // 'No data' is the same as a failed reload.
+  return restored_data.release();
 }
 
 // static
 URLIndexPrivateData* URLIndexPrivateData::RebuildFromHistory(
     HistoryDatabase* history_db) {
   if (!history_db)
     return NULL;
 
   base::TimeTicks beginning_time = base::TimeTicks::Now();
 
@@ skipping 134 matching lines @@
     if (iter->has_title()) {
       string16 title(UTF8ToUTF16(iter->title()));
       url_row.set_title(title);
     }
     history_info_map_[history_id] = url_row;
   }
   return true;
 }
 
 }  // namespace history