mirror of
https://github.com/fergalmoran/ladybird.git
synced 2025-12-25 19:04:58 +00:00
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.
121 lines
5.1 KiB
C++
121 lines
5.1 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
* 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.
|
|
*/
|
|
|
|
#include <AK/FileStream.h>
|
|
#include <AK/SharedBuffer.h>
|
|
#include <LibProtocol/Client.h>
|
|
#include <LibProtocol/Download.h>
|
|
|
|
namespace Protocol {
|
|
|
|
Client::Client()
|
|
: IPC::ServerConnection<ProtocolClientEndpoint, ProtocolServerEndpoint>(*this, "/tmp/portal/protocol")
|
|
{
|
|
handshake();
|
|
}
|
|
|
|
void Client::handshake()
|
|
{
|
|
auto response = send_sync<Messages::ProtocolServer::Greet>();
|
|
set_my_client_id(response->client_id());
|
|
}
|
|
|
|
bool Client::is_supported_protocol(const String& protocol)
|
|
{
|
|
return send_sync<Messages::ProtocolServer::IsSupportedProtocol>(protocol)->supported();
|
|
}
|
|
|
|
template<typename RequestHashMapTraits>
|
|
RefPtr<Download> Client::start_download(const String& method, const String& url, const HashMap<String, String, RequestHashMapTraits>& request_headers, ReadonlyBytes request_body)
|
|
{
|
|
IPC::Dictionary header_dictionary;
|
|
for (auto& it : request_headers)
|
|
header_dictionary.add(it.key, it.value);
|
|
|
|
auto response = send_sync<Messages::ProtocolServer::StartDownload>(method, url, header_dictionary, ByteBuffer::copy(request_body));
|
|
auto download_id = response->download_id();
|
|
auto response_fd = response->response_fd().fd();
|
|
if (download_id < 0 || response_fd < 0)
|
|
return nullptr;
|
|
auto download = Download::create_from_id({}, *this, download_id);
|
|
download->set_download_fd({}, response_fd);
|
|
m_downloads.set(download_id, download);
|
|
return download;
|
|
}
|
|
|
|
bool Client::stop_download(Badge<Download>, Download& download)
|
|
{
|
|
if (!m_downloads.contains(download.id()))
|
|
return false;
|
|
return send_sync<Messages::ProtocolServer::StopDownload>(download.id())->success();
|
|
}
|
|
|
|
bool Client::set_certificate(Badge<Download>, Download& download, String certificate, String key)
|
|
{
|
|
if (!m_downloads.contains(download.id()))
|
|
return false;
|
|
return send_sync<Messages::ProtocolServer::SetCertificate>(download.id(), move(certificate), move(key))->success();
|
|
}
|
|
|
|
void Client::handle(const Messages::ProtocolClient::DownloadFinished& message)
|
|
{
|
|
RefPtr<Download> download;
|
|
if ((download = m_downloads.get(message.download_id()).value_or(nullptr))) {
|
|
download->did_finish({}, message.success(), message.total_size());
|
|
}
|
|
m_downloads.remove(message.download_id());
|
|
}
|
|
|
|
void Client::handle(const Messages::ProtocolClient::DownloadProgress& message)
|
|
{
|
|
if (auto download = const_cast<Download*>(m_downloads.get(message.download_id()).value_or(nullptr))) {
|
|
download->did_progress({}, message.total_size(), message.downloaded_size());
|
|
}
|
|
}
|
|
|
|
void Client::handle(const Messages::ProtocolClient::HeadersBecameAvailable& message)
|
|
{
|
|
if (auto download = const_cast<Download*>(m_downloads.get(message.download_id()).value_or(nullptr))) {
|
|
HashMap<String, String, CaseInsensitiveStringTraits> headers;
|
|
message.response_headers().for_each_entry([&](auto& name, auto& value) { headers.set(name, value); });
|
|
download->did_receive_headers({}, headers, message.status_code());
|
|
}
|
|
}
|
|
|
|
OwnPtr<Messages::ProtocolClient::CertificateRequestedResponse> Client::handle(const Messages::ProtocolClient::CertificateRequested& message)
|
|
{
|
|
if (auto download = const_cast<Download*>(m_downloads.get(message.download_id()).value_or(nullptr))) {
|
|
download->did_request_certificates({});
|
|
}
|
|
|
|
return make<Messages::ProtocolClient::CertificateRequestedResponse>();
|
|
}
|
|
|
|
}
|
|
|
|
template RefPtr<Protocol::Download> Protocol::Client::start_download(const String& method, const String& url, const HashMap<String, String>& request_headers, ReadonlyBytes request_body);
|
|
template RefPtr<Protocol::Download> Protocol::Client::start_download(const String& method, const String& url, const HashMap<String, String, CaseInsensitiveStringTraits>& request_headers, ReadonlyBytes request_body);
|