4a2da10e38
This patchset makes ProtocolServer stream the downloads to its client
(LibProtocol), and as such changes the download API; a possible
download lifecycle could be as such:
notation = client->server:'>', server->client:'<', pipe activity:'*'
```
> StartDownload(GET, url, headers, {})
< Response(0, fd 8)
* {data, 1024b}
< HeadersBecameAvailable(0, response_headers, 200)
< DownloadProgress(0, 4K, 1024)
* {data, 1024b}
* {data, 1024b}
< DownloadProgress(0, 4K, 2048)
* {data, 1024b}
< DownloadProgress(0, 4K, 1024)
< DownloadFinished(0, true, 4K)
```
Since managing the received file descriptor is a pain, LibProtocol
implements `Download::stream_into(OutputStream)`, which can be used to
stream the download into any given output stream (be it a file, or
memory, or writing stuff with a delay, etc.).
Also, as some of the users of this API require all the downloaded data
upfront, LibProtocol also implements `set_should_buffer_all_input()`,
which causes the download instance to buffer all the data until the
download is complete, and to call the `on_buffered_download_finish`
hook.
87 lines
3.2 KiB
C++
87 lines
3.2 KiB
C++
/*
|
|
* Copyright (c) 2020, The SerenityOS developers.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/FileStream.h>
|
|
#include <AK/HashMap.h>
|
|
#include <AK/Optional.h>
|
|
#include <LibCore/NetworkJob.h>
|
|
#include <LibCore/TCPSocket.h>
|
|
#include <LibHTTP/HttpRequest.h>
|
|
#include <LibHTTP/HttpResponse.h>
|
|
|
|
namespace HTTP {
|
|
|
|
class Job : public Core::NetworkJob {
|
|
public:
|
|
explicit Job(const HttpRequest&, OutputStream&);
|
|
virtual ~Job() override;
|
|
|
|
virtual void start() override = 0;
|
|
virtual void shutdown() override = 0;
|
|
|
|
HttpResponse* response() { return static_cast<HttpResponse*>(Core::NetworkJob::response()); }
|
|
const HttpResponse* response() const { return static_cast<const HttpResponse*>(Core::NetworkJob::response()); }
|
|
|
|
protected:
|
|
void finish_up();
|
|
void on_socket_connected();
|
|
void flush_received_buffers();
|
|
virtual void register_on_ready_to_read(Function<void()>) = 0;
|
|
virtual void register_on_ready_to_write(Function<void()>) = 0;
|
|
virtual bool can_read_line() const = 0;
|
|
virtual String read_line(size_t) = 0;
|
|
virtual bool can_read() const = 0;
|
|
virtual ByteBuffer receive(size_t) = 0;
|
|
virtual bool eof() const = 0;
|
|
virtual bool write(ReadonlyBytes) = 0;
|
|
virtual bool is_established() const = 0;
|
|
virtual bool should_fail_on_empty_payload() const { return true; }
|
|
virtual void read_while_data_available(Function<IterationDecision()> read) { read(); };
|
|
|
|
enum class State {
|
|
InStatus,
|
|
InHeaders,
|
|
InBody,
|
|
Trailers,
|
|
Finished,
|
|
};
|
|
|
|
HttpRequest m_request;
|
|
State m_state { State::InStatus };
|
|
int m_code { -1 };
|
|
HashMap<String, String, CaseInsensitiveStringTraits> m_headers;
|
|
Vector<ByteBuffer, 2> m_received_buffers;
|
|
size_t m_buffered_size { 0 };
|
|
size_t m_received_size { 0 };
|
|
bool m_sent_data { 0 };
|
|
Optional<ssize_t> m_current_chunk_remaining_size;
|
|
Optional<size_t> m_current_chunk_total_size;
|
|
bool m_can_stream_response { true };
|
|
};
|
|
|
|
}
|