widget/nsBaseFilePicker.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsCOMPtr.h"
   8 #include "nsPIDOMWindow.h"
   9 #include "nsIInterfaceRequestorUtils.h"
  10 #include "nsIWidget.h"
  11
  12 #include "nsIStringBundle.h"
  13 #include "nsString.h"
  14 #include "nsCOMArray.h"
  15 #include "nsIFile.h"
  16 #include "nsEnumeratorUtils.h"
  17 #include "mozilla/dom/Directory.h"
  18 #include "mozilla/dom/File.h"
  19 #include "mozilla/dom/Promise.h"
  20 #include "mozilla/Components.h"
  21 #include "WidgetUtils.h"
  22 #include "nsSimpleEnumerator.h"
  23 #include "nsThreadUtils.h"
  24
  25 #include "nsBaseFilePicker.h"
  26
  27 using namespace mozilla::widget;
  28 using namespace mozilla::dom;
  29 using mozilla::ErrorResult;
  30
  31 #define FILEPICKER_TITLES "chrome://global/locale/filepicker.properties"
  32 #define FILEPICKER_FILTERS "chrome://global/content/filepicker.properties"
  33
  34 namespace {
  35
  36 nsresult LocalFileToDirectoryOrBlob(nsPIDOMWindowInner* aWindow,
  37                                     bool aIsDirectory, nsIFile* aFile,
  38                                     nsISupports** aResult) {
  39   MOZ_ASSERT(aWindow);
  40
  41   if (aIsDirectory) {
  42 #ifdef DEBUG
  43     bool isDir;
  44     aFile->IsDirectory(&isDir);
  45     MOZ_ASSERT(isDir);
  46 #endif
  47
  48     RefPtr<Directory> directory = Directory::Create(aWindow->AsGlobal(), aFile);
  49     MOZ_ASSERT(directory);
  50
  51     directory.forget(aResult);
  52     return NS_OK;
  53   }
  54
  55   RefPtr<File> file = File::CreateFromFile(aWindow->AsGlobal(), aFile);
  56   if (NS_WARN_IF(!file)) {
  57     return NS_ERROR_FAILURE;
  58   }
  59
  60   file.forget(aResult);
  61   return NS_OK;
  62 }
  63
  64 }  // anonymous namespace
  65
  66 #ifndef XP_WIN
  67 /**
  68  * A runnable to dispatch from the main thread to the main thread to display
  69  * the file picker while letting the showAsync method return right away.
  70  *
  71  * Not needed on Windows, where nsFilePicker::Open() is fully async.
  72  */
  73 class nsBaseFilePicker::AsyncShowFilePicker : public mozilla::Runnable {
  74  public:
  75   AsyncShowFilePicker(nsBaseFilePicker* aFilePicker,
  76                       nsIFilePickerShownCallback* aCallback)
  77       : mozilla::Runnable("AsyncShowFilePicker"),
  78         mFilePicker(aFilePicker),
  79         mCallback(aCallback) {}
  80
  81   NS_IMETHOD Run() override {
  82     NS_ASSERTION(NS_IsMainThread(),
  83                  "AsyncShowFilePicker should be on the main thread!");
  84
  85     // It's possible that some widget implementations require GUI operations
  86     // to be on the main thread, so that's why we're not dispatching to another
  87     // thread and calling back to the main after it's done.
  88     nsIFilePicker::ResultCode result = nsIFilePicker::returnCancel;
  89     nsresult rv = mFilePicker->Show(&result);
  90     if (NS_FAILED(rv)) {
  91       NS_ERROR("FilePicker's Show() implementation failed!");
  92     }
  93
  94     if (mCallback) {
  95       mCallback->Done(result);
  96     }
  97     return NS_OK;
  98   }
  99
 100  private:
 101   RefPtr<nsBaseFilePicker> mFilePicker;
 102   RefPtr<nsIFilePickerShownCallback> mCallback;
 103 };
 104 #endif
 105
 106 class nsBaseFilePickerEnumerator : public nsSimpleEnumerator {
 107  public:
 108   nsBaseFilePickerEnumerator(nsPIDOMWindowOuter* aParent,
 109                              nsISimpleEnumerator* iterator,
 110                              nsIFilePicker::Mode aMode)
 111       : mIterator(iterator),
 112         mParent(aParent->GetCurrentInnerWindow()),
 113         mMode(aMode) {}
 114
 115   const nsID& DefaultInterface() override { return NS_GET_IID(nsIFile); }
 116
 117   NS_IMETHOD
 118   GetNext(nsISupports** aResult) override {
 119     nsCOMPtr<nsISupports> tmp;
 120     nsresult rv = mIterator->GetNext(getter_AddRefs(tmp));
 121     NS_ENSURE_SUCCESS(rv, rv);
 122
 123     if (!tmp) {
 124       return NS_OK;
 125     }
 126
 127     nsCOMPtr<nsIFile> localFile = do_QueryInterface(tmp);
 128     if (!localFile) {
 129       return NS_ERROR_FAILURE;
 130     }
 131
 132     if (!mParent) {
 133       return NS_ERROR_FAILURE;
 134     }
 135
 136     return LocalFileToDirectoryOrBlob(
 137         mParent, mMode == nsIFilePicker::modeGetFolder, localFile, aResult);
 138   }
 139
 140   NS_IMETHOD
 141   HasMoreElements(bool* aResult) override {
 142     return mIterator->HasMoreElements(aResult);
 143   }
 144
 145  private:
 146   nsCOMPtr<nsISimpleEnumerator> mIterator;
 147   nsCOMPtr<nsPIDOMWindowInner> mParent;
 148   nsIFilePicker::Mode mMode;
 149 };
 150
 151 nsBaseFilePicker::nsBaseFilePicker()
 152     : mAddToRecentDocs(true), mMode(nsIFilePicker::modeOpen) {}
 153
 154 nsBaseFilePicker::~nsBaseFilePicker() = default;
 155
 156 NS_IMETHODIMP nsBaseFilePicker::Init(mozIDOMWindowProxy* aParent,
 157                                      const nsAString& aTitle,
 158                                      nsIFilePicker::Mode aMode) {
 159   MOZ_ASSERT(aParent,
 160              "Null parent passed to filepicker, no file "
 161              "picker for you!");
 162
 163   mParent = nsPIDOMWindowOuter::From(aParent);
 164
 165   nsCOMPtr<nsIWidget> widget = WidgetUtils::DOMWindowToWidget(mParent);
 166   NS_ENSURE_TRUE(widget, NS_ERROR_FAILURE);
 167
 168   mMode = aMode;
 169   InitNative(widget, aTitle);
 170
 171   return NS_OK;
 172 }
 173
 174 NS_IMETHODIMP
 175 nsBaseFilePicker::IsModeSupported(nsIFilePicker::Mode aMode, JSContext* aCx,
 176                                   Promise** aPromise) {
 177   MOZ_ASSERT(aCx);
 178   MOZ_ASSERT(aPromise);
 179
 180   nsIGlobalObject* globalObject = xpc::CurrentNativeGlobal(aCx);
 181   if (NS_WARN_IF(!globalObject)) {
 182     return NS_ERROR_FAILURE;
 183   }
 184
 185   ErrorResult result;
 186   RefPtr<Promise> promise = Promise::Create(globalObject, result);
 187   if (NS_WARN_IF(result.Failed())) {
 188     return result.StealNSResult();
 189   }
 190
 191   promise->MaybeResolve(true);
 192   promise.forget(aPromise);
 193
 194   return NS_OK;
 195 }
 196
 197 #ifndef XP_WIN
 198 NS_IMETHODIMP
 199 nsBaseFilePicker::Open(nsIFilePickerShownCallback* aCallback) {
 200   nsCOMPtr<nsIRunnable> filePickerEvent =
 201       new AsyncShowFilePicker(this, aCallback);
 202   return NS_DispatchToMainThread(filePickerEvent);
 203 }
 204 #endif
 205
 206 NS_IMETHODIMP
 207 nsBaseFilePicker::Close() {
 208   NS_WARNING("Unimplemented nsFilePicker::Close");
 209   return NS_OK;
 210 }
 211
 212 NS_IMETHODIMP
 213 nsBaseFilePicker::AppendFilters(int32_t aFilterMask) {
 214   nsCOMPtr<nsIStringBundleService> stringService =
 215       mozilla::components::StringBundle::Service();
 216   if (!stringService) return NS_ERROR_FAILURE;
 217
 218   nsCOMPtr<nsIStringBundle> titleBundle, filterBundle;
 219
 220   nsresult rv = stringService->CreateBundle(FILEPICKER_TITLES,
 221                                             getter_AddRefs(titleBundle));
 222   if (NS_FAILED(rv)) return NS_ERROR_FAILURE;
 223
 224   rv = stringService->CreateBundle(FILEPICKER_FILTERS,
 225                                    getter_AddRefs(filterBundle));
 226   if (NS_FAILED(rv)) return NS_ERROR_FAILURE;
 227
 228   nsAutoString title;
 229   nsAutoString filter;
 230
 231   if (aFilterMask & filterAll) {
 232     titleBundle->GetStringFromName("allTitle", title);
 233     filterBundle->GetStringFromName("allFilter", filter);
 234     AppendFilter(title, filter);
 235   }
 236   if (aFilterMask & filterHTML) {
 237     titleBundle->GetStringFromName("htmlTitle", title);
 238     filterBundle->GetStringFromName("htmlFilter", filter);
 239     AppendFilter(title, filter);
 240   }
 241   if (aFilterMask & filterText) {
 242     titleBundle->GetStringFromName("textTitle", title);
 243     filterBundle->GetStringFromName("textFilter", filter);
 244     AppendFilter(title, filter);
 245   }
 246   if (aFilterMask & filterImages) {
 247     titleBundle->GetStringFromName("imageTitle", title);
 248     filterBundle->GetStringFromName("imageFilter", filter);
 249     AppendFilter(title, filter);
 250   }
 251   if (aFilterMask & filterAudio) {
 252     titleBundle->GetStringFromName("audioTitle", title);
 253     filterBundle->GetStringFromName("audioFilter", filter);
 254     AppendFilter(title, filter);
 255   }
 256   if (aFilterMask & filterVideo) {
 257     titleBundle->GetStringFromName("videoTitle", title);
 258     filterBundle->GetStringFromName("videoFilter", filter);
 259     AppendFilter(title, filter);
 260   }
 261   if (aFilterMask & filterXML) {
 262     titleBundle->GetStringFromName("xmlTitle", title);
 263     filterBundle->GetStringFromName("xmlFilter", filter);
 264     AppendFilter(title, filter);
 265   }
 266   if (aFilterMask & filterXUL) {
 267     titleBundle->GetStringFromName("xulTitle", title);
 268     filterBundle->GetStringFromName("xulFilter", filter);
 269     AppendFilter(title, filter);
 270   }
 271   if (aFilterMask & filterApps) {
 272     titleBundle->GetStringFromName("appsTitle", title);
 273     // Pass the magic string "..apps" to the platform filepicker, which it
 274     // should recognize and do the correct platform behavior for.
 275     AppendFilter(title, u"..apps"_ns);
 276   }
 277   if (aFilterMask & filterPDF) {
 278     titleBundle->GetStringFromName("pdfTitle", title);
 279     filterBundle->GetStringFromName("pdfFilter", filter);
 280     AppendFilter(title, filter);
 281   }
 282   return NS_OK;
 283 }
 284
 285 NS_IMETHODIMP nsBaseFilePicker::AppendRawFilter(const nsAString& aFilter) {
 286   mRawFilters.AppendElement(aFilter);
 287   return NS_OK;
 288 }
 289
 290 NS_IMETHODIMP nsBaseFilePicker::GetCapture(
 291     nsIFilePicker::CaptureTarget* aCapture) {
 292   *aCapture = nsIFilePicker::CaptureTarget::captureNone;
 293   return NS_OK;
 294 }
 295
 296 NS_IMETHODIMP nsBaseFilePicker::SetCapture(
 297     nsIFilePicker::CaptureTarget aCapture) {
 298   return NS_OK;
 299 }
 300
 301 // Set the filter index
 302 NS_IMETHODIMP nsBaseFilePicker::GetFilterIndex(int32_t* aFilterIndex) {
 303   *aFilterIndex = 0;
 304   return NS_OK;
 305 }
 306
 307 NS_IMETHODIMP nsBaseFilePicker::SetFilterIndex(int32_t aFilterIndex) {
 308   return NS_OK;
 309 }
 310
 311 NS_IMETHODIMP nsBaseFilePicker::GetFiles(nsISimpleEnumerator** aFiles) {
 312   NS_ENSURE_ARG_POINTER(aFiles);
 313   nsCOMArray<nsIFile> files;
 314   nsresult rv;
 315
 316   // if we get into the base class, the platform
 317   // doesn't implement GetFiles() yet.
 318   // so we fake it.
 319   nsCOMPtr<nsIFile> file;
 320   rv = GetFile(getter_AddRefs(file));
 321   NS_ENSURE_SUCCESS(rv, rv);
 322
 323   files.AppendObject(file);
 324
 325   return NS_NewArrayEnumerator(aFiles, files, NS_GET_IID(nsIFile));
 326 }
 327
 328 // Set the display directory
 329 NS_IMETHODIMP nsBaseFilePicker::SetDisplayDirectory(nsIFile* aDirectory) {
 330   // if displaySpecialDirectory has been previously called, let's abort this
 331   // operation.
 332   if (!mDisplaySpecialDirectory.IsEmpty()) {
 333     return NS_OK;
 334   }
 335
 336   if (!aDirectory) {
 337     mDisplayDirectory = nullptr;
 338     return NS_OK;
 339   }
 340   nsCOMPtr<nsIFile> directory;
 341   nsresult rv = aDirectory->Clone(getter_AddRefs(directory));
 342   if (NS_FAILED(rv)) return rv;
 343   mDisplayDirectory = directory;
 344   return NS_OK;
 345 }
 346
 347 // Get the display directory
 348 NS_IMETHODIMP nsBaseFilePicker::GetDisplayDirectory(nsIFile** aDirectory) {
 349   *aDirectory = nullptr;
 350
 351   // if displaySpecialDirectory has been previously called, let's abort this
 352   // operation.
 353   if (!mDisplaySpecialDirectory.IsEmpty()) {
 354     return NS_OK;
 355   }
 356
 357   if (!mDisplayDirectory) return NS_OK;
 358   nsCOMPtr<nsIFile> directory;
 359   nsresult rv = mDisplayDirectory->Clone(getter_AddRefs(directory));
 360   if (NS_FAILED(rv)) {
 361     return rv;
 362   }
 363   directory.forget(aDirectory);
 364   return NS_OK;
 365 }
 366
 367 // Set the display special directory
 368 NS_IMETHODIMP nsBaseFilePicker::SetDisplaySpecialDirectory(
 369     const nsAString& aDirectory) {
 370   // if displayDirectory has been previously called, let's abort this operation.
 371   if (mDisplayDirectory && mDisplaySpecialDirectory.IsEmpty()) {
 372     return NS_OK;
 373   }
 374
 375   mDisplaySpecialDirectory = aDirectory;
 376   if (mDisplaySpecialDirectory.IsEmpty()) {
 377     mDisplayDirectory = nullptr;
 378     return NS_OK;
 379   }
 380
 381   return ResolveSpecialDirectory(aDirectory);
 382 }
 383
 384 nsresult nsBaseFilePicker::ResolveSpecialDirectory(
 385     const nsAString& aSpecialDirectory) {
 386   // Only perform special-directory name resolution in the parent process.
 387   // (Subclasses of `nsBaseFilePicker` used in other processes must override
 388   // this function.)
 389   MOZ_ASSERT(XRE_IsParentProcess());
 390   return NS_GetSpecialDirectory(NS_ConvertUTF16toUTF8(aSpecialDirectory).get(),
 391                                 getter_AddRefs(mDisplayDirectory));
 392 }
 393
 394 // Get the display special directory
 395 NS_IMETHODIMP nsBaseFilePicker::GetDisplaySpecialDirectory(
 396     nsAString& aDirectory) {
 397   aDirectory = mDisplaySpecialDirectory;
 398   return NS_OK;
 399 }
 400
 401 NS_IMETHODIMP
 402 nsBaseFilePicker::GetAddToRecentDocs(bool* aFlag) {
 403   *aFlag = mAddToRecentDocs;
 404   return NS_OK;
 405 }
 406
 407 NS_IMETHODIMP
 408 nsBaseFilePicker::SetAddToRecentDocs(bool aFlag) {
 409   mAddToRecentDocs = aFlag;
 410   return NS_OK;
 411 }
 412
 413 NS_IMETHODIMP
 414 nsBaseFilePicker::GetMode(nsIFilePicker::Mode* aMode) {
 415   *aMode = mMode;
 416   return NS_OK;
 417 }
 418
 419 NS_IMETHODIMP
 420 nsBaseFilePicker::SetOkButtonLabel(const nsAString& aLabel) {
 421   mOkButtonLabel = aLabel;
 422   return NS_OK;
 423 }
 424
 425 NS_IMETHODIMP
 426 nsBaseFilePicker::GetOkButtonLabel(nsAString& aLabel) {
 427   aLabel = mOkButtonLabel;
 428   return NS_OK;
 429 }
 430
 431 NS_IMETHODIMP
 432 nsBaseFilePicker::GetDomFileOrDirectory(nsISupports** aValue) {
 433   nsCOMPtr<nsIFile> localFile;
 434   nsresult rv = GetFile(getter_AddRefs(localFile));
 435   NS_ENSURE_SUCCESS(rv, rv);
 436
 437   if (!localFile) {
 438     *aValue = nullptr;
 439     return NS_OK;
 440   }
 441
 442   auto* innerParent = mParent ? mParent->GetCurrentInnerWindow() : nullptr;
 443
 444   if (!innerParent) {
 445     return NS_ERROR_FAILURE;
 446   }
 447
 448   return LocalFileToDirectoryOrBlob(
 449       innerParent, mMode == nsIFilePicker::modeGetFolder, localFile, aValue);
 450 }
 451
 452 NS_IMETHODIMP
 453 nsBaseFilePicker::GetDomFileOrDirectoryEnumerator(
 454     nsISimpleEnumerator** aValue) {
 455   nsCOMPtr<nsISimpleEnumerator> iter;
 456   nsresult rv = GetFiles(getter_AddRefs(iter));
 457   NS_ENSURE_SUCCESS(rv, rv);
 458
 459   RefPtr<nsBaseFilePickerEnumerator> retIter =
 460       new nsBaseFilePickerEnumerator(mParent, iter, mMode);
 461
 462   retIter.forget(aValue);
 463   return NS_OK;
 464 }