chrome/browser/chrome_select_file_dialog_factory_win.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/chrome_select_file_dialog_factory_win.h"
   6
   7 #include <Windows.h>
   8 #include <commdlg.h>
   9
  10 #include "base/bind.h"
  11 #include "base/bind_helpers.h"
  12 #include "base/callback.h"
  13 #include "base/location.h"
  14 #include "base/logging.h"
  15 #include "base/metrics/field_trial.h"
  16 #include "base/strings/string16.h"
  17 #include "base/synchronization/waitable_event.h"
  18 #include "base/win/metro.h"
  19 #include "chrome/common/chrome_utility_messages.h"
  20 #include "chrome/grit/generated_resources.h"
  21 #include "content/public/browser/utility_process_host.h"
  22 #include "content/public/browser/utility_process_host_client.h"
  23 #include "ipc/ipc_message_macros.h"
  24 #include "ui/base/l10n/l10n_util.h"
  25 #include "ui/base/win/open_file_name_win.h"
  26 #include "ui/shell_dialogs/select_file_dialog_win.h"
  27
  28 namespace {
  29
  30 bool CallMetroOPENFILENAMEMethod(const char* method_name, OPENFILENAME* ofn) {
  31   typedef BOOL (*MetroOPENFILENAMEMethod)(OPENFILENAME*);
  32   MetroOPENFILENAMEMethod metro_method = NULL;
  33   HMODULE metro_module = base::win::GetMetroModule();
  34
  35   if (metro_module != NULL) {
  36     metro_method = reinterpret_cast<MetroOPENFILENAMEMethod>(
  37         ::GetProcAddress(metro_module, method_name));
  38   }
  39
  40   if (metro_method != NULL)
  41     return metro_method(ofn) == TRUE;
  42
  43   NOTREACHED();
  44
  45   return false;
  46 }
  47
  48 bool ShouldIsolateShellOperations() {
  49   return base::FieldTrialList::FindFullName("IsolateShellOperations") ==
  50          "Enabled";
  51 }
  52
  53 // Receives the GetOpenFileName result from the utility process.
  54 class GetOpenFileNameClient : public content::UtilityProcessHostClient {
  55  public:
  56   GetOpenFileNameClient();
  57
  58   // Blocks until the GetOpenFileName result is received (including failure to
  59   // launch or a crash of the utility process).
  60   void WaitForCompletion();
  61
  62   // Returns the selected directory.
  63   const base::FilePath& directory() const { return directory_; }
  64
  65   // Returns the list of selected filenames. Each should be interpreted as a
  66   // child of directory().
  67   const std::vector<base::FilePath>& filenames() const { return filenames_; }
  68
  69   // UtilityProcessHostClient implementation
  70   void OnProcessCrashed(int exit_code) override;
  71   void OnProcessLaunchFailed() override;
  72   bool OnMessageReceived(const IPC::Message& message) override;
  73
  74  protected:
  75   ~GetOpenFileNameClient() override;
  76
  77  private:
  78   void OnResult(const base::FilePath& directory,
  79                 const std::vector<base::FilePath>& filenames);
  80   void OnFailure();
  81
  82   base::FilePath directory_;
  83   std::vector<base::FilePath> filenames_;
  84   base::WaitableEvent event_;
  85
  86   DISALLOW_COPY_AND_ASSIGN(GetOpenFileNameClient);
  87 };
  88
  89 GetOpenFileNameClient::GetOpenFileNameClient() : event_(true, false) {
  90 }
  91
  92 void GetOpenFileNameClient::WaitForCompletion() {
  93   event_.Wait();
  94 }
  95
  96 void GetOpenFileNameClient::OnProcessCrashed(int exit_code) {
  97   event_.Signal();
  98 }
  99
 100 void GetOpenFileNameClient::OnProcessLaunchFailed() {
 101   event_.Signal();
 102 }
 103
 104 bool GetOpenFileNameClient::OnMessageReceived(const IPC::Message& message) {
 105   bool handled = true;
 106   IPC_BEGIN_MESSAGE_MAP(GetOpenFileNameClient, message)
 107     IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_GetOpenFileName_Failed,
 108                         OnFailure)
 109     IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_GetOpenFileName_Result,
 110                         OnResult)
 111     IPC_MESSAGE_UNHANDLED(handled = false)
 112   IPC_END_MESSAGE_MAP()
 113   return handled;
 114 }
 115
 116 GetOpenFileNameClient::~GetOpenFileNameClient() {}
 117
 118 void GetOpenFileNameClient::OnResult(
 119     const base::FilePath& directory,
 120     const std::vector<base::FilePath>& filenames) {
 121   directory_ = directory;
 122   filenames_ = filenames;
 123   event_.Signal();
 124 }
 125
 126 void GetOpenFileNameClient::OnFailure() {
 127   event_.Signal();
 128 }
 129
 130 // Initiates IPC with a new utility process using |client|. Instructs the
 131 // utility process to call GetOpenFileName with |ofn|. |current_task_runner|
 132 // must be the currently executing task runner.
 133 void DoInvokeGetOpenFileName(
 134     OPENFILENAME* ofn,
 135     scoped_refptr<GetOpenFileNameClient> client,
 136     const scoped_refptr<base::SequencedTaskRunner>& current_task_runner) {
 137   DCHECK(current_task_runner->RunsTasksOnCurrentThread());
 138
 139   base::WeakPtr<content::UtilityProcessHost> utility_process_host(
 140       content::UtilityProcessHost::Create(client, current_task_runner)
 141       ->AsWeakPtr());
 142   utility_process_host->SetName(l10n_util::GetStringUTF16(
 143       IDS_UTILITY_PROCESS_FILE_DIALOG_NAME));
 144   utility_process_host->DisableSandbox();
 145   utility_process_host->Send(new ChromeUtilityMsg_GetOpenFileName(
 146       ofn->hwndOwner,
 147       ofn->Flags & ~OFN_ENABLEHOOK,  // We can't send a hook function over IPC.
 148       ui::win::OpenFileName::GetFilters(ofn),
 149       base::FilePath(ofn->lpstrInitialDir ? ofn->lpstrInitialDir
 150                                           : base::string16()),
 151       base::FilePath(ofn->lpstrFile)));
 152 }
 153
 154 // Invokes GetOpenFileName in a utility process. Blocks until the result is
 155 // received. Uses |blocking_task_runner| for IPC.
 156 bool GetOpenFileNameInUtilityProcess(
 157     const scoped_refptr<base::SequencedTaskRunner>& blocking_task_runner,
 158     OPENFILENAME* ofn) {
 159   scoped_refptr<GetOpenFileNameClient> client(new GetOpenFileNameClient);
 160   blocking_task_runner->PostTask(
 161       FROM_HERE,
 162       base::Bind(&DoInvokeGetOpenFileName,
 163                  base::Unretained(ofn), client, blocking_task_runner));
 164   client->WaitForCompletion();
 165
 166   if (!client->filenames().size())
 167     return false;
 168
 169   ui::win::OpenFileName::SetResult(
 170       client->directory(), client->filenames(), ofn);
 171   return true;
 172 }
 173
 174 // Implements GetOpenFileName for CreateWinSelectFileDialog by delegating either
 175 // to Metro or a utility process.
 176 bool GetOpenFileNameImpl(
 177     const scoped_refptr<base::SequencedTaskRunner>& blocking_task_runner,
 178     OPENFILENAME* ofn) {
 179   if (base::win::IsMetroProcess())
 180     return CallMetroOPENFILENAMEMethod("MetroGetOpenFileName", ofn);
 181
 182   if (ShouldIsolateShellOperations())
 183     return GetOpenFileNameInUtilityProcess(blocking_task_runner, ofn);
 184
 185   return ::GetOpenFileName(ofn) == TRUE;
 186 }
 187
 188 class GetSaveFileNameClient : public content::UtilityProcessHostClient {
 189  public:
 190   GetSaveFileNameClient();
 191
 192   // Blocks until the GetSaveFileName result is received (including failure to
 193   // launch or a crash of the utility process).
 194   void WaitForCompletion();
 195
 196   // Returns the selected path.
 197   const base::FilePath& path() const { return path_; }
 198
 199   // Returns the index of the user-selected filter.
 200   int one_based_filter_index() const { return one_based_filter_index_; }
 201
 202   // UtilityProcessHostClient implementation
 203   void OnProcessCrashed(int exit_code) override;
 204   void OnProcessLaunchFailed() override;
 205   bool OnMessageReceived(const IPC::Message& message) override;
 206
 207  protected:
 208   ~GetSaveFileNameClient() override;
 209
 210  private:
 211   void OnResult(const base::FilePath& path, int one_based_filter_index);
 212   void OnFailure();
 213
 214   base::FilePath path_;
 215   int one_based_filter_index_;
 216   base::WaitableEvent event_;
 217
 218   DISALLOW_COPY_AND_ASSIGN(GetSaveFileNameClient);
 219 };
 220
 221 GetSaveFileNameClient::GetSaveFileNameClient()
 222     : one_based_filter_index_(0), event_(true, false) {
 223 }
 224
 225 void GetSaveFileNameClient::WaitForCompletion() {
 226   event_.Wait();
 227 }
 228
 229 void GetSaveFileNameClient::OnProcessCrashed(int exit_code) {
 230   event_.Signal();
 231 }
 232
 233 void GetSaveFileNameClient::OnProcessLaunchFailed() {
 234   event_.Signal();
 235 }
 236
 237 bool GetSaveFileNameClient::OnMessageReceived(const IPC::Message& message) {
 238   bool handled = true;
 239   IPC_BEGIN_MESSAGE_MAP(GetSaveFileNameClient, message)
 240     IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_GetSaveFileName_Failed,
 241                         OnFailure)
 242     IPC_MESSAGE_HANDLER(ChromeUtilityHostMsg_GetSaveFileName_Result,
 243                         OnResult)
 244     IPC_MESSAGE_UNHANDLED(handled = false)
 245   IPC_END_MESSAGE_MAP()
 246   return handled;
 247 }
 248
 249 GetSaveFileNameClient::~GetSaveFileNameClient() {}
 250
 251 void GetSaveFileNameClient::OnResult(const base::FilePath& path,
 252                                      int one_based_filter_index) {
 253   path_ = path;
 254   one_based_filter_index_ = one_based_filter_index;
 255   event_.Signal();
 256 }
 257
 258 void GetSaveFileNameClient::OnFailure() {
 259   event_.Signal();
 260 }
 261
 262 // Initiates IPC with a new utility process using |client|. Instructs the
 263 // utility process to call GetSaveFileName with |ofn|. |current_task_runner|
 264 // must be the currently executing task runner.
 265 void DoInvokeGetSaveFileName(
 266     OPENFILENAME* ofn,
 267     scoped_refptr<GetSaveFileNameClient> client,
 268     const scoped_refptr<base::SequencedTaskRunner>& current_task_runner) {
 269   DCHECK(current_task_runner->RunsTasksOnCurrentThread());
 270
 271   base::WeakPtr<content::UtilityProcessHost> utility_process_host(
 272       content::UtilityProcessHost::Create(client, current_task_runner)
 273       ->AsWeakPtr());
 274   utility_process_host->SetName(l10n_util::GetStringUTF16(
 275       IDS_UTILITY_PROCESS_FILE_DIALOG_NAME));
 276   utility_process_host->DisableSandbox();
 277   ChromeUtilityMsg_GetSaveFileName_Params params;
 278   params.owner = ofn->hwndOwner;
 279   // We can't pass the hook function over IPC.
 280   params.flags = ofn->Flags & ~OFN_ENABLEHOOK;
 281   params.filters = ui::win::OpenFileName::GetFilters(ofn);
 282   params.one_based_filter_index = ofn->nFilterIndex;
 283   params.suggested_filename = base::FilePath(ofn->lpstrFile);
 284   params.initial_directory = base::FilePath(
 285       ofn->lpstrInitialDir ? ofn->lpstrInitialDir : base::string16());
 286   params.default_extension =
 287       ofn->lpstrDefExt ? base::string16(ofn->lpstrDefExt) : base::string16();
 288
 289   utility_process_host->Send(new ChromeUtilityMsg_GetSaveFileName(params));
 290 }
 291
 292 // Invokes GetSaveFileName in a utility process. Blocks until the result is
 293 // received. Uses |blocking_task_runner| for IPC.
 294 bool GetSaveFileNameInUtilityProcess(
 295     const scoped_refptr<base::SequencedTaskRunner>& blocking_task_runner,
 296     OPENFILENAME* ofn) {
 297   scoped_refptr<GetSaveFileNameClient> client(new GetSaveFileNameClient);
 298   blocking_task_runner->PostTask(
 299       FROM_HERE,
 300       base::Bind(&DoInvokeGetSaveFileName,
 301                  base::Unretained(ofn), client, blocking_task_runner));
 302   client->WaitForCompletion();
 303
 304   if (client->path().empty())
 305     return false;
 306
 307   base::wcslcpy(ofn->lpstrFile, client->path().value().c_str(), ofn->nMaxFile);
 308   ofn->nFilterIndex = client->one_based_filter_index();
 309
 310   return true;
 311 }
 312
 313 // Implements GetSaveFileName for CreateWinSelectFileDialog by delegating either
 314 // to Metro or a utility process.
 315 bool GetSaveFileNameImpl(
 316     const scoped_refptr<base::SequencedTaskRunner>& blocking_task_runner,
 317     OPENFILENAME* ofn) {
 318   if (base::win::IsMetroProcess())
 319     return CallMetroOPENFILENAMEMethod("MetroGetSaveFileName", ofn);
 320
 321   if (ShouldIsolateShellOperations())
 322     return GetSaveFileNameInUtilityProcess(blocking_task_runner, ofn);
 323
 324   return ::GetSaveFileName(ofn) == TRUE;
 325 }
 326
 327 }  // namespace
 328
 329 ChromeSelectFileDialogFactory::ChromeSelectFileDialogFactory(
 330     const scoped_refptr<base::SequencedTaskRunner>& blocking_task_runner)
 331     : blocking_task_runner_(blocking_task_runner) {
 332 }
 333
 334 ChromeSelectFileDialogFactory::~ChromeSelectFileDialogFactory() {}
 335
 336 ui::SelectFileDialog* ChromeSelectFileDialogFactory::Create(
 337     ui::SelectFileDialog::Listener* listener,
 338     ui::SelectFilePolicy* policy) {
 339   return ui::CreateWinSelectFileDialog(
 340       listener,
 341       policy,
 342       base::Bind(GetOpenFileNameImpl, blocking_task_runner_),
 343       base::Bind(GetSaveFileNameImpl, blocking_task_runner_));
 344 }