637fd51595
Represent WebIDL C++ types with a single CppType model that tracks nullability, optional presence, and contained storage. GC-like values now use GC::Ref/GC::Ptr directly, while containers choose "plain", "Root", or "Conservative" container types depending on what they contain. For example, sequence<Element> becomes a RootVector of GC::Ref values, while sequence<SomeDictionary> becomes a ConservativeVector only when the dictionary contains GC-like values. This moves the generated bindings away from wrapping GC values in GC::Root by default. This has broad fallout as the types passed to interfaces for GC objects changes almost fully across the board.
107 lines
4.8 KiB
C++
107 lines
4.8 KiB
C++
/*
|
|
* Copyright (c) 2022-2023, Linus Groh <linusg@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/ByteBuffer.h>
|
|
#include <AK/Forward.h>
|
|
#include <AK/NonnullRefPtr.h>
|
|
#include <AK/Optional.h>
|
|
#include <AK/Variant.h>
|
|
#include <LibCore/ImmutableBytes.h>
|
|
#include <LibGC/Ptr.h>
|
|
#include <LibGC/Root.h>
|
|
#include <LibWeb/Export.h>
|
|
#include <LibWeb/Fetch/Infrastructure/Task.h>
|
|
#include <LibWeb/FileAPI/Blob.h>
|
|
#include <LibWeb/Streams/ReadableStream.h>
|
|
#include <LibWeb/WebIDL/Promise.h>
|
|
|
|
namespace Web::Fetch::Infrastructure {
|
|
|
|
// https://mimesniff.spec.whatwg.org/#reading-the-resource-header
|
|
static constexpr size_t MAX_SNIFF_BYTES = 1445;
|
|
|
|
// https://fetch.spec.whatwg.org/#concept-body
|
|
class WEB_API Body final : public JS::Cell {
|
|
GC_CELL(Body, JS::Cell);
|
|
GC_DECLARE_ALLOCATOR(Body);
|
|
|
|
public:
|
|
using SourceType = Variant<Empty, ByteBuffer, Core::ImmutableBytes, GC::Ref<FileAPI::Blob>>;
|
|
// processBody must be an algorithm accepting a byte sequence.
|
|
using ProcessBodyCallback = GC::Ref<GC::Function<void(ByteBuffer)>>;
|
|
// processBodyError must be an algorithm optionally accepting an exception.
|
|
using ProcessBodyErrorCallback = GC::Ref<GC::Function<void(JS::Value)>>;
|
|
// processBodyChunk must be an algorithm accepting a byte sequence.
|
|
using ProcessBodyChunkCallback = GC::Ref<GC::Function<void(ByteBuffer)>>;
|
|
// processEndOfBody must be an algorithm accepting no arguments
|
|
using ProcessEndOfBodyCallback = GC::Ref<GC::Function<void()>>;
|
|
|
|
[[nodiscard]] static GC::Ref<Body> create(JS::VM&, GC::Ref<Streams::ReadableStream>);
|
|
[[nodiscard]] static GC::Ref<Body> create(JS::VM&, GC::Ref<Streams::ReadableStream>, SourceType, Optional<u64>);
|
|
|
|
[[nodiscard]] GC::Ref<Streams::ReadableStream> stream() const { return *m_stream; }
|
|
void set_stream(GC::Ref<Streams::ReadableStream> value) { m_stream = value; }
|
|
[[nodiscard]] SourceType const& source() const { return m_source; }
|
|
void set_source(Core::ImmutableBytes, Optional<u64> length);
|
|
[[nodiscard]] Optional<u64> const& length() const { return m_length; }
|
|
|
|
// https://mimesniff.spec.whatwg.org/#reading-the-resource-header
|
|
// Non-standard infrastructure to obtain the "resource header" for MIME type sniffing.
|
|
// The spec defines resource header as the byte sequence to sniff, obtained by reading
|
|
// "until [...] 1445 or more bytes have been read" or end of resource is reached.
|
|
// For non-streaming bodies (ByteBuffer/Blob source), bytes are available immediately.
|
|
// For streaming bodies, bytes are captured during fetch and delivered via callback.
|
|
using SniffBytesCallback = GC::Ref<GC::Function<void(ReadonlyBytes)>>;
|
|
Optional<ReadonlyBytes> sniff_bytes_if_available() const;
|
|
void wait_for_sniff_bytes(SniffBytesCallback on_ready);
|
|
|
|
// Called by FetchedDataReceiver to provide sniff bytes during streaming fetch.
|
|
void append_sniff_bytes(ReadonlyBytes bytes);
|
|
void set_sniff_bytes_complete();
|
|
|
|
[[nodiscard]] GC::Ref<Body> clone(JS::Realm&);
|
|
|
|
void fully_read(JS::Realm&, ProcessBodyCallback process_body, ProcessBodyErrorCallback process_body_error, TaskDestination) const;
|
|
void incrementally_read(ProcessBodyChunkCallback process_body_chunk, ProcessEndOfBodyCallback process_end_of_body, ProcessBodyErrorCallback process_body_error, TaskDestination);
|
|
void incrementally_read_loop(Streams::ReadableStreamDefaultReader& reader, TaskDestination, ProcessBodyChunkCallback process_body_chunk, ProcessEndOfBodyCallback process_end_of_body, ProcessBodyErrorCallback process_body_error);
|
|
|
|
virtual void visit_edges(JS::Cell::Visitor&) override;
|
|
|
|
private:
|
|
explicit Body(GC::Ref<Streams::ReadableStream>);
|
|
Body(GC::Ref<Streams::ReadableStream>, SourceType, Optional<u64>);
|
|
|
|
// https://fetch.spec.whatwg.org/#concept-body-stream
|
|
// A stream (a ReadableStream object).
|
|
GC::Ref<Streams::ReadableStream> m_stream;
|
|
|
|
// https://fetch.spec.whatwg.org/#concept-body-source
|
|
// A source (null, a byte sequence, a Blob object, or a FormData object), initially null.
|
|
SourceType m_source;
|
|
|
|
// https://fetch.spec.whatwg.org/#concept-body-total-bytes
|
|
// A length (null or an integer), initially null.
|
|
Optional<u64> m_length;
|
|
|
|
// https://mimesniff.spec.whatwg.org/#reading-the-resource-header
|
|
// Non-standard: Captured "resource header" bytes for MIME type sniffing.
|
|
ByteBuffer m_sniff_bytes;
|
|
bool m_sniff_bytes_complete { false };
|
|
GC::Ptr<GC::Function<void(ReadonlyBytes)>> m_sniff_bytes_callback;
|
|
};
|
|
|
|
// https://fetch.spec.whatwg.org/#body-with-type
|
|
// A body with type is a tuple that consists of a body (a body) and a type (a header value or null).
|
|
struct BodyWithType {
|
|
GC::Ref<Body> body;
|
|
Optional<ByteString> type;
|
|
};
|
|
|
|
WEB_API GC::Ref<Body> byte_sequence_as_body(JS::Realm&, ReadonlyBytes);
|
|
|
|
}
|