widget/nsFilePickerProxy.cpp

   1 /* -*- Mode: C++; tab-width: 4; 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 "nsFilePickerProxy.h"
   8 #include "nsComponentManagerUtils.h"
   9 #include "nsIFile.h"
  10 #include "nsSimpleEnumerator.h"
  11 #include "mozilla/dom/BlobImpl.h"
  12 #include "mozilla/dom/Directory.h"
  13 #include "mozilla/dom/File.h"
  14 #include "mozilla/dom/BrowserChild.h"
  15 #include "mozilla/dom/IPCBlobUtils.h"
  16
  17 using namespace mozilla::dom;
  18
  19 NS_IMPL_ISUPPORTS(nsFilePickerProxy, nsIFilePicker)
  20
  21 nsFilePickerProxy::nsFilePickerProxy()
  22     : mSelectedType(0), mCapture(captureNone), mIPCActive(false) {}
  23
  24 nsFilePickerProxy::~nsFilePickerProxy() = default;
  25
  26 NS_IMETHODIMP
  27 nsFilePickerProxy::Init(mozIDOMWindowProxy* aParent, const nsAString& aTitle,
  28                         nsIFilePicker::Mode aMode) {
  29   BrowserChild* browserChild = BrowserChild::GetFrom(aParent);
  30   if (!browserChild) {
  31     return NS_ERROR_FAILURE;
  32   }
  33
  34   mParent = nsPIDOMWindowOuter::From(aParent);
  35
  36   mMode = aMode;
  37
  38   browserChild->SendPFilePickerConstructor(this, aTitle, aMode);
  39
  40   mIPCActive = true;
  41   return NS_OK;
  42 }
  43
  44 void nsFilePickerProxy::InitNative(nsIWidget* aParent,
  45                                    const nsAString& aTitle) {}
  46
  47 NS_IMETHODIMP
  48 nsFilePickerProxy::AppendFilter(const nsAString& aTitle,
  49                                 const nsAString& aFilter) {
  50   mFilterNames.AppendElement(aTitle);
  51   mFilters.AppendElement(aFilter);
  52   return NS_OK;
  53 }
  54
  55 NS_IMETHODIMP
  56 nsFilePickerProxy::GetCapture(nsIFilePicker::CaptureTarget* aCapture) {
  57   *aCapture = mCapture;
  58   return NS_OK;
  59 }
  60
  61 NS_IMETHODIMP
  62 nsFilePickerProxy::SetCapture(nsIFilePicker::CaptureTarget aCapture) {
  63   mCapture = aCapture;
  64   return NS_OK;
  65 }
  66
  67 NS_IMETHODIMP
  68 nsFilePickerProxy::GetDefaultString(nsAString& aDefaultString) {
  69   aDefaultString = mDefault;
  70   return NS_OK;
  71 }
  72
  73 NS_IMETHODIMP
  74 nsFilePickerProxy::SetDefaultString(const nsAString& aDefaultString) {
  75   mDefault = aDefaultString;
  76   return NS_OK;
  77 }
  78
  79 NS_IMETHODIMP
  80 nsFilePickerProxy::GetDefaultExtension(nsAString& aDefaultExtension) {
  81   aDefaultExtension = mDefaultExtension;
  82   return NS_OK;
  83 }
  84
  85 NS_IMETHODIMP
  86 nsFilePickerProxy::SetDefaultExtension(const nsAString& aDefaultExtension) {
  87   mDefaultExtension = aDefaultExtension;
  88   return NS_OK;
  89 }
  90
  91 NS_IMETHODIMP
  92 nsFilePickerProxy::GetFilterIndex(int32_t* aFilterIndex) {
  93   *aFilterIndex = mSelectedType;
  94   return NS_OK;
  95 }
  96
  97 NS_IMETHODIMP
  98 nsFilePickerProxy::SetFilterIndex(int32_t aFilterIndex) {
  99   mSelectedType = aFilterIndex;
 100   return NS_OK;
 101 }
 102
 103 NS_IMETHODIMP
 104 nsFilePickerProxy::GetFile(nsIFile** aFile) {
 105   MOZ_ASSERT(false, "GetFile is unimplemented; use GetDomFileOrDirectory");
 106   return NS_ERROR_FAILURE;
 107 }
 108
 109 NS_IMETHODIMP
 110 nsFilePickerProxy::GetFileURL(nsIURI** aFileURL) {
 111   MOZ_ASSERT(false, "GetFileURL is unimplemented; use GetDomFileOrDirectory");
 112   return NS_ERROR_FAILURE;
 113 }
 114
 115 NS_IMETHODIMP
 116 nsFilePickerProxy::GetFiles(nsISimpleEnumerator** aFiles) {
 117   MOZ_ASSERT(false,
 118              "GetFiles is unimplemented; use GetDomFileOrDirectoryEnumerator");
 119   return NS_ERROR_FAILURE;
 120 }
 121
 122 nsresult nsFilePickerProxy::Show(nsIFilePicker::ResultCode* aReturn) {
 123   MOZ_ASSERT(false, "Show is unimplemented; use Open");
 124   return NS_ERROR_NOT_IMPLEMENTED;
 125 }
 126
 127 NS_IMETHODIMP
 128 nsFilePickerProxy::Open(nsIFilePickerShownCallback* aCallback) {
 129   mCallback = aCallback;
 130
 131   nsString displayDirectory;
 132   if (mDisplayDirectory) {
 133     mDisplayDirectory->GetPath(displayDirectory);
 134   }
 135
 136   if (!mIPCActive) {
 137     return NS_ERROR_FAILURE;
 138   }
 139
 140   SendOpen(mSelectedType, mAddToRecentDocs, mDefault, mDefaultExtension,
 141            mFilters, mFilterNames, mRawFilters, displayDirectory,
 142            mDisplaySpecialDirectory, mOkButtonLabel, mCapture);
 143
 144   return NS_OK;
 145 }
 146
 147 mozilla::ipc::IPCResult nsFilePickerProxy::Recv__delete__(
 148     const MaybeInputData& aData, const nsIFilePicker::ResultCode& aResult) {
 149   nsPIDOMWindowInner* inner =
 150       mParent ? mParent->GetCurrentInnerWindow() : nullptr;
 151
 152   if (NS_WARN_IF(!inner)) {
 153     return IPC_OK();
 154   }
 155
 156   if (aData.type() == MaybeInputData::TInputBlobs) {
 157     const nsTArray<IPCBlob>& blobs = aData.get_InputBlobs().blobs();
 158     for (uint32_t i = 0; i < blobs.Length(); ++i) {
 159       RefPtr<BlobImpl> blobImpl = IPCBlobUtils::Deserialize(blobs[i]);
 160       NS_ENSURE_TRUE(blobImpl, IPC_OK());
 161
 162       if (!blobImpl->IsFile()) {
 163         return IPC_OK();
 164       }
 165
 166       RefPtr<File> file = File::Create(inner->AsGlobal(), blobImpl);
 167       if (NS_WARN_IF(!file)) {
 168         return IPC_OK();
 169       }
 170
 171       OwningFileOrDirectory* element = mFilesOrDirectories.AppendElement();
 172       element->SetAsFile() = file;
 173     }
 174   } else if (aData.type() == MaybeInputData::TInputDirectory) {
 175     nsCOMPtr<nsIFile> file;
 176     const nsAString& path(aData.get_InputDirectory().directoryPath());
 177     nsresult rv = NS_NewLocalFile(path, true, getter_AddRefs(file));
 178     if (NS_WARN_IF(NS_FAILED(rv))) {
 179       return IPC_OK();
 180     }
 181
 182     RefPtr<Directory> directory = Directory::Create(inner->AsGlobal(), file);
 183     MOZ_ASSERT(directory);
 184
 185     OwningFileOrDirectory* element = mFilesOrDirectories.AppendElement();
 186     element->SetAsDirectory() = directory;
 187   }
 188
 189   if (mCallback) {
 190     mCallback->Done(aResult);
 191     mCallback = nullptr;
 192   }
 193
 194   return IPC_OK();
 195 }
 196
 197 NS_IMETHODIMP
 198 nsFilePickerProxy::GetDomFileOrDirectory(nsISupports** aValue) {
 199   *aValue = nullptr;
 200   if (mFilesOrDirectories.IsEmpty()) {
 201     return NS_OK;
 202   }
 203
 204   MOZ_ASSERT(mFilesOrDirectories.Length() == 1);
 205
 206   if (mFilesOrDirectories[0].IsFile()) {
 207     nsCOMPtr<nsISupports> blob = ToSupports(mFilesOrDirectories[0].GetAsFile());
 208     blob.forget(aValue);
 209     return NS_OK;
 210   }
 211
 212   MOZ_ASSERT(mFilesOrDirectories[0].IsDirectory());
 213   RefPtr<Directory> directory = mFilesOrDirectories[0].GetAsDirectory();
 214   directory.forget(aValue);
 215   return NS_OK;
 216 }
 217
 218 namespace {
 219
 220 class SimpleEnumerator final : public nsSimpleEnumerator {
 221  public:
 222   explicit SimpleEnumerator(
 223       const nsTArray<OwningFileOrDirectory>& aFilesOrDirectories)
 224       : mFilesOrDirectories(aFilesOrDirectories.Clone()), mIndex(0) {}
 225
 226   NS_IMETHOD
 227   HasMoreElements(bool* aRetvalue) override {
 228     MOZ_ASSERT(aRetvalue);
 229     *aRetvalue = mIndex < mFilesOrDirectories.Length();
 230     return NS_OK;
 231   }
 232
 233   NS_IMETHOD
 234   GetNext(nsISupports** aValue) override {
 235     NS_ENSURE_TRUE(mIndex < mFilesOrDirectories.Length(), NS_ERROR_FAILURE);
 236
 237     uint32_t index = mIndex++;
 238
 239     if (mFilesOrDirectories[index].IsFile()) {
 240       nsCOMPtr<nsISupports> blob =
 241           ToSupports(mFilesOrDirectories[index].GetAsFile());
 242       blob.forget(aValue);
 243       return NS_OK;
 244     }
 245
 246     MOZ_ASSERT(mFilesOrDirectories[index].IsDirectory());
 247     RefPtr<Directory> directory = mFilesOrDirectories[index].GetAsDirectory();
 248     directory.forget(aValue);
 249     return NS_OK;
 250   }
 251
 252  private:
 253   nsTArray<mozilla::dom::OwningFileOrDirectory> mFilesOrDirectories;
 254   uint32_t mIndex;
 255 };
 256
 257 }  // namespace
 258
 259 NS_IMETHODIMP
 260 nsFilePickerProxy::GetDomFileOrDirectoryEnumerator(
 261     nsISimpleEnumerator** aDomfiles) {
 262   RefPtr<SimpleEnumerator> enumerator =
 263       new SimpleEnumerator(mFilesOrDirectories);
 264   enumerator.forget(aDomfiles);
 265   return NS_OK;
 266 }
 267
 268 void nsFilePickerProxy::ActorDestroy(ActorDestroyReason aWhy) {
 269   mIPCActive = false;
 270
 271   if (mCallback) {
 272     mCallback->Done(nsIFilePicker::returnCancel);
 273     mCallback = nullptr;
 274   }
 275 }
 276
 277 nsresult nsFilePickerProxy::ResolveSpecialDirectory(
 278     const nsAString& aSpecialDirectory) {
 279   MOZ_ASSERT(XRE_IsContentProcess());
 280   // Resolving the special-directory name to a path in both the child and parent
 281   // processes is redundant -- and sandboxing may prevent us from doing so in
 282   // the child process, anyway. (See bugs 1357846 and 1838244.)
 283   //
 284   // Unfortunately we can't easily verify that `aSpecialDirectory` is usable or
 285   // even meaningful here, so we just accept anything.
 286   return NS_OK;
 287 }