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 "nsIDocShell.h"
  10 #include "nsIInterfaceRequestorUtils.h"
  11 #include "nsIBaseWindow.h"
  12 #include "nsIWidget.h"
  13
  14 #include "nsIStringBundle.h"
  15 #include "nsXPIDLString.h"
  16 #include "nsIServiceManager.h"
  17 #include "nsCOMArray.h"
  18 #include "nsIFile.h"
  19 #include "nsEnumeratorUtils.h"
  20 #include "mozilla/dom/File.h"
  21 #include "mozilla/Services.h"
  22 #include "WidgetUtils.h"
  23 #include "nsThreadUtils.h"
  24
  25 #include "nsBaseFilePicker.h"
  26
  27 using namespace mozilla::widget;
  28 using namespace mozilla::dom;
  29
  30 #define FILEPICKER_TITLES "chrome://global/locale/filepicker.properties"
  31 #define FILEPICKER_FILTERS "chrome://global/content/filepicker.properties"
  32
  33 /**
  34  * A runnable to dispatch from the main thread to the main thread to display
  35  * the file picker while letting the showAsync method return right away.
  36 */
  37 class AsyncShowFilePicker : public nsRunnable
  38 {
  39 public:
  40   AsyncShowFilePicker(nsIFilePicker *aFilePicker,
  41                       nsIFilePickerShownCallback *aCallback) :
  42     mFilePicker(aFilePicker),
  43     mCallback(aCallback)
  44   {
  45   }
  46
  47   NS_IMETHOD Run()
  48   {
  49     NS_ASSERTION(NS_IsMainThread(),
  50                  "AsyncShowFilePicker should be on the main thread!");
  51
  52     // It's possible that some widget implementations require GUI operations
  53     // to be on the main thread, so that's why we're not dispatching to another
  54     // thread and calling back to the main after it's done.
  55     int16_t result = nsIFilePicker::returnCancel;
  56     nsresult rv = mFilePicker->Show(&result);
  57     if (NS_FAILED(rv)) {
  58       NS_ERROR("FilePicker's Show() implementation failed!");
  59     }
  60
  61     if (mCallback) {
  62       mCallback->Done(result);
  63     }
  64     return NS_OK;
  65   }
  66
  67 private:
  68   nsRefPtr<nsIFilePicker> mFilePicker;
  69   nsRefPtr<nsIFilePickerShownCallback> mCallback;
  70 };
  71
  72 class nsBaseFilePickerEnumerator : public nsISimpleEnumerator
  73 {
  74 public:
  75   NS_DECL_ISUPPORTS
  76
  77   explicit nsBaseFilePickerEnumerator(nsPIDOMWindow* aParent,
  78                                       nsISimpleEnumerator* iterator)
  79     : mIterator(iterator)
  80     , mParent(aParent)
  81   {}
  82
  83   NS_IMETHOD
  84   GetNext(nsISupports** aResult) MOZ_OVERRIDE
  85   {
  86     nsCOMPtr<nsISupports> tmp;
  87     nsresult rv = mIterator->GetNext(getter_AddRefs(tmp));
  88     NS_ENSURE_SUCCESS(rv, rv);
  89
  90     if (!tmp) {
  91       return NS_OK;
  92     }
  93
  94     nsCOMPtr<nsIFile> localFile = do_QueryInterface(tmp);
  95     if (!localFile) {
  96       return NS_ERROR_FAILURE;
  97     }
  98
  99     nsCOMPtr<nsIDOMFile> domFile = File::CreateFromFile(mParent, localFile);
 100     domFile.forget(aResult);
 101     return NS_OK;
 102   }
 103
 104   NS_IMETHOD
 105   HasMoreElements(bool* aResult) MOZ_OVERRIDE
 106   {
 107     return mIterator->HasMoreElements(aResult);
 108   }
 109
 110 protected:
 111   virtual ~nsBaseFilePickerEnumerator()
 112   {}
 113
 114 private:
 115   nsCOMPtr<nsISimpleEnumerator> mIterator;
 116   nsCOMPtr<nsPIDOMWindow> mParent;
 117 };
 118
 119 NS_IMPL_ISUPPORTS(nsBaseFilePickerEnumerator, nsISimpleEnumerator)
 120
 121 nsBaseFilePicker::nsBaseFilePicker()
 122   : mAddToRecentDocs(true)
 123   , mMode(nsIFilePicker::modeOpen)
 124 {
 125
 126 }
 127
 128 nsBaseFilePicker::~nsBaseFilePicker()
 129 {
 130
 131 }
 132
 133 NS_IMETHODIMP nsBaseFilePicker::Init(nsIDOMWindow *aParent,
 134                                      const nsAString& aTitle,
 135                                      int16_t aMode)
 136 {
 137   NS_PRECONDITION(aParent, "Null parent passed to filepicker, no file "
 138                   "picker for you!");
 139   nsCOMPtr<nsIWidget> widget = WidgetUtils::DOMWindowToWidget(aParent);
 140   NS_ENSURE_TRUE(widget, NS_ERROR_FAILURE);
 141
 142   mParent = do_QueryInterface(aParent);
 143   if (!mParent->IsInnerWindow()) {
 144     mParent = mParent->GetCurrentInnerWindow();
 145   }
 146
 147   mMode = aMode;
 148   InitNative(widget, aTitle);
 149
 150   return NS_OK;
 151 }
 152
 153 NS_IMETHODIMP
 154 nsBaseFilePicker::Open(nsIFilePickerShownCallback *aCallback)
 155 {
 156   nsCOMPtr<nsIRunnable> filePickerEvent =
 157     new AsyncShowFilePicker(this, aCallback);
 158   return NS_DispatchToMainThread(filePickerEvent);
 159 }
 160
 161 NS_IMETHODIMP
 162 nsBaseFilePicker::AppendFilters(int32_t aFilterMask)
 163 {
 164   nsCOMPtr<nsIStringBundleService> stringService =
 165     mozilla::services::GetStringBundleService();
 166   if (!stringService)
 167     return NS_ERROR_FAILURE;
 168
 169   nsCOMPtr<nsIStringBundle> titleBundle, filterBundle;
 170
 171   nsresult rv = stringService->CreateBundle(FILEPICKER_TITLES,
 172                                             getter_AddRefs(titleBundle));
 173   if (NS_FAILED(rv))
 174     return NS_ERROR_FAILURE;
 175
 176   rv = stringService->CreateBundle(FILEPICKER_FILTERS, getter_AddRefs(filterBundle));
 177   if (NS_FAILED(rv))
 178     return NS_ERROR_FAILURE;
 179
 180   nsXPIDLString title;
 181   nsXPIDLString filter;
 182
 183   if (aFilterMask & filterAll) {
 184     titleBundle->GetStringFromName(MOZ_UTF16("allTitle"), getter_Copies(title));
 185     filterBundle->GetStringFromName(MOZ_UTF16("allFilter"), getter_Copies(filter));
 186     AppendFilter(title,filter);
 187   }
 188   if (aFilterMask & filterHTML) {
 189     titleBundle->GetStringFromName(MOZ_UTF16("htmlTitle"), getter_Copies(title));
 190     filterBundle->GetStringFromName(MOZ_UTF16("htmlFilter"), getter_Copies(filter));
 191     AppendFilter(title,filter);
 192   }
 193   if (aFilterMask & filterText) {
 194     titleBundle->GetStringFromName(MOZ_UTF16("textTitle"), getter_Copies(title));
 195     filterBundle->GetStringFromName(MOZ_UTF16("textFilter"), getter_Copies(filter));
 196     AppendFilter(title,filter);
 197   }
 198   if (aFilterMask & filterImages) {
 199     titleBundle->GetStringFromName(MOZ_UTF16("imageTitle"), getter_Copies(title));
 200     filterBundle->GetStringFromName(MOZ_UTF16("imageFilter"), getter_Copies(filter));
 201     AppendFilter(title,filter);
 202   }
 203   if (aFilterMask & filterAudio) {
 204     titleBundle->GetStringFromName(MOZ_UTF16("audioTitle"), getter_Copies(title));
 205     filterBundle->GetStringFromName(MOZ_UTF16("audioFilter"), getter_Copies(filter));
 206     AppendFilter(title,filter);
 207   }
 208   if (aFilterMask & filterVideo) {
 209     titleBundle->GetStringFromName(MOZ_UTF16("videoTitle"), getter_Copies(title));
 210     filterBundle->GetStringFromName(MOZ_UTF16("videoFilter"), getter_Copies(filter));
 211     AppendFilter(title,filter);
 212   }
 213   if (aFilterMask & filterXML) {
 214     titleBundle->GetStringFromName(MOZ_UTF16("xmlTitle"), getter_Copies(title));
 215     filterBundle->GetStringFromName(MOZ_UTF16("xmlFilter"), getter_Copies(filter));
 216     AppendFilter(title,filter);
 217   }
 218   if (aFilterMask & filterXUL) {
 219     titleBundle->GetStringFromName(MOZ_UTF16("xulTitle"), getter_Copies(title));
 220     filterBundle->GetStringFromName(MOZ_UTF16("xulFilter"), getter_Copies(filter));
 221     AppendFilter(title, filter);
 222   }
 223   if (aFilterMask & filterApps) {
 224     titleBundle->GetStringFromName(MOZ_UTF16("appsTitle"), getter_Copies(title));
 225     // Pass the magic string "..apps" to the platform filepicker, which it
 226     // should recognize and do the correct platform behavior for.
 227     AppendFilter(title, NS_LITERAL_STRING("..apps"));
 228   }
 229   return NS_OK;
 230 }
 231
 232 // Set the filter index
 233 NS_IMETHODIMP nsBaseFilePicker::GetFilterIndex(int32_t *aFilterIndex)
 234 {
 235   *aFilterIndex = 0;
 236   return NS_OK;
 237 }
 238
 239 NS_IMETHODIMP nsBaseFilePicker::SetFilterIndex(int32_t aFilterIndex)
 240 {
 241   return NS_OK;
 242 }
 243
 244 NS_IMETHODIMP nsBaseFilePicker::GetFiles(nsISimpleEnumerator **aFiles)
 245 {
 246   NS_ENSURE_ARG_POINTER(aFiles);
 247   nsCOMArray <nsIFile> files;
 248   nsresult rv;
 249
 250   // if we get into the base class, the platform
 251   // doesn't implement GetFiles() yet.
 252   // so we fake it.
 253   nsCOMPtr <nsIFile> file;
 254   rv = GetFile(getter_AddRefs(file));
 255   NS_ENSURE_SUCCESS(rv,rv);
 256
 257   files.AppendObject(file);
 258
 259   return NS_NewArrayEnumerator(aFiles, files);
 260 }
 261
 262 // Set the display directory
 263 NS_IMETHODIMP nsBaseFilePicker::SetDisplayDirectory(nsIFile *aDirectory)
 264 {
 265   if (!aDirectory) {
 266     mDisplayDirectory = nullptr;
 267     return NS_OK;
 268   }
 269   nsCOMPtr<nsIFile> directory;
 270   nsresult rv = aDirectory->Clone(getter_AddRefs(directory));
 271   if (NS_FAILED(rv))
 272     return rv;
 273   mDisplayDirectory = do_QueryInterface(directory, &rv);
 274   return rv;
 275 }
 276
 277 // Get the display directory
 278 NS_IMETHODIMP nsBaseFilePicker::GetDisplayDirectory(nsIFile **aDirectory)
 279 {
 280   *aDirectory = nullptr;
 281   if (!mDisplayDirectory)
 282     return NS_OK;
 283   nsCOMPtr<nsIFile> directory;
 284   nsresult rv = mDisplayDirectory->Clone(getter_AddRefs(directory));
 285   if (NS_FAILED(rv)) {
 286     return rv;
 287   }
 288   directory.forget(aDirectory);
 289   return NS_OK;
 290 }
 291
 292 NS_IMETHODIMP
 293 nsBaseFilePicker::GetAddToRecentDocs(bool *aFlag)
 294 {
 295   *aFlag = mAddToRecentDocs;
 296   return NS_OK;
 297 }
 298
 299 NS_IMETHODIMP
 300 nsBaseFilePicker::SetAddToRecentDocs(bool aFlag)
 301 {
 302   mAddToRecentDocs = aFlag;
 303   return NS_OK;
 304 }
 305
 306 NS_IMETHODIMP
 307 nsBaseFilePicker::GetMode(int16_t* aMode)
 308 {
 309   *aMode = mMode;
 310   return NS_OK;
 311 }
 312
 313 NS_IMETHODIMP
 314 nsBaseFilePicker::GetDomfile(nsIDOMFile** aDomfile)
 315 {
 316   nsCOMPtr<nsIFile> localFile;
 317   nsresult rv = GetFile(getter_AddRefs(localFile));
 318   NS_ENSURE_SUCCESS(rv, rv);
 319
 320   if (!localFile) {
 321     *aDomfile = nullptr;
 322     return NS_OK;
 323   }
 324
 325   nsRefPtr<File> domFile = File::CreateFromFile(mParent, localFile);
 326   domFile.forget(aDomfile);
 327   return NS_OK;
 328 }
 329
 330 NS_IMETHODIMP
 331 nsBaseFilePicker::GetDomfiles(nsISimpleEnumerator** aDomfiles)
 332 {
 333   nsCOMPtr<nsISimpleEnumerator> iter;
 334   nsresult rv = GetFiles(getter_AddRefs(iter));
 335   NS_ENSURE_SUCCESS(rv, rv);
 336
 337   nsRefPtr<nsBaseFilePickerEnumerator> retIter =
 338     new nsBaseFilePickerEnumerator(mParent, iter);
 339
 340   retIter.forget(aDomfiles);
 341   return NS_OK;
 342 }
 343