Handle Search suggest subtypes for Shortcuts DB

chrome/browser/autocomplete/shortcuts_backend.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/autocomplete/shortcuts_backend.h"
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/guid.h"
 #include "base/i18n/case_conversion.h"
 #include "base/strings/string_util.h"
+#include "chrome/browser/autocomplete/autocomplete_input.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/autocomplete/autocomplete_result.h"
+#include "chrome/browser/autocomplete/base_search_provider.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/history/history_notifications.h"
 #include "chrome/browser/history/history_service.h"
 #include "chrome/browser/history/shortcuts_database.h"
 #include "chrome/browser/omnibox/omnibox_log.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/common/autocomplete_match_type.h"
 #include "chrome/common/chrome_constants.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/notification_details.h"
 #include "content/public/browser/notification_source.h"
 #include "extensions/common/extension.h"
 
 using content::BrowserThread;
 
 namespace {
 
@@ skipping 11 matching lines @@
 
 // Normally shortcuts have the same match type as the original match they were
 // created from, but for certain match types, we should modify the shortcut's
 // type slightly to reflect that the origin of the shortcut is historical.
 AutocompleteMatch::Type GetTypeForShortcut(AutocompleteMatch::Type type) {
   switch (type) {
     case AutocompleteMatchType::URL_WHAT_YOU_TYPED:
     case AutocompleteMatchType::NAVSUGGEST:
       return AutocompleteMatchType::HISTORY_URL;
 
-    case AutocompleteMatchType::SEARCH_WHAT_YOU_TYPED:
-    case AutocompleteMatchType::SEARCH_SUGGEST:
-    case AutocompleteMatchType::SEARCH_SUGGEST_ENTITY:
-    case AutocompleteMatchType::SEARCH_SUGGEST_INFINITE:
-    case AutocompleteMatchType::SEARCH_SUGGEST_PERSONALIZED:
-    case AutocompleteMatchType::SEARCH_SUGGEST_PROFILE:
-      return AutocompleteMatchType::SEARCH_HISTORY;
+    case AutocompleteMatchType::SEARCH_OTHER_ENGINE:
+      return type;
 
     default:
-      return type;
+      return AutocompleteMatch::IsSearchType(type) ?
+          AutocompleteMatchType::SEARCH_HISTORY : type;
   }
 }
 
 }  // namespace
 
 
 // ShortcutsBackend -----------------------------------------------------------
 
 ShortcutsBackend::ShortcutsBackend(Profile* profile, bool suppress_db)
-    : current_state_(NOT_INITIALIZED),
+    : profile_(profile),
+      current_state_(NOT_INITIALIZED),
       no_db_access_(suppress_db) {
   if (!suppress_db) {
     db_ = new history::ShortcutsDatabase(
         profile->GetPath().Append(chrome::kShortcutsDatabaseName));
   }
   // |profile| can be NULL in tests.
   if (profile) {
     notification_registrar_.Add(
         this, chrome::NOTIFICATION_EXTENSION_UNLOADED_DEPRECATED,
         content::Source<Profile>(profile));
@@ skipping 32 matching lines @@
 void ShortcutsBackend::AddOrUpdateShortcut(const base::string16& text,
                                            const AutocompleteMatch& match) {
   const base::string16 text_lowercase(base::i18n::ToLower(text));
   const base::Time now(base::Time::Now());
   for (ShortcutMap::const_iterator it(
        shortcuts_map_.lower_bound(text_lowercase));
        it != shortcuts_map_.end() &&
            StartsWith(it->first, text_lowercase, true); ++it) {
     if (match.destination_url == it->second.match_core.destination_url) {
       UpdateShortcut(history::ShortcutsDatabase::Shortcut(
-          it->second.id, text, MatchToMatchCore(match), now,
+          it->second.id, text, MatchToMatchCore(match, profile_), now,
           it->second.number_of_hits + 1));
       return;
     }
   }
   AddShortcut(history::ShortcutsDatabase::Shortcut(
-      base::GenerateGUID(), text, MatchToMatchCore(match), now, 1));
+      base::GenerateGUID(), text, MatchToMatchCore(match, profile_), now, 1));
 }
 
 ShortcutsBackend::~ShortcutsBackend() {
 }
 
 // static
 history::ShortcutsDatabase::Shortcut::MatchCore
-    ShortcutsBackend::MatchToMatchCore(const AutocompleteMatch& match) {
+    ShortcutsBackend::MatchToMatchCore(const AutocompleteMatch& match,
+                                       Profile* profile) {
+  const base::string16& suggestion = match.search_terms_args->search_terms;
+  const AutocompleteMatch::Type match_type = GetTypeForShortcut(match.type);

[Peter Kasting, 2014/03/24 18:59:19]

Nit: Can you inline this into the MatchCore() call below?  Placed here, it's
confusing that we calculate this, but then (purposefully) use match.type instead
of match_type in the next statement.

[Anuj, 2014/03/24 21:45:50]

I ended up using match_type below.

+  const AutocompleteMatch& normalized_match =
+      AutocompleteMatch::IsSpecializedSearchType(match.type) ?
+          BaseSearchProvider::CreateSearchSuggestion(
+              NULL,
+              AutocompleteInput(),
+              BaseSearchProvider::SuggestResult(
+                  suggestion,

[Peter Kasting, 2014/03/24 18:59:19]

Hmm.  4 levels of indenting, for many lines, is kinda sad.

What if we added a public CreateSearchSuggestion() method on BaseSearchProvider
that took only the args you need to pass?  This would result in less nesting in
both places, and would also avoid the need for a friend declaration.

[Anuj, 2014/03/24 21:45:50]

Done.

+                  match.type,
+                  suggestion,
+                  base::string16(), // Omit match_contents_prefix.
+                  base::string16(),
+                  std::string(), // Omit suggest_query_params.
+                  std::string(), // Omit deletion_url.
+                  (match.transition == content::PAGE_TRANSITION_KEYWORD),
+                  0, // Ignore relevance.
+                  false, // Ignore relevance_from_server.
+                  false, // Ignore should_prefetch.
+                  base::string16()), // Omit input_test.
+              match.GetTemplateURL(profile, false),
+              0, // accepted_suggestion
+              0, // omnibox_start_margin,
+              false) : match;

[Peter Kasting, 2014/03/24 18:59:19]

Nit: Break after ':' and unindent

[Anuj, 2014/03/24 21:45:50]

Done.

   return history::ShortcutsDatabase::Shortcut::MatchCore(
-      match.fill_into_edit, match.destination_url, match.contents,
-      StripMatchMarkers(match.contents_class), match.description,
-      StripMatchMarkers(match.description_class), match.transition,
-      GetTypeForShortcut(match.type), match.keyword);
+      normalized_match.fill_into_edit, normalized_match.destination_url,
+      normalized_match.contents,
+      StripMatchMarkers(normalized_match.contents_class),
+      normalized_match.description,
+      StripMatchMarkers(normalized_match.description_class),
+      normalized_match.transition, match_type,
+      normalized_match.keyword);
 }
 
 void ShortcutsBackend::ShutdownOnUIThread() {
   DCHECK(!BrowserThread::IsThreadInitialized(BrowserThread::UI) ||
          BrowserThread::CurrentlyOn(BrowserThread::UI));
   notification_registrar_.RemoveAll();
 }
 
 void ShortcutsBackend::Observe(int type,
                                const content::NotificationSource& source,
@@ skipping 143 matching lines @@
   guid_map_.clear();
   FOR_EACH_OBSERVER(ShortcutsBackendObserver, observer_list_,
                     OnShortcutsChanged());
   return no_db_access_ ||
       BrowserThread::PostTask(
           BrowserThread::DB, FROM_HERE,
           base::Bind(base::IgnoreResult(
                          &history::ShortcutsDatabase::DeleteAllShortcuts),
                      db_.get()));
 }