LadybirdBrowser/ladybird
1
1
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-01-07 11:39:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
b4da228ea5
ladybird/Userland/Applications/Browser/DownloadWidget.h

42 lines
970 B
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>
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 11:24:48 +03:00
* SPDX-License-Identifier: BSD-2-Clause
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
*/
#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>
Everywhere: It's now "Foobar", not "FooBar", and not "foo bar" I hereby declare these to be full nouns that we don't split, neither by space, nor by underscore: - Breadcrumbbar - Coolbar - Menubar - Progressbar - Scrollbar - Statusbar - Taskbar - Toolbar This patch makes everything consistent by replacing every other variant of these with the proper one. :^)
2021-04-13 17:18:20 +03:00
#include <LibGUI/Progressbar.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/Widget.h>
Services: Rename ProtocolServer to RequestServer The current ProtocolServer was really only used for requests, and with the recent introduction of the WebSocket service, long-lasting connections with another server are not part of it. To better reflect this, this commit renames it to RequestServer. This commit also changes the existing 'protocol' portal to 'request', the existing 'protocol' user and group to 'request', and most mentions of the 'download' aspect of the request to 'request' when relevant, to make everything consistent across the system. Note that LibProtocol still exists as-is, but the more generic Client class and the more specific Download class have both been renamed to a more accurate RequestClient and Request to match the new names. This commit only change names, not behaviors.
2021-04-23 23:45:52 +03:00
#include <LibProtocol/Request.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
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;
Services: Rename ProtocolServer to RequestServer The current ProtocolServer was really only used for requests, and with the recent introduction of the WebSocket service, long-lasting connections with another server are not part of it. To better reflect this, this commit renames it to RequestServer. This commit also changes the existing 'protocol' portal to 'request', the existing 'protocol' user and group to 'request', and most mentions of the 'download' aspect of the request to 'request' when relevant, to make everything consistent across the system. Note that LibProtocol still exists as-is, but the more generic Client class and the more specific Download class have both been renamed to a more accurate RequestClient and Request to match the new names. This commit only change names, not behaviors.
2021-04-23 23:45:52 +03:00
RefPtr<Protocol::Request> m_download;
Everywhere: It's now "Foobar", not "FooBar", and not "foo bar" I hereby declare these to be full nouns that we don't split, neither by space, nor by underscore: - Breadcrumbbar - Coolbar - Menubar - Progressbar - Scrollbar - Statusbar - Taskbar - Toolbar This patch makes everything consistent by replacing every other variant of these with the proper one. :^)
2021-04-13 17:18:20 +03:00
RefPtr<GUI::Progressbar> m_progressbar;
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
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