mirror of
https://github.com/RGBCube/serenity
synced 2025-05-31 14:18:12 +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.
74 lines
3 KiB
C++
74 lines
3 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 <LibHTTP/HttpJob.h>
|
|
#include <LibHTTP/HttpResponse.h>
|
|
#include <ProtocolServer/HttpDownload.h>
|
|
|
|
namespace ProtocolServer {
|
|
|
|
HttpDownload::HttpDownload(ClientConnection& client, NonnullRefPtr<HTTP::HttpJob> job, NonnullOwnPtr<OutputFileStream>&& output_stream)
|
|
: Download(client, move(output_stream))
|
|
, m_job(job)
|
|
{
|
|
m_job->on_headers_received = [this](auto& headers, auto response_code) {
|
|
if (response_code.has_value())
|
|
set_status_code(response_code.value());
|
|
set_response_headers(headers);
|
|
};
|
|
|
|
m_job->on_finish = [this](bool success) {
|
|
if (auto* response = m_job->response()) {
|
|
set_status_code(response->code());
|
|
set_response_headers(response->headers());
|
|
set_downloaded_size(this->output_stream().size());
|
|
}
|
|
|
|
// if we didn't know the total size, pretend that the download finished successfully
|
|
// and set the total size to the downloaded size
|
|
if (!total_size().has_value())
|
|
did_progress(downloaded_size(), downloaded_size());
|
|
|
|
did_finish(success);
|
|
};
|
|
m_job->on_progress = [this](Optional<u32> total, u32 current) {
|
|
did_progress(total, current);
|
|
};
|
|
}
|
|
|
|
HttpDownload::~HttpDownload()
|
|
{
|
|
m_job->on_finish = nullptr;
|
|
m_job->on_progress = nullptr;
|
|
m_job->shutdown();
|
|
}
|
|
|
|
NonnullOwnPtr<HttpDownload> HttpDownload::create_with_job(Badge<HttpProtocol>, ClientConnection& client, NonnullRefPtr<HTTP::HttpJob> job, NonnullOwnPtr<OutputFileStream>&& output_stream)
|
|
{
|
|
return adopt_own(*new HttpDownload(client, move(job), move(output_stream)));
|
|
}
|
|
|
|
}
|