1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ui/webui/searchbox/searchbox_handler.h"
#include "base/base64.h"
#include "base/base64url.h"
#include "base/containers/contains.h"
#include "base/strings/utf_string_conversions.h"
#include "build/branding_buildflags.h"
#include "chrome/browser/autocomplete/chrome_autocomplete_scheme_classifier.h"
#include "chrome/browser/bookmarks/bookmark_model_factory.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/new_tab_page/new_tab_page_util.h"
#include "chrome/browser/preloading/prefetch/search_prefetch/search_prefetch_service.h"
#include "chrome/browser/preloading/prefetch/search_prefetch/search_prefetch_service_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/webui/metrics_reporter/metrics_reporter.h"
#include "chrome/common/pref_names.h"
#include "chrome/grit/generated_resources.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "components/omnibox/browser/omnibox_controller.h"
#include "components/omnibox/browser/omnibox_prefs.h"
#include "components/omnibox/browser/vector_icons.h"
#include "components/omnibox/common/omnibox_feature_configs.h"
#include "components/search/ntp_features.h"
#include "components/strings/grit/components_strings.h"
#include "components/variations/variations_client.h"
#include "components/vector_icons/vector_icons.h"
#include "content/public/browser/web_ui_data_source.h"
#include "third_party/omnibox_proto/answer_data.pb.h"
#include "third_party/omnibox_proto/answer_type.pb.h"
#include "third_party/omnibox_proto/rich_answer_template.pb.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/window_open_disposition_utils.h"
#include "ui/gfx/image/image.h"
namespace {
// TODO(niharm): convert back to constexpr char[] once feature is cleaned up
const char* kAnswerCurrencyIconResourceName =
"//resources/cr_components/searchbox/icons/currency.svg";
constexpr char kAnswerDefaultIconResourceName[] =
"//resources/cr_components/searchbox/icons/default.svg";
const char* kAnswerDictionaryIconResourceName =
"//resources/cr_components/searchbox/icons/definition.svg";
const char* kAnswerFinanceIconResourceName =
"//resources/cr_components/searchbox/icons/finance.svg";
const char* kAnswerSunriseIconResourceName =
"//resources/cr_components/searchbox/icons/sunrise.svg";
const char* kAnswerTranslationIconResourceName =
"//resources/cr_components/searchbox/icons/translation.svg";
const char* kAnswerWhenIsIconResourceName =
"//resources/cr_components/searchbox/icons/when_is.svg";
const char* kBookmarkIconResourceName = "//resources/images/icon_bookmark.svg";
const char* kCalculatorIconResourceName =
"//resources/cr_components/searchbox/icons/calculator.svg";
const char* kChromeProductIconResourceName =
"//resources/cr_components/searchbox/icons/chrome_product.svg";
const char* kClockIconResourceName = "//resources/images/icon_clock.svg";
const char* kDinoIconResourceName =
"//resources/cr_components/searchbox/icons/dino.svg";
constexpr char kDriveDocsIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_docs.svg";
constexpr char kDriveFolderIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_folder.svg";
constexpr char kDriveFormIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_form.svg";
constexpr char kDriveImageIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_image.svg";
constexpr char kDriveLogoIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_logo.svg";
constexpr char kDrivePdfIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_pdf.svg";
constexpr char kDriveSheetsIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_sheets.svg";
constexpr char kDriveSlidesIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_slides.svg";
constexpr char kDriveVideoIconResourceName[] =
"//resources/cr_components/searchbox/icons/drive_video.svg";
constexpr char kExtensionAppIconResourceName[] =
"//resources/cr_components/searchbox/icons/extension_app.svg";
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
constexpr char kGoogleCalendarIconResourceName[] =
"//resources/cr_components/searchbox/icons/calendar.svg";
const char* kGoogleGIconResourceName =
"//resources/cr_components/searchbox/icons/google_g.svg";
constexpr char kGoogleKeepNoteIconResourceName[] =
"//resources/cr_components/searchbox/icons/note.svg";
constexpr char kGoogleSitesIconResourceName[] =
"//resources/cr_components/searchbox/icons/sites.svg";
#endif
const char* kHistoryIconResourceName = "//resources/images/icon_history.svg";
const char* kIncognitoIconResourceName =
"//resources/cr_components/searchbox/icons/incognito.svg";
const char* kJourneysIconResourceName =
"//resources/cr_components/searchbox/icons/journeys.svg";
const char* kPageIconResourceName =
"//resources/cr_components/searchbox/icons/page.svg";
const char* kPageSparkIconResourceName =
"//resources/cr_components/searchbox/icons/page_spark.svg";
const char* kPedalsIconResourceName = "//theme/current-channel-logo";
const char* kSearchIconResourceName = "//resources/images/icon_search.svg";
const char* kSearchSparkIconResourceName =
"//resources/cr_components/searchbox/icons/search_spark.svg";
const char* kSparkIconResourceName =
"//resources/cr_components/searchbox/icons/spark.svg";
const char* kStarActiveIconResourceName =
"//resources/cr_components/searchbox/icons/star_active.svg";
const char* kTabIconResourceName =
"//resources/cr_components/searchbox/icons/tab.svg";
const char* kTrendingUpIconResourceName =
"//resources/cr_components/searchbox/icons/trending_up.svg";
#if BUILDFLAG(IS_MAC)
const char* kMacShareIconResourceName =
"//resources/cr_components/searchbox/icons/mac_share.svg";
#elif BUILDFLAG(IS_WIN)
const char* kWinShareIconResourceName =
"//resources/cr_components/searchbox/icons/win_share.svg";
#elif BUILDFLAG(IS_LINUX)
const char* kLinuxShareIconResourceName =
"//resources/cr_components/searchbox/icons/share.svg";
#else
const char* kShareIconResourceName =
"//resources/cr_components/searchbox/icons/share.svg";
#endif
static void DefineChromeRefreshRealboxIcons() {
kAnswerCurrencyIconResourceName =
"//resources/cr_components/searchbox/icons/currency_cr23.svg";
kAnswerDictionaryIconResourceName =
"//resources/cr_components/searchbox/icons/definition_cr23.svg";
kAnswerFinanceIconResourceName =
"//resources/cr_components/searchbox/icons/finance_cr23.svg";
kAnswerSunriseIconResourceName =
"//resources/cr_components/searchbox/icons/sunrise_cr23.svg";
kAnswerTranslationIconResourceName =
"//resources/cr_components/searchbox/icons/translation_cr23.svg";
kAnswerWhenIsIconResourceName =
"//resources/cr_components/searchbox/icons/when_is_cr23.svg";
kBookmarkIconResourceName =
"//resources/cr_components/searchbox/icons/bookmark_cr23.svg";
kCalculatorIconResourceName =
"//resources/cr_components/searchbox/icons/calculator_cr23.svg";
kChromeProductIconResourceName =
"//resources/cr_components/searchbox/icons/chrome_product_cr23.svg";
kClockIconResourceName =
"//resources/cr_components/searchbox/icons/clock_cr23.svg";
kDinoIconResourceName =
"//resources/cr_components/searchbox/icons/dino_cr23.svg";
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
kGoogleGIconResourceName =
"//resources/cr_components/searchbox/icons/google_g_cr23.svg";
#endif
kHistoryIconResourceName =
"//resources/cr_components/searchbox/icons/history_cr23.svg";
kIncognitoIconResourceName =
"//resources/cr_components/searchbox/icons/incognito_cr23.svg";
kJourneysIconResourceName =
"//resources/cr_components/searchbox/icons/journeys_cr23.svg";
kPageIconResourceName =
"//resources/cr_components/searchbox/icons/page_cr23.svg";
kPedalsIconResourceName =
"//resources/cr_components/searchbox/icons/chrome_product_cr23.svg";
kSearchIconResourceName =
"//resources/cr_components/searchbox/icons/search_cr23.svg";
kTabIconResourceName =
"//resources/cr_components/searchbox/icons/tab_cr23.svg";
kTrendingUpIconResourceName =
"//resources/cr_components/searchbox/icons/trending_up_cr23.svg";
#if BUILDFLAG(IS_MAC)
kMacShareIconResourceName =
"//resources/cr_components/searchbox/icons/mac_share_cr23.svg";
#elif BUILDFLAG(IS_WIN)
kWinShareIconResourceName =
"//resources/cr_components/searchbox/icons/win_share_cr23.svg";
#elif BUILDFLAG(IS_LINUX)
kLinuxShareIconResourceName =
"//resources/cr_components/searchbox/icons/share_cr23.svg";
#else
kShareIconResourceName =
"//resources/cr_components/searchbox/icons/share_cr23.svg";
#endif
}
std::u16string GetAdditionalA11yMessage(
const AutocompleteMatch& match,
searchbox::mojom::SelectionLineState state) {
switch (state) {
case searchbox::mojom::SelectionLineState::kNormal: {
if (match.has_tab_match.value_or(false)) {
return l10n_util::GetStringUTF16(IDS_ACC_TAB_SWITCH_SUFFIX);
}
const OmniboxAction* action = match.GetActionAt(0u);
if (action) {
return action->GetLabelStrings().accessibility_suffix;
}
if (match.SupportsDeletion()) {
return l10n_util::GetStringUTF16(IDS_ACC_REMOVE_SUGGESTION_SUFFIX);
}
break;
}
case searchbox::mojom::SelectionLineState::kFocusedButtonRemoveSuggestion:
return l10n_util::GetStringUTF16(
IDS_ACC_REMOVE_SUGGESTION_FOCUSED_PREFIX);
default:
NOTREACHED();
}
return std::u16string();
}
bool MatchHasSideTypeAndRenderType(
const AutocompleteMatch& match,
omnibox::GroupConfig_SideType side_type,
omnibox::GroupConfig_RenderType render_type,
const omnibox::GroupConfigMap& suggestion_groups_map) {
omnibox::GroupId group_id =
match.suggestion_group_id.value_or(omnibox::GROUP_INVALID);
return base::Contains(suggestion_groups_map, group_id) &&
suggestion_groups_map.at(group_id).side_type() == side_type &&
suggestion_groups_map.at(group_id).render_type() == render_type;
}
std::vector<searchbox::mojom::AutocompleteMatchPtr> CreateAutocompleteMatches(
const AutocompleteResult& result,
const OmniboxEditModel* edit_model,
bookmarks::BookmarkModel* bookmark_model,
const omnibox::GroupConfigMap& suggestion_groups_map,
const TemplateURLService* turl_service) {
std::vector<searchbox::mojom::AutocompleteMatchPtr> matches;
int line = 0;
for (const AutocompleteMatch& match : result) {
// Skip the primary column horizontal matches. This check guards against
// this unexpected scenario as the UI expects the primary column matches to
// be vertical ones.
if (MatchHasSideTypeAndRenderType(
match, omnibox::GroupConfig_SideType_DEFAULT_PRIMARY,
omnibox::GroupConfig_RenderType_HORIZONTAL,
suggestion_groups_map)) {
continue;
}
// Skip the secondary column horizontal matches that are not entities or do
// not have images. This check guards against this unexpected scenario as
// the UI expects the secondary column horizontal matches to be entity
// suggestions with images.
if (MatchHasSideTypeAndRenderType(
match, omnibox::GroupConfig_SideType_SECONDARY,
omnibox::GroupConfig_RenderType_HORIZONTAL,
suggestion_groups_map) &&
(match.type != AutocompleteMatchType::SEARCH_SUGGEST_ENTITY ||
!match.image_url.is_valid())) {
continue;
}
searchbox::mojom::AutocompleteMatchPtr mojom_match =
searchbox::mojom::AutocompleteMatch::New();
mojom_match->allowed_to_be_default_match =
match.allowed_to_be_default_match;
mojom_match->contents = match.contents;
for (const auto& contents_class : match.contents_class) {
mojom_match->contents_class.push_back(
searchbox::mojom::ACMatchClassification::New(contents_class.offset,
contents_class.style));
}
mojom_match->description = match.description;
for (const auto& description_class : match.description_class) {
mojom_match->description_class.push_back(
searchbox::mojom::ACMatchClassification::New(
description_class.offset, description_class.style));
}
mojom_match->destination_url = match.destination_url;
mojom_match->suggestion_group_id =
match.suggestion_group_id.value_or(omnibox::GROUP_INVALID);
const bool is_bookmarked =
bookmark_model->IsBookmarked(match.destination_url);
// For starter pack suggestions, use template url to generate proper vector
// icon.
const TemplateURL* turl = match.associated_keyword
? turl_service->GetTemplateURLForKeyword(
match.associated_keyword->keyword)
: nullptr;
mojom_match->icon_path =
SearchboxHandler::AutocompleteMatchVectorIconToResourceName(
match.GetVectorIcon(is_bookmarked, turl));
mojom_match->icon_url = match.icon_url.spec();
mojom_match->image_dominant_color = match.image_dominant_color;
mojom_match->image_url = match.image_url.spec();
mojom_match->fill_into_edit = match.fill_into_edit;
mojom_match->inline_autocompletion = match.inline_autocompletion;
mojom_match->is_search_type = AutocompleteMatch::IsSearchType(match.type);
mojom_match->is_enterprise_search_aggregator_people_type =
match.enterprise_search_aggregator_type ==
AutocompleteMatch::EnterpriseSearchAggregatorType::PEOPLE;
mojom_match->swap_contents_and_description =
match.swap_contents_and_description;
mojom_match->type = AutocompleteMatchType::ToString(match.type);
mojom_match->supports_deletion = match.SupportsDeletion();
if (match.answer_template.has_value()) {
const omnibox::AnswerData& answer_data =
match.answer_template->answers(0);
const omnibox::FormattedString& headline = answer_data.headline();
std::u16string headline_substr;
if (headline.fragments_size() > 0) {
const std::string& headline_text = headline.text();
// Grab the substring of headline starting after the first fragment text
// ends. Not making use of the first fragment because it contains the
// same data as `match.contents` but with HTML tags.
headline_substr = base::UTF8ToUTF16(headline_text.substr(
headline.fragments(0).text().size(),
headline_text.size() - headline.fragments(0).text().size()));
}
const auto& subhead_text =
base::UTF8ToUTF16(answer_data.subhead().text());
// Reusing SuggestionAnswer because `headline` and `subhead` are
// equivalent to `first_line` and `second_line`.
mojom_match->answer = searchbox::mojom::SuggestionAnswer::New(
headline_substr.empty()
? match.contents
: base::JoinString({match.contents, headline_substr}, u" "),
subhead_text);
mojom_match->image_url = answer_data.image().url();
mojom_match->is_weather_answer_suggestion =
match.answer_type == omnibox::ANSWER_TYPE_WEATHER;
}
mojom_match->is_rich_suggestion =
!mojom_match->image_url.empty() ||
match.type == AutocompleteMatchType::CALCULATOR ||
match.answer_type != omnibox::ANSWER_TYPE_UNSPECIFIED ||
match.enterprise_search_aggregator_type ==
AutocompleteMatch::EnterpriseSearchAggregatorType::PEOPLE;
for (const auto& action : match.actions) {
std::string icon_path;
if (action->GetIconImage().IsEmpty()) {
icon_path = SearchboxHandler::ActionVectorIconToResourceName(
action->GetVectorIcon());
} else {
icon_path = webui::GetBitmapDataUrl(action->GetIconImage().AsBitmap());
}
const OmniboxAction::LabelStrings& label_strings =
action->GetLabelStrings();
mojom_match->actions.emplace_back(searchbox::mojom::Action::New(
label_strings.accessibility_hint, label_strings.hint,
label_strings.suggestion_contents, icon_path));
}
std::u16string header_text =
edit_model->GetSuggestionGroupHeaderText(match.suggestion_group_id);
mojom_match->a11y_label = AutocompleteMatchType::ToAccessibilityLabel(
match, header_text, match.contents, line, 0,
GetAdditionalA11yMessage(
match, searchbox::mojom::SelectionLineState::kNormal));
mojom_match->remove_button_a11y_label =
AutocompleteMatchType::ToAccessibilityLabel(
match, header_text, match.contents, line, 0,
GetAdditionalA11yMessage(match,
searchbox::mojom::SelectionLineState::
kFocusedButtonRemoveSuggestion));
mojom_match->tail_suggest_common_prefix = match.tail_suggest_common_prefix;
matches.push_back(std::move(mojom_match));
line++;
}
return matches;
}
std::string GetBase64UrlVariations(Profile* profile) {
variations::VariationsClient* provider = profile->GetVariationsClient();
variations::mojom::VariationsHeadersPtr headers =
provider->GetVariationsHeaders();
if (headers.is_null()) {
return std::string();
}
const std::string variations_base64 = headers->headers_map.at(
variations::mojom::GoogleWebVisibility::FIRST_PARTY);
// Variations headers are base64 encoded, however, we're attaching the value
// to a URL query parameter so they need to be base64url encoded.
std::string variations_decoded;
base::Base64Decode(variations_base64, &variations_decoded);
std::string variations_base64url;
base::Base64UrlEncode(variations_decoded,
base::Base64UrlEncodePolicy::OMIT_PADDING,
&variations_base64url);
return variations_base64url;
}
base::flat_map<int32_t, searchbox::mojom::SuggestionGroupPtr>
CreateSuggestionGroupsMap(
const AutocompleteResult& result,
const PrefService* prefs,
const omnibox::GroupConfigMap& suggestion_groups_map) {
base::flat_map<int32_t, searchbox::mojom::SuggestionGroupPtr> result_map;
for (const auto& pair : suggestion_groups_map) {
searchbox::mojom::SuggestionGroupPtr suggestion_group =
searchbox::mojom::SuggestionGroup::New();
suggestion_group->header = base::UTF8ToUTF16(pair.second.header_text());
suggestion_group->side_type =
static_cast<searchbox::mojom::SideType>(pair.second.side_type());
suggestion_group->render_type =
static_cast<searchbox::mojom::RenderType>(pair.second.render_type());
result_map.emplace(static_cast<int>(pair.first),
std::move(suggestion_group));
}
return result_map;
}
searchbox::mojom::AutocompleteResultPtr CreateAutocompleteResult(
const std::u16string& input,
const AutocompleteResult& result,
const OmniboxEditModel* edit_model,
bookmarks::BookmarkModel* bookmark_model,
const PrefService* prefs,
const TemplateURLService* turl_service) {
return searchbox::mojom::AutocompleteResult::New(
input,
CreateSuggestionGroupsMap(result, prefs, result.suggestion_groups_map()),
CreateAutocompleteMatches(result, edit_model, bookmark_model,
result.suggestion_groups_map(), turl_service));
}
} // namespace
// static
void SearchboxHandler::SetupWebUIDataSource(content::WebUIDataSource* source,
Profile* profile,
bool enable_voice_search,
bool enable_lens_search) {
// Embedders which are served from chrome-untrusted:// URLs should override
// this to false. The chrome.timeTicks capability that the metrics reporter
// depends on is not defined in chrome-untrusted environments and attempting
// to use it will lead to a renderer process crash. See
// http://g/chrome-webui/haW6I9yt-uA/38ckX-aGAgAJ for details.
source->AddBoolean("reportMetrics", true);
// The lens searchboxes overrides this to true to adjust various color and
// layout options.
source->AddBoolean("isLensSearchbox", false);
source->AddBoolean("queryAutocompleteOnEmptyInput", false);
source->AddBoolean("forceHideEllipsis", false);
source->AddBoolean("enableThumbnailSizingTweaks", false);
source->AddBoolean("enableCsbMotionTweaks", false);
static constexpr webui::LocalizedString kStrings[] = {
{"lensSearchButtonLabel", IDS_TOOLTIP_LENS_SEARCH},
{"searchboxSeparator", IDS_AUTOCOMPLETE_MATCH_DESCRIPTION_SEPARATOR},
{"removeSuggestion", IDS_OMNIBOX_REMOVE_SUGGESTION},
{"searchBoxHint", IDS_GOOGLE_SEARCH_BOX_EMPTY_HINT_MD},
{"searchBoxHintMultimodal", IDS_GOOGLE_SEARCH_BOX_EMPTY_HINT_MULTIMODAL},
{"searchboxThumbnailLabel",
IDS_GOOGLE_SEARCH_BOX_MULTIMODAL_IMAGE_THUMBNAIL},
{"voiceSearchButtonLabel", IDS_TOOLTIP_MIC_SEARCH},
{"searchboxComposeButtonText", IDS_NTP_COMPOSE_ENTRYPOINT}};
source->AddLocalizedStrings(kStrings);
source->AddBoolean(
"searchboxMatchSearchboxTheme",
base::FeatureList::IsEnabled(ntp_features::kRealboxMatchSearchboxTheme));
DefineChromeRefreshRealboxIcons();
source->AddString(
"searchboxDefaultIcon",
base::FeatureList::IsEnabled(ntp_features::kRealboxUseGoogleGIcon)
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
? kGoogleGIconResourceName
#else
? kSearchIconResourceName
#endif
: kSearchIconResourceName);
source->AddBoolean("searchboxVoiceSearch", enable_voice_search);
source->AddBoolean("searchboxLensSearch", enable_lens_search);
source->AddString("searchboxLensVariations", GetBase64UrlVariations(profile));
source->AddBoolean(
"searchboxCr23Theming",
base::FeatureList::IsEnabled(ntp_features::kRealboxCr23Theming));
source->AddBoolean("searchboxCr23SteadyStateShadow",
ntp_features::kNtpRealboxCr23SteadyStateShadow.Get());
source->AddBoolean("searchboxShowComposeAnimation",
profile->GetPrefs()->GetInteger(
prefs::kNtpComposeButtonShownCountPrefName) < 3);
}
// static
std::string SearchboxHandler::AutocompleteMatchVectorIconToResourceName(
const gfx::VectorIcon& icon) {
if (icon.name == omnibox::kAnswerCurrencyIcon.name ||
icon.name == omnibox::kAnswerCurrencyChromeRefreshIcon.name) {
return kAnswerCurrencyIconResourceName;
} else if (icon.name == omnibox::kAnswerDefaultIcon.name) {
return kAnswerDefaultIconResourceName;
} else if (icon.name == omnibox::kAnswerDictionaryIcon.name ||
icon.name == omnibox::kAnswerDictionaryChromeRefreshIcon.name) {
return kAnswerDictionaryIconResourceName;
} else if (icon.name == omnibox::kAnswerFinanceIcon.name ||
icon.name == omnibox::kAnswerFinanceChromeRefreshIcon.name) {
return kAnswerFinanceIconResourceName;
} else if (icon.name == omnibox::kAnswerSunriseIcon.name ||
icon.name == omnibox::kAnswerSunriseChromeRefreshIcon.name) {
return kAnswerSunriseIconResourceName;
} else if (icon.name == omnibox::kAnswerTranslationIcon.name ||
icon.name == omnibox::kAnswerTranslationChromeRefreshIcon.name) {
return kAnswerTranslationIconResourceName;
} else if (icon.name == omnibox::kAnswerWhenIsIcon.name ||
icon.name == omnibox::kAnswerWhenIsChromeRefreshIcon.name) {
return kAnswerWhenIsIconResourceName;
} else if (icon.name == omnibox::kBookmarkIcon.name ||
icon.name == omnibox::kBookmarkChromeRefreshIcon.name) {
return kBookmarkIconResourceName;
} else if (icon.name == omnibox::kCalculatorIcon.name ||
icon.name == omnibox::kCalculatorChromeRefreshIcon.name) {
return kCalculatorIconResourceName;
} else if (icon.name == omnibox::kClockIcon.name ||
icon.name == omnibox::kClockChromeRefreshIcon.name) {
return kClockIconResourceName;
} else if (icon.name == omnibox::kDriveDocsIcon.name) {
return kDriveDocsIconResourceName;
} else if (icon.name == omnibox::kDriveFolderIcon.name) {
return kDriveFolderIconResourceName;
} else if (icon.name == omnibox::kDriveFormsIcon.name) {
return kDriveFormIconResourceName;
} else if (icon.name == omnibox::kDriveImageIcon.name) {
return kDriveImageIconResourceName;
} else if (icon.name == omnibox::kDriveLogoIcon.name) {
return kDriveLogoIconResourceName;
} else if (icon.name == omnibox::kDrivePdfIcon.name) {
return kDrivePdfIconResourceName;
} else if (icon.name == omnibox::kDriveSheetsIcon.name) {
return kDriveSheetsIconResourceName;
} else if (icon.name == omnibox::kDriveSlidesIcon.name) {
return kDriveSlidesIconResourceName;
} else if (icon.name == omnibox::kDriveVideoIcon.name) {
return kDriveVideoIconResourceName;
} else if (icon.name == omnibox::kExtensionAppIcon.name) {
return kExtensionAppIconResourceName;
} else if (icon.name == vector_icons::kHistoryIcon.name ||
icon.name == vector_icons::kHistoryChromeRefreshIcon.name) {
return kHistoryIconResourceName;
} else if (icon.name == omnibox::kJourneysIcon.name ||
icon.name == omnibox::kJourneysChromeRefreshIcon.name) {
return kJourneysIconResourceName;
} else if (icon.name == omnibox::kPageIcon.name ||
icon.name == omnibox::kPageChromeRefreshIcon.name) {
return kPageIconResourceName;
} else if (icon.name == omnibox::kProductIcon.name ||
icon.name == omnibox::kProductChromeRefreshIcon.name) {
return kChromeProductIconResourceName;
} else if (icon.name == vector_icons::kSearchIcon.name ||
icon.name == vector_icons::kSearchChromeRefreshIcon.name) {
return kSearchIconResourceName;
} else if (icon.name == omnibox::kTrendingUpIcon.name ||
icon.name == omnibox::kTrendingUpChromeRefreshIcon.name) {
return kTrendingUpIconResourceName;
} else if (icon.is_empty()) {
return ""; // An empty resource name is effectively a blank icon.
} else {
return ActionVectorIconToResourceName(icon);
}
}
// static
std::string SearchboxHandler::ActionVectorIconToResourceName(
const gfx::VectorIcon& icon) {
if (icon.name == omnibox::kSwitchIcon.name ||
icon.name == omnibox::kSwitchCr2023Icon.name) {
return kTabIconResourceName;
}
if (icon.name == omnibox::kDinoIcon.name ||
icon.name == omnibox::kDinoCr2023Icon.name) {
return kDinoIconResourceName;
}
if (icon.name == omnibox::kDriveFormsIcon.name) {
return kDriveFormIconResourceName;
}
if (icon.name == omnibox::kDriveDocsIcon.name) {
return kDriveDocsIconResourceName;
}
if (icon.name == omnibox::kDriveSheetsIcon.name) {
return kDriveSheetsIconResourceName;
}
if (icon.name == omnibox::kDriveSlidesIcon.name) {
return kDriveSlidesIconResourceName;
}
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
if (icon.name == vector_icons::kGoogleCalendarIcon.name) {
return kGoogleCalendarIconResourceName;
}
if (icon.name == vector_icons::kGoogleKeepNoteIcon.name) {
return kGoogleKeepNoteIconResourceName;
}
if (icon.name == vector_icons::kGoogleSitesIcon.name) {
return kGoogleSitesIconResourceName;
}
if (icon.name == vector_icons::kGoogleSuperGIcon.name ||
icon.name == vector_icons::kGoogleGLogoMonochromeIcon.name) {
return kGoogleGIconResourceName;
}
#endif
if (icon.name == omnibox::kIncognitoIcon.name ||
icon.name == omnibox::kIncognitoCr2023Icon.name) {
return kIncognitoIconResourceName;
}
if (icon.name == omnibox::kJourneysIcon.name ||
icon.name == omnibox::kJourneysChromeRefreshIcon.name) {
return kJourneysIconResourceName;
}
if (icon.name == omnibox::kPageSparkIcon.name) {
return kPageSparkIconResourceName;
}
if (icon.name == omnibox::kPedalIcon.name ||
icon.name == omnibox::kProductChromeRefreshIcon.name) {
return kPedalsIconResourceName;
}
#if BUILDFLAG(IS_MAC)
if (icon.name == omnibox::kShareMacIcon.name ||
icon.name == omnibox::kShareMacChromeRefreshIcon.name) {
return kMacShareIconResourceName;
}
#elif BUILDFLAG(IS_WIN)
if (icon.name == omnibox::kShareWinIcon.name ||
icon.name == omnibox::kShareWinChromeRefreshIcon.name) {
return kWinShareIconResourceName;
}
#elif BUILDFLAG(IS_LINUX)
if (icon.name == omnibox::kShareIcon.name ||
icon.name == omnibox::kShareLinuxChromeRefreshIcon.name) {
return kLinuxShareIconResourceName;
}
#else
if (icon.name == omnibox::kShareIcon.name ||
icon.name == omnibox::kShareChromeRefreshIcon.name) {
return kShareIconResourceName;
}
#endif
if (icon.name == omnibox::kSearchSparkIcon.name) {
return kSearchSparkIconResourceName;
}
if (icon.name == omnibox::kSparkIcon.name) {
return kSparkIconResourceName;
}
if (icon.name == omnibox::kStarActiveIcon.name ||
icon.name == omnibox::kStarActiveChromeRefreshIcon.name) {
return kStarActiveIconResourceName;
}
if (icon.name == omnibox::kSubdirectoryArrowRightIcon.name) {
// The subdirectory arrow right icon is used for contextual suggestions only
// in the omnibox. It is not supported in the WebUI contextual searchbox,
// so use the search icon instead.
// TODO(crbug.com/419077032): Allow the derived class to override these
// icons so that there is not conditional logic based on one derived class.
return kSearchIconResourceName;
}
NOTREACHED() << "Every vector icon returned by OmniboxAction::GetVectorIcon "
"must have an equivalent SVG resource for the NTP Realbox. "
"icon.name: '"
<< icon.name << "'";
}
SearchboxHandler::SearchboxHandler(
mojo::PendingReceiver<searchbox::mojom::PageHandler> pending_page_handler,
Profile* profile,
content::WebContents* web_contents,
MetricsReporter* metrics_reporter)
: profile_(profile),
web_contents_(web_contents),
metrics_reporter_(metrics_reporter),
page_set_(false),
page_handler_(this, std::move(pending_page_handler)) {}
SearchboxHandler::~SearchboxHandler() {
// Avoids dangling pointer warning when `controller_` is not owned.
controller_ = nullptr;
}
bool SearchboxHandler::IsRemoteBound() const {
return page_set_;
}
void SearchboxHandler::SetPage(
mojo::PendingRemote<searchbox::mojom::Page> pending_page) {
page_.Bind(std::move(pending_page));
page_set_ = page_.is_bound();
}
void SearchboxHandler::OnFocusChanged(bool focused) {
if (focused) {
edit_model()->OnSetFocus(false);
} else {
edit_model()->OnWillKillFocus();
edit_model()->OnKillFocus();
}
}
void SearchboxHandler::QueryAutocomplete(const std::u16string& input,
bool prevent_inline_autocomplete) {
// TODO(tommycli): We use the input being empty as a signal we are requesting
// on-focus suggestions. It would be nice if we had a more explicit signal.
bool is_on_focus = input.empty();
// Early exit if a query is already in progress for on focus inputs.
if (!autocomplete_controller()->done() && is_on_focus) {
return;
}
// This will SetInputInProgress and consequently mark the input timer so that
// Omnibox.TypingDuration will be logged correctly.
edit_model()->SetUserText(input);
// RealboxOmniboxClient::GetPageClassification() ignores the arguments.
const auto page_classification =
omnibox_controller()->client()->GetPageClassification(
/*is_prefetch=*/false);
AutocompleteInput autocomplete_input(
input, page_classification, ChromeAutocompleteSchemeClassifier(profile_));
autocomplete_input.set_current_url(controller_->client()->GetURL());
autocomplete_input.set_focus_type(
is_on_focus ? metrics::OmniboxFocusType::INTERACTION_FOCUS
: metrics::OmniboxFocusType::INTERACTION_DEFAULT);
autocomplete_input.set_prevent_inline_autocomplete(
prevent_inline_autocomplete);
// Disable keyword matches as NTP realbox has no UI affordance for it.
autocomplete_input.set_prefer_keyword(false);
autocomplete_input.set_allow_exact_keyword_match(false);
// Set the lens overlay suggest inputs, if available.
if (std::optional<lens::proto::LensOverlaySuggestInputs> suggest_inputs =
controller_->client()->GetLensOverlaySuggestInputs()) {
autocomplete_input.set_lens_overlay_suggest_inputs(*suggest_inputs);
}
edit_model()->SetAutocompleteInput(autocomplete_input);
omnibox_controller()->StartAutocomplete(autocomplete_input);
}
void SearchboxHandler::StopAutocomplete(bool clear_result) {
omnibox_controller()->StopAutocomplete(clear_result);
}
void SearchboxHandler::OpenAutocompleteMatch(uint8_t line,
const GURL& url,
bool are_matches_showing,
uint8_t mouse_button,
bool alt_key,
bool ctrl_key,
bool meta_key,
bool shift_key) {
const AutocompleteMatch* match = GetMatchWithUrl(line, url);
if (!match) {
// This can happen due to asynchronous updates changing the result while
// the web UI is referencing a stale match.
return;
}
const base::TimeTicks timestamp = base::TimeTicks::Now();
const WindowOpenDisposition disposition = ui::DispositionFromClick(
/*middle_button=*/mouse_button == 1, alt_key, ctrl_key, meta_key,
shift_key);
edit_model()->OpenSelection(OmniboxPopupSelection(line), timestamp,
disposition);
}
void SearchboxHandler::OnNavigationLikely(
uint8_t line,
const GURL& url,
omnibox::mojom::NavigationPredictor navigation_predictor) {
const AutocompleteMatch* match = GetMatchWithUrl(line, url);
if (!match) {
// This can happen due to asynchronous updates changing the result while
// the web UI is referencing a stale match.
return;
}
if (auto* search_prefetch_service =
SearchPrefetchServiceFactory::GetForProfile(profile_)) {
search_prefetch_service->OnNavigationLikely(
line, *match, navigation_predictor, web_contents_);
}
}
void SearchboxHandler::OnResultChanged(AutocompleteController* controller,
bool default_match_changed) {
if (metrics_reporter_ && !metrics_reporter_->HasLocalMark("ResultChanged")) {
metrics_reporter_->Mark("ResultChanged");
}
page_->AutocompleteResultChanged(CreateAutocompleteResult(
autocomplete_controller()->input().text(),
autocomplete_controller()->result(), edit_model(),
BookmarkModelFactory::GetForBrowserContext(profile_),
profile_->GetPrefs(),
omnibox_controller()->client()->GetTemplateURLService()));
// The owned OmniboxController does not observe the AutocompleteController.
// Notify the prerender here to start preloading if the results are ready.
// TODO(crbug.com/40062053): Make the owned OmniboxController observe the
// AutocompleteController and move this logic to the RealboxOmniboxClient.
if (owned_controller_) {
if (autocomplete_controller()->done()) {
if (SearchPrefetchService* search_prefetch_service =
SearchPrefetchServiceFactory::GetForProfile(profile_)) {
search_prefetch_service->OnResultChanged(
web_contents_, autocomplete_controller()->result());
}
}
}
}
const AutocompleteMatch* SearchboxHandler::GetMatchWithUrl(size_t index,
const GURL& url) {
const AutocompleteResult& result = autocomplete_controller()->result();
if (index >= result.size()) {
// This can happen due to asynchronous updates changing the result while
// the web UI is referencing a stale match.
return nullptr;
}
const AutocompleteMatch& match = result.match_at(index);
if (match.destination_url != url) {
// This can happen also, for the same reason. We could search the result
// for the match with this URL, but there would be no guarantee that it's
// the same match, so for this edge case we treat result mismatch as none.
return nullptr;
}
return &match;
}
OmniboxController* SearchboxHandler::omnibox_controller() const {
return controller_;
}
AutocompleteController* SearchboxHandler::autocomplete_controller() const {
return omnibox_controller()->autocomplete_controller();
}
OmniboxEditModel* SearchboxHandler::edit_model() const {
return omnibox_controller()->edit_model();
}
|