b345a0acca
- Prefer VM::current_realm() over GlobalObject::associated_realm() - Prefer VM::heap() over GlobalObject::heap() - Prefer Cell::vm() over Cell::global_object() - Prefer Wrapper::vm() over Wrapper::global_object() - Inline Realm::global_object() calls used to access intrinsics as they will later perform a direct lookup without going through the global object
310 lines
13 KiB
C++
310 lines
13 KiB
C++
/*
|
||
* Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
|
||
*
|
||
* SPDX-License-Identifier: BSD-2-Clause
|
||
*/
|
||
|
||
#include <LibWeb/Bindings/HeadersWrapper.h>
|
||
#include <LibWeb/Fetch/Headers.h>
|
||
|
||
namespace Web::Fetch {
|
||
|
||
// https://fetch.spec.whatwg.org/#dom-headers
|
||
DOM::ExceptionOr<NonnullRefPtr<Headers>> Headers::create(Optional<HeadersInit> const& init)
|
||
{
|
||
// The new Headers(init) constructor steps are:
|
||
|
||
auto headers = adopt_ref(*new Headers());
|
||
|
||
// 1. Set this’s guard to "none".
|
||
headers->m_guard = Guard::None;
|
||
|
||
// 2. If init is given, then fill this with init.
|
||
if (init.has_value())
|
||
TRY(headers->fill(*init));
|
||
|
||
return headers;
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#dom-headers-append
|
||
DOM::ExceptionOr<void> Headers::append(String const& name_string, String const& value_string)
|
||
{
|
||
// The append(name, value) method steps are to append (name, value) to this.
|
||
auto header = Infrastructure::Header {
|
||
.name = TRY_OR_RETURN_OOM(ByteBuffer::copy(name_string.bytes())),
|
||
.value = TRY_OR_RETURN_OOM(ByteBuffer::copy(value_string.bytes())),
|
||
};
|
||
TRY(append(move(header)));
|
||
return {};
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#dom-headers-delete
|
||
DOM::ExceptionOr<void> Headers::delete_(String const& name_string)
|
||
{
|
||
// The delete(name) method steps are:
|
||
auto name = name_string.bytes();
|
||
|
||
// 1. If name is not a header name, then throw a TypeError.
|
||
if (!Infrastructure::is_header_name(name))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header name" };
|
||
|
||
// 2. If this’s guard is "immutable", then throw a TypeError.
|
||
if (m_guard == Guard::Immutable)
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Headers object is immutable" };
|
||
|
||
// 3. Otherwise, if this’s guard is "request" and name is a forbidden header name, return.
|
||
if (m_guard == Guard::Request && Infrastructure::is_forbidden_header_name(name))
|
||
return {};
|
||
|
||
// 4. Otherwise, if this’s guard is "request-no-cors", name is not a no-CORS-safelisted request-header name, and name is not a privileged no-CORS request-header name, return.
|
||
if (m_guard == Guard::RequestNoCORS && !Infrastructure::is_no_cors_safelisted_request_header_name(name) && !Infrastructure::is_privileged_no_cors_request_header_name(name))
|
||
return {};
|
||
|
||
// 5. Otherwise, if this’s guard is "response" and name is a forbidden response-header name, return.
|
||
if (m_guard == Guard::Response && Infrastructure::is_forbidden_response_header_name(name))
|
||
return {};
|
||
|
||
// 6. If this’s header list does not contain name, then return.
|
||
if (!m_header_list.contains(name))
|
||
return {};
|
||
|
||
// 7. Delete name from this’s header list.
|
||
m_header_list.delete_(name);
|
||
|
||
// 8. If this’s guard is "request-no-cors", then remove privileged no-CORS request headers from this.
|
||
if (m_guard == Guard::RequestNoCORS)
|
||
remove_privileged_no_cors_headers();
|
||
|
||
return {};
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#dom-headers-get
|
||
DOM::ExceptionOr<String> Headers::get(String const& name_string)
|
||
{
|
||
// The get(name) method steps are:
|
||
auto name = name_string.bytes();
|
||
|
||
// 1. If name is not a header name, then throw a TypeError.
|
||
if (!Infrastructure::is_header_name(name))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header name" };
|
||
|
||
// 2. Return the result of getting name from this’s header list.
|
||
auto byte_buffer = TRY_OR_RETURN_OOM(m_header_list.get(name));
|
||
// FIXME: Teach WrapperGenerator about Optional<String>
|
||
return byte_buffer.has_value() ? String { byte_buffer->span() } : String {};
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#dom-headers-has
|
||
DOM::ExceptionOr<bool> Headers::has(String const& name_string)
|
||
{
|
||
// The has(name) method steps are:
|
||
auto name = name_string.bytes();
|
||
|
||
// 1. If name is not a header name, then throw a TypeError.
|
||
if (!Infrastructure::is_header_name(name))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header name" };
|
||
|
||
// 2. Return true if this’s header list contains name; otherwise false.
|
||
return m_header_list.contains(name);
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#dom-headers-set
|
||
DOM::ExceptionOr<void> Headers::set(String const& name_string, String const& value_string)
|
||
{
|
||
// The set(name, value) method steps are:
|
||
auto name = name_string.bytes();
|
||
auto value = value_string.bytes();
|
||
|
||
// 1. Normalize value.
|
||
auto normalized_value = TRY_OR_RETURN_OOM(Infrastructure::normalize_header_value(value));
|
||
|
||
auto header = Infrastructure::Header {
|
||
.name = TRY_OR_RETURN_OOM(ByteBuffer::copy(name)),
|
||
.value = move(normalized_value),
|
||
};
|
||
|
||
// 2. If name is not a header name or value is not a header value, then throw a TypeError.
|
||
if (!Infrastructure::is_header_name(name))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header name" };
|
||
if (!Infrastructure::is_header_value(value))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header value" };
|
||
|
||
// 3. If this’s guard is "immutable", then throw a TypeError.
|
||
if (m_guard == Guard::Immutable)
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Headers object is immutable" };
|
||
|
||
// 4. Otherwise, if this’s guard is "request" and name is a forbidden header name, return.
|
||
if (m_guard == Guard::Request && Infrastructure::is_forbidden_header_name(name))
|
||
return {};
|
||
|
||
// 5. Otherwise, if this’s guard is "request-no-cors" and name/value is not a no-CORS-safelisted request-header, return.
|
||
if (m_guard == Guard::RequestNoCORS && !Infrastructure::is_no_cors_safelisted_request_header(header))
|
||
return {};
|
||
|
||
// 6. Otherwise, if this’s guard is "response" and name is a forbidden response-header name, return.
|
||
if (m_guard == Guard::Response && Infrastructure::is_forbidden_response_header_name(name))
|
||
return {};
|
||
|
||
// 7. Set (name, value) in this’s header list.
|
||
TRY_OR_RETURN_OOM(m_header_list.set(move(header)));
|
||
|
||
// 8. If this’s guard is "request-no-cors", then remove privileged no-CORS request headers from this.
|
||
if (m_guard == Guard::RequestNoCORS)
|
||
remove_privileged_no_cors_headers();
|
||
|
||
return {};
|
||
}
|
||
|
||
// https://webidl.spec.whatwg.org/#es-iterable, Step 4
|
||
JS::ThrowCompletionOr<void> Headers::for_each(ForEachCallback callback)
|
||
{
|
||
auto& vm = wrapper()->vm();
|
||
|
||
// The value pairs to iterate over are the return value of running sort and combine with this’s header list.
|
||
auto value_pairs_to_iterate_over = [&]() -> JS::ThrowCompletionOr<Vector<Fetch::Infrastructure::Header>> {
|
||
auto headers_or_error = m_header_list.sort_and_combine();
|
||
if (headers_or_error.is_error())
|
||
return vm.throw_completion<JS::InternalError>(JS::ErrorType::NotEnoughMemoryToAllocate);
|
||
return headers_or_error.release_value();
|
||
};
|
||
|
||
// 1-5. Are done in the generated wrapper code.
|
||
|
||
// 6. Let pairs be idlObject’s list of value pairs to iterate over.
|
||
auto pairs = TRY(value_pairs_to_iterate_over());
|
||
|
||
// 7. Let i be 0.
|
||
size_t i = 0;
|
||
|
||
// 8. While i < pairs’s size:
|
||
while (i < pairs.size()) {
|
||
// 1. Let pair be pairs[i].
|
||
auto const& pair = pairs[i];
|
||
|
||
// 2. Invoke idlCallback with « pair’s value, pair’s key, idlObject » and with thisArg as the callback this value.
|
||
TRY(callback(StringView { pair.name }, StringView { pair.value }));
|
||
|
||
// 3. Set pairs to idlObject’s current list of value pairs to iterate over. (It might have changed.)
|
||
pairs = TRY(value_pairs_to_iterate_over());
|
||
|
||
// 4. Set i to i + 1.
|
||
++i;
|
||
}
|
||
|
||
return {};
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#concept-headers-append
|
||
DOM::ExceptionOr<void> Headers::append(Infrastructure::Header header)
|
||
{
|
||
// To append a header (name, value) to a Headers object headers, run these steps:
|
||
auto& [name, value] = header;
|
||
|
||
// 1. Normalize value.
|
||
value = TRY_OR_RETURN_OOM(Infrastructure::normalize_header_value(value));
|
||
|
||
// 2. If name is not a header name or value is not a header value, then throw a TypeError.
|
||
if (!Infrastructure::is_header_name(name))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header name" };
|
||
if (!Infrastructure::is_header_value(value))
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Invalid header value" };
|
||
|
||
// 3. If headers’s guard is "immutable", then throw a TypeError.
|
||
if (m_guard == Guard::Immutable)
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Headers object is immutable" };
|
||
|
||
// 4. Otherwise, if headers’s guard is "request" and name is a forbidden header name, return.
|
||
if (m_guard == Guard::Request && Infrastructure::is_forbidden_header_name(name))
|
||
return {};
|
||
|
||
// 5. Otherwise, if headers’s guard is "request-no-cors":
|
||
if (m_guard == Guard::RequestNoCORS) {
|
||
// 1. Let temporaryValue be the result of getting name from headers’s header list.
|
||
auto temporary_value = TRY_OR_RETURN_OOM(m_header_list.get(name));
|
||
|
||
// 2. If temporaryValue is null, then set temporaryValue to value.
|
||
if (!temporary_value.has_value()) {
|
||
temporary_value = TRY_OR_RETURN_OOM(ByteBuffer::copy(value));
|
||
}
|
||
// 3. Otherwise, set temporaryValue to temporaryValue, followed by 0x2C 0x20, followed by value.
|
||
else {
|
||
TRY_OR_RETURN_OOM(temporary_value->try_append(0x2c));
|
||
TRY_OR_RETURN_OOM(temporary_value->try_append(0x20));
|
||
TRY_OR_RETURN_OOM(temporary_value->try_append(value));
|
||
}
|
||
|
||
auto temporary_header = Infrastructure::Header {
|
||
.name = TRY_OR_RETURN_OOM(ByteBuffer::copy(name)),
|
||
.value = temporary_value.release_value(),
|
||
};
|
||
|
||
// 4. If name/temporaryValue is not a no-CORS-safelisted request-header, then return.
|
||
if (!Infrastructure::is_no_cors_safelisted_request_header(temporary_header))
|
||
return {};
|
||
}
|
||
|
||
// 6. Otherwise, if headers’s guard is "response" and name is a forbidden response-header name, return.
|
||
if (m_guard == Guard::Response && Infrastructure::is_forbidden_response_header_name(name))
|
||
return {};
|
||
|
||
// 7. Append (name, value) to headers’s header list.
|
||
TRY_OR_RETURN_OOM(m_header_list.append(move(header)));
|
||
|
||
// 8. If headers’s guard is "request-no-cors", then remove privileged no-CORS request headers from headers.
|
||
if (m_guard == Guard::RequestNoCORS)
|
||
remove_privileged_no_cors_headers();
|
||
|
||
return {};
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#concept-headers-fill
|
||
DOM::ExceptionOr<void> Headers::fill(HeadersInit const& object)
|
||
{
|
||
// To fill a Headers object headers with a given object object, run these steps:
|
||
return object.visit(
|
||
// 1. If object is a sequence, then for each header in object:
|
||
[this](Vector<Vector<String>> const& object) -> DOM::ExceptionOr<void> {
|
||
for (auto const& entry : object) {
|
||
// 1. If header does not contain exactly two items, then throw a TypeError.
|
||
if (entry.size() != 2)
|
||
return DOM::SimpleException { DOM::SimpleExceptionType::TypeError, "Array must contain header key/value pair" };
|
||
|
||
// 2. Append (header’s first item, header’s second item) to headers.
|
||
auto header = Fetch::Infrastructure::Header {
|
||
.name = TRY_OR_RETURN_OOM(ByteBuffer::copy(entry[0].bytes())),
|
||
.value = TRY_OR_RETURN_OOM(ByteBuffer::copy(entry[1].bytes())),
|
||
};
|
||
TRY(append(move(header)));
|
||
}
|
||
return {};
|
||
},
|
||
// 2. Otherwise, object is a record, then for each key → value in object, append (key, value) to headers.
|
||
[this](OrderedHashMap<String, String> const& object) -> DOM::ExceptionOr<void> {
|
||
for (auto const& entry : object) {
|
||
auto header = Fetch::Infrastructure::Header {
|
||
.name = TRY_OR_RETURN_OOM(ByteBuffer::copy(entry.key.bytes())),
|
||
.value = TRY_OR_RETURN_OOM(ByteBuffer::copy(entry.value.bytes())),
|
||
};
|
||
TRY(append(move(header)));
|
||
}
|
||
return {};
|
||
});
|
||
}
|
||
|
||
// https://fetch.spec.whatwg.org/#concept-headers-remove-privileged-no-cors-request-headers
|
||
void Headers::remove_privileged_no_cors_headers()
|
||
{
|
||
// To remove privileged no-CORS request headers from a Headers object (headers), run these steps:
|
||
|
||
static constexpr Array privileged_no_cors_request_header_names = {
|
||
"Range"sv,
|
||
};
|
||
|
||
// 1. For each headerName of privileged no-CORS request-header names:
|
||
for (auto const& header_name : privileged_no_cors_request_header_names) {
|
||
// 1. Delete headerName from headers’s header list.
|
||
m_header_list.delete_(header_name.bytes());
|
||
}
|
||
}
|
||
|
||
}
|