net/base/url_search_params_view.cc

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

#include "net/base/url_search_params_view.h"

#include <algorithm>
#include <concepts>
#include <ranges>
#include <string>
#include <string_view>
#include <utility>
#include <vector>

#include "base/check.h"
#include "base/containers/to_vector.h"
#include "base/strings/string_number_conversions.h"
#include "net/base/url_unescape_iterator.h"
#include "net/base/url_util.h"
#include "url/gurl.h"

namespace net {

namespace {

std::string Unescape(std::string_view view) {
  const auto unescaped_range = MakeUrlUnescapeRange(view);
  std::string decoded(std::ranges::begin(unescaped_range),
                      std::ranges::end(unescaped_range));
  return decoded;
}

// %-Escapes metacharacters in `utf8` and appends it to `output`. Only a minimal
// set of characters are escaped.
template <typename Range>
  requires(std::convertible_to<std::ranges::range_value_t<Range>, char>)
void EscapeRangeAndAppendToString(const Range& utf8, std::string& output) {
  for (char c : utf8) {
    // The character comparisons are written in a simple way rather that using a
    // base::flat_set or similar, because Clang optimizes this pattern really
    // effectively.
    const bool is_special_in_query = c == '&' || c == '=';
    const bool is_url_escape_metacharacter = c == '%' || c == '+';
    const bool is_start_of_fragment = c == '#';
    const bool is_common_source_of_coding_errors = c == '\0';
    if (is_special_in_query || is_url_escape_metacharacter ||
        is_start_of_fragment || is_common_source_of_coding_errors) {
      output.push_back('%');
      base::AppendHexEncodedByte(static_cast<uint8_t>(c), output);
    } else {
      output.push_back(c);
    }
  }
}

}  // namespace

UrlSearchParamsView::UrlSearchParamsView(const GURL& url) {
  for (auto it = QueryIterator(url); !it.IsAtEnd(); it.Advance()) {
    // Keys are actively unescaped and copied during construction. Values are
    // not copied, and are lazily unescaped on use.
    params_.emplace_back(Unescape(it.GetKey()), it.GetValue());
  }
}

UrlSearchParamsView::~UrlSearchParamsView() = default;

bool UrlSearchParamsView::operator==(const UrlSearchParamsView& other) const =
    default;

void UrlSearchParamsView::Sort() {
  if (params_.size() <= 1u) {
    // No sort needed, so avoid doing any work.
    return;
  }

  // Note: the standard specifies sorting by UTF-16 code unit. Here we are
  // sorting by UTF-8 code unit, which will give a different order in some edge
  // cases, but because we only care about normalizing the order, and not the
  // actual order itself, it doesn't matter.
  std::ranges::stable_sort(params_, std::less<>(), &KeyValue::unescaped_key);
}

void UrlSearchParamsView::DeleteAllWithNames(
    const base::flat_set<std::string>& names) {
  absl::erase_if(params_, [&names](const KeyValue& key_value) {
    return names.contains(key_value.unescaped_key);
  });
}

void UrlSearchParamsView::DeleteAllExceptWithNames(
    const base::flat_set<std::string>& names) {
  absl::erase_if(params_, [&names](const KeyValue& key_value) {
    return !names.contains(key_value.unescaped_key);
  });
}

std::string UrlSearchParamsView::SerializeAsUtf8() const {
  std::string output;
  output.reserve(EstimateSerializedOutputSize());
  bool first = true;
  for (const auto& [unescaped_key, escaped_value] : params_) {
    if (first) {
      first = false;
    } else {
      output.push_back('&');
    }
    EscapeRangeAndAppendToString(unescaped_key, output);
    output.push_back('=');
    EscapeRangeAndAppendToString(MakeUrlUnescapeRange(escaped_value), output);
  }
  return output;
}

std::vector<std::pair<std::string, std::string>>
UrlSearchParamsView::GetDecodedParamsForTesting() const {
  return base::ToVector(params_, [](const KeyValue& key_value) {
    return std::pair(key_value.unescaped_key,
                     Unescape(key_value.escaped_value));
  });
}

bool UrlSearchParamsView::KeyValue::operator==(const KeyValue& other) const {
  return unescaped_key == other.unescaped_key &&
         EqualsAfterUrlDecoding(escaped_value, other.escaped_value);
}

size_t UrlSearchParamsView::EstimateSerializedOutputSize() const {
  if (params_.empty()) {
    return 0u;
  }
  const size_t number_of_equals_signs = params_.size();
  const size_t number_of_ampersands = number_of_equals_signs - 1;
  size_t estimate = number_of_equals_signs + number_of_ampersands;
  for (const auto& [unescaped_key, escaped_value] : params_) {
    estimate += unescaped_key.size() + escaped_value.size();
  }
  return estimate;
}

}  // namespace net