// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/search_engines/template_url.h"

#include <algorithm>
#include <memory>
#include <string>
#include <string_view>
#include <tuple>
#include <vector>

#include "base/base64.h"
#include "base/base64url.h"
#include "base/check_op.h"
#include "base/command_line.h"
#include "base/containers/adapters.h"
#include "base/debug/dump_without_crashing.h"
#include "base/feature_list.h"
#include "base/format_macros.h"
#include "base/i18n/case_conversion.h"
#include "base/i18n/icu_string_conversions.h"
#include "base/i18n/rtl.h"
#include "base/metrics/field_trial.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/strings/escape.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/trace_event/memory_usage_estimator.h"
#include "base/trace_event/typed_macros.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "components/google/core/common/google_util.h"
#include "components/omnibox/common/omnibox_feature_configs.h"
#include "components/omnibox/common/omnibox_features.h"
#include "components/search_engines/regulatory_extension_type.h"
#include "components/search_engines/search_engine_utils.h"
#include "components/search_engines/search_engines_switches.h"
#include "components/search_engines/search_terms_data.h"
#include "components/search_engines/template_url_data.h"
#include "components/search_engines/template_url_service.h"
#include "components/search_engines/template_url_data_util.h"
#include "components/search_engines/template_url_prepopulate_data.h"
#include "components/search_engines/template_url_starter_pack_data.h"
#include "components/strings/grit/components_strings.h"
#include "components/sync/base/features.h"
#include "components/url_formatter/url_formatter.h"
#include "google_apis/google_api_keys.h"
#include "net/base/mime_util.h"
#include "net/base/url_util.h"
#include "third_party/metrics_proto/omnibox_event.pb.h"
#include "third_party/metrics_proto/omnibox_input_type.pb.h"
#include "third_party/search_engines_data/resources/definitions/prepopulated_engines.h"
#include "ui/base/device_form_factor.h"
#include "ui/base/l10n/l10n_util.h"
#include "url/gurl.h"

#if BUILDFLAG(ENABLE_BUILTIN_SEARCH_PROVIDER_ASSETS) && !BUILDFLAG(IS_ANDROID)
#include "third_party/search_engines_data/search_engine_descriptions_strings_map.h"
#endif

namespace {

const bool kEnableBuiltinSearchProviderAssets =
    !!BUILDFLAG(ENABLE_BUILTIN_SEARCH_PROVIDER_ASSETS);

// The TemplateURLRef has any number of terms that need to be replaced. Each of
// the terms is enclosed in braces. If the character preceding the final brace
// is a ?, it indicates the term is optional and can be replaced with an empty
// string.
const char kStartParameter = '{';
const char kEndParameter = '}';
const char kOptional = '?';

// Known parameters found in the URL.
const char kSearchTermsParameter[] = "searchTerms";
const char kSearchTermsParameterFull[] = "{searchTerms}";
const char kSearchTermsParameterFullEscaped[] = "%7BsearchTerms%7D";

// Same as kSearchTermsParameter, with no escaping.
const char kGoogleUnescapedSearchTermsParameter[] =
    "google:unescapedSearchTerms";
const char kGoogleUnescapedSearchTermsParameterFull[] =
    "{google:unescapedSearchTerms}";

// Display value for kSearchTermsParameter.
const char kDisplaySearchTerms[] = "%s";

// Display value for kGoogleUnescapedSearchTermsParameter.
const char kDisplayUnescapedSearchTerms[] = "%S";

// Used if the count parameter is not optional. Indicates we want 10 search
// results.
const char kDefaultCount[] = "10";

// Used if the output encoding parameter is required.
const char kOutputEncodingType[] = "UTF-8";

const size_t kMaxStringEncodeStringLength = 1'000'000;

// Attempts to encode |terms| and |original_query| in |encoding| and escape
// them.  |terms| may be escaped as path or query depending on |is_in_query|;
// |original_query| is always escaped as query. If |force_encode| is true
// encoding ignores errors and function always returns true. Otherwise function
// returns whether the encoding process succeeded.
bool TryEncoding(std::u16string_view terms,
                 std::u16string_view original_query,
                 const char* encoding,
                 bool is_in_query,
                 bool force_encode,
                 std::u16string* escaped_terms,
                 std::u16string* escaped_original_query) {
  DCHECK(escaped_terms);
  DCHECK(escaped_original_query);

  // Both |base::UTF16ToCodepage()| and |net::Escape*()| invocations below
  // create strings longer than their inputs. To ensure doing so does not crash,
  // this truncates |terms| to |kMaxStringEncodeStringLength|.
  const std::u16string_view truncated_terms =
      terms.size() > kMaxStringEncodeStringLength
          ? terms.substr(0, kMaxStringEncodeStringLength)
          : terms;

  base::OnStringConversionError::Type error_handling =
      force_encode ? base::OnStringConversionError::SKIP
                   : base::OnStringConversionError::FAIL;
  std::string encoded_terms;
  if (!base::UTF16ToCodepage(truncated_terms, encoding, error_handling,
                             &encoded_terms)) {
    return false;
  }
  *escaped_terms = base::UTF8ToUTF16(
      is_in_query ? base::EscapeQueryParamValue(encoded_terms, true)
                  : base::EscapePath(encoded_terms));
  if (original_query.empty()) {
    return true;
  }
  std::string encoded_original_query;
  if (!base::UTF16ToCodepage(original_query, encoding, error_handling,
                             &encoded_original_query)) {
    return false;
  }
  *escaped_original_query = base::UTF8ToUTF16(
      base::EscapeQueryParamValue(encoded_original_query, true));
  return true;
}

// Finds the position of the search terms' parameter in the URL component.
class SearchTermLocation {
 public:
  SearchTermLocation(std::string_view url_component,
                     url::Parsed::ComponentType url_component_type)
      : found_(false) {
    if (url_component_type == url::Parsed::PATH) {
      // GURL's constructor escapes "{" and "}" in the path of a passed string.
      found_ =
          TryMatchSearchParam(url_component, kSearchTermsParameterFullEscaped);
    } else {
      DCHECK((url_component_type == url::Parsed::QUERY) ||
             (url_component_type == url::Parsed::REF));
      url::Component query, key, value;
      query.len = static_cast<int>(url_component.size());
      while (url::ExtractQueryKeyValue(url_component, &query, &key, &value)) {
        if (key.is_nonempty() && value.is_nonempty()) {
          const std::string_view value_string =
              url_component.substr(value.begin, value.len);
          if (TryMatchSearchParam(value_string, kSearchTermsParameterFull) ||
              TryMatchSearchParam(value_string,
                                  kGoogleUnescapedSearchTermsParameterFull)) {
            found_ = true;
            key_ = std::string(url_component.substr(key.begin, key.len));
            break;
          }
        }
      }
    }
  }

  SearchTermLocation(const SearchTermLocation&) = delete;
  SearchTermLocation& operator=(const SearchTermLocation&) = delete;

  bool found() const { return found_; }
  const std::string& key() const { return key_; }
  const std::string& value_prefix() const { return value_prefix_; }
  const std::string& value_suffix() const { return value_suffix_; }

 private:
  // Returns true if the search term placeholder is present, and also assigns
  // the constant prefix/suffix found.
  bool TryMatchSearchParam(std::string_view value, std::string_view pattern) {
    size_t pos = value.find(pattern);
    if (pos == std::string_view::npos) {
      return false;
    }
    value_prefix_ = std::string(value.substr(0, pos));
    value_suffix_ = std::string(value.substr(pos + pattern.size()));
    return true;
  }

  bool found_;
  std::string key_;
  std::string value_prefix_;
  std::string value_suffix_;
};

bool IsTemplateParameterString(const std::string& param) {
  return param.length() > 2 && *param.begin() == kStartParameter &&
         *param.rbegin() == kEndParameter;
}

std::string YandexSearchPathFromDeviceFormFactor() {
  switch (ui::GetDeviceFormFactor()) {
    case ui::DEVICE_FORM_FACTOR_DESKTOP:
    case ui::DEVICE_FORM_FACTOR_TV:
      return "search/";
    case ui::DEVICE_FORM_FACTOR_PHONE:
      return "search/touch/";
    case ui::DEVICE_FORM_FACTOR_TABLET:
    case ui::DEVICE_FORM_FACTOR_FOLDABLE:
    case ui::DEVICE_FORM_FACTOR_AUTOMOTIVE:
    case ui::DEVICE_FORM_FACTOR_XR:
      return "search/pad/";
  }
  NOTREACHED();
}

// Returns true if `policy_engine` is strictly better than `other_engine`,
// where `policy_engine` is a search engine created by the
// `SiteSearchSettings` or `EnterpriseSearchAggregatorSettings` policy, and
// `other_engine` is a search engine not created by policy.
bool IsPolicySearchEngineBetterThanNonPolicyEngine(
    const TemplateURL* policy_engine,
    const TemplateURL* other_engine) {
  // Keyword conflicts between search engines set by policy are handled when the
  // policies are processed. At this point, `policy_engine` is created by
  // the `SiteSearchSettings` or `EnterpriseSearchAggregatorSettings` policy,
  // `other_engine` should have been created by something else, but not via
  // policy.
  CHECK(policy_engine->CreatedByNonDefaultSearchProviderPolicy());
  CHECK(!other_engine->CreatedByPolicy());

  const std::u16string& keyword = policy_engine->keyword();
  // Prefer `policy_engine` if the `keyword` starts with the "@" symbol.
  // Otherwise, prefer `other_engine` if it has been manually edited by the
  // user.
  return (!keyword.empty() && keyword[0] == u'@') ||
         other_engine->safe_for_autoreplace();
}

}  // namespace

// TemplateURLRef::SearchTermsArgs --------------------------------------------

TemplateURLRef::SearchTermsArgs::SearchTermsArgs() = default;

TemplateURLRef::SearchTermsArgs::SearchTermsArgs(
    const std::u16string& search_terms)
    : search_terms(search_terms) {}

TemplateURLRef::SearchTermsArgs::SearchTermsArgs(const SearchTermsArgs& other) =
    default;

TemplateURLRef::SearchTermsArgs::~SearchTermsArgs() = default;

size_t TemplateURLRef::SearchTermsArgs::EstimateMemoryUsage() const {
  size_t res = 0;

  res += base::trace_event::EstimateMemoryUsage(search_terms);
  res += base::trace_event::EstimateMemoryUsage(original_query);
  res += base::trace_event::EstimateMemoryUsage(current_page_url);
  res += base::trace_event::EstimateMemoryUsage(session_token);
  res += base::trace_event::EstimateMemoryUsage(prefetch_query);
  res += base::trace_event::EstimateMemoryUsage(prefetch_query_type);
  res += base::trace_event::EstimateMemoryUsage(additional_query_params);
  res += base::trace_event::EstimateMemoryUsage(image_thumbnail_content);
  res += base::trace_event::EstimateMemoryUsage(image_thumbnail_content_type);
  res += base::trace_event::EstimateMemoryUsage(image_url);
  res += base::trace_event::EstimateMemoryUsage(contextual_search_params);
  res += base::trace_event::EstimateMemoryUsage(input_state);
  res += base::trace_event::EstimateMemoryUsage(image_translate_source_locale);
  res += base::trace_event::EstimateMemoryUsage(image_translate_target_locale);
  res += base::trace_event::EstimateMemoryUsage(previous_query);

  return res;
}

TemplateURLRef::SearchTermsArgs::ContextualSearchParams::
    ContextualSearchParams() = default;

TemplateURLRef::SearchTermsArgs::ContextualSearchParams::ContextualSearchParams(
    int version,
    int contextual_cards_version,
    std::string home_country,
    int64_t previous_event_id,
    int previous_event_results,
    bool is_exact_search,
    std::string source_lang,
    std::string target_lang,
    std::string fluent_languages,
    std::string related_searches_stamp,
    bool apply_lang_hint,
    bool use_snippet_as_subtitle)
    : version(version),
      contextual_cards_version(contextual_cards_version),
      home_country(home_country),
      previous_event_id(previous_event_id),
      previous_event_results(previous_event_results),
      is_exact_search(is_exact_search),
      source_lang(source_lang),
      target_lang(target_lang),
      fluent_languages(fluent_languages),
      related_searches_stamp(related_searches_stamp),
      apply_lang_hint(apply_lang_hint),
      use_snippet_as_subtitle(use_snippet_as_subtitle) {}

TemplateURLRef::SearchTermsArgs::ContextualSearchParams::ContextualSearchParams(
    const ContextualSearchParams& other) = default;

TemplateURLRef::SearchTermsArgs::ContextualSearchParams::
    ~ContextualSearchParams() = default;

size_t
TemplateURLRef::SearchTermsArgs::ContextualSearchParams::EstimateMemoryUsage()
    const {
  return base::trace_event::EstimateMemoryUsage(home_country);
}

// TemplateURLRef -------------------------------------------------------------

TemplateURLRef::TemplateURLRef(const TemplateURL* owner, Type type)
    : owner_(owner), type_(type) {
  DCHECK(owner_);
  DCHECK_NE(INDEXED, type_);
}

TemplateURLRef::TemplateURLRef(const TemplateURL* owner, size_t index_in_owner)
    : owner_(owner), type_(INDEXED), index_in_owner_(index_in_owner) {
  DCHECK(owner_);
  DCHECK_LT(index_in_owner_, owner_->alternate_urls().size());
}

TemplateURLRef::~TemplateURLRef() = default;

TemplateURLRef::TemplateURLRef(const TemplateURLRef& source) = default;

TemplateURLRef& TemplateURLRef::operator=(const TemplateURLRef& source) =
    default;

std::string TemplateURLRef::GetURL() const {
  switch (type_) {
    case SEARCH:
      return owner_->url();
    case SUGGEST:
      return owner_->suggestions_url();
    case IMAGE:
      return owner_->image_url();
    case IMAGE_TRANSLATE:
      return owner_->image_translate_url();
    case NEW_TAB:
      return owner_->new_tab_url();
    case CONTEXTUAL_SEARCH:
      return owner_->contextual_search_url();
    case INDEXED:
      return owner_->alternate_urls()[index_in_owner_];
    default:
      NOTREACHED();
  }
}

std::string TemplateURLRef::GetPostParamsString() const {
  switch (type_) {
    case INDEXED:
    case SEARCH:
      return owner_->search_url_post_params();
    case SUGGEST:
      return owner_->suggestions_url_post_params();
    case NEW_TAB:
      return std::string();
    case CONTEXTUAL_SEARCH:
      return std::string();
    case IMAGE:
    case IMAGE_TRANSLATE:
      return owner_->image_url_post_params();
    default:
      NOTREACHED();
  }
}

bool TemplateURLRef::UsesPOSTMethod(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return !post_params_.empty();
}

size_t TemplateURLRef::EstimateMemoryUsage() const {
  size_t res = 0;

  res += base::trace_event::EstimateMemoryUsage(parsed_url_);
  res += base::trace_event::EstimateMemoryUsage(replacements_);
  res += base::trace_event::EstimateMemoryUsage(host_);
  res += base::trace_event::EstimateMemoryUsage(port_);
  res += base::trace_event::EstimateMemoryUsage(path_prefix_);
  res += base::trace_event::EstimateMemoryUsage(path_suffix_);
  res += base::trace_event::EstimateMemoryUsage(search_term_key_);
  res += base::trace_event::EstimateMemoryUsage(search_term_value_prefix_);
  res += base::trace_event::EstimateMemoryUsage(search_term_value_suffix_);
  res += base::trace_event::EstimateMemoryUsage(post_params_);
  res += sizeof(path_wildcard_present_);

  return res;
}

size_t TemplateURLRef::PostParam::EstimateMemoryUsage() const {
  size_t res = 0;

  res += base::trace_event::EstimateMemoryUsage(name);
  res += base::trace_event::EstimateMemoryUsage(value);
  res += base::trace_event::EstimateMemoryUsage(content_type);

  return res;
}

bool TemplateURLRef::EncodeFormData(const PostParams& post_params,
                                    PostContent* post_content) const {
  if (post_params.empty()) {
    return true;
  }
  if (!post_content) {
    return false;
  }

  const char kUploadDataMIMEType[] = "multipart/form-data; boundary=";
  // Each name/value pair is stored in a body part which is preceded by a
  // boundary delimiter line.
  std::string boundary = net::GenerateMimeMultipartBoundary();
  // Sets the content MIME type.
  post_content->first = kUploadDataMIMEType;
  post_content->first += boundary;
  // Encodes the post parameters.
  std::string* post_data = &post_content->second;
  post_data->clear();
  for (const auto& param : post_params) {
    DCHECK(!param.name.empty());
    net::AddMultipartValueForUpload(param.name, param.value, boundary,
                                    param.content_type, post_data);
  }
  net::AddMultipartFinalDelimiterForUpload(boundary, post_data);
  return true;
}

bool TemplateURLRef::SupportsReplacement(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return valid_ && supports_replacements_;
}

std::string TemplateURLRef::ReplaceSearchTerms(
    const SearchTermsArgs& search_terms_args,
    const SearchTermsData& search_terms_data,
    PostContent* post_content,
    std::string_view url_override) const {
  ParseIfNecessary(search_terms_data, url_override);
  if (!valid_) {
    return std::string();
  }

  std::string url(
      HandleReplacements(search_terms_args, search_terms_data, post_content));

  GURL gurl(url);
  if (!gurl.is_valid()) {
    return url;
  }

  std::vector<std::string> query_params;
  if (search_terms_args.append_extra_query_params_from_command_line) {
    std::string extra_params(
        base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
            switches::kExtraSearchQueryParams));
    if (!extra_params.empty()) {
      query_params.push_back(extra_params);
    }
  }
  if (!search_terms_args.additional_query_params.empty()) {
    query_params.push_back(search_terms_args.additional_query_params);
  }
  if (!gurl.GetQuery().empty()) {
    query_params.push_back(gurl.GetQuery());
  }

  if (type_ == SEARCH || type_ == SUGGEST) {
    auto regulatory_extension_type = owner_->GetRegulatoryExtensionType();
    base::UmaHistogramEnumeration(
        type_ == SEARCH
            ? "Omnibox.TemplateUrl.RegulatoryExtension.SearchVariant"
            : "Omnibox.TemplateUrl.RegulatoryExtension.SuggestVariant",
        regulatory_extension_type);

    auto* regulatory_extension =
        owner_->GetRegulatoryExtension(regulatory_extension_type);
    if (regulatory_extension) {
      const char* regulatory_params =
          type_ == SEARCH ? regulatory_extension->search_params
                          : regulatory_extension->suggest_params;
      if (regulatory_params && strlen(regulatory_params) > 0) {
        query_params.push_back(regulatory_params);
      }
    }
  }

  if (query_params.empty()) {
    return url;
  }

  GURL::Replacements replacements;
  std::string query_str = base::JoinString(query_params, "&");
  replacements.SetQueryStr(query_str);
  return gurl.ReplaceComponents(replacements).possibly_invalid_spec();
}

bool TemplateURLRef::IsValid(const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return valid_;
}

std::u16string TemplateURLRef::DisplayURL(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  std::string result(GetURL());
  if (valid_ && !replacements_.empty()) {
    base::ReplaceSubstringsAfterOffset(&result, 0, kSearchTermsParameterFull,
                                       kDisplaySearchTerms);
    base::ReplaceSubstringsAfterOffset(&result, 0,
                                       kGoogleUnescapedSearchTermsParameterFull,
                                       kDisplayUnescapedSearchTerms);
  }
  return base::UTF8ToUTF16(result);
}

// static
std::string TemplateURLRef::DisplayURLToURLRef(
    const std::u16string& display_url) {
  std::string result = base::UTF16ToUTF8(display_url);
  base::ReplaceSubstringsAfterOffset(&result, 0, kDisplaySearchTerms,
                                     kSearchTermsParameterFull);
  base::ReplaceSubstringsAfterOffset(&result, 0, kDisplayUnescapedSearchTerms,
                                     kGoogleUnescapedSearchTermsParameterFull);
  return result;
}

const std::string& TemplateURLRef::GetHost(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return host_;
}

std::string TemplateURLRef::GetPath(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return path_prefix_ + path_suffix_;
}

const std::string& TemplateURLRef::GetSearchTermKey(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return search_term_key_;
}

url::Parsed::ComponentType TemplateURLRef::GetSearchTermKeyLocation(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return search_term_key_location_;
}

const std::string& TemplateURLRef::GetSearchTermValuePrefix(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return search_term_value_prefix_;
}

const std::string& TemplateURLRef::GetSearchTermValueSuffix(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return search_term_value_suffix_;
}

std::u16string TemplateURLRef::SearchTermToString16(
    std::string_view term) const {
  const std::vector<std::string>& encodings = owner_->input_encodings();
  std::u16string result;

  base::UnescapeRule::Type unescape_rules =
      base::UnescapeRule::SPACES | base::UnescapeRule::PATH_SEPARATORS |
      base::UnescapeRule::URL_SPECIAL_CHARS_EXCEPT_PATH_SEPARATORS;
  if (search_term_key_location_ != url::Parsed::PATH) {
    unescape_rules |= base::UnescapeRule::REPLACE_PLUS_WITH_SPACE;
  }

  std::string unescaped = base::UnescapeURLComponent(term, unescape_rules);
  for (size_t i = 0; i < encodings.size(); ++i) {
    if (base::CodepageToUTF16(unescaped, encodings[i].c_str(),
                              base::OnStringConversionError::FAIL, &result)) {
      return result;
    }
  }

  // Always fall back on UTF-8 if it works.
  if (base::CodepageToUTF16(unescaped, base::kCodepageUTF8,
                            base::OnStringConversionError::FAIL, &result)) {
    return result;
  }

  // When nothing worked, just use the escaped text. We have no idea what the
  // encoding is. We need to substitute spaces for pluses ourselves since we're
  // not sending it through an unescaper.
  result = base::UTF8ToUTF16(term);
  if (unescape_rules & base::UnescapeRule::REPLACE_PLUS_WITH_SPACE) {
    std::replace(result.begin(), result.end(), '+', ' ');
  }
  return result;
}

bool TemplateURLRef::HasGoogleBaseURLs(
    const SearchTermsData& search_terms_data) const {
  ParseIfNecessary(search_terms_data);
  return std::ranges::any_of(replacements_, [](const Replacement& replacement) {
    return replacement.type == GOOGLE_BASE_URL ||
           replacement.type == GOOGLE_BASE_SUGGEST_URL;
  });
}

bool TemplateURLRef::ExtractSearchTermsFromURL(
    const GURL& url,
    std::u16string* search_terms,
    const SearchTermsData& search_terms_data,
    url::Parsed::ComponentType* search_terms_component,
    url::Component* search_terms_position) const {
  DCHECK(search_terms);
  search_terms->clear();

  ParseIfNecessary(search_terms_data);

  // We need a search term in the template URL to extract something.
  if (search_term_key_.empty() &&
      search_term_key_location_ != url::Parsed::PATH) {
    return false;
  }

  // Host, port, and path must match.
  if (url.GetHost() != host_ || url.GetPort() != port_ ||
      (!PathIsEqual(url) && (search_term_key_location_ != url::Parsed::PATH))) {
    return false;
  }

  std::string_view source;
  url::Component position;

  if (search_term_key_location_ == url::Parsed::PATH) {
    source = url.path();

    // If the path does not contain the expected prefix and suffix, then this is
    // not a match.
    if (source.size() < (search_term_value_prefix_.size() +
                         search_term_value_suffix_.size()) ||
        !base::StartsWith(source, search_term_value_prefix_) ||
        !base::EndsWith(source, search_term_value_suffix_)) {
      return false;
    }
    position =
        url::MakeRange(search_term_value_prefix_.size(),
                       source.length() - search_term_value_suffix_.size());
  } else {
    DCHECK(search_term_key_location_ == url::Parsed::QUERY ||
           search_term_key_location_ == url::Parsed::REF);
    source = (search_term_key_location_ == url::Parsed::QUERY) ? url.query()
                                                               : url.ref();

    url::Component query, key, value;
    query.len = static_cast<int>(source.size());
    bool key_found = false;
    while (url::ExtractQueryKeyValue(source, &query, &key, &value)) {
      if (key.is_nonempty()) {
        if (source.substr(key.begin, key.len) == search_term_key_) {
          // Fail if search term key is found twice.
          if (key_found) {
            return false;
          }

          // If the query parameter does not contain the expected prefix and
          // suffix, then this is not a match.
          std::string_view search_term =
              std::string_view(source).substr(value.begin, value.len);
          if (search_term.size() < (search_term_value_prefix_.size() +
                                    search_term_value_suffix_.size()) ||
              !base::StartsWith(search_term, search_term_value_prefix_) ||
              !base::EndsWith(search_term, search_term_value_suffix_)) {
            continue;
          }

          key_found = true;
          position =
              url::MakeRange(value.begin + search_term_value_prefix_.size(),
                             value.end() - search_term_value_suffix_.size());
        }
      }
    }
    if (!key_found) {
      return false;
    }
  }

  // Extract the search term.
  *search_terms =
      SearchTermToString16(source.substr(position.begin, position.len));
  if (search_terms_component) {
    *search_terms_component = search_term_key_location_;
  }
  if (search_terms_position) {
    *search_terms_position = position;
  }
  return true;
}

void TemplateURLRef::InvalidateCachedValues() const {
  supports_replacements_ = valid_ = parsed_ = path_wildcard_present_ = false;
  host_.clear();
  port_.clear();
  path_prefix_.clear();
  path_suffix_.clear();
  search_term_key_.clear();
  search_term_key_location_ = url::Parsed::QUERY;
  search_term_value_prefix_.clear();
  search_term_value_suffix_.clear();
  replacements_.clear();
  post_params_.clear();
}

bool TemplateURLRef::ParseParameter(size_t start,
                                    size_t end,
                                    std::string* url,
                                    Replacements* replacements) const {
  DCHECK(start != std::string::npos && end != std::string::npos && end > start);
  size_t length = end - start - 1;
  bool optional = false;
  // Make a copy of |url| that can be referenced in StringPieces below. |url| is
  // modified, so that can't be used in std::string_view.
  const std::string original_url(*url);
  if (original_url[end - 1] == kOptional) {
    optional = true;
    length--;
  }

  const std::string_view parameter =
      std::string_view(original_url).substr(start + 1, length);
  // Remove the parameter from the string.  For parameters who replacement is
  // constant and already known, just replace them directly.  For other cases,
  // like parameters whose values may change over time, use |replacements|.
  url->erase(start, end - start + 1);
  if (parameter == kSearchTermsParameter) {
    replacements->push_back(Replacement(SEARCH_TERMS, start));
  } else if (parameter == "count") {
    if (!optional) {
      url->insert(start, kDefaultCount);
    }
  } else if (parameter == "google:assistedQueryStats") {
    replacements->push_back(Replacement(GOOGLE_ASSISTED_QUERY_STATS, start));
  } else if (parameter == "google:baseURL") {
    replacements->push_back(Replacement(GOOGLE_BASE_URL, start));
  } else if (parameter == "google:baseSearchByImageURL") {
    replacements->push_back(
        Replacement(GOOGLE_BASE_SEARCH_BY_IMAGE_URL, start));
  } else if (parameter == "google:baseSuggestURL") {
    replacements->push_back(Replacement(GOOGLE_BASE_SUGGEST_URL, start));
  } else if (parameter == "google:currentPageUrl") {
    replacements->push_back(Replacement(GOOGLE_CURRENT_PAGE_URL, start));
  } else if (parameter == "google:cursorPosition") {
    replacements->push_back(Replacement(GOOGLE_CURSOR_POSITION, start));
  } else if (parameter == "google:imageOriginalHeight") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_IMAGE_ORIGINAL_HEIGHT, start));
  } else if (parameter == "google:imageOriginalWidth") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_IMAGE_ORIGINAL_WIDTH, start));
  } else if (parameter == "google:imageSearchSource") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_IMAGE_SEARCH_SOURCE, start));
  } else if (parameter == "google:imageThumbnail") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_IMAGE_THUMBNAIL, start));
  } else if (parameter == "google:imageThumbnailBase64") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_IMAGE_THUMBNAIL_BASE64, start));
  } else if (parameter == "google:processedImageDimensions") {
    replacements->emplace_back(
        Replacement(TemplateURLRef::GOOGLE_PROCESSED_IMAGE_DIMENSIONS, start));
  } else if (parameter == "google:imageURL") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_IMAGE_URL, start));
  } else if (parameter == "google:inputType") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_INPUT_TYPE, start));
  } else if (parameter == "google:omniboxFocusType") {
    replacements->push_back(
        Replacement(TemplateURLRef::GOOGLE_OMNIBOX_FOCUS_TYPE, start));
  } else if (parameter == "google:language") {
    replacements->push_back(Replacement(GOOGLE_LANGUAGE, start));
  } else if (parameter == "google:iOSSearchLanguage") {
    // TODO(b/343792225): Do not remove this.
    // The google:iOSSearchLanguage parameter does not appear in any template
    // URL in components/search_engines/prepopulated_engines.json. However,
    // template URLs may be served from other sources so even though the value
    // is no longer required, the parameter still needs to be handled. Doing
    // nothing here will result in simply removing the parameter from the URL.
  } else if (parameter == "google:contextualSearchVersion") {
    replacements->push_back(
        Replacement(GOOGLE_CONTEXTUAL_SEARCH_VERSION, start));
  } else if (parameter == "google:contextualSearchContextData") {
    replacements->push_back(
        Replacement(GOOGLE_CONTEXTUAL_SEARCH_CONTEXT_DATA, start));
  } else if (parameter == "google:originalQueryForSuggestion") {
    replacements->push_back(
        Replacement(GOOGLE_ORIGINAL_QUERY_FOR_SUGGESTION, start));
  } else if (parameter == "google:pageClassification") {
    replacements->push_back(Replacement(GOOGLE_PAGE_CLASSIFICATION, start));
  } else if (parameter == "google:clientCacheTimeToLive") {
    replacements->push_back(
        Replacement(GOOGLE_CLIENT_CACHE_TIME_TO_LIVE, start));
  } else if (parameter == "google:pathWildcard") {
    // Do nothing, we just want the path wildcard removed from the URL.
  } else if (parameter == "google:prefetchQuery") {
    replacements->push_back(Replacement(GOOGLE_PREFETCH_QUERY, start));
  } else if (parameter == "google:prefetchSource") {
    replacements->push_back(Replacement(GOOGLE_PREFETCH_SOURCE, start));
  } else if (parameter == "google:RLZ") {
    replacements->push_back(Replacement(GOOGLE_RLZ, start));
  } else if (parameter == "google:searchClient") {
    replacements->push_back(Replacement(GOOGLE_SEARCH_CLIENT, start));
  } else if (parameter == "google:searchFieldtrialParameter") {
    replacements->push_back(Replacement(GOOGLE_SEARCH_FIELDTRIAL_GROUP, start));
  } else if (parameter == "google:searchSource") {
    replacements->push_back(Replacement(GOOGLE_SEARCH_SOURCE, start));
  } else if (parameter == "google:searchVersion") {
    replacements->push_back(Replacement(GOOGLE_SEARCH_VERSION, start));
  } else if (parameter == "google:sessionToken") {
    replacements->push_back(Replacement(GOOGLE_SESSION_TOKEN, start));
  } else if (parameter == "google:sourceId") {
    replacements->push_back(Replacement(GOOGLE_SEARCH_SOURCE_ID, start));
  } else if (parameter == "google:suggestAPIKeyParameter") {
    url->insert(start,
                base::EscapeQueryParamValue(google_apis::GetAPIKey(), false));
  } else if (parameter == "google:suggestPath") {
    replacements->push_back(Replacement(GOOGLE_SUGGEST_PATH, start));
  } else if (parameter == "google:suggestClient") {
    replacements->push_back(Replacement(GOOGLE_SUGGEST_CLIENT, start));
  } else if (parameter == "google:suggestRid") {
    replacements->push_back(Replacement(GOOGLE_SUGGEST_REQUEST_ID, start));
  } else if (parameter == kGoogleUnescapedSearchTermsParameter) {
    replacements->push_back(Replacement(GOOGLE_UNESCAPED_SEARCH_TERMS, start));
  } else if (parameter == "yandex:referralID") {
    replacements->push_back(Replacement(YANDEX_REFERRAL_ID, start));
  } else if (parameter == "mailru:referralID") {
    replacements->push_back(Replacement(MAIL_RU_REFERRAL_ID, start));
  } else if (parameter == "yandex:searchPath") {
    url->insert(start, YandexSearchPathFromDeviceFormFactor());
  } else if (parameter == "imageTranslateSourceLocale") {
    replacements->push_back(Replacement(IMAGE_TRANSLATE_SOURCE_LOCALE, start));
  } else if (parameter == "imageTranslateTargetLocale") {
    replacements->push_back(Replacement(IMAGE_TRANSLATE_TARGET_LOCALE, start));
  } else if (parameter == "inputEncoding") {
    replacements->push_back(Replacement(ENCODING, start));
  } else if (parameter == "language") {
    replacements->push_back(Replacement(LANGUAGE, start));
  } else if (parameter == "outputEncoding") {
    if (!optional) {
      url->insert(start, kOutputEncodingType);
    }
  } else if ((parameter == "startIndex") || (parameter == "startPage")) {
    // We don't support these.
    if (!optional) {
      url->insert(start, "1");
    }
  } else {
    // Despite Chrome normally relying on prepopulated_engines.json file, there
    // are other mechanisms that can supply overrides - see:
    // http://cs/search?q=google:acceptedSuggestion
    // The use of these parameters - and Template URLs - was further confirmed
    // by collecting additional data with the help of the crash/ service.
    //
    // Since we can't mark this NOTREACHED(), remove all parameters seen here.
    //
    // Fallthrough.
    base::UmaHistogramBoolean("Omnibox.TemplateUrl.UnrecognizedParameter",
                              prepopulated_);
  }
  return true;
}

std::string TemplateURLRef::ParseURL(const std::string& url,
                                     Replacements* replacements,
                                     PostParams* post_params,
                                     bool* valid) const {
  *valid = false;
  std::string parsed_url = url;
  for (size_t last = 0; last != std::string::npos;) {
    last = parsed_url.find(kStartParameter, last);
    if (last != std::string::npos) {
      size_t template_end = parsed_url.find(kEndParameter, last);
      if (template_end != std::string::npos) {
        // Since we allow Javascript in the URL, {} pairs could be nested. Match
        // only leaf pairs with supported parameters.
        size_t next_template_start = parsed_url.find(kStartParameter, last + 1);
        if (next_template_start == std::string::npos ||
            next_template_start > template_end) {
          // If successful, ParseParameter erases from the string as such no
          // need to update |last|. If failed, move |last| to the end of pair.
          if (!ParseParameter(last, template_end, &parsed_url, replacements)) {
            // |template_end| + 1 may be beyond the end of the string.
            last = template_end;
          }
        } else {
          last = next_template_start;
        }
      } else {
        // Open brace without a closing brace, return.
        return std::string();
      }
    }
  }

  // Handles the post parameters.
  const std::string& post_params_string = GetPostParamsString();
  if (!post_params_string.empty()) {
    for (std::string_view cur :
         base::SplitStringPiece(post_params_string, ",", base::TRIM_WHITESPACE,
                                base::SPLIT_WANT_ALL)) {
      // The '=' delimiter is required and the name must be not empty.
      std::vector<std::string_view> parts = base::SplitStringPiece(
          cur, "=", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
      if ((parts.size() != 2U) || parts[0].empty()) {
        return std::string();
      }

      std::string value(parts[1]);
      size_t replacements_size = replacements->size();
      if (IsTemplateParameterString(value)) {
        ParseParameter(0, value.length() - 1, &value, replacements);
      }
      PostParam param = {std::string(parts[0]), std::move(value)};
      post_params->push_back(std::move(param));
      // If there was a replacement added, points its index to last added
      // PostParam.
      if (replacements->size() > replacements_size) {
        DCHECK_EQ(replacements_size + 1, replacements->size());
        Replacement* r = &replacements->back();
        r->is_post_param = true;
        r->index = post_params->size() - 1;
      }
    }
    DCHECK(!post_params->empty());
  }

  *valid = true;
  return parsed_url;
}

void TemplateURLRef::ParseIfNecessary(const SearchTermsData& search_terms_data,
                                      std::string_view url_override) const {
  bool url_override_is_valid = GURL(url_override).is_valid();
  if (!parsed_ || url_override_is_valid) {
    InvalidateCachedValues();
    parsed_ = true;
    parsed_url_ =
        ParseURL(url_override_is_valid ? std::string(url_override) : GetURL(),
                 &replacements_, &post_params_, &valid_);
    supports_replacements_ = false;
    if (valid_) {
      bool has_only_one_search_term = false;
      for (Replacements::const_iterator i = replacements_.begin();
           i != replacements_.end(); ++i) {
        if ((i->type == SEARCH_TERMS) ||
            (i->type == GOOGLE_UNESCAPED_SEARCH_TERMS)) {
          if (has_only_one_search_term) {
            has_only_one_search_term = false;
            break;
          }
          has_only_one_search_term = true;
          supports_replacements_ = true;
        }
      }
      // Only parse the host/key if there is one search term. Technically there
      // could be more than one term, but it's uncommon; so we punt.
      if (has_only_one_search_term) {
        ParseHostAndSearchTermKey(search_terms_data);
      }
    }
  }
}

void TemplateURLRef::ParsePath(const std::string& path) const {
  // Wildcard string used when matching URLs.
  const std::string wildcard_escaped = "%7Bgoogle:pathWildcard%7D";

  // We only search for the escaped wildcard because we're only replacing it in
  // the path, and GURL's constructor escapes { and }.
  size_t wildcard_start = path.find(wildcard_escaped);
  path_wildcard_present_ = wildcard_start != std::string::npos;
  path_prefix_ = path.substr(0, wildcard_start);
  path_suffix_ = path_wildcard_present_
                     ? path.substr(wildcard_start + wildcard_escaped.length())
                     : std::string();
}

bool TemplateURLRef::PathIsEqual(const GURL& url) const {
  std::string_view path = url.path();
  if (!path_wildcard_present_) {
    return path == path_prefix_;
  }
  return ((path.length() >= path_prefix_.length() + path_suffix_.length()) &&
          base::StartsWith(path, path_prefix_) &&
          base::EndsWith(path, path_suffix_));
}

void TemplateURLRef::ParseHostAndSearchTermKey(
    const SearchTermsData& search_terms_data) const {
  std::string url_string(GetURL());
  base::ReplaceSubstringsAfterOffset(&url_string, 0, "{google:baseURL}",
                                     search_terms_data.GoogleBaseURLValue());
  base::ReplaceSubstringsAfterOffset(
      &url_string, 0, "{google:baseSuggestURL}",
      search_terms_data.GoogleBaseSuggestURLValue());
  std::string suggest_path = TemplateURLService::kSuggestPath;
  if (base::FeatureList::GetInstance()) {
    const auto& config =
        omnibox_feature_configs::SuggestPathClientConfig::Get();
    if (config.enabled && config.enable_for_all) {
      suggest_path = TemplateURLService::kShortSuggestPath;
    }
  }
  // TODO(crbug.com/509448052): ParseHostAndSearchTermKey manually replaces a
  // subset of structural placeholders. This logic should ideally be unified
  // with HandleReplacements to avoid duplication.
  base::ReplaceSubstringsAfterOffset(&url_string, 0, "{google:suggestPath}",
                                     suggest_path);
  base::ReplaceSubstringsAfterOffset(&url_string, 0, "{yandex:searchPath}",
                                     YandexSearchPathFromDeviceFormFactor());

  GURL url(url_string);
  if (!url.is_valid()) {
    return;
  }

  SearchTermLocation query_result(url.query(), url::Parsed::QUERY);
  SearchTermLocation ref_result(url.ref(), url::Parsed::REF);
  SearchTermLocation path_result(url.path(), url::Parsed::PATH);
  const bool in_query = query_result.found();
  const bool in_ref = ref_result.found();
  const bool in_path = path_result.found();
  if (in_query ? (in_ref || in_path) : (in_ref == in_path)) {
    return;  // No key or multiple keys found.  We only handle having one key.
  }

  host_ = url.GetHost();
  port_ = url.GetPort();
  if (in_query) {
    search_term_key_location_ = url::Parsed::QUERY;
    search_term_key_ = query_result.key();
    search_term_value_prefix_ = query_result.value_prefix();
    search_term_value_suffix_ = query_result.value_suffix();
    ParsePath(url.GetPath());
  } else if (in_ref) {
    search_term_key_location_ = url::Parsed::REF;
    search_term_key_ = ref_result.key();
    search_term_value_prefix_ = ref_result.value_prefix();
    search_term_value_suffix_ = ref_result.value_suffix();
    ParsePath(url.GetPath());
  } else {
    DCHECK(in_path);
    search_term_key_location_ = url::Parsed::PATH;
    search_term_value_prefix_ = path_result.value_prefix();
    search_term_value_suffix_ = path_result.value_suffix();
  }
}

void TemplateURLRef::HandleReplacement(const std::string& name,
                                       const std::string& value,
                                       const Replacement& replacement,
                                       std::string* url) const {
  size_t pos = replacement.index;
  if (replacement.is_post_param) {
    DCHECK_LT(pos, post_params_.size());
    DCHECK(!post_params_[pos].name.empty());
    post_params_[pos].value = value;
  } else {
    url->insert(pos, name.empty() ? value : (name + "=" + value + "&"));
  }
}

std::string TemplateURLRef::HandleReplacements(
    const SearchTermsArgs& search_terms_args,
    const SearchTermsData& search_terms_data,
    PostContent* post_content) const {
  TRACE_EVENT0("omnibox", "TemplateURLRef::HandleReplacement");
  if (replacements_.empty()) {
    if (!post_params_.empty()) {
      EncodeFormData(post_params_, post_content);
    }
    return parsed_url_;
  }

  // Determine if the search terms are in the query or before. We're escaping
  // space as '+' in the former case and as '%20' in the latter case.
  bool is_in_query = true;

  auto search_terms =
      std::ranges::find(replacements_, SEARCH_TERMS, &Replacement::type);

  if (search_terms != replacements_.end()) {
    std::u16string::size_type query_start = parsed_url_.find('?');
    is_in_query = query_start != std::u16string::npos &&
                  (static_cast<std::u16string::size_type>(search_terms->index) >
                   query_start);
  }

  std::string input_encoding;
  std::u16string encoded_terms;
  std::u16string encoded_original_query;
  owner_->EncodeSearchTerms(search_terms_args, is_in_query, &input_encoding,
                            &encoded_terms, &encoded_original_query);

  std::string url = parsed_url_;

  // replacements_ is ordered in ascending order, as such we need to iterate
  // from the back.
  for (const Replacement& replacement : base::Reversed(replacements_)) {
    switch (replacement.type) {
      case ENCODING:
        HandleReplacement(std::string(), input_encoding, replacement, &url);
        break;

      case GOOGLE_CONTEXTUAL_SEARCH_VERSION:
        if (search_terms_args.contextual_search_params.version >= 0) {
          HandleReplacement(
              "ctxs",
              base::NumberToString(
                  search_terms_args.contextual_search_params.version),
              replacement, &url);
        }
        break;

      case GOOGLE_CONTEXTUAL_SEARCH_CONTEXT_DATA: {
        DCHECK(!replacement.is_post_param);

        const SearchTermsArgs::ContextualSearchParams& params =
            search_terms_args.contextual_search_params;
        std::vector<std::string> args;

        if (params.contextual_cards_version > 0) {
          args.push_back("ctxsl_coca=" +
                         base::NumberToString(params.contextual_cards_version));
        }
        if (!params.home_country.empty()) {
          args.push_back("ctxs_hc=" + params.home_country);
        }
        if (params.previous_event_id != 0) {
          args.push_back("ctxsl_pid=" +
                         base::NumberToString(params.previous_event_id));
        }
        if (params.previous_event_results != 0) {
          args.push_back("ctxsl_per=" +
                         base::NumberToString(params.previous_event_results));
        }
        if (params.is_exact_search) {
          args.push_back("ctxsl_exact=1");
        }
        if (!params.source_lang.empty()) {
          args.push_back("tlitesl=" + params.source_lang);
        }
        if (!params.target_lang.empty()) {
          args.push_back("tlitetl=" + params.target_lang);
        }
        if (!params.fluent_languages.empty()) {
          args.push_back("ctxs_fls=" + params.fluent_languages);
        }
        if (!params.related_searches_stamp.empty()) {
          args.push_back("ctxsl_rs=" + params.related_searches_stamp);
        }
        if (params.apply_lang_hint) {
          args.push_back("ctxsl_applylh=1");
        }
        if (params.use_snippet_as_subtitle) {
          args.push_back("ctxs_usas=1");
        }

        HandleReplacement(std::string(), base::JoinString(args, "&"),
                          replacement, &url);
        break;
      }

      case GOOGLE_ASSISTED_QUERY_STATS: {
        DCHECK(!replacement.is_post_param);

        // TODO(crbug.com/345275145): Use GOOGLE_ASSISTED_QUERY_STATS which is
        // on both the server and local configuration to attach the prefetch
        // param. If this approach works well, remove the prefetchSource
        // component. If the browser process is starting up,
        // base::FeatureList::GetInstance may return null, in this case we treat
        // it as enabled to ensure the prefetch parameter is always attached to
        // the URL.
        bool is_search_prefetch = !search_terms_args.prefetch_param.empty();
        bool should_attach_prefetch_param =
            is_search_prefetch &&
            (!base::FeatureList::GetInstance() ||
             base::FeatureList::IsEnabled(switches::kPrefetchParameterFix));
        if (should_attach_prefetch_param) {
          // Ensure the prefetch param is attached even if gs_lcrp is not
          // needed.
          HandleReplacement("pf", search_terms_args.prefetch_param, replacement,
                            &url);
        }

        const size_t searchbox_stats_size =
            search_terms_args.searchbox_stats.ByteSizeLong();
        if (searchbox_stats_size == 0) {
          break;
        }

        // Don't have to attach the searchbox stats to prefetch requests.
        if (is_search_prefetch &&
            base::FeatureList::IsEnabled(
                switches::kRemoveSearchboxStatsParamFromPrefetchRequests)) {
          break;
        }

        // Get the base URL without substituting gs_lcrp to avoid infinite
        // recursion and unwanted replacement respectively. We need the URL to
        // find out if it meets all gs_lcrp requirements (e.g. HTTPS protocol
        // check). See TemplateURLRef::SearchTermsArgs for more details.
        SearchTermsArgs sanitized_search_terms_args(search_terms_args);
        // Clear the proto. Its empty state has a serialized size of zero.
        sanitized_search_terms_args.searchbox_stats.Clear();
        GURL base_url(ReplaceSearchTerms(sanitized_search_terms_args,
                                         search_terms_data, nullptr));
        if (base_url.SchemeIsCryptographic()) {
          TRACE_EVENT0(
              "omnibox",
              "TemplateURLRef::HandleReplacement:serialize_searchbox_stats");
          std::vector<uint8_t> serialized_searchbox_stats(searchbox_stats_size);
          search_terms_args.searchbox_stats.SerializeWithCachedSizesToArray(
              &serialized_searchbox_stats[0]);
          std::string encoded_searchbox_stats;
          base::Base64UrlEncode(serialized_searchbox_stats,
                                base::Base64UrlEncodePolicy::OMIT_PADDING,
                                &encoded_searchbox_stats);
          HandleReplacement("gs_lcrp", encoded_searchbox_stats, replacement,
                            &url);
          base::UmaHistogramCounts1000(
              "Omnibox.SearchboxStats.Length",
              static_cast<int>(encoded_searchbox_stats.length()));
        }
        break;
      }

      case GOOGLE_BASE_URL:
        DCHECK(!replacement.is_post_param);
        HandleReplacement(std::string(), search_terms_data.GoogleBaseURLValue(),
                          replacement, &url);
        break;

      case GOOGLE_BASE_SEARCH_BY_IMAGE_URL:
        DCHECK(!replacement.is_post_param);
        HandleReplacement(std::string(),
                          search_terms_data.GoogleBaseSearchByImageURLValue(),
                          replacement, &url);
        break;

      case GOOGLE_BASE_SUGGEST_URL:
        DCHECK(!replacement.is_post_param);
        HandleReplacement(std::string(),
                          search_terms_data.GoogleBaseSuggestURLValue(),
                          replacement, &url);
        break;

      case GOOGLE_CURRENT_PAGE_URL:
        DCHECK(!replacement.is_post_param);
        if (!search_terms_args.current_page_url.empty()) {
          const std::string& escaped_current_page_url =
              base::EscapeQueryParamValue(search_terms_args.current_page_url,
                                          true);
          HandleReplacement("url", escaped_current_page_url, replacement, &url);
        }
        break;

      case GOOGLE_CURSOR_POSITION:
        DCHECK(!replacement.is_post_param);
        if (search_terms_args.cursor_position != std::u16string::npos) {
          HandleReplacement(
              "cp",
              base::StringPrintf("%" PRIuS, search_terms_args.cursor_position),
              replacement, &url);
        }
        break;

      case GOOGLE_INPUT_TYPE:
        DCHECK(!replacement.is_post_param);
        HandleReplacement("oit",
                          base::NumberToString(search_terms_args.input_type),
                          replacement, &url);
        break;

      case GOOGLE_OMNIBOX_FOCUS_TYPE:
        DCHECK(!replacement.is_post_param);
        if (search_terms_args.focus_type !=
            metrics::OmniboxFocusType::INTERACTION_DEFAULT) {
          HandleReplacement("oft",
                            base::NumberToString(
                                static_cast<int>(search_terms_args.focus_type)),
                            replacement, &url);
        }
        break;

      case GOOGLE_ORIGINAL_QUERY_FOR_SUGGESTION:
        DCHECK(!replacement.is_post_param);
        if (search_terms_args.accepted_suggestion >= 0 ||
            search_terms_args.searchbox_stats.ByteSizeLong() > 0) {
          HandleReplacement("oq", base::UTF16ToUTF8(encoded_original_query),
                            replacement, &url);
        }
        break;

      case GOOGLE_PAGE_CLASSIFICATION:
        if (search_terms_args.page_classification !=
            metrics::OmniboxEventProto::INVALID_SPEC) {
          HandleReplacement(
              "pgcl",
              base::NumberToString(search_terms_args.page_classification),
              replacement, &url);
        }
        break;

      case GOOGLE_CLIENT_CACHE_TIME_TO_LIVE:
        if (search_terms_args.search_terms.size() == 0 &&
            search_terms_args.zero_suggest_cache_duration_sec > 0) {
          HandleReplacement(
              "ccttl",
              base::NumberToString(
                  search_terms_args.zero_suggest_cache_duration_sec),
              replacement, &url);
        }
        break;

      case GOOGLE_PREFETCH_QUERY: {
        const std::string& query = search_terms_args.prefetch_query;
        const std::string& type = search_terms_args.prefetch_query_type;
        if (!query.empty() && !type.empty()) {
          HandleReplacement(std::string(),
                            "pfq=" + query + "&qha=" + type + "&", replacement,
                            &url);
        }
        break;
      }

      case GOOGLE_PREFETCH_SOURCE: {
        // Ignore this replacement if the fix feature flag is enabled; the
        // parameter will be handled by `GOOGLE_ASSISTED_QUERY_STATS`. See
        // crbug.com/345275145 for details.
        if ((base::FeatureList::GetInstance() &&
             !base::FeatureList::IsEnabled(switches::kPrefetchParameterFix)) &&
            !search_terms_args.prefetch_param.empty()) {
          HandleReplacement("pf", search_terms_args.prefetch_param, replacement,
                            &url);
        }
        break;
      }

      case GOOGLE_RLZ: {
        DCHECK(!replacement.is_post_param);
        // On platforms that don't have RLZ, we still want this branch
        // to happen so that we replace the RLZ template with the
        // empty string.  (If we don't handle this case, we hit a
        // NOTREACHED below.)
        std::u16string rlz_string = search_terms_data.GetRlzParameterValue(
            search_terms_args.request_source == RequestSource::CROS_APP_LIST);
        if (!rlz_string.empty()) {
          HandleReplacement("rlz", base::UTF16ToUTF8(rlz_string), replacement,
                            &url);
          base::UmaHistogramBoolean("Omnibox.TemplateUrl.RlzPresent", true);
        } else {
          base::UmaHistogramBoolean("Omnibox.TemplateUrl.RlzPresent", false);
        }
        break;
      }

      case GOOGLE_SEARCH_CLIENT: {
        DCHECK(!replacement.is_post_param);
        std::string client = search_terms_data.GetSearchClient();
        if (!client.empty()) {
          base::UmaHistogramBoolean("Omnibox.TemplateUrl.SearchClientPresent",
                                    true);
          HandleReplacement("client", client, replacement, &url);
        } else {
          base::UmaHistogramBoolean("Omnibox.TemplateUrl.SearchClientPresent",
                                    false);
        }
        break;
      }

      case GOOGLE_SEARCH_FIELDTRIAL_GROUP:
        // We are not currently running any fieldtrials that modulate the search
        // url.  If we do, then we'd have some conditional insert such as:
        // url.insert(replacement.index, used_www ? "gcx=w&" : "gcx=c&");
        break;

      case GOOGLE_SEARCH_SOURCE: {
        DCHECK(!replacement.is_post_param);
        using OEP = ::metrics::OmniboxEventProto;
        std::string source_param;
        const auto pc = search_terms_args.page_classification;
        if (pc == OEP::NTP ||
            pc == OEP::INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS ||
            pc == OEP::SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT ||
            pc == OEP::SEARCH_RESULT_PAGE_DOING_SEARCH_TERM_REPLACEMENT ||
            pc == OEP::SEARCH_RESULT_PAGE_ON_CCT ||
            pc == OEP::SRP_ZPS_PREFETCH || pc == OEP::OTHER) {
          source_param = "chrome.ob";
        } else if (pc == OEP::NTP_REALBOX) {
          source_param = "chrome.rb";
        }
        if (!source_param.empty()) {
          HandleReplacement("source", source_param, replacement, &url);
        }
        break;
      }

      case GOOGLE_SEARCH_SOURCE_ID: {
        DCHECK(!replacement.is_post_param);
        switch (search_terms_args.request_source) {
          case RequestSource::NTP_MODULE:
          case RequestSource::SEARCHBOX:
          case RequestSource::CROS_APP_LIST:
          case RequestSource::COMPOSEBOX:
          case RequestSource::NTP_ACTION_CHIPS:
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
            HandleReplacement("sourceid", "chrome-mobile", replacement, &url);
#else
            HandleReplacement("sourceid", "chrome", replacement, &url);
#endif
            break;
          case RequestSource::LENS_OVERLAY:
            // Lens Overlay searchboxes don't rely on TemplateURL replacement
            // and set `source=` in //c/b/u/lens/lens_overlay_url_builder.cc.
            break;
        }
        break;
      }

      case GOOGLE_SEARCH_VERSION:
        HandleReplacement("gs_rn", "42", replacement, &url);
        break;

      case GOOGLE_SESSION_TOKEN: {
        std::string token = search_terms_args.session_token;
        if (!token.empty()) {
          HandleReplacement("psi", token, replacement, &url);
        }
        break;
      }

      case GOOGLE_SUGGEST_CLIENT: {
        std::string client_name =
            TemplateURL::GetSuggestionClient(search_terms_args);
        if (!client_name.empty()) {
          HandleReplacement(std::string(), client_name, replacement, &url);
        }
        break;
      }

      case GOOGLE_SUGGEST_PATH: {
        if (search_terms_args.request_source ==
            SearchTermsData::RequestSource::LENS_OVERLAY) {
          // For LENS_OVERLAY requests, we don't have access to the client name
          // here so the final URL construction, including
          // the appropriate client and path, is handled entirely within the
          // RemoteSuggestionsService. We insert a placeholder here, which the
          // RemoteSuggestionsService is responsible for replacing with the
          // correct path.
          HandleReplacement(
              std::string(),
              TemplateURLService::kLensOverlaySuggestPathPlaceholder,
              replacement, &url);
          break;
        }

        const std::string path = TemplateURL::GetSuggestionPath(
            TemplateURL::GetSuggestionClient(search_terms_args));
        HandleReplacement(std::string(), path, replacement, &url);
        base::UmaHistogramBoolean(
            "Omnibox.SuggestionShown.SuggestionResultType",
            path == TemplateURLService::kShortSuggestPath);
        break;
      }

      case GOOGLE_SUGGEST_REQUEST_ID:
        switch (search_terms_args.request_source) {
          case RequestSource::SEARCHBOX:
          case RequestSource::CROS_APP_LIST:
#if BUILDFLAG(IS_ANDROID)
            if (ui::GetDeviceFormFactor() == ui::DEVICE_FORM_FACTOR_PHONE) {
              HandleReplacement(std::string(), "chrome-mobile-ext-ansg",
                                replacement, &url);
              break;
            }
#endif
            if (search_terms_args.page_classification ==
                    metrics::OmniboxEventProto::NTP_REALBOX &&
                search_terms_args.lens_overlay_suggest_inputs.has_value()) {
              // No replacement. `gs_ri` is not recommended for contextual
              // queries.
              break;
            }
            HandleReplacement(std::string(), "chrome-ext-ansg", replacement,
                              &url);
            break;
          case RequestSource::NTP_MODULE:
          case RequestSource::LENS_OVERLAY:
          case RequestSource::COMPOSEBOX:
          case RequestSource::NTP_ACTION_CHIPS:
            // No replacement. `gs_ri` is longer recommended for new clients.
            // New identifiers should be based on their client names.
            break;
        }
        break;

      case GOOGLE_UNESCAPED_SEARCH_TERMS: {
        std::string unescaped_terms;
        base::UTF16ToCodepage(
            search_terms_args.search_terms, input_encoding.c_str(),
            base::OnStringConversionError::SKIP, &unescaped_terms);
        HandleReplacement(std::string(), unescaped_terms, replacement, &url);
        break;
      }

      case LANGUAGE:
        HandleReplacement(std::string(),
                          search_terms_data.GetApplicationLocale(), replacement,
                          &url);
        break;

      case SEARCH_TERMS:
        HandleReplacement(std::string(), base::UTF16ToUTF8(encoded_terms),
                          replacement, &url);
        break;

      case GOOGLE_IMAGE_THUMBNAIL:
        HandleReplacement(std::string(),
                          search_terms_args.image_thumbnail_content,
                          replacement, &url);
        if (replacement.is_post_param) {
          if (!search_terms_args.image_thumbnail_content_type.empty()) {
            post_params_[replacement.index].content_type =
                search_terms_args.image_thumbnail_content_type;
          } else {
            post_params_[replacement.index].content_type = "image/jpeg";
          }
        }
        break;

      case GOOGLE_IMAGE_THUMBNAIL_BASE64: {
        std::string base64_thumbnail_content =
            base::Base64Encode(search_terms_args.image_thumbnail_content);
        HandleReplacement(std::string(), base64_thumbnail_content, replacement,
                          &url);
        if (replacement.is_post_param) {
          if (!search_terms_args.image_thumbnail_content_type.empty()) {
            post_params_[replacement.index].content_type =
                search_terms_args.image_thumbnail_content_type;
          } else {
            post_params_[replacement.index].content_type = "image/jpeg";
          }
        }
        break;
      }

      case GOOGLE_PROCESSED_IMAGE_DIMENSIONS: {
        std::string dimensions = search_terms_args.processed_image_dimensions;
        if (!dimensions.empty()) {
          HandleReplacement(std::string(), dimensions, replacement, &url);
        }
        break;
      }

      case GOOGLE_IMAGE_URL:
        if (search_terms_args.image_url.is_valid()) {
          HandleReplacement(std::string(), search_terms_args.image_url.spec(),
                            replacement, &url);
        }
        break;

      case GOOGLE_IMAGE_ORIGINAL_WIDTH:
        if (!search_terms_args.image_original_size.IsEmpty()) {
          HandleReplacement(std::string(),
                            base::NumberToString(
                                search_terms_args.image_original_size.width()),
                            replacement, &url);
        }
        break;

      case GOOGLE_IMAGE_ORIGINAL_HEIGHT:
        if (!search_terms_args.image_original_size.IsEmpty()) {
          HandleReplacement(std::string(),
                            base::NumberToString(
                                search_terms_args.image_original_size.height()),
                            replacement, &url);
        }
        break;

      case GOOGLE_IMAGE_SEARCH_SOURCE:
        HandleReplacement(std::string(),
                          search_terms_data.GoogleImageSearchSource(),
                          replacement, &url);
        break;

      case GOOGLE_LANGUAGE:
#if BUILDFLAG(IS_IOS)
        if (base::FeatureList::IsEnabled(
                omnibox::kReportApplicationLanguageInSearchRequest)) {
          HandleReplacement("hl", search_terms_data.GetApplicationLocale(),
                            replacement, &url);
        }
#endif
        break;

      case YANDEX_REFERRAL_ID: {
        std::string referral_id = search_terms_data.GetYandexReferralID();
        if (!referral_id.empty()) {
          HandleReplacement("clid", referral_id, replacement, &url);
        }
        break;
      }

      case MAIL_RU_REFERRAL_ID: {
        std::string referral_id = search_terms_data.GetMailRUReferralID();
        if (!referral_id.empty()) {
          HandleReplacement("gp", referral_id, replacement, &url);
        }
        break;
      }

      case IMAGE_TRANSLATE_SOURCE_LOCALE: {
        if (!search_terms_args.image_translate_source_locale.empty()) {
          HandleReplacement(owner_->image_translate_source_language_param_key(),
                            search_terms_args.image_translate_source_locale,
                            replacement, &url);
        }
        break;
      }

      case IMAGE_TRANSLATE_TARGET_LOCALE: {
        if (!search_terms_args.image_translate_target_locale.empty()) {
          HandleReplacement(owner_->image_translate_target_language_param_key(),
                            search_terms_args.image_translate_target_locale,
                            replacement, &url);
        }
        break;
      }

      default:
        NOTREACHED();
    }
  }

  if (!post_params_.empty()) {
    EncodeFormData(post_params_, post_content);
  }
  return url;
}

// TemplateURL ----------------------------------------------------------------

TemplateURL::AssociatedExtensionInfo::AssociatedExtensionInfo(
    const std::string& extension_id,
    base::Time install_time,
    bool wants_to_be_default_engine)
    : extension_id(extension_id),
      install_time(install_time),
      wants_to_be_default_engine(wants_to_be_default_engine) {}

TemplateURL::AssociatedExtensionInfo::~AssociatedExtensionInfo() = default;

size_t TemplateURL::AssociatedExtensionInfo::EstimateMemoryUsage() const {
  return base::trace_event::EstimateMemoryUsage(extension_id);
}

TemplateURL::TemplateURL(const TemplateURLData& data, Type type)
    : TemplateURL(data, std::nullopt, type) {}

TemplateURL::TemplateURL(const std::optional<TemplateURLData>& local_data,
                         const std::optional<TemplateURLData>& account_data,
                         Type type)
    : local_data_(local_data),
      account_data_(account_data),
      suggestions_url_ref_(this, TemplateURLRef::SUGGEST),
      image_url_ref_(this, TemplateURLRef::IMAGE),
      image_translate_url_ref_(this, TemplateURLRef::IMAGE_TRANSLATE),
      new_tab_url_ref_(this, TemplateURLRef::NEW_TAB),
      contextual_search_url_ref_(this, TemplateURLRef::CONTEXTUAL_SEARCH),
      type_(type),
      engine_type_(SEARCH_ENGINE_UNKNOWN) {
  CHECK(local_data || account_data);
  ResizeURLRefVector();
  SetPrepopulateId(active_data().prepopulate_id);
}

TemplateURL::TemplateURL(const TemplateURLData& data,
                         Type type,
                         std::string extension_id,
                         base::Time install_time,
                         bool wants_to_be_default_engine)
    : TemplateURL(data, type) {
  DCHECK(type == NORMAL_CONTROLLED_BY_EXTENSION ||
         type == OMNIBOX_API_EXTENSION);
  // Omnibox keywords may not be set as default.
  DCHECK(!wants_to_be_default_engine || type != OMNIBOX_API_EXTENSION) << type;
  DCHECK_EQ(kInvalidTemplateURLID, data.id);
  extension_info_ = std::make_unique<AssociatedExtensionInfo>(
      extension_id, install_time, wants_to_be_default_engine);
}

TemplateURL::TemplateURL(TemplateURL&& other) = default;

TemplateURL::~TemplateURL() = default;

bool TemplateURL::IsBetterThanConflictingEngine(
    const TemplateURL* other) const {
  DCHECK(other);

  // Site search and Enterprise Search Aggregator engines set by enterprise
  // policy have different priority over existing search engines because we
  // don't want to break current workflows for power users.
  if (CreatedByNonDefaultSearchProviderPolicy() && !other->CreatedByPolicy()) {
    return IsPolicySearchEngineBetterThanNonPolicyEngine(this, other);
  } else if (!CreatedByPolicy() &&
             other->CreatedByNonDefaultSearchProviderPolicy()) {
    return !IsPolicySearchEngineBetterThanNonPolicyEngine(other, this);
  } else if (CreatedByNonDefaultSearchProviderPolicy() &&
             other->CreatedByNonDefaultSearchProviderPolicy()) {
    // If both engines are created by the `SiteSearchSettings` or
    // `EnterpriseSearchAggregatorSettings` policy, prefer the one that is
    // featured. Otherwise, fallback to the comparison based on the signals
    // below.
    if (this->featured_by_policy() && !other->featured_by_policy()) {
      return true;
    } else if (!this->featured_by_policy() && other->featured_by_policy()) {
      return false;
    }
  }

  auto get_sort_key = [](const TemplateURL* engine) {
    return std::make_tuple(
        // Policy-created engines always win over non-policy created engines.
        // At this point, managed search engine should be created by DSP policy.
        engine->CreatedByDefaultSearchProviderPolicy(),
        // Policy-enforced engines always win over policy-recommended engines.
        engine->enforced_by_policy(),
        // Favor starter pack engines over other engines.
        engine->starter_pack_id() !=
            template_url_starter_pack_data::StarterPackId::kNone,
        // The integral value of the type enum is used to sort next.
        // This makes extension-controlled engines win.
        engine->type(),
        // For engines with associated extensions; more recently installed
        // extensions win.
        engine->extension_info_ ? engine->extension_info_->install_time
                                : base::Time(),
        // Prefer engines that CANNOT be auto-replaced.
        !engine->safe_for_autoreplace(),
        // Prefer engines created by regulatory programs.
        engine->CreatedByRegulatoryProgram(),
        // Favor prepopulated engines over other auto-generated engines.
        engine->prepopulate_id() > 0,
        // Favor engines derived from OpenSearch descriptions over
        // autogenerated engines heuristically generated from searchable forms.
        engine->originating_url().is_valid(),
        // More recently modified engines or created engines win.
        engine->last_modified(), engine->date_created(),
        // TODO(tommycli): This should be a tie-breaker than provides a total
        // ordering of all TemplateURLs so that distributed clients resolve
        // conflicts identically. This sync_guid is not globally unique today,
        // so we need to fix that before we can resolve conflicts with this.
        engine->sync_guid());
  };

  // Although normally sort is done by operator<, in this case, we want the
  // BETTER engine to be preceding the worse engine.
  return get_sort_key(this) > get_sort_key(other);
}

// static
std::u16string TemplateURL::GenerateKeyword(const GURL& url) {
  DCHECK(url.is_valid());
  // Strip "www." off the front of the keyword; otherwise the keyword won't work
  // properly.  See http://code.google.com/p/chromium/issues/detail?id=6984 .
  // |url|'s hostname may be IDN-encoded. Before generating |keyword| from it,
  // convert to Unicode, so it won't look like a confusing punycode string.
  std::u16string keyword =
      url_formatter::IDNToUnicode(url_formatter::StripWWW(url.GetHost()));
  return base::i18n::ToLower(keyword);
}

// static
GURL TemplateURL::GenerateFaviconURL(const GURL& url) {
  DCHECK(url.is_valid());
  GURL::Replacements rep;

  static const char kFaviconPath[] = "/favicon.ico";

  rep.SetPathStr(kFaviconPath);
  rep.ClearUsername();
  rep.ClearPassword();
  rep.ClearQuery();
  rep.ClearRef();
  return url.ReplaceComponents(rep);
}

// static
std::string TemplateURL::GetSuggestionClient(
    const TemplateURLRef::SearchTermsArgs& search_terms_args) {
  switch (search_terms_args.request_source) {
    case SearchTermsData::RequestSource::NTP_MODULE:
#if BUILDFLAG(IS_ANDROID)
      return "chrome-android-search-resumption-module";
#elif BUILDFLAG(IS_IOS)
      return "chrome-ios-ntp";
#else
      NOTREACHED();
#endif
    case SearchTermsData::RequestSource::SEARCHBOX:
    case SearchTermsData::RequestSource::CROS_APP_LIST:
#if BUILDFLAG(IS_ANDROID)
      if (ui::GetDeviceFormFactor() == ui::DEVICE_FORM_FACTOR_PHONE) {
        return "chrome";
      }
      return "chrome-omni";
#elif BUILDFLAG(IS_IOS)
      return "chrome";
#else
      return "chrome-omni";
#endif
    case SearchTermsData::RequestSource::COMPOSEBOX: {
      // Co-browsing composebox uses a different client since its zps
      // behave differently.
      if (search_terms_args.page_classification ==
          metrics::OmniboxEventProto::CO_BROWSING_COMPOSEBOX) {
        return "chrome-cobrowse-compose";
      }
      // SearchTermsData::RequestSource::COMPOSEBOX will use
      // "chrome-omni" for delayed context uploads.
      // TODO(crbug.com/460858102): Figure out how to support delayed uploads
      // using "chrome-compose."
      if (base::FeatureList::IsEnabled(
              omnibox::kComposeboxUsesChromeComposeClient)) {
        // `kComposeboxUsesChromeComposeClient` is ENABLED
        if (search_terms_args.page_classification ==
                metrics::OmniboxEventProto::NTP_COMPOSEBOX &&
            !search_terms_args.current_page_url.empty()) {
          return "chrome-omni";
        } else {
          return omnibox::kComposeboxClientOverride.Get();
        }
      } else {
        // `kComposeboxUsesChromeComposeClient` is DISABLED
        return "chrome-omni";
      }
    }
    case SearchTermsData::RequestSource::NTP_ACTION_CHIPS: {
      return "chrome-ntp-action";
    }
    case SearchTermsData::RequestSource::LENS_OVERLAY: {
      // No replacement. Lens Overlay searchboxes don't rely on
      // TemplateURL replacement and set `client=` in
      // //components/omnibox/browser/remote_suggestions_service.cc.
      return "";
    }
  }

  return "";
}

// static
std::string TemplateURL::GetSuggestionPath(const std::string& client_name) {
  if (base::FeatureList::GetInstance()) {
    const auto& config =
        omnibox_feature_configs::SuggestPathClientConfig::Get();
    if (config.ShouldUseShortPath(client_name)) {
      return TemplateURLService::kShortSuggestPath;
    }
  }

  return TemplateURLService::kSuggestPath;
}

// static
bool TemplateURL::MatchesData(const TemplateURL* t_url,
                              const TemplateURLData* data,
                              const SearchTermsData& search_terms_data) {
  if (!t_url || !data) {
    return !t_url && !data;
  }

  return (t_url->short_name() == data->short_name()) &&
         t_url->HasSameKeywordAs(*data, search_terms_data) &&
         (t_url->url() == data->url()) &&
         (t_url->suggestions_url() == data->suggestions_url) &&
         (t_url->image_url() == data->image_url) &&
         (t_url->image_translate_url() == data->image_translate_url) &&
         (t_url->new_tab_url() == data->new_tab_url) &&
         (t_url->search_url_post_params() == data->search_url_post_params) &&
         (t_url->suggestions_url_post_params() ==
          data->suggestions_url_post_params) &&
         (t_url->image_url_post_params() == data->image_url_post_params) &&
         (t_url->safe_for_autoreplace() == data->safe_for_autoreplace) &&
         (t_url->input_encodings() == data->input_encodings) &&
         (t_url->alternate_urls() == data->alternate_urls);
}

std::u16string TemplateURL::AdjustedShortNameForLocaleDirection() const {
  std::u16string bidi_safe_short_name = data().short_name();
  base::i18n::AdjustStringForLocaleDirection(&bidi_safe_short_name);
  return bidi_safe_short_name;
}

bool TemplateURL::SupportsReplacement(
    const SearchTermsData& search_terms_data) const {
  return url_ref().SupportsReplacement(search_terms_data);
}

bool TemplateURL::HasGoogleBaseURLs(
    const SearchTermsData& search_terms_data) const {
  if (std::ranges::any_of(url_refs_, [&](const TemplateURLRef& ref) {
        return ref.HasGoogleBaseURLs(search_terms_data);
      })) {
    return true;
  }

  return suggestions_url_ref_.HasGoogleBaseURLs(search_terms_data) ||
         image_url_ref_.HasGoogleBaseURLs(search_terms_data) ||
         image_translate_url_ref_.HasGoogleBaseURLs(search_terms_data) ||
         new_tab_url_ref_.HasGoogleBaseURLs(search_terms_data) ||
         contextual_search_url_ref_.HasGoogleBaseURLs(search_terms_data);
}

bool TemplateURL::IsGoogleSearchURLWithReplaceableKeyword(
    const SearchTermsData& search_terms_data) const {
  return (type_ == NORMAL) && url_ref().HasGoogleBaseURLs(search_terms_data) &&
         google_util::IsGoogleHostname(base::UTF16ToUTF8(data().keyword()),
                                       google_util::DISALLOW_SUBDOMAIN);
}

bool TemplateURL::HasSameKeywordAs(
    const TemplateURLData& other,
    const SearchTermsData& search_terms_data) const {
  return (data().keyword() == other.keyword()) ||
         (IsGoogleSearchURLWithReplaceableKeyword(search_terms_data) &&
          TemplateURL(other).IsGoogleSearchURLWithReplaceableKeyword(
              search_terms_data));
}

std::string TemplateURL::GetExtensionId() const {
  DCHECK(extension_info_);
  return GetExtensionInfo()->extension_id;
}

std::optional<std::string_view> TemplateURL::GetBaseBuiltinResourceId() const {
  if constexpr (!kEnableBuiltinSearchProviderAssets) {
    return std::nullopt;
  }

  // User-defined engines should not be decorated with branded icons.
  if (data().prepopulate_id == 0) {
    return std::nullopt;
  }

  if (!base_builtin_resource_id_.has_value()) {
    // 1. Attempt to identify the definition by keyword.
    // This is going to handle 99% of the cases correctly, including Yahoo
    // variants, where different countries may use different assets.
    const TemplateURLPrepopulateData::PrepopulatedEngine*
        reference_builtin_engine =
            TemplateURLPrepopulateData::GetPrepopulatedEngineFromBuiltInData(
                data().keyword(),
                /*regional_prepopulated_engines=*/{},
                /*regional_variants=*/{});

    if (!reference_builtin_engine) {
      // 2. Attempt to identify the definition by prepopulate_id.
      // Failed to look up engine by keyword. Fall back to identifying engine by
      // matching prepopulate id. This might cause some assets to be incorrectly
      // assigned if the regional variant of a search engine expects to use a
      // different asset which has not been supplied (see: Yahoo vs Yahoo JP).
      reference_builtin_engine =
          TemplateURLPrepopulateData::GetPrepopulatedEngineFromBuiltInData(
              data().prepopulate_id,
              /*regional_prepopulated_engines=*/{},
              /*regional_variants=*/{});
    }

    if (reference_builtin_engine &&
        reference_builtin_engine->base_builtin_resource_id) {
      base_builtin_resource_id_ =
          reference_builtin_engine->base_builtin_resource_id;
    } else {
      base_builtin_resource_id_ = std::optional<std::string_view>();
    }
  }

  return base_builtin_resource_id_.value();
}

std::string TemplateURL::GetBuiltinImageResourceId() const {
  std::optional<std::string_view> base_resource_id = GetBaseBuiltinResourceId();
  if (base_resource_id.has_value()) {
    return base::StrCat({"IDR_", base_resource_id.value(), "_IMAGE"});
  }
  return "IDR_DEFAULT_FAVICON";
}

std::string TemplateURL::GetBuiltinDescriptionResourceId() const {
  std::optional<std::string_view> base_resource_id = GetBaseBuiltinResourceId();
  if (base_resource_id.has_value()) {
    return base::StrCat({"IDS_", base_resource_id.value(), "_DESCRIPTION"});
  }
  return {};
}

std::optional<std::u16string> TemplateURL::GetBuiltinMarketingSnippet() const {
#if BUILDFLAG(ENABLE_BUILTIN_SEARCH_PROVIDER_ASSETS) && !BUILDFLAG(IS_ANDROID)
  auto resource_id = GetBuiltinDescriptionResourceId();
  if (!resource_id.empty()) {
    auto iter = std::ranges::find_if(
        kSearchEngineDescriptionsStrings,
        [&](const auto& resource) { return resource.path == resource_id; });

    if (iter != std::end(kSearchEngineDescriptionsStrings)) {
      return l10n_util::GetStringUTF16(iter->id);
    }
  }
#endif
  return std::nullopt;
}

#if !BUILDFLAG(IS_ANDROID)
std::u16string TemplateURL::GetMarketingSnippet() const {
  return GetBuiltinMarketingSnippet().value_or(l10n_util::GetStringFUTF16(
      IDS_SEARCH_ENGINE_FALLBACK_MARKETING_SNIPPET, short_name()));
}
#endif

SearchEngineType TemplateURL::GetEngineType(
    const SearchTermsData& search_terms_data) const {
  if (engine_type_ == SEARCH_ENGINE_UNKNOWN) {
    const GURL url = GenerateSearchURL(search_terms_data);
    engine_type_ = url.is_valid() ? search_engine_utils::GetEngineType(url)
                                  : SEARCH_ENGINE_OTHER;
    DCHECK_NE(SEARCH_ENGINE_UNKNOWN, engine_type_);
  }
  return engine_type_;
}

BuiltinEngineType TemplateURL::GetBuiltinEngineType() const {
  if (data().prepopulate_id != 0) {
    return KEYWORD_MODE_PREPOPULATED_ENGINE;
  } else if (starter_pack_id() !=
             template_url_starter_pack_data::StarterPackId::kNone) {
    switch (starter_pack_id()) {
      case template_url_starter_pack_data::StarterPackId::kBookmarks:
        return KEYWORD_MODE_STARTER_PACK_BOOKMARKS;
      case template_url_starter_pack_data::StarterPackId::kHistory:
        return KEYWORD_MODE_STARTER_PACK_HISTORY;
      case template_url_starter_pack_data::StarterPackId::kTabs:
        return KEYWORD_MODE_STARTER_PACK_TABS;
      case template_url_starter_pack_data::StarterPackId::kGemini:
        return KEYWORD_MODE_STARTER_PACK_GEMINI;
      case template_url_starter_pack_data::StarterPackId::kPage:
        return KEYWORD_MODE_STARTER_PACK_PAGE;
      case template_url_starter_pack_data::StarterPackId::kAiMode:
        return KEYWORD_MODE_STARTER_PACK_AI_MODE;
      default:
        // In theory, this code path should never be reached.  However, it's
        // possible that when expanding the starter pack, a new entry may
        // persist in the database that does not yet exist in this version of
        // chrome. (e.g. a user runs a newer version with the new starter pack
        // entry, has sync on, which syncs to another login instance running an
        // older version that hasn't received the new starter pack update yet).
        // Realistically, this is not catastrophic.
        return KEYWORD_MODE_NON_BUILT_IN;
    }
  } else {
    return KEYWORD_MODE_NON_BUILT_IN;
  }
}

bool TemplateURL::ExtractSearchTermsFromURL(
    const GURL& url,
    const SearchTermsData& search_terms_data,
    std::u16string* search_terms) const {
  return FindSearchTermsInURL(url, search_terms_data, search_terms, nullptr,
                              nullptr);
}

bool TemplateURL::IsSearchURL(const GURL& url,
                              const SearchTermsData& search_terms_data) const {
  std::u16string search_terms;
  return ExtractSearchTermsFromURL(url, search_terms_data, &search_terms) &&
         !search_terms.empty();
}

bool TemplateURL::KeepSearchTermsInURL(const GURL& url,
                                       const SearchTermsData& search_terms_data,
                                       const bool keep_search_intent_params,
                                       const bool normalize_search_terms,
                                       GURL* out_url,
                                       std::u16string* out_search_terms) const {
  std::u16string search_terms;
  if (!ExtractSearchTermsFromURL(url, search_terms_data, &search_terms) ||
      search_terms.empty()) {
    return false;
  }

  if (normalize_search_terms) {
    search_terms =
        base::i18n::ToLower(base::CollapseWhitespace(search_terms, false));
  }

  if (!url_ref().SupportsReplacement(search_terms_data)) {
    return false;
  }

  std::vector<std::string> query_params;
  if (keep_search_intent_params && !data().search_intent_params.empty()) {
    for (net::QueryIterator it(url); !it.IsAtEnd(); it.Advance()) {
      if (!std::ranges::contains(data().search_intent_params, it.GetKey())) {
        continue;
      }
      query_params.push_back(base::StrCat({it.GetKey(), "=", it.GetValue()}));
    }
  }

  TemplateURLRef::SearchTermsArgs search_terms_args(search_terms);
  search_terms_args.additional_query_params =
      base::JoinString(query_params, "&");

  *out_url =
      GURL(url_ref().ReplaceSearchTerms(search_terms_args, search_terms_data));
  if (out_search_terms) {
    *out_search_terms = search_terms;
  }
  return true;
}

bool TemplateURL::ReplaceSearchTermsInURL(
    const GURL& url,
    const TemplateURLRef::SearchTermsArgs& search_terms_args,
    const SearchTermsData& search_terms_data,
    GURL* result) const {
  // TODO(beaudoin): Use AQS from |search_terms_args| too.
  url::Parsed::ComponentType search_term_component;
  url::Component search_terms_position;
  std::u16string search_terms;
  if (!FindSearchTermsInURL(url, search_terms_data, &search_terms,
                            &search_term_component, &search_terms_position)) {
    return false;
  }
  DCHECK(search_terms_position.is_nonempty());

  // Query and ref are encoded in the same way.
  const bool is_in_query = (search_term_component != url::Parsed::PATH);

  std::string input_encoding;
  std::u16string encoded_terms;
  std::u16string encoded_original_query;
  EncodeSearchTerms(search_terms_args, is_in_query, &input_encoding,
                    &encoded_terms, &encoded_original_query);

  std::string old_params;
  if (search_term_component == url::Parsed::QUERY) {
    old_params = url.GetQuery();
  } else if (search_term_component == url::Parsed::REF) {
    old_params = url.GetRef();
  } else {
    DCHECK_EQ(search_term_component, url::Parsed::PATH);
    old_params = url.GetPath();
  }

  std::string new_params(old_params, 0, search_terms_position.begin);
  new_params += base::UTF16ToUTF8(encoded_terms);
  new_params += old_params.substr(search_terms_position.end());
  GURL::Replacements replacements;

  if (search_term_component == url::Parsed::QUERY) {
    replacements.SetQueryStr(new_params);
  } else if (search_term_component == url::Parsed::REF) {
    replacements.SetRefStr(new_params);
  } else {
    DCHECK_EQ(search_term_component, url::Parsed::PATH);
    replacements.SetPathStr(new_params);
  }

  *result = url.ReplaceComponents(replacements);
  return true;
}

void TemplateURL::EncodeSearchTerms(
    const TemplateURLRef::SearchTermsArgs& search_terms_args,
    bool is_in_query,
    std::string* input_encoding,
    std::u16string* encoded_terms,
    std::u16string* encoded_original_query) const {
  std::vector<std::string> encodings(input_encodings());
  if (!std::ranges::contains(encodings, "UTF-8")) {
    encodings.push_back("UTF-8");
  }
  for (auto i = encodings.begin(); i != encodings.end(); ++i) {
    if (TryEncoding(search_terms_args.search_terms,
                    search_terms_args.original_query, i->c_str(), is_in_query,
                    std::next(i) == encodings.end(), encoded_terms,
                    encoded_original_query)) {
      *input_encoding = *i;
      return;
    }
  }
  NOTREACHED();
}

GURL TemplateURL::GenerateSearchURL(const SearchTermsData& search_terms_data,
                                    const std::u16string& search_terms) const {
  if (!url_ref().IsValid(search_terms_data)) {
    return GURL();
  }

  if (!url_ref().SupportsReplacement(search_terms_data)) {
    return GURL(url());
  }

  return GURL(url_ref().ReplaceSearchTerms(
      TemplateURLRef::SearchTermsArgs(search_terms), search_terms_data,
      nullptr));
}

GURL TemplateURL::GenerateSuggestionURL(
    const SearchTermsData& search_terms_data) const {
  if (!suggestions_url_ref().IsValid(search_terms_data)) {
    return GURL();
  }

  if (!suggestions_url_ref().SupportsReplacement(search_terms_data)) {
    return GURL(suggestions_url());
  }

  return GURL(suggestions_url_ref().ReplaceSearchTerms(
      TemplateURLRef::SearchTermsArgs(), search_terms_data, nullptr));
}

bool TemplateURL::CreatedByPolicy() const {
  return data().CreatedByPolicy();
}

bool TemplateURL::CreatedByDefaultSearchProviderPolicy() const {
  return data().CreatedByDefaultSearchProviderPolicy();
}

bool TemplateURL::CreatedByNonDefaultSearchProviderPolicy() const {
  return data().CreatedByNonDefaultSearchProviderPolicy();
}

bool TemplateURL::CreatedByEnterpriseSearchAggregatorPolicy() const {
  return data().CreatedByEnterpriseSearchAggregatorPolicy();
}

bool TemplateURL::CreatedByRegulatoryProgram() const {
  return data().CreatedByRegulatoryProgram();
}

bool TemplateURL::RequiresRemovalConfirmation() const {
  return prepopulate_id() != 0 || CreatedByNonDefaultSearchProviderPolicy();
}

RegulatoryExtensionType TemplateURL::GetRegulatoryExtensionType() const {
  return data().regulatory_origin;
}

const TemplateURLData::RegulatoryExtension* TemplateURL::GetRegulatoryExtension(
    RegulatoryExtensionType type) const {
  auto extension_iter = data().regulatory_extensions.find(type);
  auto* extension = extension_iter == data().regulatory_extensions.end()
                        ? nullptr
                        : extension_iter->second.get();

  DCHECK(extension == nullptr || extension->variant == type);
  return extension;
}

void TemplateURL::CopyFrom(const TemplateURL& other) {
  if (this == &other) {
    return;
  }

  local_data_ = other.local_data_;
  account_data_ = other.account_data_;
  ResizeURLRefVector();
  InvalidateCachedValues();
  SetPrepopulateId(other.data().prepopulate_id);
}

void TemplateURL::SetURL(const std::string& url) {
  active_data().SetURL(url);

  engine_type_ = SEARCH_ENGINE_UNKNOWN;
  url_ref().InvalidateCachedValues();
}

void TemplateURL::SetPrepopulateId(int id) {
  active_data().prepopulate_id = id;
  const bool prepopulated = id > 0;
  for (TemplateURLRef& ref : url_refs_) {
    ref.prepopulated_ = prepopulated;
  }
  suggestions_url_ref_.prepopulated_ = prepopulated;
  image_url_ref_.prepopulated_ = prepopulated;
  image_translate_url_ref_.prepopulated_ = prepopulated;
  new_tab_url_ref_.prepopulated_ = prepopulated;
  contextual_search_url_ref_.prepopulated_ = prepopulated;
}

void TemplateURL::ResetKeywordIfNecessary(
    const SearchTermsData& search_terms_data,
    bool force) {
  if (IsGoogleSearchURLWithReplaceableKeyword(search_terms_data) || force) {
    DCHECK_NE(OMNIBOX_API_EXTENSION, type_);
    GURL url(GenerateSearchURL(search_terms_data));
    if (url.is_valid()) {
      active_data().SetKeyword(GenerateKeyword(url));
    }
  }
}

void TemplateURL::InvalidateCachedValues() const {
  for (const TemplateURLRef& ref : url_refs_) {
    ref.InvalidateCachedValues();
  }
  suggestions_url_ref_.InvalidateCachedValues();
  image_url_ref_.InvalidateCachedValues();
  image_translate_url_ref_.InvalidateCachedValues();
  new_tab_url_ref_.InvalidateCachedValues();
  contextual_search_url_ref_.InvalidateCachedValues();
}

size_t TemplateURL::EstimateMemoryUsage() const {
  size_t res = 0;

  if (local_data_) {
    res += base::trace_event::EstimateMemoryUsage(*local_data_);
  }
  if (account_data_) {
    res += base::trace_event::EstimateMemoryUsage(*account_data_);
  }
  res += base::trace_event::EstimateMemoryUsage(url_refs_);
  res += base::trace_event::EstimateMemoryUsage(suggestions_url_ref_);
  res += base::trace_event::EstimateMemoryUsage(image_url_ref_);
  res += base::trace_event::EstimateMemoryUsage(image_translate_url_ref_);
  res += base::trace_event::EstimateMemoryUsage(new_tab_url_ref_);
  res += base::trace_event::EstimateMemoryUsage(contextual_search_url_ref_);
  res += base::trace_event::EstimateMemoryUsage(extension_info_);

  return res;
}

void TemplateURL::ResizeURLRefVector() {
  const size_t new_size = active_data().alternate_urls.size() + 1;
  if (url_refs_.size() == new_size) {
    return;
  }

  url_refs_.clear();
  url_refs_.reserve(new_size);
  for (size_t i = 0; i != active_data().alternate_urls.size(); ++i) {
    url_refs_.emplace_back(this, i);
  }
  url_refs_.emplace_back(this, TemplateURLRef::SEARCH);
}

bool TemplateURL::FindSearchTermsInURL(
    const GURL& url,
    const SearchTermsData& search_terms_data,
    std::u16string* search_terms,
    url::Parsed::ComponentType* search_term_component,
    url::Component* search_terms_position) const {
  DCHECK(search_terms);
  search_terms->clear();

  // Try to match with every pattern.
  for (const TemplateURLRef& ref : url_refs_) {
    if (ref.ExtractSearchTermsFromURL(url, search_terms, search_terms_data,
                                      search_term_component,
                                      search_terms_position)) {
      // If ExtractSearchTermsFromURL() returns true and |search_terms| is empty
      // it means the pattern matched but no search terms were present. In this
      // case we fail immediately without looking for matches in subsequent
      // patterns. This means that given patterns
      //    [ "http://foo/#q={searchTerms}", "http://foo/?q={searchTerms}" ],
      // calling ExtractSearchTermsFromURL() on "http://foo/?q=bar#q=' would
      // return false. This is important for at least Google, where such URLs
      // are invalid.
      return !search_terms->empty();
    }
  }
  return false;
}

const TemplateURLData& TemplateURL::data() const {
  return const_cast<TemplateURL*>(this)->active_data();
}

TemplateURLData& TemplateURL::active_data() {
  CHECK(local_data_ || base::FeatureList::IsEnabled(
                           syncer::kSeparateLocalAndAccountSearchEngines));
  CHECK(!account_data_ || base::FeatureList::IsEnabled(
                              syncer::kSeparateLocalAndAccountSearchEngines));
  // TODO(crbug.com/386916073): Improve the conflict resolution.
  if (local_data_ && account_data_) {
    TemplateURL local_turl(local_data_, std::nullopt);
    TemplateURL account_turl(std::nullopt, account_data_);
    return local_turl.IsBetterThanConflictingEngine(&account_turl)
               ? *local_data_
               : *account_data_;
  }
  return local_data_ ? *local_data_ : *account_data_;
}

void TemplateURL::set_short_name(const std::u16string& short_name) {
  active_data().SetShortName(short_name);
}

void TemplateURL::set_keyword(const std::u16string& keyword) {
  active_data().SetKeyword(keyword);
}

void TemplateURL::set_safe_for_autoreplace(bool safe_for_autoreplace) {
  active_data().safe_for_autoreplace = safe_for_autoreplace;
}

void TemplateURL::set_id(TemplateURLID id) {
  active_data().id = id;
}

void TemplateURL::IncrementUsageCount() {
  active_data().usage_count++;
}

void TemplateURL::GenerateSyncGUID() {
  active_data().GenerateSyncGUID();
}

void TemplateURL::set_is_active(TemplateURLData::ActiveStatus active_status) {
  active_data().is_active = active_status;
}

const std::optional<TemplateURLData>& TemplateURL::GetLocalData() const {
  return local_data_;
}

const std::optional<TemplateURLData>& TemplateURL::GetAccountData() const {
  return account_data_;
}

void TemplateURL::CopyActiveValueToLocalAndAccount() {
  TemplateURLData new_data = data();
  local_data_ = new_data;
  account_data_ = new_data;
}

bool TemplateURL::CanPolicyBeOverridden() const {
  switch (policy_origin()) {
    case TemplateURLData::PolicyOrigin::kSiteSearch:
      return !enforced_by_policy();
    case TemplateURLData::PolicyOrigin::kDefaultSearchProvider:
    case TemplateURLData::PolicyOrigin::kSearchAggregator:
    case TemplateURLData::PolicyOrigin::kNoPolicy:
      return false;
  }
}

std::u16string TemplateURL::GetFullName() const {
  std::u16string short_name = AdjustedShortNameForLocaleDirection();

  if (is_ask_type()) {
    return l10n_util::GetStringFUTF16(IDS_OMNIBOX_SELECTED_KEYWORD_ASK_TEXT,
                                      short_name);
  } else if (starter_pack_id() ==
             template_url_starter_pack_data::StarterPackId::kPage) {
    return l10n_util::GetStringUTF16(IDS_STARTER_PACK_PAGE_KEYWORD_TEXT);
  } else if (type() == TemplateURL::OMNIBOX_API_EXTENSION) {
    return short_name;
  }
  return l10n_util::GetStringFUTF16(IDS_OMNIBOX_KEYWORD_TEXT_MD, short_name);
}