widget/src/xpwidgets/nsBaseFilePicker.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Stuart Parmenter <pavlov@netscape.com>
  25  *   Mike Pinkerton   <pinkerton@netscape.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #include "nsCOMPtr.h"
  42 #include "nsPIDOMWindow.h"
  43 #include "nsIDocShell.h"
  44 #include "nsIDocShellTreeItem.h"
  45 #include "nsIInterfaceRequestorUtils.h"
  46 #include "nsIBaseWindow.h"
  47 #include "nsIContentViewer.h"
  48 #include "nsIDocumentViewer.h"
  49 #include "nsIWidget.h"
  50
  51 #include "nsIStringBundle.h"
  52 #include "nsXPIDLString.h"
  53 #include "nsIServiceManager.h"
  54 #include "nsISupportsArray.h"
  55 #include "nsILocalFile.h"
  56 #include "nsEnumeratorUtils.h"
  57
  58 #include "nsBaseFilePicker.h"
  59
  60 #define FILEPICKER_PROPERTIES "chrome://global/locale/filepicker.properties"
  61
  62 nsBaseFilePicker::nsBaseFilePicker()
  63 {
  64
  65 }
  66
  67 nsBaseFilePicker::~nsBaseFilePicker()
  68 {
  69
  70 }
  71
  72 // XXXdholbert -- this function is duplicated in nsPrintDialogGTK.cpp
  73 // and needs to be unified in some generic utility class.
  74 nsIWidget *nsBaseFilePicker::DOMWindowToWidget(nsIDOMWindow *dw)
  75 {
  76   nsCOMPtr<nsIWidget> widget;
  77
  78   nsCOMPtr<nsPIDOMWindow> window = do_QueryInterface(dw);
  79   if (window) {
  80     nsCOMPtr<nsIBaseWindow> baseWin(do_QueryInterface(window->GetDocShell()));
  81
  82     while (!widget && baseWin) {
  83       baseWin->GetParentWidget(getter_AddRefs(widget));
  84       if (!widget) {
  85         nsCOMPtr<nsIDocShellTreeItem> docShellAsItem(do_QueryInterface(baseWin));
  86         if (!docShellAsItem)
  87           return nsnull;
  88
  89         nsCOMPtr<nsIDocShellTreeItem> parent;
  90         docShellAsItem->GetSameTypeParent(getter_AddRefs(parent));
  91
  92         window = do_GetInterface(parent);
  93         if (!window)
  94           return nsnull;
  95
  96         baseWin = do_QueryInterface(window->GetDocShell());
  97       }
  98     }
  99   }
 100
 101   // This will return a pointer that we're about to release, but
 102   // that's ok since the docshell (nsIBaseWindow) holds the widget
 103   // alive.
 104   return widget.get();
 105 }
 106
 107 //-------------------------------------------------------------------------
 108 NS_IMETHODIMP nsBaseFilePicker::Init(nsIDOMWindow *aParent,
 109                                      const nsAString& aTitle,
 110                                      PRInt16 aMode)
 111 {
 112   NS_PRECONDITION(aParent, "Null parent passed to filepicker, no file "
 113                   "picker for you!");
 114   nsIWidget *widget = DOMWindowToWidget(aParent);
 115   NS_ENSURE_TRUE(widget, NS_ERROR_FAILURE);
 116
 117   InitNative(widget, aTitle, aMode);
 118
 119   return NS_OK;
 120 }
 121
 122
 123 NS_IMETHODIMP
 124 nsBaseFilePicker::AppendFilters(PRInt32 aFilterMask)
 125 {
 126   nsresult rv;
 127   nsCOMPtr<nsIStringBundleService> stringService = do_GetService(NS_STRINGBUNDLE_CONTRACTID, &rv);
 128   NS_ENSURE_SUCCESS(rv, rv);
 129
 130   nsCOMPtr<nsIStringBundle> stringBundle;
 131
 132   rv = stringService->CreateBundle(FILEPICKER_PROPERTIES, getter_AddRefs(stringBundle));
 133   if (NS_FAILED(rv))
 134     return NS_ERROR_FAILURE;
 135
 136   nsXPIDLString title;
 137   nsXPIDLString filter;
 138
 139   if (aFilterMask & filterAll) {
 140     stringBundle->GetStringFromName(NS_LITERAL_STRING("allTitle").get(), getter_Copies(title));
 141     stringBundle->GetStringFromName(NS_LITERAL_STRING("allFilter").get(), getter_Copies(filter));
 142     AppendFilter(title,filter);
 143   }
 144   if (aFilterMask & filterHTML) {
 145     stringBundle->GetStringFromName(NS_LITERAL_STRING("htmlTitle").get(), getter_Copies(title));
 146     stringBundle->GetStringFromName(NS_LITERAL_STRING("htmlFilter").get(), getter_Copies(filter));
 147     AppendFilter(title,filter);
 148   }
 149   if (aFilterMask & filterText) {
 150     stringBundle->GetStringFromName(NS_LITERAL_STRING("textTitle").get(), getter_Copies(title));
 151     stringBundle->GetStringFromName(NS_LITERAL_STRING("textFilter").get(), getter_Copies(filter));
 152     AppendFilter(title,filter);
 153   }
 154   if (aFilterMask & filterImages) {
 155     stringBundle->GetStringFromName(NS_LITERAL_STRING("imageTitle").get(), getter_Copies(title));
 156     stringBundle->GetStringFromName(NS_LITERAL_STRING("imageFilter").get(), getter_Copies(filter));
 157     AppendFilter(title,filter);
 158   }
 159   if (aFilterMask & filterXML) {
 160     stringBundle->GetStringFromName(NS_LITERAL_STRING("xmlTitle").get(), getter_Copies(title));
 161     stringBundle->GetStringFromName(NS_LITERAL_STRING("xmlFilter").get(), getter_Copies(filter));
 162     AppendFilter(title,filter);
 163   }
 164   if (aFilterMask & filterXUL) {
 165     stringBundle->GetStringFromName(NS_LITERAL_STRING("xulTitle").get(), getter_Copies(title));
 166     stringBundle->GetStringFromName(NS_LITERAL_STRING("xulFilter").get(), getter_Copies(filter));
 167     AppendFilter(title, filter);
 168   }
 169   if (aFilterMask & filterApps) {
 170     stringBundle->GetStringFromName(NS_LITERAL_STRING("appsTitle").get(), getter_Copies(title));
 171     // Pass the magic string "..apps" to the platform filepicker, which it
 172     // should recognize and do the correct platform behavior for.
 173     AppendFilter(title, NS_LITERAL_STRING("..apps"));
 174   }
 175   return NS_OK;
 176 }
 177
 178 //-------------------------------------------------------------------------
 179 //
 180 // Set the filter index
 181 //
 182 //-------------------------------------------------------------------------
 183 NS_IMETHODIMP nsBaseFilePicker::GetFilterIndex(PRInt32 *aFilterIndex)
 184 {
 185   *aFilterIndex = 0;
 186   return NS_OK;
 187 }
 188
 189 NS_IMETHODIMP nsBaseFilePicker::SetFilterIndex(PRInt32 aFilterIndex)
 190 {
 191   return NS_OK;
 192 }
 193
 194 NS_IMETHODIMP nsBaseFilePicker::GetFiles(nsISimpleEnumerator **aFiles)
 195 {
 196   NS_ENSURE_ARG_POINTER(aFiles);
 197   nsCOMPtr <nsISupportsArray> files;
 198   nsresult rv = NS_NewISupportsArray(getter_AddRefs(files));
 199   NS_ENSURE_SUCCESS(rv,rv);
 200
 201   // if we get into the base class, the platform
 202   // doesn't implement GetFiles() yet.
 203   // so we fake it.
 204   nsCOMPtr <nsILocalFile> file;
 205   rv = GetFile(getter_AddRefs(file));
 206   NS_ENSURE_SUCCESS(rv,rv);
 207
 208   rv = files->AppendElement(file);
 209   NS_ENSURE_SUCCESS(rv,rv);
 210
 211   return NS_NewArrayEnumerator(aFiles, files);
 212 }
 213
 214 #ifdef BASEFILEPICKER_HAS_DISPLAYDIRECTORY
 215 //-------------------------------------------------------------------------
 216 //
 217 // Set the display directory
 218 //
 219 //-------------------------------------------------------------------------
 220 NS_IMETHODIMP nsBaseFilePicker::SetDisplayDirectory(nsILocalFile *aDirectory)
 221 {
 222   if (!aDirectory) {
 223     mDisplayDirectory = nsnull;
 224     return NS_OK;
 225   }
 226   nsCOMPtr<nsIFile> directory;
 227   nsresult rv = aDirectory->Clone(getter_AddRefs(directory));
 228   if (NS_FAILED(rv))
 229     return rv;
 230   mDisplayDirectory = do_QueryInterface(directory, &rv);
 231   return rv;
 232 }
 233
 234 //-------------------------------------------------------------------------
 235 //
 236 // Get the display directory
 237 //
 238 //-------------------------------------------------------------------------
 239 NS_IMETHODIMP nsBaseFilePicker::GetDisplayDirectory(nsILocalFile **aDirectory)
 240 {
 241   *aDirectory = nsnull;
 242   if (!mDisplayDirectory)
 243     return NS_OK;
 244   nsCOMPtr<nsIFile> directory;
 245   nsresult rv = mDisplayDirectory->Clone(getter_AddRefs(directory));
 246   if (NS_FAILED(rv))
 247     return rv;
 248   return CallQueryInterface(directory, aDirectory);
 249 }
 250 #endif