Introduce BookmarkClient interface to abstract embedder

chrome/browser/bookmarks/bookmark_index.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/bookmarks/bookmark_index.h"
 
 #include <algorithm>
 #include <iterator>
 #include <list>
 
 #include "base/i18n/case_conversion.h"
 #include "base/strings/string16.h"
-#include "chrome/browser/bookmarks/bookmark_model.h"
-#include "chrome/browser/history/history_service.h"
-#include "chrome/browser/history/history_service_factory.h"
-#include "chrome/browser/history/url_database.h"
+#include "components/bookmarks/core/browser/bookmark_client.h"
+#include "components/bookmarks/core/browser/bookmark_node.h"
 #include "components/bookmarks/core/browser/bookmark_title_match.h"
 #include "components/query_parser/query_parser.h"
 #include "third_party/icu/source/common/unicode/normalizer2.h"
 
 namespace {
 
 // Returns a normalized version of the UTF16 string |text|.  If it fails to
 // normalize the string, returns |text| itself as a best-effort.
 base::string16 Normalize(const base::string16& text) {
   UErrorCode status = U_ZERO_ERROR;
@@ skipping 37 matching lines @@
 
 BookmarkIndex::NodeSet::const_iterator
     BookmarkIndex::Match::nodes_begin() const {
   return nodes.empty() ? terms.front()->second.begin() : nodes.begin();
 }
 
 BookmarkIndex::NodeSet::const_iterator BookmarkIndex::Match::nodes_end() const {
   return nodes.empty() ? terms.front()->second.end() : nodes.end();
 }
 
-BookmarkIndex::BookmarkIndex(content::BrowserContext* browser_context)
-    : browser_context_(browser_context) {
+BookmarkIndex::BookmarkIndex() {
 }
 
 BookmarkIndex::~BookmarkIndex() {
 }
 
 void BookmarkIndex::Add(const BookmarkNode* node) {
   if (!node->is_url())
     return;
   std::vector<base::string16> terms =
       ExtractQueryWords(Normalize(node->GetTitle()));
   for (size_t i = 0; i < terms.size(); ++i)
     RegisterNode(terms[i], node);
 }
 
 void BookmarkIndex::Remove(const BookmarkNode* node) {
   if (!node->is_url())
     return;
 
   std::vector<base::string16> terms =
       ExtractQueryWords(Normalize(node->GetTitle()));
   for (size_t i = 0; i < terms.size(); ++i)
     UnregisterNode(terms[i], node);
 }
 
 void BookmarkIndex::GetBookmarksWithTitlesMatching(
+    BookmarkClient* client,
     const base::string16& input_query,
     size_t max_count,
     std::vector<BookmarkTitleMatch>* results) {
   const base::string16 query = Normalize(input_query);
   std::vector<base::string16> terms = ExtractQueryWords(query);
   if (terms.empty())
     return;
 
   Matches matches;
   for (size_t i = 0; i < terms.size(); ++i) {
     if (!GetBookmarksWithTitleMatchingTerm(terms[i], i == 0, &matches))
       return;
   }
 
   NodeTypedCountPairs node_typed_counts;
-  SortMatches(matches, &node_typed_counts);
+  SortMatches(client, matches, &node_typed_counts);
 
   // We use a QueryParser to fill in match positions for us. It's not the most
   // efficient way to go about this, but by the time we get here we know what
   // matches and so this shouldn't be performance critical.
   query_parser::QueryParser parser;
   ScopedVector<query_parser::QueryNode> query_nodes;
   parser.ParseQueryNodes(query, &query_nodes.get());
 
   // The highest typed counts should be at the beginning of the results vector
   // so that the best matches will always be included in the results. The loop
   // that calculates result relevance in HistoryContentsProvider::ConvertResults
   // will run backwards to assure higher relevance will be attributed to the
   // best matches.
   for (NodeTypedCountPairs::const_iterator i = node_typed_counts.begin();
        i != node_typed_counts.end() && results->size() < max_count; ++i)
     AddMatchToResults(i->first, &parser, query_nodes.get(), results);
 }
 
-void BookmarkIndex::SortMatches(const Matches& matches,
+void BookmarkIndex::SortMatches(BookmarkClient* client,
+                                const Matches& matches,
                                 NodeTypedCountPairs* node_typed_counts) const {
-  HistoryService* const history_service = browser_context_ ?
-      HistoryServiceFactory::GetForProfile(
-          Profile::FromBrowserContext(browser_context_),
-          Profile::EXPLICIT_ACCESS) : NULL;
-
-  history::URLDatabase* url_db = history_service ?
-      history_service->InMemoryDatabase() : NULL;
-
-  for (Matches::const_iterator i = matches.begin(); i != matches.end(); ++i)
-    ExtractBookmarkNodePairs(url_db, *i, node_typed_counts);
+  for (Matches::const_iterator i = matches.begin(); i != matches.end(); ++i) {
+    const NodeSet& nodes =
+        i->nodes.empty() ? i->terms.front()->second : i->nodes;
+    client->GetTypedCountForNodes(nodes, node_typed_counts);

[sky, 2014/04/18 17:05:04]

If the intention is that some clients don't support GetTypedCountForNodes should
we have a SupportsTypedCountForNodes on the client interface?

[sdefresne, 2014/04/18 22:25:49]

I think that exporting a SupportsTypedCountForNodes method on the client
interface make the code more complex. I've done it, but I think it would be
simpler to state in the interface that it should return a typed count of 0 if it
is not supported.

[sky, 2014/04/21 15:24:20]

My thinking was that you can avoid this loop entirely if the client always
returns 0. But we can do this later.

+  }
 
   std::sort(node_typed_counts->begin(), node_typed_counts->end(),
             &NodeTypedCountPairSortFunc);
   // Eliminate duplicates.
   node_typed_counts->erase(std::unique(node_typed_counts->begin(),
                                        node_typed_counts->end()),
                            node_typed_counts->end());
 }
 
-void BookmarkIndex::ExtractBookmarkNodePairs(
-    history::URLDatabase* url_db,
-    const Match& match,
-    NodeTypedCountPairs* node_typed_counts) const {
-
-  for (NodeSet::const_iterator i = match.nodes_begin();
-       i != match.nodes_end(); ++i) {
-    int typed_count = 0;
-
-    // If |url_db| is the InMemoryDatabase, it might not cache all URLRows, but
-    // it guarantees to contain those with |typed_count| > 0. Thus, if we cannot
-    // fetch the URLRow, it is safe to assume that its |typed_count| is 0.
-    history::URLRow url;
-    if (url_db && url_db->GetRowForURL((*i)->url(), &url))
-      typed_count = url.typed_count();
-
-    NodeTypedCountPair pair(*i, typed_count);
-    node_typed_counts->push_back(pair);
-  }
-}
-
 void BookmarkIndex::AddMatchToResults(
     const BookmarkNode* node,
     query_parser::QueryParser* parser,
     const std::vector<query_parser::QueryNode*>& query_nodes,
     std::vector<BookmarkTitleMatch>* results) {
   BookmarkTitleMatch title_match;
   // Check that the result matches the query.  The previous search
   // was a simple per-word search, while the more complex matching
   // of QueryParser may filter it out.  For example, the query
   // ["thi"] will match the bookmark titled [Thinking], but since
@@ skipping 107 matching lines @@
   Index::iterator i = index_.find(term);
   if (i == index_.end()) {
     // We can get here if the node has the same term more than once. For
     // example, a bookmark with the title 'foo foo' would end up here.
     return;
   }
   i->second.erase(node);
   if (i->second.empty())
     index_.erase(i);
 }