Applications: Move to Userland/Applications/

Userland/Applications/FileManager/DirectoryView.cpp

@@ -0,0 +1,591 @@
+/*
+ * 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 "DirectoryView.h"
+#include "FileUtils.h"
+#include <AK/LexicalPath.h>
+#include <AK/NumberFormat.h>
+#include <AK/StringBuilder.h>
+#include <LibCore/MimeData.h>
+#include <LibCore/StandardPaths.h>
+#include <LibGUI/FileIconProvider.h>
+#include <LibGUI/InputBox.h>
+#include <LibGUI/Label.h>
+#include <LibGUI/MessageBox.h>
+#include <LibGUI/ModelEditingDelegate.h>
+#include <LibGUI/SortingProxyModel.h>
+#include <serenity.h>
+#include <spawn.h>
+#include <stdio.h>
+#include <unistd.h>
+
+namespace FileManager {
+
+NonnullRefPtr<GUI::Action> LauncherHandler::create_launch_action(Function<void(const LauncherHandler&)> launch_handler)
+{
+    auto icon = GUI::FileIconProvider::icon_for_executable(details().executable).bitmap_for_size(16);
+    return GUI::Action::create(details().name, move(icon), [this, launch_handler = move(launch_handler)](auto&) {
+        launch_handler(*this);
+    });
+}
+
+RefPtr<LauncherHandler> DirectoryView::get_default_launch_handler(const NonnullRefPtrVector<LauncherHandler>& handlers)
+{
+    // If this is an application, pick it first
+    for (size_t i = 0; i < handlers.size(); i++) {
+        if (handlers[i].details().launcher_type == Desktop::Launcher::LauncherType::Application)
+            return handlers[i];
+    }
+    // If there's a handler preferred by the user, pick this first
+    for (size_t i = 0; i < handlers.size(); i++) {
+        if (handlers[i].details().launcher_type == Desktop::Launcher::LauncherType::UserPreferred)
+            return handlers[i];
+    }
+    // Otherwise, use the user's default, if available
+    for (size_t i = 0; i < handlers.size(); i++) {
+        if (handlers[i].details().launcher_type == Desktop::Launcher::LauncherType::UserDefault)
+            return handlers[i];
+    }
+    // If still no match, use the first one we find
+    if (!handlers.is_empty()) {
+        return handlers[0];
+    }
+
+    return {};
+}
+
+NonnullRefPtrVector<LauncherHandler> DirectoryView::get_launch_handlers(const URL& url)
+{
+    NonnullRefPtrVector<LauncherHandler> handlers;
+    for (auto& h : Desktop::Launcher::get_handlers_with_details_for_url(url)) {
+        handlers.append(adopt(*new LauncherHandler(h)));
+    }
+    return handlers;
+}
+
+NonnullRefPtrVector<LauncherHandler> DirectoryView::get_launch_handlers(const String& path)
+{
+    return get_launch_handlers(URL::create_with_file_protocol(path));
+}
+
+void DirectoryView::handle_activation(const GUI::ModelIndex& index)
+{
+    if (!index.is_valid())
+        return;
+    dbgln("on activation: {},{}, this={:p}, m_model={:p}", index.row(), index.column(), this, m_model.ptr());
+    auto& node = this->node(index);
+    auto path = node.full_path();
+
+    struct stat st;
+    if (stat(path.characters(), &st) < 0) {
+        perror("stat");
+        return;
+    }
+
+    if (S_ISDIR(st.st_mode)) {
+        if (is_desktop()) {
+            Desktop::Launcher::open(URL::create_with_file_protocol(path));
+            return;
+        }
+        open(path);
+        return;
+    }
+
+    auto url = URL::create_with_file_protocol(path);
+    auto launcher_handlers = get_launch_handlers(url);
+    auto default_launcher = get_default_launch_handler(launcher_handlers);
+    if (default_launcher) {
+        launch(url, *default_launcher);
+    } else {
+        auto error_message = String::format("Could not open %s", path.characters());
+        GUI::MessageBox::show(window(), error_message, "File Manager", GUI::MessageBox::Type::Error);
+    }
+}
+
+DirectoryView::DirectoryView(Mode mode)
+    : m_mode(mode)
+    , m_model(GUI::FileSystemModel::create({}))
+    , m_sorting_model(GUI::SortingProxyModel::create(m_model))
+{
+    set_active_widget(nullptr);
+    set_content_margins({ 2, 2, 2, 2 });
+
+    setup_actions();
+
+    m_error_label = add<GUI::Label>();
+    m_error_label->set_font(m_error_label->font().bold_variant());
+
+    setup_model();
+
+    setup_icon_view();
+    if (mode != Mode::Desktop) {
+        setup_columns_view();
+        setup_table_view();
+    }
+
+    set_view_mode(ViewMode::Icon);
+}
+
+const GUI::FileSystemModel::Node& DirectoryView::node(const GUI::ModelIndex& index) const
+{
+    return model().node(m_sorting_model->map_to_source(index));
+}
+
+void DirectoryView::setup_model()
+{
+    m_model->on_error = [this](int, const char* error_string) {
+        auto failed_path = m_model->root_path();
+        auto error_message = String::formatted("Could not read {}:\n{}", failed_path, error_string);
+        m_error_label->set_text(error_message);
+        set_active_widget(m_error_label);
+
+        m_mkdir_action->set_enabled(false);
+        m_touch_action->set_enabled(false);
+
+        add_path_to_history(model().root_path());
+
+        if (on_path_change)
+            on_path_change(failed_path, false);
+    };
+
+    m_model->on_complete = [this] {
+        if (m_table_view)
+            m_table_view->selection().clear();
+        if (m_icon_view)
+            m_icon_view->selection().clear();
+
+        add_path_to_history(model().root_path());
+
+        bool can_write_in_path = access(model().root_path().characters(), W_OK) == 0;
+
+        m_mkdir_action->set_enabled(can_write_in_path);
+        m_touch_action->set_enabled(can_write_in_path);
+
+        if (on_path_change)
+            on_path_change(model().root_path(), can_write_in_path);
+    };
+
+    m_model->register_client(*this);
+
+    m_model->on_thumbnail_progress = [this](int done, int total) {
+        if (on_thumbnail_progress)
+            on_thumbnail_progress(done, total);
+    };
+
+    if (is_desktop())
+        m_model->set_root_path(Core::StandardPaths::desktop_directory());
+}
+
+void DirectoryView::setup_icon_view()
+{
+    m_icon_view = add<GUI::IconView>();
+    m_icon_view->set_should_hide_unnecessary_scrollbars(true);
+    m_icon_view->set_selection_mode(GUI::AbstractView::SelectionMode::MultiSelection);
+    m_icon_view->set_editable(true);
+    m_icon_view->set_edit_triggers(GUI::AbstractView::EditTrigger::EditKeyPressed);
+    m_icon_view->aid_create_editing_delegate = [](auto&) {
+        return make<GUI::StringModelEditingDelegate>();
+    };
+
+    if (is_desktop()) {
+        m_icon_view->set_frame_shape(Gfx::FrameShape::NoFrame);
+        m_icon_view->set_scrollbars_enabled(false);
+        m_icon_view->set_fill_with_background_color(false);
+        m_icon_view->set_draw_item_text_with_shadow(true);
+        m_icon_view->set_flow_direction(GUI::IconView::FlowDirection::TopToBottom);
+    }
+
+    m_icon_view->set_model(m_sorting_model);
+    m_icon_view->set_model_column(GUI::FileSystemModel::Column::Name);
+    m_icon_view->on_activation = [&](auto& index) {
+        handle_activation(index);
+    };
+    m_icon_view->on_selection_change = [this] {
+        handle_selection_change();
+    };
+    m_icon_view->on_context_menu_request = [this](auto& index, auto& event) {
+        if (on_context_menu_request)
+            on_context_menu_request(index, event);
+    };
+    m_icon_view->on_drop = [this](auto& index, auto& event) {
+        handle_drop(index, event);
+    };
+}
+
+void DirectoryView::setup_columns_view()
+{
+    m_columns_view = add<GUI::ColumnsView>();
+    m_columns_view->set_should_hide_unnecessary_scrollbars(true);
+    m_columns_view->set_selection_mode(GUI::AbstractView::SelectionMode::MultiSelection);
+    m_columns_view->set_editable(true);
+    m_columns_view->set_edit_triggers(GUI::AbstractView::EditTrigger::EditKeyPressed);
+    m_columns_view->aid_create_editing_delegate = [](auto&) {
+        return make<GUI::StringModelEditingDelegate>();
+    };
+
+    m_columns_view->set_model(m_sorting_model);
+    m_columns_view->set_model_column(GUI::FileSystemModel::Column::Name);
+
+    m_columns_view->on_activation = [&](auto& index) {
+        handle_activation(index);
+    };
+
+    m_columns_view->on_selection_change = [this] {
+        handle_selection_change();
+    };
+
+    m_columns_view->on_context_menu_request = [this](auto& index, auto& event) {
+        if (on_context_menu_request)
+            on_context_menu_request(index, event);
+    };
+
+    m_columns_view->on_drop = [this](auto& index, auto& event) {
+        handle_drop(index, event);
+    };
+}
+
+void DirectoryView::setup_table_view()
+{
+    m_table_view = add<GUI::TableView>();
+    m_table_view->set_should_hide_unnecessary_scrollbars(true);
+    m_table_view->set_selection_mode(GUI::AbstractView::SelectionMode::MultiSelection);
+    m_table_view->set_editable(true);
+    m_table_view->set_edit_triggers(GUI::AbstractView::EditTrigger::EditKeyPressed);
+    m_table_view->aid_create_editing_delegate = [](auto&) {
+        return make<GUI::StringModelEditingDelegate>();
+    };
+
+    m_table_view->set_model(m_sorting_model);
+    m_table_view->set_key_column_and_sort_order(GUI::FileSystemModel::Column::Name, GUI::SortOrder::Ascending);
+
+    m_table_view->on_activation = [&](auto& index) {
+        handle_activation(index);
+    };
+
+    m_table_view->on_selection_change = [this] {
+        handle_selection_change();
+    };
+
+    m_table_view->on_context_menu_request = [this](auto& index, auto& event) {
+        if (on_context_menu_request)
+            on_context_menu_request(index, event);
+    };
+
+    m_table_view->on_drop = [this](auto& index, auto& event) {
+        handle_drop(index, event);
+    };
+}
+
+DirectoryView::~DirectoryView()
+{
+    m_model->unregister_client(*this);
+}
+
+void DirectoryView::model_did_update(unsigned flags)
+{
+    if (flags & GUI::Model::UpdateFlag::InvalidateAllIndexes) {
+        for_each_view_implementation([](auto& view) {
+            view.selection().clear();
+        });
+    }
+    update_statusbar();
+}
+
+void DirectoryView::set_view_mode(ViewMode mode)
+{
+    if (m_view_mode == mode)
+        return;
+    m_view_mode = mode;
+    update();
+    if (mode == ViewMode::Table) {
+        set_active_widget(m_table_view);
+        return;
+    }
+    if (mode == ViewMode::Columns) {
+        set_active_widget(m_columns_view);
+        return;
+    }
+    if (mode == ViewMode::Icon) {
+        set_active_widget(m_icon_view);
+        return;
+    }
+    ASSERT_NOT_REACHED();
+}
+
+void DirectoryView::add_path_to_history(const StringView& path)
+{
+    if (m_path_history.size() && m_path_history.at(m_path_history_position) == path)
+        return;
+
+    if (m_path_history_position < m_path_history.size())
+        m_path_history.resize(m_path_history_position + 1);
+
+    m_path_history.append(path);
+    m_path_history_position = m_path_history.size() - 1;
+}
+
+void DirectoryView::open(const StringView& path)
+{
+    if (model().root_path() == path) {
+        model().update();
+        return;
+    }
+
+    set_active_widget(&current_view());
+    model().set_root_path(path);
+}
+
+void DirectoryView::set_status_message(const StringView& message)
+{
+    if (on_status_message)
+        on_status_message(message);
+}
+
+void DirectoryView::open_parent_directory()
+{
+    auto path = String::formatted("{}/..", model().root_path());
+    model().set_root_path(path);
+}
+
+void DirectoryView::refresh()
+{
+    model().update();
+}
+
+void DirectoryView::open_previous_directory()
+{
+    if (m_path_history_position > 0) {
+        set_active_widget(&current_view());
+        m_path_history_position--;
+        model().set_root_path(m_path_history[m_path_history_position]);
+    }
+}
+void DirectoryView::open_next_directory()
+{
+    if (m_path_history_position < m_path_history.size() - 1) {
+        set_active_widget(&current_view());
+        m_path_history_position++;
+        model().set_root_path(m_path_history[m_path_history_position]);
+    }
+}
+
+void DirectoryView::update_statusbar()
+{
+    // If we're triggered during widget construction, just ignore it.
+    if (m_view_mode == ViewMode::Invalid)
+        return;
+
+    size_t total_size = model().node({}).total_size;
+    if (current_view().selection().is_empty()) {
+        set_status_message(String::formatted("{} item(s) ({})",
+            model().row_count(),
+            human_readable_size(total_size)));
+        return;
+    }
+
+    int selected_item_count = current_view().selection().size();
+    size_t selected_byte_count = 0;
+
+    current_view().selection().for_each_index([&](auto& index) {
+        auto& model = *current_view().model();
+        auto size_index = model.index(index.row(), GUI::FileSystemModel::Column::Size, model.parent_index(index));
+        auto file_size = size_index.data().to_i32();
+        selected_byte_count += file_size;
+    });
+
+    StringBuilder builder;
+    builder.append(String::number(selected_item_count));
+    builder.append(" item");
+    if (selected_item_count != 1)
+        builder.append('s');
+    builder.append(" selected (");
+    builder.append(human_readable_size(selected_byte_count).characters());
+    builder.append(')');
+
+    if (selected_item_count == 1) {
+        auto& node = this->node(current_view().selection().first());
+        if (!node.symlink_target.is_empty()) {
+            builder.append(" -> ");
+            builder.append(node.symlink_target);
+        }
+    }
+
+    set_status_message(builder.to_string());
+}
+
+void DirectoryView::set_should_show_dotfiles(bool show_dotfiles)
+{
+    m_model->set_should_show_dotfiles(show_dotfiles);
+}
+
+void DirectoryView::launch(const URL&, const LauncherHandler& launcher_handler)
+{
+    pid_t child;
+    if (launcher_handler.details().launcher_type == Desktop::Launcher::LauncherType::Application) {
+        const char* argv[] = { launcher_handler.details().name.characters(), nullptr };
+        posix_spawn(&child, launcher_handler.details().executable.characters(), nullptr, nullptr, const_cast<char**>(argv), environ);
+        if (disown(child) < 0)
+            perror("disown");
+    } else {
+        for (auto& path : selected_file_paths()) {
+            const char* argv[] = { launcher_handler.details().name.characters(), path.characters(), nullptr };
+            posix_spawn(&child, launcher_handler.details().executable.characters(), nullptr, nullptr, const_cast<char**>(argv), environ);
+            if (disown(child) < 0)
+                perror("disown");
+        }
+    }
+}
+
+Vector<String> DirectoryView::selected_file_paths() const
+{
+    Vector<String> paths;
+    auto& view = current_view();
+    auto& model = *view.model();
+    view.selection().for_each_index([&](const GUI::ModelIndex& index) {
+        auto parent_index = model.parent_index(index);
+        auto name_index = model.index(index.row(), GUI::FileSystemModel::Column::Name, parent_index);
+        auto path = name_index.data(GUI::ModelRole::Custom).to_string();
+        paths.append(path);
+    });
+    return paths;
+}
+
+void DirectoryView::do_delete(bool should_confirm)
+{
+    auto paths = selected_file_paths();
+    ASSERT(!paths.is_empty());
+    FileUtils::delete_paths(paths, should_confirm, window());
+}
+
+void DirectoryView::handle_selection_change()
+{
+    update_statusbar();
+
+    bool can_delete = !current_view().selection().is_empty() && access(path().characters(), W_OK) == 0;
+    m_delete_action->set_enabled(can_delete);
+    m_force_delete_action->set_enabled(can_delete);
+
+    if (on_selection_change)
+        on_selection_change(current_view());
+}
+
+void DirectoryView::setup_actions()
+{
+    m_mkdir_action = GUI::Action::create("New directory...", { Mod_Ctrl | Mod_Shift, Key_N }, Gfx::Bitmap::load_from_file("/res/icons/16x16/mkdir.png"), [&](const GUI::Action&) {
+        String value;
+        if (GUI::InputBox::show(value, window(), "Enter name:", "New directory") == GUI::InputBox::ExecOK && !value.is_empty()) {
+            auto new_dir_path = LexicalPath::canonicalized_path(String::formatted("{}/{}", path(), value));
+            int rc = mkdir(new_dir_path.characters(), 0777);
+            if (rc < 0) {
+                auto saved_errno = errno;
+                GUI::MessageBox::show(window(), String::formatted("mkdir(\"{}\") failed: {}", new_dir_path, strerror(saved_errno)), "Error", GUI::MessageBox::Type::Error);
+            }
+        }
+    });
+
+    m_touch_action = GUI::Action::create("New file...", { Mod_Ctrl | Mod_Shift, Key_F }, Gfx::Bitmap::load_from_file("/res/icons/16x16/new.png"), [&](const GUI::Action&) {
+        String value;
+        if (GUI::InputBox::show(value, window(), "Enter name:", "New file") == GUI::InputBox::ExecOK && !value.is_empty()) {
+            auto new_file_path = LexicalPath::canonicalized_path(String::formatted("{}/{}", path(), value));
+            struct stat st;
+            int rc = stat(new_file_path.characters(), &st);
+            if ((rc < 0 && errno != ENOENT)) {
+                auto saved_errno = errno;
+                GUI::MessageBox::show(window(), String::formatted("stat(\"{}\") failed: {}", new_file_path, strerror(saved_errno)), "Error", GUI::MessageBox::Type::Error);
+                return;
+            }
+            if (rc == 0) {
+                GUI::MessageBox::show(window(), String::formatted("{}: Already exists", new_file_path), "Error", GUI::MessageBox::Type::Error);
+                return;
+            }
+            int fd = creat(new_file_path.characters(), 0666);
+            if (fd < 0) {
+                auto saved_errno = errno;
+                GUI::MessageBox::show(window(), String::formatted("creat(\"{}\") failed: {}", new_file_path, strerror(saved_errno)), "Error", GUI::MessageBox::Type::Error);
+                return;
+            }
+            rc = close(fd);
+            ASSERT(rc >= 0);
+        }
+    });
+
+    m_open_terminal_action = GUI::Action::create("Open Terminal here", Gfx::Bitmap::load_from_file("/res/icons/16x16/app-terminal.png"), [&](auto&) {
+        posix_spawn_file_actions_t spawn_actions;
+        posix_spawn_file_actions_init(&spawn_actions);
+        posix_spawn_file_actions_addchdir(&spawn_actions, path().characters());
+        pid_t pid;
+        const char* argv[] = { "Terminal", nullptr };
+        if ((errno = posix_spawn(&pid, "/bin/Terminal", &spawn_actions, nullptr, const_cast<char**>(argv), environ))) {
+            perror("posix_spawn");
+        } else {
+            if (disown(pid) < 0)
+                perror("disown");
+        }
+        posix_spawn_file_actions_destroy(&spawn_actions);
+    });
+
+    m_delete_action = GUI::CommonActions::make_delete_action([this](auto&) { do_delete(true); }, window());
+
+    m_force_delete_action = GUI::Action::create(
+        "Delete without confirmation", { Mod_Shift, Key_Delete },
+        [this](auto&) { do_delete(false); },
+        window());
+}
+
+void DirectoryView::handle_drop(const GUI::ModelIndex& index, const GUI::DropEvent& event)
+{
+    if (!event.mime_data().has_urls())
+        return;
+    auto urls = event.mime_data().urls();
+    if (urls.is_empty()) {
+        dbgln("No files to drop");
+        return;
+    }
+
+    auto& target_node = node(index);
+    if (!target_node.is_directory())
+        return;
+
+    bool had_accepted_drop = false;
+    for (auto& url_to_copy : urls) {
+        if (!url_to_copy.is_valid() || url_to_copy.path() == target_node.full_path())
+            continue;
+        auto new_path = String::formatted("{}/{}", target_node.full_path(), LexicalPath(url_to_copy.path()).basename());
+        if (url_to_copy.path() == new_path)
+            continue;
+
+        if (!FileUtils::copy_file_or_directory(url_to_copy.path(), new_path)) {
+            auto error_message = String::formatted("Could not copy {} into {}.", url_to_copy.to_string(), new_path);
+            GUI::MessageBox::show(window(), error_message, "File Manager", GUI::MessageBox::Type::Error);
+        } else {
+            had_accepted_drop = true;
+        }
+    }
+    if (had_accepted_drop && on_accepted_drop)
+        on_accepted_drop();
+}
+
+}