Commit b896c2e6 authored by Kathleen Brade's avatar Kathleen Brade Committed by Matthew Finkel
Browse files

Bug 9173: Change the default Firefox profile directory to be TBB-relative. 

This should eliminate our need to rely on a wrapper script that
sets /Users/arthur and launches Firefox with -profile.
parent c01d320f

toolkit/profile/nsToolkitProfileService.cpp

+3 −2
Original line number Diff line number Diff line
@@ -724,10 +724,11 @@ nsresult nsToolkitProfileService::Init() { 
  NS_ASSERTION(gDirServiceProvider, "No dirserviceprovider!");

  nsresult rv;



  rv = nsXREDirProvider::GetUserAppDataDirectory(getter_AddRefs(mAppData));

  rv = gDirServiceProvider->GetUserAppDataDirectory(getter_AddRefs(mAppData));

  NS_ENSURE_SUCCESS(rv, rv);



  rv = nsXREDirProvider::GetUserLocalDataDirectory(getter_AddRefs(mTempData));

  rv =

      gDirServiceProvider->GetUserLocalDataDirectory(getter_AddRefs(mTempData));

  NS_ENSURE_SUCCESS(rv, rv);



  rv = mAppData->Clone(getter_AddRefs(mProfileDBFile));

toolkit/xre/nsAppRunner.cpp

+1 −1
Original line number Diff line number Diff line
@@ -3618,7 +3618,7 @@ int XREMain::XRE_mainInit(bool* aExitFlag) { 
  if ((mAppData->flags & NS_XRE_ENABLE_CRASH_REPORTER) &&

      NS_SUCCEEDED(CrashReporter::SetExceptionHandler(xreBinDirectory))) {

    nsCOMPtr<nsIFile> file;

    rv = nsXREDirProvider::GetUserAppDataDirectory(getter_AddRefs(file));

    rv = mDirProvider.GetUserAppDataDirectory(getter_AddRefs(file));

    if (NS_SUCCEEDED(rv)) {

      CrashReporter::SetUserAppDataDirectory(file);

    }

toolkit/xre/nsConsoleWriter.cpp

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ void WriteConsoleLog() { 
  } else {

    if (!gLogConsoleErrors) return;



    rv = nsXREDirProvider::GetUserAppDataDirectory(getter_AddRefs(lfile));

    rv = gDirServiceProvider->GetUserAppDataDirectory(getter_AddRefs(lfile));

    if (NS_FAILED(rv)) return;



    lfile->AppendNative("console.log"_ns);

toolkit/xre/nsXREDirProvider.cpp

+33 −116
Original line number Diff line number Diff line
@@ -32,6 +32,7 @@ 
#include "nsArrayEnumerator.h"

#include "nsEnumeratorUtils.h"

#include "nsReadableUtils.h"

#include "nsXPCOMPrivate.h"  // for XPCOM_FILE_PATH_SEPARATOR



#include "GeckoProfiler.h"

#include "SpecialSystemDirectory.h"
@@ -246,9 +247,6 @@ nsresult nsXREDirProvider::GetUserProfilesRootDir(nsIFile** aResult) { 
  nsresult rv = GetUserDataDirectory(getter_AddRefs(file), false);



  if (NS_SUCCEEDED(rv)) {

#if !defined(XP_UNIX) || defined(XP_MACOSX)

    rv = file->AppendNative("Profiles"_ns);

#endif

    // We must create the profile directory here if it does not exist.

    nsresult tmp = EnsureDirectoryExists(file);

    if (NS_FAILED(tmp)) {
@@ -264,9 +262,6 @@ nsresult nsXREDirProvider::GetUserProfilesLocalDir(nsIFile** aResult) { 
  nsresult rv = GetUserDataDirectory(getter_AddRefs(file), true);



  if (NS_SUCCEEDED(rv)) {

#if !defined(XP_UNIX) || defined(XP_MACOSX)

    rv = file->AppendNative("Profiles"_ns);

#endif

    // We must create the profile directory here if it does not exist.

    nsresult tmp = EnsureDirectoryExists(file);

    if (NS_FAILED(tmp)) {
@@ -1396,7 +1391,7 @@ nsresult nsXREDirProvider::SetUserDataProfileDirectory(nsCOMPtr<nsIFile>& aFile, 
nsresult nsXREDirProvider::GetUserDataDirectoryHome(nsIFile** aFile,

                                                    bool aLocal) {

  // Copied from nsAppFileLocationProvider (more or less)

  nsresult rv;

  NS_ENSURE_ARG_POINTER(aFile);

  nsCOMPtr<nsIFile> localDir;



  if (aLocal && gDataDirHomeLocal) {
@@ -1406,80 +1401,39 @@ nsresult nsXREDirProvider::GetUserDataDirectoryHome(nsIFile** aFile, 
    return gDataDirHome->Clone(aFile);

  }



  nsresult rv = GetAppDir()->Clone(getter_AddRefs(localDir));

  NS_ENSURE_SUCCESS(rv, rv);



  int levelsToRemove = 1;  // In FF21+, appDir points to browser subdirectory.

#if defined(XP_MACOSX)

  FSRef fsRef;

  OSType folderType;

  if (aLocal) {

    folderType = kCachedDataFolderType;

  } else {

#  ifdef MOZ_THUNDERBIRD

    folderType = kDomainLibraryFolderType;

#  else

    folderType = kApplicationSupportFolderType;

  levelsToRemove += 2;

#endif

  }

  OSErr err = ::FSFindFolder(kUserDomain, folderType, kCreateFolder, &fsRef);

  NS_ENSURE_FALSE(err, NS_ERROR_FAILURE);



  rv = NS_NewNativeLocalFile(""_ns, true, getter_AddRefs(localDir));

  while (localDir && (levelsToRemove > 0)) {

    // When crawling up the hierarchy, components named "." do not count.

    nsAutoCString removedName;

    rv = localDir->GetNativeLeafName(removedName);

    NS_ENSURE_SUCCESS(rv, rv);

    bool didRemove = !removedName.Equals(".");



  nsCOMPtr<nsILocalFileMac> dirFileMac = do_QueryInterface(localDir);

  NS_ENSURE_TRUE(dirFileMac, NS_ERROR_UNEXPECTED);



  rv = dirFileMac->InitWithFSRef(&fsRef);

    // Remove a directory component.

    nsCOMPtr<nsIFile> parentDir;

    rv = localDir->GetParent(getter_AddRefs(parentDir));

    NS_ENSURE_SUCCESS(rv, rv);



  localDir = dirFileMac;

#elif defined(XP_IOS)

  nsAutoCString userDir;

  if (GetUIKitDirectory(aLocal, userDir)) {

    rv = NS_NewNativeLocalFile(userDir, true, getter_AddRefs(localDir));

  } else {

    rv = NS_ERROR_FAILURE;

    localDir = parentDir;

    if (didRemove) --levelsToRemove;

  }

  NS_ENSURE_SUCCESS(rv, rv);

#elif defined(XP_WIN)

  nsString path;

  if (aLocal) {

    rv = GetShellFolderPath(FOLDERID_LocalAppData, path);

    if (NS_FAILED(rv)) rv = GetRegWindowsAppDataFolder(aLocal, path);

  }

  if (!aLocal || NS_FAILED(rv)) {

    rv = GetShellFolderPath(FOLDERID_RoamingAppData, path);

    if (NS_FAILED(rv)) {

      if (!aLocal) rv = GetRegWindowsAppDataFolder(aLocal, path);

    }

  }

  NS_ENSURE_SUCCESS(rv, rv);



  rv = NS_NewLocalFile(path, true, getter_AddRefs(localDir));

#elif defined(XP_UNIX)

  const char* homeDir = getenv("HOME");

  if (!homeDir || !*homeDir) return NS_ERROR_FAILURE;

  if (!localDir) return NS_ERROR_FAILURE;



#  ifdef ANDROID /* We want (ProfD == ProfLD) on Android. */

  aLocal = false;

#  endif

  rv = localDir->AppendRelativeNativePath("TorBrowser" XPCOM_FILE_PATH_SEPARATOR

                                          "Data" XPCOM_FILE_PATH_SEPARATOR

                                          "Browser"_ns);

  NS_ENSURE_SUCCESS(rv, rv);



  if (aLocal) {

    // If $XDG_CACHE_HOME is defined use it, otherwise use $HOME/.cache.

    const char* cacheHome = getenv("XDG_CACHE_HOME");

    if (cacheHome && *cacheHome) {

      rv = NS_NewNativeLocalFile(nsDependentCString(cacheHome), true,

                                 getter_AddRefs(localDir));

    } else {

      rv = NS_NewNativeLocalFile(nsDependentCString(homeDir), true,

                                 getter_AddRefs(localDir));

      if (NS_SUCCEEDED(rv)) rv = localDir->AppendNative(".cache"_ns);

    }

  } else {

    rv = NS_NewNativeLocalFile(nsDependentCString(homeDir), true,

                               getter_AddRefs(localDir));

    rv = localDir->AppendNative("Caches"_ns);

    NS_ENSURE_SUCCESS(rv, rv);

  }

#else

#  error "Don't know how to get product dir on your platform"

#endif



  NS_IF_ADDREF(*aFile = localDir);

  return rv;
@@ -1662,39 +1616,23 @@ nsresult nsXREDirProvider::AppendProfilePath(nsIFile* aFile, bool aLocal) { 
  }



  nsAutoCString profile;

  nsAutoCString appName;

  nsAutoCString vendor;

  if (gAppData->profile) {

    profile = gAppData->profile;

  } else {

    appName = gAppData->name;

    vendor = gAppData->vendor;

  }



  nsresult rv = NS_OK;

  nsresult rv = NS_ERROR_FAILURE;



#if defined(XP_MACOSX)

  if (!profile.IsEmpty()) {

    rv = AppendProfileString(aFile, profile.get());

  } else {

    // Note that MacOS ignores the vendor when creating the profile hierarchy -

    // all application preferences directories live alongside one another in

    // ~/Library/Application Support/

    rv = aFile->AppendNative(appName);

  }

    NS_ENSURE_SUCCESS(rv, rv);

  }



#elif defined(XP_WIN)

  if (!profile.IsEmpty()) {

    rv = AppendProfileString(aFile, profile.get());

  } else {

    if (!vendor.IsEmpty()) {

      rv = aFile->AppendNative(vendor);

    NS_ENSURE_SUCCESS(rv, rv);

  }

    rv = aFile->AppendNative(appName);

  }

  NS_ENSURE_SUCCESS(rv, rv);



#elif defined(ANDROID)

  // The directory used for storing profiles
@@ -1704,11 +1642,6 @@ nsresult nsXREDirProvider::AppendProfilePath(nsIFile* aFile, bool aLocal) { 
  rv = aFile->AppendNative(nsDependentCString("mozilla"));

  NS_ENSURE_SUCCESS(rv, rv);

#elif defined(XP_UNIX)

  nsAutoCString folder;

  // Make it hidden (by starting with "."), except when local (the

  // profile is already under ~/.cache or XDG_CACHE_HOME).

  if (!aLocal) folder.Assign('.');



  if (!profile.IsEmpty()) {

    // Skip any leading path characters

    const char* profileStart = profile.get();
@@ -1716,33 +1649,17 @@ nsresult nsXREDirProvider::AppendProfilePath(nsIFile* aFile, bool aLocal) { 


    // On the off chance that someone wanted their folder to be hidden don't

    // let it become ".."

    if (*profileStart == '.' && !aLocal) profileStart++;

    if (*profileStart == '.') profileStart++;



    // Make it hidden (by starting with ".").

    nsAutoCString folder(".");

    folder.Append(profileStart);

    ToLowerCase(folder);



    rv = AppendProfileString(aFile, folder.BeginReading());

  } else {

    if (!vendor.IsEmpty()) {

      folder.Append(vendor);

      ToLowerCase(folder);



      rv = aFile->AppendNative(folder);

    NS_ENSURE_SUCCESS(rv, rv);



      folder.Truncate();

  }



    // This can be the case in tests.

    if (!appName.IsEmpty()) {

      folder.Append(appName);

      ToLowerCase(folder);



      rv = aFile->AppendNative(folder);

    }

  }

  NS_ENSURE_SUCCESS(rv, rv);



#else

#  error "Don't know how to get profile path on your platform"

#endif

toolkit/xre/nsXREDirProvider.h

+10 −6
Original line number Diff line number Diff line
@@ -63,15 +63,19 @@ class nsXREDirProvider final : public nsIDirectoryServiceProvider2, 


  void DoShutdown();



  static nsresult GetUserAppDataDirectory(nsIFile** aFile) {

  nsresult GetUserAppDataDirectory(nsIFile** aFile) {

    return GetUserDataDirectory(aFile, false);

  }

  static nsresult GetUserLocalDataDirectory(nsIFile** aFile) {

  nsresult GetUserLocalDataDirectory(nsIFile** aFile) {

    return GetUserDataDirectory(aFile, true);

  }



  // GetUserDataDirectory gets the profile path from gAppData.

  static nsresult GetUserDataDirectory(nsIFile** aFile, bool aLocal);



  // This function now calls GetAppDir(), so it cannot be static anymore.

  // The same happens with all the functions (in)directly calling this one (the

  // rest of Get*Directory functions in this file)

  nsresult GetUserDataDirectory(nsIFile** aFile, bool aLocal);



  /* make sure you clone it, if you need to do stuff to it */

  nsIFile* GetGREDir() { return mGREDir; }
@@ -112,9 +116,9 @@ class nsXREDirProvider final : public nsIDirectoryServiceProvider2, 
 protected:

  nsresult GetFilesInternal(const char* aProperty,

                            nsISimpleEnumerator** aResult);

  static nsresult GetUserDataDirectoryHome(nsIFile** aFile, bool aLocal);

  static nsresult GetSysUserExtensionsDirectory(nsIFile** aFile);

  static nsresult GetSysUserExtensionsDevDirectory(nsIFile** aFile);

  nsresult GetUserDataDirectoryHome(nsIFile** aFile, bool aLocal);

  nsresult GetSysUserExtensionsDirectory(nsIFile** aFile);

  nsresult GetSysUserExtensionsDevDirectory(nsIFile** aFile);

#if defined(XP_UNIX) || defined(XP_MACOSX)

  static nsresult GetSystemExtensionsDirectory(nsIFile** aFile);

#endif