1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/widget/filedialog/WinFileDialogCommands.h"
#include <shobjidl.h>
#include <shtypes.h>
#include <winerror.h>
#include "WinUtils.h"
namespace mozilla::widget::filedialog {
// Visitor to apply commands to the dialog.
struct Applicator {
IFileDialog* dialog = nullptr;
HRESULT Visit(Command const& c) {
switch (c.type()) {
default:
case Command::T__None:
return E_INVALIDARG;
case Command::TSetOptions:
return Apply(c.get_SetOptions());
case Command::TSetTitle:
return Apply(c.get_SetTitle());
case Command::TSetOkButtonLabel:
return Apply(c.get_SetOkButtonLabel());
case Command::TSetFolder:
return Apply(c.get_SetFolder());
case Command::TSetFileName:
return Apply(c.get_SetFileName());
case Command::TSetDefaultExtension:
return Apply(c.get_SetDefaultExtension());
case Command::TSetFileTypes:
return Apply(c.get_SetFileTypes());
case Command::TSetFileTypeIndex:
return Apply(c.get_SetFileTypeIndex());
}
}
HRESULT Apply(SetOptions const& c) { return dialog->SetOptions(c.options()); }
HRESULT Apply(SetTitle const& c) { return dialog->SetTitle(c.title().get()); }
HRESULT Apply(SetOkButtonLabel const& c) {
return dialog->SetOkButtonLabel(c.label().get());
}
HRESULT Apply(SetFolder const& c) {
RefPtr<IShellItem> folder;
if (SUCCEEDED(SHCreateItemFromParsingName(
c.path().get(), nullptr, IID_IShellItem, getter_AddRefs(folder)))) {
return dialog->SetFolder(folder);
}
// graciously accept that the provided path may have been nonsense
return S_OK;
}
HRESULT Apply(SetFileName const& c) {
return dialog->SetFileName(c.filename().get());
}
HRESULT Apply(SetDefaultExtension const& c) {
return dialog->SetDefaultExtension(c.extension().get());
}
HRESULT Apply(SetFileTypes const& c) {
std::vector<COMDLG_FILTERSPEC> vec;
for (auto const& filter : c.filterList()) {
vec.push_back(
{.pszName = filter.name().get(), .pszSpec = filter.spec().get()});
}
return dialog->SetFileTypes(vec.size(), vec.data());
}
HRESULT Apply(SetFileTypeIndex const& c) {
return dialog->SetFileTypeIndex(c.index());
}
};
namespace {
static HRESULT GetShellItemPath(IShellItem* aItem, nsString& aResultString) {
NS_ENSURE_TRUE(aItem, E_INVALIDARG);
LPWSTR str = nullptr;
auto const onExit = MakeScopeExit([&]() { CoTaskMemFree(str); });
HRESULT const hr = aItem->GetDisplayName(SIGDN_FILESYSPATH, &str);
if (SUCCEEDED(hr)) {
aResultString.Assign(str);
}
return hr;
}
} // namespace
#define MOZ_ENSURE_HRESULT_OK(call_) \
do { \
HRESULT const hr = (call_); \
if (FAILED(hr)) return Err(nsresult(hr)); \
} while (0)
nsresult ApplyCommands(::IFileDialog* dialog,
nsTArray<Command> const& commands) {
Applicator applicator{.dialog = dialog};
for (auto const& cmd : commands) {
MOZ_ENSURE_HRESULT_OK(applicator.Visit(cmd));
}
return NS_OK;
}
mozilla::Result<Results, nsresult> GetFileResults(::IFileDialog* dialog) {
FILEOPENDIALOGOPTIONS fos;
MOZ_ENSURE_HRESULT_OK(dialog->GetOptions(&fos));
using widget::WinUtils;
// Extract which filter type the user selected
UINT index;
MOZ_ENSURE_HRESULT_OK(dialog->GetFileTypeIndex(&index));
// single selection
if ((fos & FOS_ALLOWMULTISELECT) == 0) {
RefPtr<IShellItem> item;
MOZ_ENSURE_HRESULT_OK(dialog->GetResult(getter_AddRefs(item)));
if (!item) {
return Err(nsresult::NS_ERROR_FAILURE);
}
nsAutoString path;
MOZ_ENSURE_HRESULT_OK(GetShellItemPath(item, path));
return Results({path}, index);
}
// multiple selection
RefPtr<IFileOpenDialog> openDlg;
dialog->QueryInterface(IID_IFileOpenDialog, getter_AddRefs(openDlg));
if (!openDlg) {
MOZ_ASSERT(false, "a file-save dialog was given FOS_ALLOWMULTISELECT?");
return Err(NS_ERROR_UNEXPECTED);
}
RefPtr<IShellItemArray> items;
MOZ_ENSURE_HRESULT_OK(openDlg->GetResults(getter_AddRefs(items)));
if (!items) {
return Err(NS_ERROR_FAILURE);
}
nsTArray<nsString> paths;
DWORD count = 0;
MOZ_ENSURE_HRESULT_OK(items->GetCount(&count));
for (DWORD idx = 0; idx < count; idx++) {
RefPtr<IShellItem> item;
MOZ_ENSURE_HRESULT_OK(items->GetItemAt(idx, getter_AddRefs(item)));
nsAutoString str;
MOZ_ENSURE_HRESULT_OK(GetShellItemPath(item, str));
paths.EmplaceBack(str);
}
return Results(std::move(paths), std::move(index));
}
mozilla::Result<nsString, nsresult> GetFolderResults(::IFileDialog* dialog) {
RefPtr<IShellItem> item;
MOZ_ENSURE_HRESULT_OK(dialog->GetResult(getter_AddRefs(item)));
if (!item) {
// shouldn't happen -- probably a precondition failure on our part, but
// might be due to misbehaving shell extensions?
MOZ_ASSERT(false,
"unexpected lack of item: was `Show`'s return value checked?");
return Err(NS_ERROR_FAILURE);
}
// If the user chose a Win7 Library, resolve to the library's
// default save folder.
RefPtr<IShellLibrary> shellLib;
RefPtr<IShellItem> folderPath;
MOZ_ENSURE_HRESULT_OK(
CoCreateInstance(CLSID_ShellLibrary, nullptr, CLSCTX_INPROC_SERVER,
IID_IShellLibrary, getter_AddRefs(shellLib)));
if (shellLib && SUCCEEDED(shellLib->LoadLibraryFromItem(item, STGM_READ)) &&
SUCCEEDED(shellLib->GetDefaultSaveFolder(DSFT_DETECT, IID_IShellItem,
getter_AddRefs(folderPath)))) {
item.swap(folderPath);
}
// get the folder's file system path
nsAutoString str;
MOZ_ENSURE_HRESULT_OK(GetShellItemPath(item, str));
return str;
}
#undef MOZ_ENSURE_HRESULT_OK
} // namespace mozilla::widget::filedialog
|
