6cb7b8d3a4* feat: promisify dialog.showSaveDialog() * address some feedback from review * filename => filePath * fix last filename => filePath
311 lines
11 KiB
C++
311 lines
11 KiB
C++
// Copyright (c) 2014 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#include "atom/browser/ui/file_dialog.h"
|
|
|
|
#include <glib/gi18n.h> // _() macro
|
|
|
|
#include "atom/browser/native_window_views.h"
|
|
#include "atom/browser/unresponsive_suppressor.h"
|
|
#include "base/callback.h"
|
|
#include "base/files/file_util.h"
|
|
#include "base/strings/string_util.h"
|
|
#include "chrome/browser/ui/libgtkui/gtk_util.h"
|
|
#include "ui/base/glib/glib_signal.h"
|
|
#include "ui/views/widget/desktop_aura/x11_desktop_handler.h"
|
|
|
|
namespace file_dialog {
|
|
|
|
DialogSettings::DialogSettings() = default;
|
|
DialogSettings::DialogSettings(const DialogSettings&) = default;
|
|
DialogSettings::~DialogSettings() = default;
|
|
|
|
namespace {
|
|
|
|
static const int kPreviewWidth = 256;
|
|
static const int kPreviewHeight = 512;
|
|
|
|
// Makes sure that .jpg also shows .JPG.
|
|
gboolean FileFilterCaseInsensitive(const GtkFileFilterInfo* file_info,
|
|
std::string* file_extension) {
|
|
// Makes .* file extension matches all file types.
|
|
if (*file_extension == ".*")
|
|
return true;
|
|
return base::EndsWith(file_info->filename, *file_extension,
|
|
base::CompareCase::INSENSITIVE_ASCII);
|
|
}
|
|
|
|
// Deletes |data| when gtk_file_filter_add_custom() is done with it.
|
|
void OnFileFilterDataDestroyed(std::string* file_extension) {
|
|
delete file_extension;
|
|
}
|
|
|
|
class FileChooserDialog {
|
|
public:
|
|
FileChooserDialog(GtkFileChooserAction action, const DialogSettings& settings)
|
|
: parent_(static_cast<atom::NativeWindowViews*>(settings.parent_window)),
|
|
filters_(settings.filters) {
|
|
const char* confirm_text = _("_OK");
|
|
|
|
if (!settings.button_label.empty())
|
|
confirm_text = settings.button_label.c_str();
|
|
else if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
|
|
confirm_text = _("_Save");
|
|
else if (action == GTK_FILE_CHOOSER_ACTION_OPEN)
|
|
confirm_text = _("_Open");
|
|
|
|
dialog_ = gtk_file_chooser_dialog_new(
|
|
settings.title.c_str(), NULL, action, _("_Cancel"), GTK_RESPONSE_CANCEL,
|
|
confirm_text, GTK_RESPONSE_ACCEPT, NULL);
|
|
if (parent_) {
|
|
parent_->SetEnabled(false);
|
|
libgtkui::SetGtkTransientForAura(dialog_, parent_->GetNativeWindow());
|
|
gtk_window_set_modal(GTK_WINDOW(dialog_), TRUE);
|
|
}
|
|
|
|
if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
|
|
gtk_file_chooser_set_do_overwrite_confirmation(GTK_FILE_CHOOSER(dialog_),
|
|
TRUE);
|
|
if (action != GTK_FILE_CHOOSER_ACTION_OPEN)
|
|
gtk_file_chooser_set_create_folders(GTK_FILE_CHOOSER(dialog_), TRUE);
|
|
|
|
if (!settings.default_path.empty()) {
|
|
if (base::DirectoryExists(settings.default_path)) {
|
|
gtk_file_chooser_set_current_folder(
|
|
GTK_FILE_CHOOSER(dialog_), settings.default_path.value().c_str());
|
|
} else {
|
|
if (settings.default_path.IsAbsolute()) {
|
|
gtk_file_chooser_set_current_folder(
|
|
GTK_FILE_CHOOSER(dialog_),
|
|
settings.default_path.DirName().value().c_str());
|
|
}
|
|
|
|
gtk_file_chooser_set_current_name(
|
|
GTK_FILE_CHOOSER(dialog_),
|
|
settings.default_path.BaseName().value().c_str());
|
|
}
|
|
}
|
|
|
|
if (!settings.filters.empty())
|
|
AddFilters(settings.filters);
|
|
|
|
preview_ = gtk_image_new();
|
|
g_signal_connect(dialog_, "update-preview",
|
|
G_CALLBACK(OnUpdatePreviewThunk), this);
|
|
gtk_file_chooser_set_preview_widget(GTK_FILE_CHOOSER(dialog_), preview_);
|
|
}
|
|
|
|
~FileChooserDialog() {
|
|
gtk_widget_destroy(dialog_);
|
|
if (parent_)
|
|
parent_->SetEnabled(true);
|
|
}
|
|
|
|
void SetupProperties(int properties) {
|
|
const auto hasProp = [properties](FileDialogProperty prop) {
|
|
return gboolean((properties & prop) != 0);
|
|
};
|
|
auto* file_chooser = GTK_FILE_CHOOSER(dialog());
|
|
gtk_file_chooser_set_select_multiple(file_chooser,
|
|
hasProp(FILE_DIALOG_MULTI_SELECTIONS));
|
|
gtk_file_chooser_set_show_hidden(file_chooser,
|
|
hasProp(FILE_DIALOG_SHOW_HIDDEN_FILES));
|
|
}
|
|
|
|
void RunAsynchronous() {
|
|
g_signal_connect(dialog_, "delete-event",
|
|
G_CALLBACK(gtk_widget_hide_on_delete), NULL);
|
|
g_signal_connect(dialog_, "response", G_CALLBACK(OnFileDialogResponseThunk),
|
|
this);
|
|
gtk_widget_show_all(dialog_);
|
|
|
|
// We need to call gtk_window_present after making the widgets visible to
|
|
// make sure window gets correctly raised and gets focus.
|
|
int time = ui::X11EventSource::GetInstance()->GetTimestamp();
|
|
gtk_window_present_with_time(GTK_WINDOW(dialog_), time);
|
|
}
|
|
|
|
void RunSaveAsynchronous(atom::util::Promise promise) {
|
|
save_promise_.reset(new atom::util::Promise(std::move(promise)));
|
|
RunAsynchronous();
|
|
}
|
|
|
|
void RunOpenAsynchronous(atom::util::Promise promise) {
|
|
open_promise_.reset(new atom::util::Promise(std::move(promise)));
|
|
RunAsynchronous();
|
|
}
|
|
|
|
base::FilePath GetFileName() const {
|
|
gchar* filename = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(dialog_));
|
|
const base::FilePath path(filename);
|
|
g_free(filename);
|
|
return path;
|
|
}
|
|
|
|
std::vector<base::FilePath> GetFileNames() const {
|
|
std::vector<base::FilePath> paths;
|
|
auto* filenames = gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog_));
|
|
for (auto* iter = filenames; iter != NULL; iter = iter->next) {
|
|
auto* filename = static_cast<char*>(iter->data);
|
|
paths.emplace_back(filename);
|
|
g_free(filename);
|
|
}
|
|
g_slist_free(filenames);
|
|
return paths;
|
|
}
|
|
|
|
CHROMEG_CALLBACK_1(FileChooserDialog,
|
|
void,
|
|
OnFileDialogResponse,
|
|
GtkWidget*,
|
|
int);
|
|
|
|
GtkWidget* dialog() const { return dialog_; }
|
|
|
|
private:
|
|
void AddFilters(const Filters& filters);
|
|
|
|
atom::NativeWindowViews* parent_;
|
|
atom::UnresponsiveSuppressor unresponsive_suppressor_;
|
|
|
|
GtkWidget* dialog_;
|
|
GtkWidget* preview_;
|
|
|
|
Filters filters_;
|
|
std::unique_ptr<atom::util::Promise> save_promise_;
|
|
std::unique_ptr<atom::util::Promise> open_promise_;
|
|
|
|
// Callback for when we update the preview for the selection.
|
|
CHROMEG_CALLBACK_0(FileChooserDialog, void, OnUpdatePreview, GtkWidget*);
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(FileChooserDialog);
|
|
};
|
|
|
|
void FileChooserDialog::OnFileDialogResponse(GtkWidget* widget, int response) {
|
|
gtk_widget_hide(dialog_);
|
|
if (save_promise_) {
|
|
mate::Dictionary dict =
|
|
mate::Dictionary::CreateEmpty(save_promise_->isolate());
|
|
if (response == GTK_RESPONSE_ACCEPT) {
|
|
dict.Set("canceled", false);
|
|
dict.Set("filePath", GetFileName());
|
|
} else {
|
|
dict.Set("canceled", true);
|
|
dict.Set("filePath", base::FilePath());
|
|
}
|
|
save_promise_->Resolve(dict.GetHandle());
|
|
} else if (open_promise_) {
|
|
mate::Dictionary dict =
|
|
mate::Dictionary::CreateEmpty(open_promise_->isolate());
|
|
if (response == GTK_RESPONSE_ACCEPT) {
|
|
dict.Set("canceled", false);
|
|
dict.Set("filePaths", GetFileNames());
|
|
} else {
|
|
dict.Set("canceled", true);
|
|
dict.Set("filePaths", std::vector<base::FilePath>());
|
|
}
|
|
open_promise_->Resolve(dict.GetHandle());
|
|
}
|
|
delete this;
|
|
}
|
|
|
|
void FileChooserDialog::AddFilters(const Filters& filters) {
|
|
for (size_t i = 0; i < filters.size(); ++i) {
|
|
const Filter& filter = filters[i];
|
|
GtkFileFilter* gtk_filter = gtk_file_filter_new();
|
|
|
|
for (size_t j = 0; j < filter.second.size(); ++j) {
|
|
auto file_extension =
|
|
std::make_unique<std::string>("." + filter.second[j]);
|
|
gtk_file_filter_add_custom(
|
|
gtk_filter, GTK_FILE_FILTER_FILENAME,
|
|
reinterpret_cast<GtkFileFilterFunc>(FileFilterCaseInsensitive),
|
|
file_extension.release(),
|
|
reinterpret_cast<GDestroyNotify>(OnFileFilterDataDestroyed));
|
|
}
|
|
|
|
gtk_file_filter_set_name(gtk_filter, filter.first.c_str());
|
|
gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog_), gtk_filter);
|
|
}
|
|
}
|
|
|
|
void FileChooserDialog::OnUpdatePreview(GtkWidget* chooser) {
|
|
gchar* filename =
|
|
gtk_file_chooser_get_preview_filename(GTK_FILE_CHOOSER(chooser));
|
|
if (!filename) {
|
|
gtk_file_chooser_set_preview_widget_active(GTK_FILE_CHOOSER(chooser),
|
|
FALSE);
|
|
return;
|
|
}
|
|
|
|
// Don't attempt to open anything which isn't a regular file. If a named pipe,
|
|
// this may hang. See https://crbug.com/534754.
|
|
struct stat stat_buf;
|
|
if (stat(filename, &stat_buf) != 0 || !S_ISREG(stat_buf.st_mode)) {
|
|
g_free(filename);
|
|
gtk_file_chooser_set_preview_widget_active(GTK_FILE_CHOOSER(chooser),
|
|
FALSE);
|
|
return;
|
|
}
|
|
|
|
// This will preserve the image's aspect ratio.
|
|
GdkPixbuf* pixbuf = gdk_pixbuf_new_from_file_at_size(filename, kPreviewWidth,
|
|
kPreviewHeight, nullptr);
|
|
g_free(filename);
|
|
if (pixbuf) {
|
|
gtk_image_set_from_pixbuf(GTK_IMAGE(preview_), pixbuf);
|
|
g_object_unref(pixbuf);
|
|
}
|
|
gtk_file_chooser_set_preview_widget_active(GTK_FILE_CHOOSER(chooser),
|
|
pixbuf ? TRUE : FALSE);
|
|
}
|
|
|
|
} // namespace
|
|
|
|
bool ShowOpenDialogSync(const DialogSettings& settings,
|
|
std::vector<base::FilePath>* paths) {
|
|
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
|
|
if (settings.properties & FILE_DIALOG_OPEN_DIRECTORY)
|
|
action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
|
|
FileChooserDialog open_dialog(action, settings);
|
|
open_dialog.SetupProperties(settings.properties);
|
|
|
|
gtk_widget_show_all(open_dialog.dialog());
|
|
int response = gtk_dialog_run(GTK_DIALOG(open_dialog.dialog()));
|
|
if (response == GTK_RESPONSE_ACCEPT) {
|
|
*paths = open_dialog.GetFileNames();
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
void ShowOpenDialog(const DialogSettings& settings,
|
|
atom::util::Promise promise) {
|
|
GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
|
|
if (settings.properties & FILE_DIALOG_OPEN_DIRECTORY)
|
|
action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
|
|
FileChooserDialog* open_dialog = new FileChooserDialog(action, settings);
|
|
open_dialog->SetupProperties(settings.properties);
|
|
open_dialog->RunOpenAsynchronous(std::move(promise));
|
|
}
|
|
|
|
bool ShowSaveDialogSync(const DialogSettings& settings, base::FilePath* path) {
|
|
FileChooserDialog save_dialog(GTK_FILE_CHOOSER_ACTION_SAVE, settings);
|
|
gtk_widget_show_all(save_dialog.dialog());
|
|
int response = gtk_dialog_run(GTK_DIALOG(save_dialog.dialog()));
|
|
if (response == GTK_RESPONSE_ACCEPT) {
|
|
*path = save_dialog.GetFileName();
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
void ShowSaveDialog(const DialogSettings& settings,
|
|
atom::util::Promise promise) {
|
|
FileChooserDialog* save_dialog =
|
|
new FileChooserDialog(GTK_FILE_CHOOSER_ACTION_SAVE, settings);
|
|
save_dialog->RunSaveAsynchronous(std::move(promise));
|
|
}
|
|
|
|
} // namespace file_dialog
|