mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2025-01-23 17:52:26 -05: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.
108 lines
3.3 KiB
C++
108 lines
3.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 <LibCore/NetworkJob.h>
|
|
#include <LibCore/NetworkResponse.h>
|
|
#include <stdio.h>
|
|
|
|
//#define CNETWORKJOB_DEBUG
|
|
|
|
namespace Core {
|
|
|
|
NetworkJob::NetworkJob(OutputStream& output_stream)
|
|
: m_output_stream(output_stream)
|
|
{
|
|
}
|
|
|
|
NetworkJob::~NetworkJob()
|
|
{
|
|
}
|
|
|
|
void NetworkJob::start()
|
|
{
|
|
}
|
|
|
|
void NetworkJob::shutdown()
|
|
{
|
|
}
|
|
|
|
void NetworkJob::did_finish(NonnullRefPtr<NetworkResponse>&& response)
|
|
{
|
|
// NOTE: We protect ourselves here, since the on_finish callback may otherwise
|
|
// trigger destruction of this job somehow.
|
|
NonnullRefPtr<NetworkJob> protector(*this);
|
|
|
|
m_response = move(response);
|
|
#ifdef CNETWORKJOB_DEBUG
|
|
dbg() << *this << " job did_finish!";
|
|
#endif
|
|
ASSERT(on_finish);
|
|
on_finish(true);
|
|
shutdown();
|
|
}
|
|
|
|
void NetworkJob::did_fail(Error error)
|
|
{
|
|
// NOTE: We protect ourselves here, since the on_finish callback may otherwise
|
|
// trigger destruction of this job somehow.
|
|
NonnullRefPtr<NetworkJob> protector(*this);
|
|
|
|
m_error = error;
|
|
#ifdef CNETWORKJOB_DEBUG
|
|
dbgprintf("%s{%p} job did_fail! error: %u (%s)\n", class_name(), this, (unsigned)error, to_string(error));
|
|
#endif
|
|
ASSERT(on_finish);
|
|
on_finish(false);
|
|
shutdown();
|
|
}
|
|
|
|
void NetworkJob::did_progress(Optional<u32> total_size, u32 downloaded)
|
|
{
|
|
// NOTE: We protect ourselves here, since the callback may otherwise
|
|
// trigger destruction of this job somehow.
|
|
NonnullRefPtr<NetworkJob> protector(*this);
|
|
|
|
if (on_progress)
|
|
on_progress(total_size, downloaded);
|
|
}
|
|
|
|
const char* to_string(NetworkJob::Error error)
|
|
{
|
|
switch (error) {
|
|
case NetworkJob::Error::ProtocolFailed:
|
|
return "ProtocolFailed";
|
|
case NetworkJob::Error::ConnectionFailed:
|
|
return "ConnectionFailed";
|
|
case NetworkJob::Error::TransmissionFailed:
|
|
return "TransmissionFailed";
|
|
case NetworkJob::Error::Cancelled:
|
|
return "Cancelled";
|
|
default:
|
|
return "(Unknown error)";
|
|
}
|
|
}
|
|
|
|
}
|