RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-28 19:25:10 +00:00
Code Issues Activity Actions

FileSystemAccessClient: Remove old API returning file descriptors :^)

Browse source 
Since all users of the old API are now removed, this commit removes all
the methods that returned raw file descriptors, in favor of returning
`ErrorOr<NonnullRefPtr<Core::File>`.
This commit is contained in:
Mustafa Quraish 2022-01-16 23:14:31 -05:00 • committed by Andreas Kling
parent bba32de857
commit ee74aafdca
2 changed files with 24 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

126
Userland/Libraries/LibFileSystemAccessClient/Client.cpp
View file

@ -1,5 +1,6 @@
/* /*
* Copyright (c) 2021, timmot <tiwwot@protonmail.com> * Copyright (c) 2021, timmot <tiwwot@protonmail.com>
* Copyright (c) 2022, Mustafa Quraish <mustafa@serenityos.org>
* *
* SPDX-License-Identifier: BSD-2-Clause * SPDX-License-Identifier: BSD-2-Clause
*/ */
@ -25,88 +26,9 @@ Client& Client::the()
return *s_the; return *s_the;
} }
Result Client::request_file_read_only_approved(i32 parent_window_id, String const& path) Result Client::try_request_file_read_only_approved(GUI::Window* parent_window, String const& path)
{ {
m_promise = Core::Promise<Result>::construct(); m_promise = Core::Promise<Result>::construct();
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
auto child_window_server_client_id = expose_window_server_client_id();
GUI::WindowServerConnection::the().async_add_window_stealing_for_client(child_window_server_client_id, parent_window_id);
ScopeGuard guard([parent_window_id, child_window_server_client_id] {
GUI::WindowServerConnection::the().async_remove_window_stealing_for_client(child_window_server_client_id, parent_window_id);
});
if (path.starts_with('/')) {
async_request_file_read_only_approved(parent_window_server_client_id, parent_window_id, path);
} else {
auto full_path = LexicalPath::join(Core::File::current_working_directory(), path).string();
async_request_file_read_only_approved(parent_window_server_client_id, parent_window_id, full_path);
}
return m_promise->await();
}
Result Client::request_file(i32 parent_window_id, String const& path, Core::OpenMode mode)
{
m_promise = Core::Promise<Result>::construct();
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
auto child_window_server_client_id = expose_window_server_client_id();
GUI::WindowServerConnection::the().async_add_window_stealing_for_client(child_window_server_client_id, parent_window_id);
ScopeGuard guard([parent_window_id, child_window_server_client_id] {
GUI::WindowServerConnection::the().async_remove_window_stealing_for_client(child_window_server_client_id, parent_window_id);
});
if (path.starts_with('/')) {
async_request_file(parent_window_server_client_id, parent_window_id, path, mode);
} else {
auto full_path = LexicalPath::join(Core::File::current_working_directory(), path).string();
async_request_file(parent_window_server_client_id, parent_window_id, full_path, mode);
}
return m_promise->await();
}
Result Client::open_file(i32 parent_window_id, String const& window_title, StringView path, Core::OpenMode requested_access)
{
m_promise = Core::Promise<Result>::construct();
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
auto child_window_server_client_id = expose_window_server_client_id();
GUI::WindowServerConnection::the().async_add_window_stealing_for_client(child_window_server_client_id, parent_window_id);
ScopeGuard guard([parent_window_id, child_window_server_client_id] {
GUI::WindowServerConnection::the().async_remove_window_stealing_for_client(child_window_server_client_id, parent_window_id);
});
async_prompt_open_file(parent_window_server_client_id, parent_window_id, window_title, path, requested_access);
return m_promise->await();
}
Result Client::save_file(i32 parent_window_id, String const& name, String const ext, Core::OpenMode requested_access)
{
m_promise = Core::Promise<Result>::construct();
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
auto child_window_server_client_id = expose_window_server_client_id();
GUI::WindowServerConnection::the().async_add_window_stealing_for_client(child_window_server_client_id, parent_window_id);
ScopeGuard guard([parent_window_id, child_window_server_client_id] {
GUI::WindowServerConnection::the().async_remove_window_stealing_for_client(child_window_server_client_id, parent_window_id);
});
async_prompt_save_file(parent_window_server_client_id, parent_window_id, name.is_null() ? "Untitled" : name, ext.is_null() ? "txt" : ext, Core::StandardPaths::home_directory(), requested_access);
return m_promise->await();
}
FileResult Client::try_request_file_read_only_approved(GUI::Window* parent_window, String const& path)
{
m_file_promise = Core::Promise<FileResult>::construct();
m_promise = nullptr;
m_parent_window = parent_window; m_parent_window = parent_window;
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id(); auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
@ -126,13 +48,12 @@ FileResult Client::try_request_file_read_only_approved(GUI::Window* parent_windo
async_request_file_read_only_approved(parent_window_server_client_id, parent_window_id, full_path); async_request_file_read_only_approved(parent_window_server_client_id, parent_window_id, full_path);
} }
return m_file_promise->await(); return m_promise->await();
} }
FileResult Client::try_request_file(GUI::Window* parent_window, String const& path, Core::OpenMode mode) Result Client::try_request_file(GUI::Window* parent_window, String const& path, Core::OpenMode mode)
{ {
m_file_promise = Core::Promise<FileResult>::construct(); m_promise = Core::Promise<Result>::construct();
m_promise = nullptr;
m_parent_window = parent_window; m_parent_window = parent_window;
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id(); auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
@ -152,13 +73,12 @@ FileResult Client::try_request_file(GUI::Window* parent_window, String const& pa
async_request_file(parent_window_server_client_id, parent_window_id, full_path, mode); async_request_file(parent_window_server_client_id, parent_window_id, full_path, mode);
} }
return m_file_promise->await(); return m_promise->await();
} }
FileResult Client::try_open_file(GUI::Window* parent_window, String const& window_title, StringView path, Core::OpenMode requested_access) Result Client::try_open_file(GUI::Window* parent_window, String const& window_title, StringView path, Core::OpenMode requested_access)
{ {
m_file_promise = Core::Promise<FileResult>::construct(); m_promise = Core::Promise<Result>::construct();
m_promise = nullptr;
m_parent_window = parent_window; m_parent_window = parent_window;
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id(); auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
@ -173,13 +93,12 @@ FileResult Client::try_open_file(GUI::Window* parent_window, String const& windo
async_prompt_open_file(parent_window_server_client_id, parent_window_id, window_title, path, requested_access); async_prompt_open_file(parent_window_server_client_id, parent_window_id, window_title, path, requested_access);
return m_file_promise->await(); return m_promise->await();
} }
FileResult Client::try_save_file(GUI::Window* parent_window, String const& name, String const ext, Core::OpenMode requested_access) Result Client::try_save_file(GUI::Window* parent_window, String const& name, String const ext, Core::OpenMode requested_access)
{ {
m_file_promise = Core::Promise<FileResult>::construct(); m_promise = Core::Promise<Result>::construct();
m_promise = nullptr;
m_parent_window = parent_window; m_parent_window = parent_window;
auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id(); auto parent_window_server_client_id = GUI::WindowServerConnection::the().expose_client_id();
@ -194,27 +113,18 @@ FileResult Client::try_save_file(GUI::Window* parent_window, String const& name,
async_prompt_save_file(parent_window_server_client_id, parent_window_id, name.is_null() ? "Untitled" : name, ext.is_null() ? "txt" : ext, Core::StandardPaths::home_directory(), requested_access); async_prompt_save_file(parent_window_server_client_id, parent_window_id, name.is_null() ? "Untitled" : name, ext.is_null() ? "txt" : ext, Core::StandardPaths::home_directory(), requested_access);
return m_file_promise->await(); return m_promise->await();
} }
void Client::handle_prompt_end(i32 error, Optional<IPC::File> const& ipc_file, Optional<String> const& chosen_file) void Client::handle_prompt_end(i32 error, Optional<IPC::File> const& ipc_file, Optional<String> const& chosen_file)
{ {
if (m_promise) { VERIFY(m_promise);
if (error == 0) {
m_promise->resolve({ error, ipc_file->take_fd(), *chosen_file });
} else {
m_promise->resolve({ error, {}, chosen_file });
}
return;
}
VERIFY(m_file_promise);
if (error != 0) { if (error != 0) {
// We don't want to show an error message for non-existent files since some applications may want // We don't want to show an error message for non-existent files since some applications may want
// to handle it as opening a new, named file. // to handle it as opening a new, named file.
if (error != -1 && error != ENOENT) if (error != -1 && error != ENOENT)
GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: {}", *chosen_file, strerror(error))); GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: {}", *chosen_file, strerror(error)));
m_file_promise->resolve(Error::from_errno(error)); m_promise->resolve(Error::from_errno(error));
return; return;
} }
@ -222,24 +132,24 @@ void Client::handle_prompt_end(i32 error, Optional<IPC::File> const& ipc_file, O
auto fd = ipc_file->take_fd(); auto fd = ipc_file->take_fd();
if (!file->open(fd, Core::OpenMode::ReadWrite, Core::File::ShouldCloseFileDescriptor::Yes) && file->error() != ENOENT) { if (!file->open(fd, Core::OpenMode::ReadWrite, Core::File::ShouldCloseFileDescriptor::Yes) && file->error() != ENOENT) {
GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: {}", *chosen_file, strerror(error))); GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: {}", *chosen_file, strerror(error)));
m_file_promise->resolve(Error::from_errno(file->error())); m_promise->resolve(Error::from_errno(file->error()));
return; return;
} }
if (file->is_device()) { if (file->is_device()) {
GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: Cannot open device files", *chosen_file)); GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: Cannot open device files", *chosen_file));
m_file_promise->resolve(Error::from_string_literal("Cannot open device files"sv)); m_promise->resolve(Error::from_string_literal("Cannot open device files"sv));
return; return;
} }
if (file->is_directory()) { if (file->is_directory()) {
GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: Cannot open directory", *chosen_file)); GUI::MessageBox::show_error(m_parent_window, String::formatted("Opening \"{}\" failed: Cannot open directory", *chosen_file));
m_file_promise->resolve(Error::from_string_literal("Cannot open directory"sv)); m_promise->resolve(Error::from_string_literal("Cannot open directory"sv));
return; return;
} }
file->set_filename(move(*chosen_file)); file->set_filename(move(*chosen_file));
m_file_promise->resolve(file); m_promise->resolve(file);
} }
void Client::die() void Client::die()

23
Userland/Libraries/LibFileSystemAccessClient/Client.h
View file

@ -1,5 +1,6 @@
/* /*
* Copyright (c) 2021, timmot <tiwwot@protonmail.com> * Copyright (c) 2021, timmot <tiwwot@protonmail.com>
* Copyright (c) 2022, Mustafa Quraish <mustafa@serenityos.org>
* *
* SPDX-License-Identifier: BSD-2-Clause * SPDX-License-Identifier: BSD-2-Clause
*/ */
@ -16,13 +17,7 @@
namespace FileSystemAccessClient { namespace FileSystemAccessClient {
struct Result { using Result = ErrorOr<NonnullRefPtr<Core::File>>;
i32 error;
Optional<i32> fd;
Optional<String> chosen_file;
};
using FileResult = ErrorOr<NonnullRefPtr<Core::File>>;
class Client final class Client final
: public IPC::ServerConnection<FileSystemAccessClientEndpoint, FileSystemAccessServerEndpoint> : public IPC::ServerConnection<FileSystemAccessClientEndpoint, FileSystemAccessServerEndpoint>
@ -30,15 +25,10 @@ class Client final
IPC_CLIENT_CONNECTION(Client, "/tmp/portal/filesystemaccess") IPC_CLIENT_CONNECTION(Client, "/tmp/portal/filesystemaccess")
public: public:
Result request_file_read_only_approved(i32 parent_window_id, String const& path); Result try_request_file_read_only_approved(GUI::Window* parent_window, String const& path);
Result request_file(i32 parent_window_id, String const& path, Core::OpenMode mode); Result try_request_file(GUI::Window* parent_window, String const& path, Core::OpenMode mode);
Result open_file(i32 parent_window_id, String const& window_title = {}, StringView path = Core::StandardPaths::home_directory(), Core::OpenMode requested_access = Core::OpenMode::ReadOnly); Result try_open_file(GUI::Window* parent_window, String const& window_title = {}, StringView path = Core::StandardPaths::home_directory(), Core::OpenMode requested_access = Core::OpenMode::ReadOnly);
Result save_file(i32 parent_window_id, String const& name, String const ext, Core::OpenMode requested_access = Core::OpenMode::WriteOnly | Core::OpenMode::Truncate); Result try_save_file(GUI::Window* parent_window, String const& name, String const ext, Core::OpenMode requested_access = Core::OpenMode::WriteOnly | Core::OpenMode::Truncate);
FileResult try_request_file_read_only_approved(GUI::Window* parent_window, String const& path);
FileResult try_request_file(GUI::Window* parent_window, String const& path, Core::OpenMode mode);
FileResult try_open_file(GUI::Window* parent_window, String const& window_title = {}, StringView path = Core::StandardPaths::home_directory(), Core::OpenMode requested_access = Core::OpenMode::ReadOnly);
FileResult try_save_file(GUI::Window* parent_window, String const& name, String const ext, Core::OpenMode requested_access = Core::OpenMode::WriteOnly | Core::OpenMode::Truncate);
static Client& the(); static Client& the();
@ -54,7 +44,6 @@ private:
virtual void handle_prompt_end(i32 error, Optional<IPC::File> const& fd, Optional<String> const& chosen_file) override; virtual void handle_prompt_end(i32 error, Optional<IPC::File> const& fd, Optional<String> const& chosen_file) override;
RefPtr<Core::Promise<Result>> m_promise; RefPtr<Core::Promise<Result>> m_promise;
RefPtr<Core::Promise<FileResult>> m_file_promise;
GUI::Window* m_parent_window { nullptr }; GUI::Window* m_parent_window { nullptr };
}; };