Omnibox: Don't Let Users Escape Keyword Mode Accidentally

chrome/browser/autocomplete/search_provider.cc

 // Copyright 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/search_provider.h"
 
 #include <algorithm>
 #include <cmath>
 
 #include "base/callback.h"
@@ skipping 1289 matching lines @@
 ACMatches::const_iterator SearchProvider::FindTopMatch(
     bool autocomplete_result_will_reorder_for_default_match) const {
   if (!autocomplete_result_will_reorder_for_default_match)
     return matches_.begin();
   ACMatches::const_iterator it = matches_.begin();
   while ((it != matches_.end()) && !it->allowed_to_be_default_match)
     ++it;
   return it;
 }
 
-bool SearchProvider::IsTopMatchNavigationInKeywordMode(
+bool SearchProvider::IsTopMatchNavigation(
     bool autocomplete_result_will_reorder_for_default_match) const {
   ACMatches::const_iterator first_match =
       FindTopMatch(autocomplete_result_will_reorder_for_default_match);
-  return !providers_.keyword_provider().empty() &&
-      (first_match != matches_.end()) &&
+  return (first_match != matches_.end()) &&
       (first_match->type == AutocompleteMatchType::NAVSUGGEST);
 }
 
+bool SearchProvider::HasKeywordMatchThatCanBeDefault(
+    bool autocomplete_result_will_reorder_for_default_match) const {
+  // In regular (non-reorder) mode we don't care about the
+  // |allowed_to_be_default_match| state, so return true saying
+  // everything is fine.
+  if (!autocomplete_result_will_reorder_for_default_match)
+    return true;

[Peter Kasting, 2013/11/19 02:58:24]

It seems kinda wrong to do this here, because it effectively makes the function
lie.  Why shouldn't the caller check this variable and not call the function to
begin with instead?

[Mark P, 2013/11/20 19:05:52]

Good point.  It does seem wrong.  Fixed.

+  const TemplateURL* keyword_url = providers_.GetKeywordProviderURL();
+  if (keyword_url == NULL)  // not in keyword mode -> say everything's okay
+    return true;
+  for (ACMatches::const_iterator it = matches_.begin(); it != matches_.end();
+       ++it) {
+    if ((it->keyword == keyword_url->keyword()) &&
+        it->allowed_to_be_default_match)
+      return true;
+  }
+  return false;
+}
+
 bool SearchProvider::IsTopMatchScoreTooLow(
     bool autocomplete_result_will_reorder_for_default_match) const {
   // In reorder mode, there's no such thing as a score that's too low.
   if (autocomplete_result_will_reorder_for_default_match)
     return false;
 
   // Here we use CalculateRelevanceForVerbatimIgnoringKeywordModeState()
   // rather than CalculateRelevanceForVerbatim() because the latter returns
   // a very low score (250) if keyword mode is active.  This is because
   // when keyword mode is active the user probably wants the keyword matches,
@@ skipping 28 matching lines @@
     if (it->allowed_to_be_default_match)
       return true;
     if (!autocomplete_result_will_reorder_for_default_match)
       return false;
   }
   return false;
 }
 
 void SearchProvider::UpdateMatches() {
   base::TimeTicks update_matches_start_time(base::TimeTicks::Now());
+  const TemplateURL* keyword_url = providers_.GetKeywordProviderURL();
   ConvertResultsToAutocompleteMatches();
 
+  // True if the omnibox will reorder matches as necessary to make the first
+  // one something that is allowed to be the default match.
+  const bool omnibox_will_reorder_for_legal_default_match =
+      OmniboxFieldTrial::ReorderForLegalDefaultMatch(
+          input_.current_page_classification());
+
   // Check constraints that may be violated by suggested relevances.
   if (!matches_.empty() &&
       (default_results_.HasServerProvidedScores() ||
        keyword_results_.HasServerProvidedScores())) {
     // These blocks attempt to repair undesirable behavior by suggested
     // relevances with minimal impact, preserving other suggested relevances.
 
-    // True if the omnibox will reorder matches as necessary to make the first
-    // one something that is allowed to be the default match.
-    const bool omnibox_will_reorder_for_legal_default_match =
-        OmniboxFieldTrial::ReorderForLegalDefaultMatch(
-            input_.current_page_classification());
-    if (IsTopMatchNavigationInKeywordMode(
-        omnibox_will_reorder_for_legal_default_match)) {
+    if ((keyword_url != NULL) &&
+        IsTopMatchNavigation(omnibox_will_reorder_for_legal_default_match)) {
       // Correct the suggested relevance scores if the top match is a
       // navigation in keyword mode, since inlining a navigation match
-      // would break the user out of keyword mode.  By the way, if the top
-      // match is a non-keyword match (query or navsuggestion) in keyword
-      // mode, the user would also break out of keyword mode.  However,
-      // that situation is impossible given the current scoring paradigm
-      // and the fact that only one search engine (Google) provides suggested
-      // relevance scores at this time.
+      // would break the user out of keyword mode.  We only need to do this
+      // correction in regular (non-reorder) mode; in reorder mode, we rely
+      // on the fact that navigation matches are marked as not allowed to be
+      // the default match.

[Peter Kasting, 2013/11/19 02:58:24]

This comment doesn't seem to match the code?  It looks like we make the
correction in reorder mode too (and check for it below in both modes).

[Mark P, 2013/11/20 19:05:52]

Clarified comment and added DCHECK.

       DemoteKeywordNavigationMatchesPastTopQuery();
       ConvertResultsToAutocompleteMatches();
-      DCHECK(!IsTopMatchNavigationInKeywordMode(
+      DCHECK(!IsTopMatchNavigation(
           omnibox_will_reorder_for_legal_default_match));
     }
+    if ((keyword_url != NULL) && !HasKeywordMatchThatCanBeDefault(
+        omnibox_will_reorder_for_legal_default_match)) {
+      // In keyword mode, disregard the keyword verbatim suggested relevance
+      // if necessary so there at least one keyword match that's allowed to
+      // be the default match.
+      keyword_results_.verbatim_relevance = -1;
+      ConvertResultsToAutocompleteMatches();
+    }
     if (IsTopMatchScoreTooLow(omnibox_will_reorder_for_legal_default_match)) {
       // Disregard the suggested verbatim relevance if the top score is below
       // the usual verbatim value. For example, a BarProvider may rely on
       // SearchProvider's verbatim or inlineable matches for input "foo" (all
       // allowed to be default match) to always outrank its own lowly-ranked
       // "bar" matches that shouldn't be the default match.
       default_results_.verbatim_relevance = -1;
       keyword_results_.verbatim_relevance = -1;
       ConvertResultsToAutocompleteMatches();
     }
@@ skipping 16 matching lines @@
       // match or inlinable).  For example, input "foo" should not invoke a
       // search for "bar", which would happen if the "bar" search match
       // outranked all other matches.  On the other hand, if the omnibox will
       // reorder matches as necessary to put a legal default match at the top,
       // all we need to guarantee is that SearchProvider returns a legal
       // default match.  (The omnibox always needs at least one legal default
       // match, and it relies on SearchProvider to always return one.)
       ApplyCalculatedRelevance();
       ConvertResultsToAutocompleteMatches();
     }
-    DCHECK(!IsTopMatchNavigationInKeywordMode(
+    DCHECK((keyword_url == NULL) ||
+        !IsTopMatchNavigation(omnibox_will_reorder_for_legal_default_match));
+    DCHECK((keyword_url == NULL) || HasKeywordMatchThatCanBeDefault(
         omnibox_will_reorder_for_legal_default_match));
     DCHECK(!IsTopMatchScoreTooLow(
         omnibox_will_reorder_for_legal_default_match));
     DCHECK(!IsTopMatchSearchWithURLInput(
         omnibox_will_reorder_for_legal_default_match));
     DCHECK(HasValidDefaultMatch(omnibox_will_reorder_for_legal_default_match));
   }
 
+  if ((keyword_url != NULL) && HasKeywordMatchThatCanBeDefault(
+      omnibox_will_reorder_for_legal_default_match)) {
+    // If there is a keyword match that is allowed to be the default match,
+    // then prohibit default provider matches from being the defaul match lest
+    // such matches cause the user to break out of keyword mode.
+    for (ACMatches::const_iterator keyword_match_it = matches_.begin();
+         keyword_match_it != matches_.end(); ++keyword_match_it) {
+      if (keyword_match_it->allowed_to_be_default_match &&
+          (keyword_match_it->keyword == keyword_url->keyword())) {

[Peter Kasting, 2013/11/19 02:58:24]

Nit: You know, if we had a functor that could compare match keywords against a
particular keyword, we could make this block be simpler by way of things like
std::find_if().

[Mark P, 2013/11/20 19:05:52]

I realized part of this block is redundant with
HasKeywordMatchThatCanBeDefault() so I simplified it.  Now the find_if doesn't
seem necessary here.  I thought about adding a functor for
HasKeywordMatchThatCanBeDefault() but it seemed heavy-handed--it would only get
used once, wouldn't save any net lines of code, and I'm not sure the net result
will be more readable.

+        // Found one such match.
+        for (ACMatches::iterator it = matches_.begin(); it != matches_.end();
+             ++it) {
+          if (it->keyword != keyword_url->keyword())
+            it->allowed_to_be_default_match = false;
+        }
+        break;
+      }
+    }
+  }
+
   base::TimeTicks update_starred_start_time(base::TimeTicks::Now());
   UpdateStarredStateOfMatches();
   UMA_HISTOGRAM_TIMES("Omnibox.SearchProvider.UpdateStarredTime",
                       base::TimeTicks::Now() - update_starred_start_time);
   UpdateDone();
   UMA_HISTOGRAM_TIMES("Omnibox.SearchProvider.UpdateMatchesTime",
                       base::TimeTicks::Now() - update_matches_start_time);
 }
 
 void SearchProvider::AddNavigationResultsToMatches(
@@ skipping 381 matching lines @@
   // Preserve the forced query '?' prefix in |match.fill_into_edit|.
   // Otherwise, user edits to a suggestion would show non-Search results.
   if (input_.type() == AutocompleteInput::FORCED_QUERY) {
     match.fill_into_edit.insert(0, ASCIIToUTF16("?"));
     if (inline_autocomplete_offset != string16::npos)
       ++inline_autocomplete_offset;
   }
   if (!input_.prevent_inline_autocomplete() &&
       (inline_autocomplete_offset != string16::npos)) {
     DCHECK(inline_autocomplete_offset <= match.fill_into_edit.length());
-    match.allowed_to_be_default_match = true;
+    // A navsuggestion can only be the default match when there is no
+    // keyword provider active lest it appear first and breaks the user

[Peter Kasting, 2013/11/19 02:58:24]

Nit: breaks -> break

Also probably add a comma after "active"

[Mark P, 2013/11/20 19:05:52]

Agree with both.  Done.

+    // out of keyword mode.
+    match.allowed_to_be_default_match =
+        (providers_.GetKeywordProviderURL() == NULL);
     match.inline_autocompletion =
         match.fill_into_edit.substr(inline_autocomplete_offset);
   }
 
   match.contents = net::FormatUrl(navigation.url(), languages,
       format_types, net::UnescapeRule::SPACES, NULL, NULL, &match_start);
   // If the first match in the untrimmed string was inside a scheme that we
   // trimmed, look for a subsequent match.
   if (match_start == string16::npos)
     match_start = match.contents.find(input);
@@ skipping 54 matching lines @@
     it->set_relevance(max_query_relevance);
     it->set_relevance_from_server(relevance_from_server);
   }
 }
 
 void SearchProvider::UpdateDone() {
   // We're done when the timer isn't running, there are no suggest queries
   // pending, and we're not waiting on Instant.
   done_ = !timer_.IsRunning() && (suggest_results_pending_ == 0);
 }