/* * Copyright (c) 2021, Idan Horowitz * Copyright (c) 2023, Shannon Booth * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include namespace Web::DOMURL { JS_DEFINE_ALLOCATOR(URLSearchParams); URLSearchParams::URLSearchParams(JS::Realm& realm, Vector list) : PlatformObject(realm) , m_list(move(list)) { } URLSearchParams::~URLSearchParams() = default; void URLSearchParams::initialize(JS::Realm& realm) { Base::initialize(realm); WEB_SET_PROTOTYPE_FOR_INTERFACE(URLSearchParams); } void URLSearchParams::visit_edges(Cell::Visitor& visitor) { Base::visit_edges(visitor); visitor.visit(m_url); } // https://url.spec.whatwg.org/#concept-urlencoded-serializer // The application/x-www-form-urlencoded serializer takes a list of name-value tuples tuples, with an optional encoding encoding (default UTF-8), and then runs these steps. They return an ASCII string. ErrorOr url_encode(Vector const& tuples, StringView encoding) { // 1. Set encoding to the result of getting an output encoding from encoding. encoding = TextCodec::get_output_encoding(encoding); // 2. Let output be the empty string. StringBuilder output; // 3. For each tuple of tuples: for (auto const& tuple : tuples) { // 1. Assert: tuple’s name and tuple’s value are scalar value strings. // 2. Let name be the result of running percent-encode after encoding with encoding, tuple’s name, the application/x-www-form-urlencoded percent-encode set, and true. // FIXME: URL::Parser does not currently implement encoding. auto name = TRY(URL::Parser::percent_encode_after_encoding(tuple.name, URL::PercentEncodeSet::ApplicationXWWWFormUrlencoded, true)); // 3. Let value be the result of running percent-encode after encoding with encoding, tuple’s value, the application/x-www-form-urlencoded percent-encode set, and true. // FIXME: URL::Parser does not currently implement encoding. auto value = TRY(URL::Parser::percent_encode_after_encoding(tuple.value, URL::PercentEncodeSet::ApplicationXWWWFormUrlencoded, true)); // 4. If output is not the empty string, then append U+0026 (&) to output. if (!output.is_empty()) TRY(output.try_append('&')); // 5. Append name, followed by U+003D (=), followed by value, to output. TRY(output.try_append(name)); TRY(output.try_append('=')); TRY(output.try_append(value)); } // 4. Return output. return output.to_string(); } // https://url.spec.whatwg.org/#concept-urlencoded-parser // The application/x-www-form-urlencoded parser takes a byte sequence input, and then runs these steps: ErrorOr> url_decode(StringView input) { // 1. Let sequences be the result of splitting input on 0x26 (&). auto sequences = input.split_view('&'); // 2. Let output be an initially empty list of name-value tuples where both name and value hold a string. Vector output; // 3. For each byte sequence bytes in sequences: for (auto bytes : sequences) { // 1. If bytes is the empty byte sequence, then continue. if (bytes.is_empty()) continue; StringView name; StringView value; // 2. If bytes contains a 0x3D (=), then let name be the bytes from the start of bytes up to but excluding its first 0x3D (=), and let value be the bytes, if any, after the first 0x3D (=) up to the end of bytes. If 0x3D (=) is the first byte, then name will be the empty byte sequence. If it is the last, then value will be the empty byte sequence. if (auto index = bytes.find('='); index.has_value()) { name = bytes.substring_view(0, *index); value = bytes.substring_view(*index + 1); } // 3. Otherwise, let name have the value of bytes and let value be the empty byte sequence. else { name = bytes; value = ""sv; } // 4. Replace any 0x2B (+) in name and value with 0x20 (SP). auto space_decoded_name = name.replace("+"sv, " "sv, ReplaceMode::All); // 5. Let nameString and valueString be the result of running UTF-8 decode without BOM on the percent-decoding of name and value, respectively. auto name_string = TRY(String::from_byte_string(URL::percent_decode(space_decoded_name))); auto value_string = TRY(String::from_byte_string(URL::percent_decode(value))); TRY(output.try_empend(move(name_string), move(value_string))); } return output; } WebIDL::ExceptionOr> URLSearchParams::create(JS::Realm& realm, Vector list) { return realm.heap().allocate(realm, realm, move(list)); } // https://url.spec.whatwg.org/#dom-urlsearchparams-urlsearchparams // https://url.spec.whatwg.org/#urlsearchparams-initialize WebIDL::ExceptionOr> URLSearchParams::construct_impl(JS::Realm& realm, Variant>, OrderedHashMap, String> const& init) { auto& vm = realm.vm(); // 1. If init is a string and starts with U+003F (?), then remove the first code point from init. // NOTE: We do this when we know that it's a string on step 3 of initialization. // 2. Initialize this with init. // URLSearchParams init from this point forward // 1. If init is a sequence, then for each pair in init: if (init.has>>()) { auto const& init_sequence = init.get>>(); Vector list; list.ensure_capacity(init_sequence.size()); for (auto const& pair : init_sequence) { // a. If pair does not contain exactly two items, then throw a TypeError. if (pair.size() != 2) return WebIDL::SimpleException { WebIDL::SimpleExceptionType::TypeError, TRY_OR_THROW_OOM(vm, String::formatted("Expected only 2 items in pair, got {}", pair.size())) }; // b. Append a new name-value pair whose name is pair’s first item, and value is pair’s second item, to query’s list. list.append(QueryParam { .name = pair[0], .value = pair[1] }); } return URLSearchParams::create(realm, move(list)); } // 2. Otherwise, if init is a record, then for each name → value of init, append a new name-value pair whose name is name and value is value, to query’s list. if (init.has>()) { auto const& init_record = init.get>(); Vector list; list.ensure_capacity(init_record.size()); for (auto const& pair : init_record) list.append(QueryParam { .name = pair.key, .value = pair.value }); return URLSearchParams::create(realm, move(list)); } // 3. Otherwise: // a. Assert: init is a string. // NOTE: `get` performs `VERIFY(has())` auto const& init_string = init.get(); // See NOTE at the start of this function. auto init_string_view = init_string.bytes_as_string_view(); auto stripped_init = init_string_view.substring_view(init_string_view.starts_with('?')); // b. Set query’s list to the result of parsing init. return URLSearchParams::create(realm, TRY_OR_THROW_OOM(vm, url_decode(stripped_init))); } // https://url.spec.whatwg.org/#dom-urlsearchparams-size size_t URLSearchParams::size() const { // The size getter steps are to return this’s list’s size. return m_list.size(); } WebIDL::ExceptionOr URLSearchParams::append(String const& name, String const& value) { auto& vm = realm().vm(); // 1. Append a new name-value pair whose name is name and value is value, to list. TRY_OR_THROW_OOM(vm, m_list.try_empend(name, value)); // 2. Update this. TRY(update()); return {}; } WebIDL::ExceptionOr URLSearchParams::update() { // 1. If query’s URL object is null, then return. if (!m_url) return {}; // 2. Let serializedQuery be the serialization of query’s list. auto serialized_query = TRY(to_string()); // 3. If serializedQuery is the empty string, then set serializedQuery to null. if (serialized_query.is_empty()) serialized_query = {}; // 4. Set query’s URL object’s URL’s query to serializedQuery. m_url->set_query({}, move(serialized_query)); return {}; } WebIDL::ExceptionOr URLSearchParams::delete_(String const& name) { // 1. Remove all name-value pairs whose name is name from list. m_list.remove_all_matching([&name](auto& entry) { return entry.name == name; }); // 2. Update this. TRY(update()); return {}; } Optional URLSearchParams::get(String const& name) { // return the value of the first name-value pair whose name is name in this’s list, if there is such a pair, and null otherwise. auto result = m_list.find_if([&name](auto& entry) { return entry.name == name; }); if (result.is_end()) return {}; return result->value; } // https://url.spec.whatwg.org/#dom-urlsearchparams-getall WebIDL::ExceptionOr> URLSearchParams::get_all(String const& name) { auto& vm = realm().vm(); // return the values of all name-value pairs whose name is name, in this’s list, in list order, and the empty sequence otherwise. Vector values; for (auto& entry : m_list) { if (entry.name == name) TRY_OR_THROW_OOM(vm, values.try_append(entry.value)); } return values; } bool URLSearchParams::has(String const& name) { // return true if there is a name-value pair whose name is name in this’s list, and false otherwise. return !m_list.find_if([&name](auto& entry) { return entry.name == name; }) .is_end(); } WebIDL::ExceptionOr URLSearchParams::set(String const& name, String const& value) { auto& vm = realm().vm(); // 1. If this’s list contains any name-value pairs whose name is name, then set the value of the first such name-value pair to value and remove the others. auto existing = m_list.find_if([&name](auto& entry) { return entry.name == name; }); if (!existing.is_end()) { existing->value = value; m_list.remove_all_matching([&name, &existing](auto& entry) { return &entry != &*existing && entry.name == name; }); } // 2. Otherwise, append a new name-value pair whose name is name and value is value, to this’s list. else { TRY_OR_THROW_OOM(vm, m_list.try_empend(name, value)); } // 3. Update this. TRY(update()); return {}; } WebIDL::ExceptionOr URLSearchParams::sort() { // 1. Sort all name-value pairs, if any, by their names. Sorting must be done by comparison of code units. The relative order between name-value pairs with equal names must be preserved. quick_sort(m_list.begin(), m_list.end(), [](auto& a, auto& b) { Utf8View a_code_points { a.name }; Utf8View b_code_points { b.name }; if (a_code_points.starts_with(b_code_points)) return false; if (b_code_points.starts_with(a_code_points)) return true; for (auto k = a_code_points.begin(), l = b_code_points.begin(); k != a_code_points.end() && l != b_code_points.end(); ++k, ++l) { if (*k != *l) { return *k < *l; } } VERIFY_NOT_REACHED(); }); // 2. Update this. TRY(update()); return {}; } WebIDL::ExceptionOr URLSearchParams::to_string() const { auto& vm = realm().vm(); // return the serialization of this’s list. return TRY_OR_THROW_OOM(vm, url_encode(m_list)); } JS::ThrowCompletionOr URLSearchParams::for_each(ForEachCallback callback) { for (auto i = 0u; i < m_list.size(); ++i) { auto& query_param = m_list[i]; // We are explicitly iterating over the indices here as the callback might delete items from the list TRY(callback(query_param.name, query_param.value)); } return {}; } }