autocomplete_controller.cc

/* Copyright (c) 2020 The Brave Authors. All rights reserved.
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "components/omnibox/browser/autocomplete_controller.h"

#include <algorithm>
#include <memory>
#include <vector>

#include "base/memory/scoped_refptr.h"
#include "base/strings/string_util.h"
#include "brave/components/ai_chat/core/browser/utils.h"
#include "brave/components/brave_search_conversion/utils.h"
#include "brave/components/commander/common/buildflags/buildflags.h"
#include "brave/components/omnibox/browser/brave_bookmark_provider.h"
#include "brave/components/omnibox/browser/brave_history_quick_provider.h"
#include "brave/components/omnibox/browser/brave_history_url_provider.h"
#include "brave/components/omnibox/browser/brave_local_history_zero_suggest_provider.h"
#include "brave/components/omnibox/browser/brave_on_device_head_provider.h"
#include "brave/components/omnibox/browser/brave_search_provider.h"
#include "brave/components/omnibox/browser/brave_shortcuts_provider.h"
#include "brave/components/omnibox/browser/leo_provider.h"
#include "brave/components/omnibox/browser/promotion_provider.h"
#include "brave/components/omnibox/browser/promotion_utils.h"
#include "brave/components/omnibox/browser/topsites_provider.h"
#include "components/omnibox/browser/autocomplete_input.h"
#include "components/omnibox/browser/autocomplete_match.h"
#include "components/omnibox/browser/calculator_provider.h"
#include "components/omnibox/browser/clipboard_provider.h"
#include "components/omnibox/browser/history_cluster_provider.h"
#include "components/omnibox/browser/history_fuzzy_provider.h"

#if BUILDFLAG(ENABLE_COMMANDER)
#include "brave/components/commander/common/buildflags/buildflags.h"
#include "brave/components/commander/common/constants.h"
#include "brave/components/commander/common/features.h"
#include "brave/components/omnibox/browser/commander_provider.h"
#endif

using brave_search_conversion::IsBraveSearchConversionFeatureEnabled;

namespace {
// If this input has triggered the commander then only show commander results.
void MaybeShowCommands(AutocompleteResult* result,
                       const AutocompleteInput& input) {
#if BUILDFLAG(ENABLE_COMMANDER)
  // If this input isn't a command, return and don't do any work.
  if (!base::FeatureList::IsEnabled(features::kBraveCommander) ||
      !input.text().starts_with(commander::kCommandPrefix)) {
    return;
  }

  // At this point all commands are moved to the top, and everything else is
  // discarded.
  result->RemoveAllMatchesNotOfType(AutocompleteProvider::TYPE_BRAVE_COMMANDER);
#endif
}

void MaybeAddCommanderProvider(AutocompleteController::Providers& providers,
                               AutocompleteController* controller) {
#if BUILDFLAG(ENABLE_COMMANDER)
  if (base::FeatureList::IsEnabled(features::kBraveCommander)) {
    providers.push_back(base::MakeRefCounted<commander::CommanderProvider>(
        controller->autocomplete_provider_client(), controller));
  }
#endif
}

void MaybeAddLeoProvider(AutocompleteController::Providers& providers,
                         AutocompleteController* controller) {
  auto* provider_client = controller->autocomplete_provider_client();
  // TestOmniboxClient has null prefs getter
  auto* prefs = provider_client->GetPrefs();
  if (prefs && ai_chat::IsAIChatEnabled(prefs) &&
      !provider_client->IsOffTheRecord()) {
    providers.push_back(base::MakeRefCounted<LeoProvider>(provider_client));
  }
}

void MaybeShowLeoMatch(AutocompleteResult* result) {
  DCHECK(result);

  // Regardless of the relevance score, we want to show the Leo match at the
  // bottom. But could be followed by Brave Search promotion.
  result->MoveMatchToBeLast(&LeoProvider::IsMatchFromLeoProvider);
}

}  // namespace

#define SearchProvider BraveSearchProvider
#define HistoryQuickProvider BraveHistoryQuickProvider
#define HistoryURLProvider BraveHistoryURLProvider
#define LocalHistoryZeroSuggestProvider BraveLocalHistoryZeroSuggestProvider
#define BookmarkProvider BraveBookmarkProvider
#define ShortcutsProvider BraveShortcutsProvider
#define OnDeviceHeadProvider BraveOnDeviceHeadProvider
#define BRAVE_AUTOCOMPLETE_CONTROLLER_AUTOCOMPLETE_CONTROLLER         \
  MaybeAddCommanderProvider(providers_, this);                        \
  MaybeAddLeoProvider(providers_, this);                              \
  providers_.push_back(new TopSitesProvider(provider_client_.get())); \
  if (IsBraveSearchConversionFeatureEnabled() &&                      \
      !provider_client_->IsOffTheRecord())                            \
    providers_.push_back(new PromotionProvider(provider_client_.get()));

// This sort should be done right after AutocompleteResult::SortAndCull() in
// the AutocompleteController::SortCullAndAnnotateResult() to make our sorting
// run last but before notifying.
#define BRAVE_AUTOCOMPLETE_CONTROLLER_UPDATE_RESULT \
  MaybeShowLeoMatch(&internal_result_);             \
  SortBraveSearchPromotionMatch(&internal_result_); \
  MaybeShowCommands(&internal_result_, input_);

#include "src/components/omnibox/browser/autocomplete_controller.cc"

#undef BRAVE_AUTOCOMPLETE_CONTROLLER_UPDATE_RESULT
#undef BRAVE_AUTOCOMPLETE_CONTROLLER_AUTOCOMPLETE_CONTROLLER
#undef OnDeviceHeadProvider
#undef ShortcutsProvider
#undef BookmarkProvider
#undef LocalHistoryZeroSuggestProvider
#undef HistoryURLProvider
#undef HistoryQuickProvider
#undef SearchProvider