ladybird/Libraries/LibGUI/FilePicker.cpp

/*
 * 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 <AK/Function.h>
#include <AK/LexicalPath.h>
#include <LibCore/StandardPaths.h>
#include <LibGUI/Action.h>
#include <LibGUI/BoxLayout.h>
#include <LibGUI/Button.h>
#include <LibGUI/FileIconProvider.h>
#include <LibGUI/FilePicker.h>
#include <LibGUI/FileSystemModel.h>
#include <LibGUI/InputBox.h>
#include <LibGUI/Label.h>
#include <LibGUI/MessageBox.h>
#include <LibGUI/MultiView.h>
#include <LibGUI/SortingProxyModel.h>
#include <LibGUI/TextBox.h>
#include <LibGUI/ToolBar.h>
#include <string.h>

namespace GUI {

Optional<String> FilePicker::get_open_filepath(Window* parent_window, const String& window_title, Options options)
{
    auto picker = FilePicker::construct(parent_window, Mode::Open, options);

    if (!window_title.is_null())
        picker->set_title(window_title);

    if (picker->exec() == Dialog::ExecOK) {
        String file_path = picker->selected_file().string();

        if (file_path.is_null())
            return {};

        return file_path;
    }
    return {};
}

Optional<String> FilePicker::get_save_filepath(Window* parent_window, const String& title, const String& extension, Options options)
{
    auto picker = FilePicker::construct(parent_window, Mode::Save, options, String::format("%s.%s", title.characters(), extension.characters()));

    if (picker->exec() == Dialog::ExecOK) {
        String file_path = picker->selected_file().string();

        if (file_path.is_null())
            return {};

        return file_path;
    }
    return {};
}

FilePicker::FilePicker(Window* parent_window, Mode mode, Options options, const StringView& file_name, const StringView& path)
    : Dialog(parent_window)
    , m_model(FileSystemModel::create())
    , m_mode(mode)
{
    switch (m_mode) {
    case Mode::Open:
        set_title("Open File");
        break;
    case Mode::OpenMultiple:
        set_title("Open Files");
        break;
    case Mode::Save:
        set_title("Save File");
        break;
    }
    set_title(m_mode == Mode::Open ? "Open File" : "Save File");
    set_rect(200, 200, 700, 400);
    auto& horizontal_container = set_main_widget<Widget>();
    horizontal_container.set_layout<HorizontalBoxLayout>();
    horizontal_container.layout()->set_margins({ 4, 4, 4, 4 });
    horizontal_container.set_fill_with_background_color(true);

    auto& vertical_container = horizontal_container.add<Widget>();
    vertical_container.set_layout<VerticalBoxLayout>();
    vertical_container.layout()->set_spacing(4);

    auto& upper_container = vertical_container.add<Widget>();
    upper_container.set_layout<HorizontalBoxLayout>();
    upper_container.layout()->set_spacing(2);
    upper_container.set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
    upper_container.set_preferred_size(0, 26);

    auto& toolbar = upper_container.add<ToolBar>();
    toolbar.set_size_policy(SizePolicy::Fixed, SizePolicy::Fill);
    toolbar.set_preferred_size(165, 0);
    toolbar.set_has_frame(false);

    m_location_textbox = upper_container.add<TextBox>();
    m_location_textbox->set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
    m_location_textbox->set_preferred_size(0, 22);
    m_location_textbox->set_text(path);

    m_view = vertical_container.add<MultiView>();
    m_view->set_multi_select(m_mode == Mode::OpenMultiple);
    m_view->set_model(SortingProxyModel::create(*m_model));
    m_view->set_model_column(FileSystemModel::Column::Name);
    m_view->set_key_column_and_sort_order(GUI::FileSystemModel::Column::Name, GUI::SortOrder::Ascending);
    m_view->set_column_hidden(FileSystemModel::Column::Owner, true);
    m_view->set_column_hidden(FileSystemModel::Column::Group, true);
    m_view->set_column_hidden(FileSystemModel::Column::Permissions, true);
    m_view->set_column_hidden(FileSystemModel::Column::Inode, true);
    m_view->set_column_hidden(FileSystemModel::Column::SymlinkTarget, true);

    set_path(path);

    m_model->register_client(*this);

    m_location_textbox->on_return_pressed = [this] {
        set_path(m_location_textbox->text());
    };

    auto open_parent_directory_action = Action::create("Open parent directory", { Mod_Alt, Key_Up }, Gfx::Bitmap::load_from_file("/res/icons/16x16/open-parent-directory.png"), [this](const Action&) {
        set_path(String::format("%s/..", m_model->root_path().characters()));
    });
    toolbar.add_action(*open_parent_directory_action);

    auto go_home_action = CommonActions::make_go_home_action([this](auto&) {
        set_path(Core::StandardPaths::home_directory());
    });
    toolbar.add_action(go_home_action);
    toolbar.add_separator();

    auto mkdir_action = Action::create("New directory...", Gfx::Bitmap::load_from_file("/res/icons/16x16/mkdir.png"), [this](const Action&) {
        String value;
        if (InputBox::show(value, this, "Enter name:", "New directory") == InputBox::ExecOK && !value.is_empty()) {
            auto new_dir_path = LexicalPath(String::format("%s/%s",
                                                m_model->root_path().characters(),
                                                value.characters()))
                                    .string();
            int rc = mkdir(new_dir_path.characters(), 0777);
            if (rc < 0) {
                MessageBox::show(this, String::format("mkdir(\"%s\") failed: %s", new_dir_path.characters(), strerror(errno)), "Error", MessageBox::Type::Error);
            } else {
                m_model->update();
            }
        }
    });

    toolbar.add_action(*mkdir_action);

    toolbar.add_separator();

    toolbar.add_action(m_view->view_as_icons_action());
    toolbar.add_action(m_view->view_as_table_action());
    toolbar.add_action(m_view->view_as_columns_action());

    auto& lower_container = vertical_container.add<Widget>();
    lower_container.set_layout<VerticalBoxLayout>();
    lower_container.layout()->set_spacing(4);
    lower_container.set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
    lower_container.set_preferred_size(0, 45);

    auto& filename_container = lower_container.add<Widget>();
    filename_container.set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
    filename_container.set_preferred_size(0, 20);
    filename_container.set_layout<HorizontalBoxLayout>();
    auto& filename_label = filename_container.add<Label>("File name:");
    filename_label.set_text_alignment(Gfx::TextAlignment::CenterLeft);
    filename_label.set_size_policy(SizePolicy::Fixed, SizePolicy::Fill);
    filename_label.set_preferred_size(60, 0);
    m_filename_textbox = filename_container.add<TextBox>();
    if (m_mode == Mode::Save) {
        m_filename_textbox->set_text(file_name);
        m_filename_textbox->set_focus(true);
        m_filename_textbox->select_all();
    }
    m_filename_textbox->on_return_pressed = [&] {
        on_file_return();
    };

    m_view->on_selection_change = [this] {
        auto index = m_view->selection().first();
        auto& filter_model = (SortingProxyModel&)*m_view->model();
        auto local_index = filter_model.map_to_source(index);
        const FileSystemModel::Node& node = m_model->node(local_index);
        LexicalPath path { node.full_path() };

        if (have_preview())
            clear_preview();

        if (!node.is_directory())
            m_filename_textbox->set_text(node.name);
        if (have_preview())
            set_preview(path);
    };

    auto& button_container = lower_container.add<Widget>();
    button_container.set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
    button_container.set_preferred_size(0, 20);
    button_container.set_layout<HorizontalBoxLayout>();
    button_container.layout()->set_spacing(4);
    button_container.layout()->add_spacer();

    auto& cancel_button = button_container.add<Button>();
    cancel_button.set_size_policy(SizePolicy::Fixed, SizePolicy::Fill);
    cancel_button.set_preferred_size(80, 0);
    cancel_button.set_text("Cancel");
    cancel_button.on_click = [this](auto) {
        done(ExecCancel);
    };

    auto& ok_button = button_container.add<Button>();
    ok_button.set_size_policy(SizePolicy::Fixed, SizePolicy::Fill);
    ok_button.set_preferred_size(80, 0);
    ok_button.set_text(ok_button_name(m_mode));
    ok_button.on_click = [this](auto) {
        on_file_return();
    };

    m_view->on_activation = [this](auto& index) {
        auto& filter_model = (SortingProxyModel&)*m_view->model();
        auto local_index = filter_model.map_to_source(index);
        const FileSystemModel::Node& node = m_model->node(local_index);
        auto path = node.full_path();

        if (node.is_directory()) {
            set_path(path);
            // NOTE: 'node' is invalid from here on
        } else {
            on_file_return();
        }
    };

    if (!((unsigned)options & (unsigned)Options::DisablePreview)) {
        m_preview_container = horizontal_container.add<Frame>();
        m_preview_container->set_visible(false);
        m_preview_container->set_size_policy(SizePolicy::Fixed, SizePolicy::Fill);
        m_preview_container->set_preferred_size(180, 0);
        m_preview_container->set_layout<VerticalBoxLayout>();
        m_preview_container->layout()->set_margins({ 8, 8, 8, 8 });

        m_preview_image = m_preview_container->add<ImageWidget>();
        m_preview_image->set_should_stretch(true);
        m_preview_image->set_auto_resize(false);
        m_preview_image->set_preferred_size(160, 160);

        m_preview_name_label = m_preview_container->add<Label>();
        m_preview_name_label->set_font(Gfx::Font::default_bold_font());
        m_preview_name_label->set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
        m_preview_name_label->set_preferred_size(0, m_preview_name_label->font().glyph_height());

        m_preview_geometry_label = m_preview_container->add<Label>();
        m_preview_geometry_label->set_size_policy(SizePolicy::Fill, SizePolicy::Fixed);
        m_preview_geometry_label->set_preferred_size(0, m_preview_name_label->font().glyph_height());
    }
}

FilePicker::~FilePicker()
{
    m_model->unregister_client(*this);
}

void FilePicker::model_did_update(unsigned)
{
    m_location_textbox->set_text(m_model->root_path());
    if (have_preview())
        clear_preview();
}

void FilePicker::set_preview(const LexicalPath& path)
{
    if (Gfx::Bitmap::is_path_a_supported_image_format(path.string())) {
        auto bitmap = Gfx::Bitmap::load_from_file(path.string());
        if (!bitmap) {
            clear_preview();
            return;
        }
        bool should_stretch = bitmap->width() > m_preview_image->width() || bitmap->height() > m_preview_image->height();
        m_preview_name_label->set_text(path.basename());
        m_preview_geometry_label->set_text(bitmap->size().to_string());
        m_preview_image->set_should_stretch(should_stretch);
        m_preview_image->set_bitmap(move(bitmap));
        m_preview_container->set_visible(true);
    }
}

void FilePicker::clear_preview()
{
    m_preview_image->set_bitmap(nullptr);
    m_preview_name_label->set_text(String::empty());
    m_preview_geometry_label->set_text(String::empty());
    m_preview_container->set_visible(false);
}

void FilePicker::on_file_return()
{
    LexicalPath path(String::format("%s/%s", m_model->root_path().characters(), m_filename_textbox->text().characters()));

    if (FilePicker::file_exists(path.string()) && m_mode == Mode::Save) {
        auto result = MessageBox::show(this, "File already exists, overwrite?", "Existing File", MessageBox::Type::Warning, MessageBox::InputType::OKCancel);
        if (result == MessageBox::ExecCancel)
            return;
    }

    m_selected_file = path;
    done(ExecOK);
}

bool FilePicker::file_exists(const StringView& path)
{
    struct stat st;
    int rc = stat(path.to_string().characters(), &st);
    if (rc < 0) {
        if (errno == ENOENT)
            return false;
    }
    if (rc == 0) {
        return true;
    }
    return false;
}

void FilePicker::set_path(const String& path)
{
    auto new_path = LexicalPath(path).string();
    m_location_textbox->set_icon(FileIconProvider::icon_for_path(new_path).bitmap_for_size(16));
    m_model->set_root_path(new_path);
}

}