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