Include a page title in the Physical Web omnibox overflow item

components/omnibox/browser/physical_web_provider.cc

 // Copyright (c) 2016 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 "base/memory/ptr_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "components/omnibox/browser/autocomplete_provider_client.h"
 #include "components/omnibox/browser/autocomplete_provider_listener.h"
 #include "components/omnibox/browser/history_url_provider.h"
 #include "components/omnibox/browser/physical_web_provider.h"
 #include "components/omnibox/browser/verbatim_match.h"
 #include "components/physical_web/data_source/physical_web_data_source.h"
 #include "components/url_formatter/url_formatter.h"
 #include "grit/components_strings.h"
 #include "ui/base/l10n/l10n_util.h"
+#include "ui/gfx/text_elider.h"
 #include "url/gurl.h"
 
 namespace {
 
 // The maximum number of match results to provide. If the number of nearby URLs
 // exceeds this limit, an overflow item is created. Tapping the overflow item
 // navigates to a page with the full list of nearby URLs. The overflow item is
 // counted as a match result for the purposes of the match limit.
 //
 // ex: With kPhysicalWebMaxMatches == 1, there should be at most one suggestion
 // created by this provider. If there is a single nearby URL, then the
 // suggestion will be for that URL. If there are multiple nearby URLs, the
 // suggestion will be the overflow item which navigates to the WebUI when
 // tapped.
 static const size_t kPhysicalWebMaxMatches = 1;
 
 // Relevance score of the first Physical Web URL autocomplete match. This score
 // is intended to be between ClipboardURLProvider and ZeroSuggestProvider.
 // Subsequent matches should decrease in relevance to preserve the ordering
 // in the metadata list.
 static const int kPhysicalWebUrlBaseRelevance = 700;
 
+// The maximum length of the page title's part of the overflow item's
+// description. Longer titles will be truncated to this length. In a normal
+// Physical Web match item (non-overflow item) we allow the omnibox display to
+// truncate the title instead.
+static const size_t kMaxTitleLength = 15;

[Mark P, 2016/09/13 23:34:42]

Please put overflow in the name somewhere here.

[mattreynolds, 2016/09/14 19:04:41]

Done.

 }
 
 // static
 PhysicalWebProvider* PhysicalWebProvider::Create(
     AutocompleteProviderClient* client,
     HistoryURLProvider* history_url_provider) {
   return new PhysicalWebProvider(client, history_url_provider);
 }
 
 void PhysicalWebProvider::Start(const AutocompleteInput& input,
@@ skipping 61 matching lines @@
     std::string title_string;
     if (!metadata_item->GetString("resolvedUrl", &url_string) ||
         !metadata_item->GetString("title", &title_string)) {
       continue;
     }
 
     // Add match items with decreasing relevance to preserve the ordering in
     // the metadata list.
     int relevance = kPhysicalWebUrlBaseRelevance - used_slots;
 
+    base::string16 title =

[Mark P, 2016/09/13 23:34:43]

nit: This goes best right after line 120.

[mattreynolds, 2016/09/14 19:04:41]

Done.

+        AutocompleteMatch::SanitizeString(base::UTF8ToUTF16(title_string));
+
     // Append an overflow item if creating a match for each metadata item would
     // exceed the match limit.
     const size_t remaining_slots = kPhysicalWebMaxMatches - used_slots;
     const size_t remaining_metadata = metadata_count - i;
     if ((remaining_slots == 1) && (remaining_metadata > remaining_slots)) {
-      AppendOverflowItem(remaining_metadata, relevance);
+      AppendOverflowItem(remaining_metadata, relevance, title);
       return;
     }
 
     GURL url(url_string);
-    base::string16 title = base::UTF8ToUTF16(title_string);
 
     AutocompleteMatch match(this, relevance, false,
         AutocompleteMatchType::PHYSICAL_WEB);
     match.destination_url = url;
 
     // Physical Web results should omit http:// (but not https://) and never
     // appear bold.
     match.contents = url_formatter::FormatUrl(url,
         url_formatter::kFormatUrlOmitHTTP, net::UnescapeRule::SPACES,
         nullptr, nullptr, nullptr);
     match.contents_class.push_back(
         ACMatchClassification(0, ACMatchClassification::URL));
 
     match.fill_into_edit =
         AutocompleteInput::FormattedStringWithEquivalentMeaning(
             url, match.contents, client_->GetSchemeClassifier());
 
-    match.description = AutocompleteMatch::SanitizeString(title);
+    match.description = title;
     match.description_class.push_back(
         ACMatchClassification(0, ACMatchClassification::NONE));
 
     matches_.push_back(match);
     ++used_slots;
   }
 }
 
 void PhysicalWebProvider::AppendOverflowItem(int additional_url_count,
-                                             int relevance) {
+                                             int relevance,
+                                             const base::string16& title) {
   std::string url_string = "chrome://physical-web";
   GURL url(url_string);
 
   AutocompleteMatch match(this, relevance, false,
       AutocompleteMatchType::PHYSICAL_WEB_OVERFLOW);
   match.destination_url = url;
 
-  // Don't omit the chrome:// scheme when displaying the WebUI URL.
-  match.contents = url_formatter::FormatUrl(url,
-      url_formatter::kFormatUrlOmitNothing, net::UnescapeRule::SPACES,
-      nullptr, nullptr, nullptr);
+  base::string16 contents_title =
+      gfx::TruncateString(title, kMaxTitleLength, gfx::CHARACTER_BREAK);
+  base::string16 contents;

[Mark P, 2016/09/13 23:34:42]

nit: consider setting match.contents directly in the two passes rather than
using a temporary variable.

[mattreynolds, 2016/09/14 19:04:41]

Done.

+  if (contents_title.empty()) {
+    contents = l10n_util::GetPluralStringFUTF16(
+        IDS_PHYSICAL_WEB_OVERFLOW_EMPTY_TITLE, additional_url_count);
+  } else {
+    base::string16 contents_suffix = l10n_util::GetPluralStringFUTF16(
+        IDS_PHYSICAL_WEB_OVERFLOW, additional_url_count - 1);
+    contents = contents_title + base::UTF8ToUTF16(" ") + contents_suffix;
+  }
+
+  match.contents = contents;
   match.contents_class.push_back(
-      ACMatchClassification(0, ACMatchClassification::URL));
+      ACMatchClassification(0, ACMatchClassification::DIM));
 
   match.fill_into_edit =
       AutocompleteInput::FormattedStringWithEquivalentMeaning(
           url, match.contents, client_->GetSchemeClassifier());
 
-  match.description = l10n_util::GetPluralStringFUTF16(
-      IDS_PHYSICAL_WEB_OVERFLOW, additional_url_count);
+  match.description =
+      l10n_util::GetStringUTF16(IDS_PHYSICAL_WEB_OVERFLOW_DESCRIPTION);
   match.description_class.push_back(
       ACMatchClassification(0, ACMatchClassification::NONE));
 
   matches_.push_back(match);
 }