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