LadybirdBrowser/ladybird
1
1
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-11 09:18:05 +03:00
Code Issues Packages Projects Releases Wiki Activity
516868e197
ladybird/Userland/Applications/Browser/DownloadWidget.h

62 lines
2.2 KiB
C
Raw Normal View History

Browser: Add a basic GUI download feature We now allow you to download files by right-clicking a link and then choosing "Download". All files are currently saved to the standard downloads location that we get from Core::StandardPaths::downloads_directory(). In the future, we'll probably want to come up with a more restrictive way of doing the "write to disk" portion of this. We should also improve the ProtocolServer to allow streaming of data instead of writing everything in one big go. At the moment, I'm just pretty happy with this GUI. :^)
2020-05-06 00:58:22 +03:00
/*
* Copyright (c) 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.
*/
#pragma once
#include <AK/URL.h>
#include <LibCore/ElapsedTimer.h>
ProtocolServer: Stream the downloaded data if possible 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.
2020-12-26 16:44:12 +03:00
#include <LibCore/FileStream.h>
Browser: Add a basic GUI download feature We now allow you to download files by right-clicking a link and then choosing "Download". All files are currently saved to the standard downloads location that we get from Core::StandardPaths::downloads_directory(). In the future, we'll probably want to come up with a more restrictive way of doing the "write to disk" portion of this. We should also improve the ProtocolServer to allow streaming of data instead of writing everything in one big go. At the moment, I'm just pretty happy with this GUI. :^)
2020-05-06 00:58:22 +03:00
#include <LibGUI/ProgressBar.h>
#include <LibGUI/Widget.h>
#include <LibProtocol/Download.h>
namespace Browser {
class DownloadWidget final : public GUI::Widget {
C_OBJECT(DownloadWidget);
public:
virtual ~DownloadWidget() override;
private:
explicit DownloadWidget(const URL&);
void did_progress(Optional<u32> total_size, u32 downloaded_size);
ProtocolServer: Stream the downloaded data if possible 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.
2020-12-26 16:44:12 +03:00
void did_finish(bool success);
Browser: Add a basic GUI download feature We now allow you to download files by right-clicking a link and then choosing "Download". All files are currently saved to the standard downloads location that we get from Core::StandardPaths::downloads_directory(). In the future, we'll probably want to come up with a more restrictive way of doing the "write to disk" portion of this. We should also improve the ProtocolServer to allow streaming of data instead of writing everything in one big go. At the moment, I'm just pretty happy with this GUI. :^)
2020-05-06 00:58:22 +03:00
URL m_url;
String m_destination_path;
RefPtr<Protocol::Download> m_download;
RefPtr<GUI::ProgressBar> m_progress_bar;
RefPtr<GUI::Label> m_progress_label;
RefPtr<GUI::Button> m_cancel_button;
RefPtr<GUI::Button> m_close_button;
ProtocolServer: Stream the downloaded data if possible 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.
2020-12-26 16:44:12 +03:00
OwnPtr<Core::OutputFileStream> m_output_file_stream;
Browser: Add a basic GUI download feature We now allow you to download files by right-clicking a link and then choosing "Download". All files are currently saved to the standard downloads location that we get from Core::StandardPaths::downloads_directory(). In the future, we'll probably want to come up with a more restrictive way of doing the "write to disk" portion of this. We should also improve the ProtocolServer to allow streaming of data instead of writing everything in one big go. At the moment, I'm just pretty happy with this GUI. :^)
2020-05-06 00:58:22 +03:00
Core::ElapsedTimer m_elapsed_timer;
};
}
Reference in New Issue Copy Permalink