widget/src/windows/nsFilePicker.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) 2000
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Stuart Parmenter <pavlov@netscape.com>
  25  *   Seth Spitzer <sspitzer@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 "nsGUIEvent.h"
  43 #include "nsReadableUtils.h"
  44 #include "nsNetUtil.h"
  45 #include "nsWindow.h"
  46 #include "nsIServiceManager.h"
  47 #include "nsIPlatformCharset.h"
  48 #include "nsICharsetConverterManager.h"
  49 #include "nsFilePicker.h"
  50 #include "nsILocalFile.h"
  51 #include "nsIURL.h"
  52 #include "nsIStringBundle.h"
  53 #include "nsEnumeratorUtils.h"
  54 #include "nsCRT.h"
  55 #include <windows.h>
  56 #include <shlobj.h>
  57
  58 // commdlg.h and cderr.h are needed to build with WIN32_LEAN_AND_MEAN
  59 #include <commdlg.h>
  60 #ifndef WINCE
  61 #include <cderr.h>
  62 #endif
  63
  64 #include "nsString.h"
  65 #include "nsToolkit.h"
  66
  67 NS_IMPL_ISUPPORTS1(nsFilePicker, nsIFilePicker)
  68
  69 PRUnichar *nsFilePicker::mLastUsedUnicodeDirectory;
  70 char nsFilePicker::mLastUsedDirectory[MAX_PATH+1] = { 0 };
  71
  72 #define MAX_EXTENSION_LENGTH 10
  73
  74 #ifndef BIF_USENEWUI
  75 // BIF_USENEWUI isn't defined in the platform SDK that comes with
  76 // MSVC6.0.
  77 #define BIF_USENEWUI 0x50
  78 #endif
  79
  80 //-------------------------------------------------------------------------
  81 //
  82 // nsFilePicker constructor
  83 //
  84 //-------------------------------------------------------------------------
  85 nsFilePicker::nsFilePicker()
  86 {
  87   mSelectedType   = 1;
  88 }
  89
  90 //-------------------------------------------------------------------------
  91 //
  92 // nsFilePicker destructor
  93 //
  94 //-------------------------------------------------------------------------
  95 nsFilePicker::~nsFilePicker()
  96 {
  97   if (mLastUsedUnicodeDirectory) {
  98     NS_Free(mLastUsedUnicodeDirectory);
  99     mLastUsedUnicodeDirectory = nsnull;
 100   }
 101 }
 102
 103 //-------------------------------------------------------------------------
 104 //
 105 // Show - Display the file dialog
 106 //
 107 //-------------------------------------------------------------------------
 108
 109 #ifndef WINCE
 110 int CALLBACK BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lParam, LPARAM lpData)
 111 {
 112   if (uMsg == BFFM_INITIALIZED)
 113   {
 114     PRUnichar * filePath = (PRUnichar *) lpData;
 115     if (filePath)
 116       ::SendMessageW(hwnd, BFFM_SETSELECTIONW,
 117                      TRUE /* true because lpData is a path string */,
 118                      lpData);
 119   }
 120   return 0;
 121 }
 122 #endif
 123
 124 NS_IMETHODIMP nsFilePicker::ShowW(PRInt16 *aReturnVal)
 125 {
 126   NS_ENSURE_ARG_POINTER(aReturnVal);
 127
 128   // suppress blur events
 129   if (mParentWidget) {
 130     nsIWidget *tmp = mParentWidget;
 131     nsWindow *parent = static_cast<nsWindow *>(tmp);
 132     parent->SuppressBlurEvents(PR_TRUE);
 133   }
 134
 135   PRBool result = PR_FALSE;
 136   PRUnichar fileBuffer[FILE_BUFFER_SIZE+1];
 137   wcsncpy(fileBuffer,  mDefault.get(), FILE_BUFFER_SIZE);
 138   fileBuffer[FILE_BUFFER_SIZE] = '\0'; // null terminate in case copy truncated
 139
 140   NS_NAMED_LITERAL_STRING(htmExt, "html");
 141   nsAutoString initialDir;
 142   if (mDisplayDirectory)
 143     mDisplayDirectory->GetPath(initialDir);
 144
 145   // If no display directory, re-use the last one.
 146   if(initialDir.IsEmpty()) {
 147     // Allocate copy of last used dir.
 148     initialDir = mLastUsedUnicodeDirectory;
 149   }
 150
 151   mUnicodeFile.Truncate();
 152
 153 #ifndef WINCE
 154
 155   if (mMode == modeGetFolder) {
 156     PRUnichar dirBuffer[MAX_PATH+1];
 157     wcsncpy(dirBuffer, initialDir.get(), MAX_PATH);
 158
 159     BROWSEINFOW browserInfo;
 160     browserInfo.hwndOwner      = (HWND)
 161       (mParentWidget.get() ? mParentWidget->GetNativeData(NS_NATIVE_WINDOW) : 0);
 162     browserInfo.pidlRoot       = nsnull;
 163     browserInfo.pszDisplayName = (LPWSTR)dirBuffer;
 164     browserInfo.lpszTitle      = mTitle.get();
 165     browserInfo.ulFlags        = BIF_USENEWUI | BIF_RETURNONLYFSDIRS;
 166     if (initialDir.Length())
 167     {
 168       // the dialog is modal so that |initialDir.get()| will be valid in
 169       // BrowserCallbackProc. Thus, we don't need to clone it.
 170       browserInfo.lParam       = (LPARAM) initialDir.get();
 171       browserInfo.lpfn         = &BrowseCallbackProc;
 172     }
 173     else
 174     {
 175     browserInfo.lParam         = nsnull;
 176       browserInfo.lpfn         = nsnull;
 177     }
 178     browserInfo.iImage         = nsnull;
 179
 180     LPITEMIDLIST list = ::SHBrowseForFolderW(&browserInfo);
 181     if (list != NULL) {
 182       result = ::SHGetPathFromIDListW(list, (LPWSTR)fileBuffer);
 183       if (result) {
 184           mUnicodeFile.Assign(fileBuffer);
 185       }
 186
 187       // free PIDL
 188       CoTaskMemFree(list);
 189     }
 190   }
 191   else
 192 #endif // WINCE
 193   {
 194
 195     OPENFILENAMEW ofn;
 196     memset(&ofn, 0, sizeof(ofn));
 197     ofn.lStructSize = sizeof(ofn);
 198     nsString filterBuffer = mFilterList;
 199
 200     if (!initialDir.IsEmpty()) {
 201       ofn.lpstrInitialDir = initialDir.get();
 202     }
 203
 204     ofn.lpstrTitle   = (LPCWSTR)mTitle.get();
 205     ofn.lpstrFilter  = (LPCWSTR)filterBuffer.get();
 206     ofn.nFilterIndex = mSelectedType;
 207     ofn.hwndOwner    = (HWND)
 208       (mParentWidget.get() ? mParentWidget->GetNativeData(NS_NATIVE_WINDOW) : 0);
 209     ofn.lpstrFile    = fileBuffer;
 210     ofn.nMaxFile     = FILE_BUFFER_SIZE;
 211
 212     ofn.Flags = OFN_NOCHANGEDIR | OFN_SHAREAWARE | OFN_LONGNAMES | OFN_OVERWRITEPROMPT | OFN_HIDEREADONLY | OFN_PATHMUSTEXIST;
 213
 214     if (!mDefaultExtension.IsEmpty()) {
 215       ofn.lpstrDefExt = mDefaultExtension.get();
 216     }
 217     else {
 218       // Get file extension from suggested filename
 219       //  to detect if we are saving an html file
 220       //XXX: nsIFile SHOULD HAVE A GetExtension() METHOD!
 221       PRInt32 extIndex = mDefault.RFind(".");
 222       if ( extIndex >= 0) {
 223         nsAutoString ext;
 224         mDefault.Right(ext, mDefault.Length() - extIndex);
 225         // Should we test for ".cgi", ".asp", ".jsp" and other
 226         // "generated" html pages?
 227
 228         if ( ext.LowerCaseEqualsLiteral(".htm")  ||
 229              ext.LowerCaseEqualsLiteral(".html") ||
 230              ext.LowerCaseEqualsLiteral(".shtml") ) {
 231           // This is supposed to append ".htm" if user doesn't supply an extension
 232           //XXX Actually, behavior is sort of weird:
 233           //    often appends ".html" even if you have an extension
 234           //    It obeys your extension if you put quotes around name
 235           ofn.lpstrDefExt = htmExt.get();
 236         }
 237       }
 238     }
 239
 240 #ifndef WINCE
 241     try {
 242 #endif
 243       if (mMode == modeOpen) {
 244         // FILE MUST EXIST!
 245         ofn.Flags |= OFN_FILEMUSTEXIST;
 246         result = ::GetOpenFileNameW(&ofn);
 247       }
 248       else if (mMode == modeOpenMultiple) {
 249         ofn.Flags |= OFN_FILEMUSTEXIST | OFN_ALLOWMULTISELECT | OFN_EXPLORER;
 250         result = ::GetOpenFileNameW(&ofn);
 251       }
 252       else if (mMode == modeSave) {
 253         ofn.Flags |= OFN_NOREADONLYRETURN;
 254
 255         // Don't follow shortcuts when saving a shortcut, this can be used
 256         // to trick users (bug 271732)
 257         NS_ConvertUTF16toUTF8 ext(mDefault);
 258         ext.Trim(" .", PR_FALSE, PR_TRUE); // watch out for trailing space and dots
 259         ToLowerCase(ext);
 260         if (StringEndsWith(ext, NS_LITERAL_CSTRING(".lnk")) ||
 261             StringEndsWith(ext, NS_LITERAL_CSTRING(".pif")) ||
 262             StringEndsWith(ext, NS_LITERAL_CSTRING(".url")))
 263           ofn.Flags |= OFN_NODEREFERENCELINKS;
 264
 265         result = ::GetSaveFileNameW(&ofn);
 266         if (!result) {
 267           // Error, find out what kind.
 268           if (::GetLastError() == ERROR_INVALID_PARAMETER ||
 269               ::CommDlgExtendedError() == FNERR_INVALIDFILENAME) {
 270             // probably the default file name is too long or contains illegal characters!
 271             // Try again, without a starting file name.
 272             ofn.lpstrFile[0] = 0;
 273             result = ::GetSaveFileNameW(&ofn);
 274           }
 275         }
 276       }
 277       else {
 278         NS_ASSERTION(0, "unsupported mode");
 279       }
 280 #ifndef WINCE
 281     }
 282     catch(...) {
 283       MessageBoxW(ofn.hwndOwner,
 284                   0,
 285                   L"The filepicker was unexpectedly closed by Windows.",
 286                   MB_ICONERROR);
 287       result = PR_FALSE;
 288     }
 289 #endif
 290
 291     if (result == PR_TRUE) {
 292       // Remember what filter type the user selected
 293       mSelectedType = (PRInt16)ofn.nFilterIndex;
 294
 295       // Set user-selected location of file or directory
 296       if (mMode == modeOpenMultiple) {
 297         nsresult rv = NS_NewISupportsArray(getter_AddRefs(mFiles));
 298         NS_ENSURE_SUCCESS(rv,rv);
 299
 300         // from msdn.microsoft.com, "Open and Save As Dialog Boxes" section:
 301         // If you specify OFN_EXPLORER,
 302         // The directory and file name strings are NULL separated,
 303         // with an extra NULL character after the last file name.
 304         // This format enables the Explorer-style dialog boxes
 305         // to return long file names that include spaces.
 306         PRUnichar *current = fileBuffer;
 307
 308         nsAutoString dirName(current);
 309         // sometimes dirName contains a trailing slash
 310         // and sometimes it doesn't.
 311         if (current[dirName.Length() - 1] != '\\')
 312           dirName.Append((PRUnichar)'\\');
 313
 314         while (current && *current && *(current + nsCRT::strlen(current) + 1)) {
 315           current = current + nsCRT::strlen(current) + 1;
 316
 317           nsCOMPtr<nsILocalFile> file = do_CreateInstance("@mozilla.org/file/local;1", &rv);
 318           NS_ENSURE_SUCCESS(rv,rv);
 319
 320           rv = file->InitWithPath(dirName + nsDependentString(current));
 321           NS_ENSURE_SUCCESS(rv,rv);
 322
 323           rv = mFiles->AppendElement(file);
 324           NS_ENSURE_SUCCESS(rv,rv);
 325         }
 326
 327         // handle the case where the user selected just one
 328         // file.  according to msdn.microsoft.com:
 329         // If you specify OFN_ALLOWMULTISELECT and the user selects
 330         // only one file, the lpstrFile string does not have
 331         // a separator between the path and file name.
 332         if (current && *current && (current == fileBuffer)) {
 333           nsCOMPtr<nsILocalFile> file = do_CreateInstance("@mozilla.org/file/local;1", &rv);
 334           NS_ENSURE_SUCCESS(rv,rv);
 335
 336           rv = file->InitWithPath(nsDependentString(current));
 337           NS_ENSURE_SUCCESS(rv,rv);
 338
 339           rv = mFiles->AppendElement(file);
 340           NS_ENSURE_SUCCESS(rv,rv);
 341         }
 342       }
 343       else {
 344         // I think it also needs a conversion here (to unicode since appending to nsString)
 345         // but doing that generates garbage file name, weird.
 346         mUnicodeFile.Assign(fileBuffer);
 347       }
 348     }
 349
 350   }
 351
 352   if (result) {
 353     PRInt16 returnOKorReplace = returnOK;
 354
 355     // Remember last used directory.
 356     nsCOMPtr<nsILocalFile> file(do_CreateInstance("@mozilla.org/file/local;1"));
 357     NS_ENSURE_TRUE(file, NS_ERROR_FAILURE);
 358
 359     // XXX  InitWithPath() will convert UCS2 to FS path !!!  corrupts unicode
 360     file->InitWithPath(mUnicodeFile);
 361     nsCOMPtr<nsIFile> dir;
 362     if (NS_SUCCEEDED(file->GetParent(getter_AddRefs(dir)))) {
 363       mDisplayDirectory = do_QueryInterface(dir);
 364       if (mDisplayDirectory) {
 365         if (mLastUsedUnicodeDirectory) {
 366           NS_Free(mLastUsedUnicodeDirectory);
 367           mLastUsedUnicodeDirectory = nsnull;
 368         }
 369
 370         nsAutoString newDir;
 371         mDisplayDirectory->GetPath(newDir);
 372         if(!newDir.IsEmpty())
 373           mLastUsedUnicodeDirectory = ToNewUnicode(newDir);
 374       }
 375     }
 376
 377     if (mMode == modeSave) {
 378       // Windows does not return resultReplace,
 379       //   we must check if file already exists
 380       PRBool exists = PR_FALSE;
 381       file->Exists(&exists);
 382
 383       if (exists)
 384         returnOKorReplace = returnReplace;
 385     }
 386     *aReturnVal = returnOKorReplace;
 387   }
 388   else {
 389     *aReturnVal = returnCancel;
 390   }
 391   if (mParentWidget) {
 392     nsIWidget *tmp = mParentWidget;
 393     nsWindow *parent = static_cast<nsWindow *>(tmp);
 394     parent->SuppressBlurEvents(PR_FALSE);
 395   }
 396
 397   return NS_OK;
 398 }
 399
 400 NS_IMETHODIMP nsFilePicker::Show(PRInt16 *aReturnVal)
 401 {
 402   return ShowW(aReturnVal);
 403 }
 404
 405 NS_IMETHODIMP nsFilePicker::GetFile(nsILocalFile **aFile)
 406 {
 407   NS_ENSURE_ARG_POINTER(aFile);
 408   *aFile = nsnull;
 409
 410   if (mUnicodeFile.IsEmpty())
 411       return NS_OK;
 412
 413   nsCOMPtr<nsILocalFile> file(do_CreateInstance("@mozilla.org/file/local;1"));
 414
 415   NS_ENSURE_TRUE(file, NS_ERROR_FAILURE);
 416
 417   file->InitWithPath(mUnicodeFile);
 418
 419   NS_ADDREF(*aFile = file);
 420
 421   return NS_OK;
 422 }
 423
 424 //-------------------------------------------------------------------------
 425 NS_IMETHODIMP nsFilePicker::GetFileURL(nsIURI **aFileURL)
 426 {
 427   *aFileURL = nsnull;
 428   nsCOMPtr<nsILocalFile> file;
 429   nsresult rv = GetFile(getter_AddRefs(file));
 430   if (!file)
 431     return rv;
 432
 433   return NS_NewFileURI(aFileURL, file);
 434 }
 435
 436 NS_IMETHODIMP nsFilePicker::GetFiles(nsISimpleEnumerator **aFiles)
 437 {
 438   NS_ENSURE_ARG_POINTER(aFiles);
 439   return NS_NewArrayEnumerator(aFiles, mFiles);
 440 }
 441
 442 //-------------------------------------------------------------------------
 443 //
 444 // Get the file + path
 445 //
 446 //-------------------------------------------------------------------------
 447 NS_IMETHODIMP nsFilePicker::SetDefaultString(const nsAString& aString)
 448 {
 449   mDefault = aString;
 450
 451   //First, make sure the file name is not too long!
 452   PRInt32 nameLength;
 453   PRInt32 nameIndex = mDefault.RFind("\\");
 454   if (nameIndex == kNotFound)
 455     nameIndex = 0;
 456   else
 457     nameIndex ++;
 458   nameLength = mDefault.Length() - nameIndex;
 459
 460   if (nameLength > _MAX_FNAME) {
 461     PRInt32 extIndex = mDefault.RFind(".");
 462     if (extIndex == kNotFound)
 463       extIndex = mDefault.Length();
 464
 465     //Let's try to shave the needed characters from the name part
 466     PRInt32 charsToRemove = nameLength - _MAX_FNAME;
 467     if (extIndex - nameIndex >= charsToRemove) {
 468       mDefault.Cut(extIndex - charsToRemove, charsToRemove);
 469     }
 470   }
 471
 472   //Then, we need to replace illegal characters.
 473   //At this stage, we cannot replace the backslash as the string might represent a file path.
 474   mDefault.ReplaceChar(FILE_ILLEGAL_CHARACTERS, '-');
 475
 476   return NS_OK;
 477 }
 478
 479 NS_IMETHODIMP nsFilePicker::GetDefaultString(nsAString& aString)
 480 {
 481   return NS_ERROR_FAILURE;
 482 }
 483
 484 //-------------------------------------------------------------------------
 485 //
 486 // The default extension to use for files
 487 //
 488 //-------------------------------------------------------------------------
 489 NS_IMETHODIMP nsFilePicker::GetDefaultExtension(nsAString& aExtension)
 490 {
 491   aExtension = mDefaultExtension;
 492   return NS_OK;
 493 }
 494
 495 NS_IMETHODIMP nsFilePicker::SetDefaultExtension(const nsAString& aExtension)
 496 {
 497   mDefaultExtension = aExtension;
 498   return NS_OK;
 499 }
 500
 501 //-------------------------------------------------------------------------
 502 //
 503 // Set the filter index
 504 //
 505 //-------------------------------------------------------------------------
 506 NS_IMETHODIMP nsFilePicker::GetFilterIndex(PRInt32 *aFilterIndex)
 507 {
 508   // Windows' filter index is 1-based, we use a 0-based system.
 509   *aFilterIndex = mSelectedType - 1;
 510   return NS_OK;
 511 }
 512
 513 NS_IMETHODIMP nsFilePicker::SetFilterIndex(PRInt32 aFilterIndex)
 514 {
 515   // Windows' filter index is 1-based, we use a 0-based system.
 516   mSelectedType = aFilterIndex + 1;
 517   return NS_OK;
 518 }
 519
 520 //-------------------------------------------------------------------------
 521 void nsFilePicker::InitNative(nsIWidget *aParent,
 522                               const nsAString& aTitle,
 523                               PRInt16 aMode)
 524 {
 525   mParentWidget = aParent;
 526   mTitle.Assign(aTitle);
 527   mMode = aMode;
 528 }
 529
 530
 531 NS_IMETHODIMP
 532 nsFilePicker::AppendFilter(const nsAString& aTitle, const nsAString& aFilter)
 533 {
 534   mFilterList.Append(aTitle);
 535   mFilterList.Append(PRUnichar('\0'));
 536
 537   if (aFilter.EqualsLiteral("..apps"))
 538     mFilterList.AppendLiteral("*.exe;*.com");
 539   else
 540   {
 541     nsAutoString filter(aFilter);
 542     filter.StripWhitespace();
 543     if (filter.EqualsLiteral("*"))
 544       filter.AppendLiteral(".*");
 545     mFilterList.Append(filter);
 546   }
 547
 548   mFilterList.Append(PRUnichar('\0'));
 549
 550   return NS_OK;
 551 }