Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-24 05:11:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1904160 - [1/7] Convert GetDownloadDirectory() to use Result r=Gijs

Browse Source 
This greatly simplifies future refactorings, mostly by obviating
`dir.forget(_directory)`.

There is one deliberate functional change: in `SetDownloadToLaunch()`,
we now check the error-return value of `GetDownloadDirectory()` and
abort if it failed, rather than proceeding.

Differential Revision: https://phabricator.services.mozilla.com/D214651
This commit is contained in:
Ray Kraesig 2024-07-08 18:38:38 +00:00
parent 8e03330d6c
commit 11e40bd17d
1 changed files with 30 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
uriloader/exthandler/nsExternalHelperAppService.cpp
View File

@ -195,10 +195,10 @@ static nsresult UnescapeFragment(const nsACString& aFragment, nsIURI* aURI,
*
* Optionally skip availability of the directory and storage.
*/
static nsresult GetDownloadDirectory(nsIFile** _directory,
bool aSkipChecks = false) {
static Result<nsCOMPtr<nsIFile>, nsresult> GetDownloadDirectory(
bool aSkipChecks = false) {
#if defined(ANDROID)
return NS_ERROR_FAILURE;
return Err(NS_ERROR_FAILURE);
#endif
bool usePrefDir = !StaticPrefs::browser_download_start_downloads_in_tmp_dir();
@ -218,8 +218,7 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
// If we're not checking for availability we're done.
if (aSkipChecks) {
dir.forget(_directory);
return NS_OK;
return dir;
}
// We have the directory, and now we need to make sure it exists
@ -241,14 +240,14 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
// On some OSes, there is no guarantee this directory exists.
// Fall back to $HOME + Downloads.
if (sFallbackDownloadDir) {
sFallbackDownloadDir->Clone(getter_AddRefs(dir));
MOZ_TRY(sFallbackDownloadDir->Clone(getter_AddRefs(dir)));
} else {
rv = NS_GetSpecialDirectory(NS_OS_HOME_DIR, getter_AddRefs(dir));
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(NS_GetSpecialDirectory(NS_OS_HOME_DIR, getter_AddRefs(dir)));
nsCOMPtr<nsIStringBundleService> bundleService =
do_GetService(NS_STRINGBUNDLE_CONTRACTID, &rv);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(rv);
nsAutoString downloadLocalized;
nsCOMPtr<nsIStringBundle> downloadBundle;
rv = bundleService->CreateBundle(
@ -261,8 +260,8 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
if (NS_FAILED(rv)) {
downloadLocalized.AssignLiteral("Downloads");
}
rv = dir->Append(downloadLocalized);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(dir->Append(downloadLocalized));
// Can't getter_AddRefs on StaticRefPtr, so do some copying.
nsCOMPtr<nsIFile> copy;
dir->Clone(getter_AddRefs(copy));
@ -270,23 +269,19 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
ClearOnShutdown(&sFallbackDownloadDir);
}
if (aSkipChecks) {
dir.forget(_directory);
return NS_OK;
return dir;
}
// We have the directory, and now we need to make sure it exists
rv = dir->Create(nsIFile::DIRECTORY_TYPE, 0755);
if (rv == NS_ERROR_FILE_ALREADY_EXISTS || NS_SUCCEEDED(rv)) {
dir.forget(_directory);
rv = NS_OK;
return dir;
}
return rv;
return Err(rv);
}
NS_ENSURE_SUCCESS(rv, rv);
}
} else {
rv = NS_GetSpecialDirectory(NS_OS_TEMP_DIR, getter_AddRefs(dir));
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(NS_GetSpecialDirectory(NS_OS_TEMP_DIR, getter_AddRefs(dir)));
#if !defined(XP_MACOSX) && defined(XP_UNIX)
// Ensuring that only the current user can read the file names we end up
@ -295,8 +290,7 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
// exists.
uint32_t permissions;
rv = dir->GetPermissions(&permissions);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(dir->GetPermissions(&permissions));
if (permissions != PR_IRWXU) {
const char* userName = PR_GetEnv("USERNAME");
@ -325,18 +319,15 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
dir->Clone(getter_AddRefs(finalPath));
finalPath->Append(countedUserDir);
rv = finalPath->Exists(&pathExists);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(finalPath->Exists(&pathExists));
if (pathExists) {
// If this path has the right permissions, use it.
rv = finalPath->GetPermissions(&permissions);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(finalPath->GetPermissions(&permissions));
// Ensuring the path is writable by the current user.
bool isWritable;
rv = finalPath->IsWritable(&isWritable);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_TRY(finalPath->IsWritable(&isWritable));
if (permissions == PR_IRWXU && isWritable) {
dir = finalPath;
@ -351,7 +342,7 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
}
if (rv != NS_ERROR_FILE_ALREADY_EXISTS) {
// Unexpected error.
return rv;
return Err(rv);
}
counter++;
}
@ -361,8 +352,7 @@ static nsresult GetDownloadDirectory(nsIFile** _directory,
}
NS_ASSERTION(dir, "Somehow we didn't get a download directory!");
dir.forget(_directory);
return NS_OK;
return dir;
}
/**
@ -1379,14 +1369,15 @@ void nsExternalAppHandler::RetargetLoadNotifications(nsIRequest* request) {
nsresult nsExternalAppHandler::SetUpTempFile(nsIChannel* aChannel) {
// First we need to try to get the destination directory for the temporary
// file.
nsresult rv = GetDownloadDirectory(getter_AddRefs(mTempFile));
NS_ENSURE_SUCCESS(rv, rv);
auto res = GetDownloadDirectory();
if (res.isErr()) return res.unwrapErr();
mTempFile = res.unwrap();
// At this point, we do not have a filename for the temp file. For security
// purposes, this cannot be predictable, so we must use a cryptographic
// quality PRNG to generate one.
nsAutoCString tempLeafName;
rv = GenerateRandomName(tempLeafName);
nsresult rv = GenerateRandomName(tempLeafName);
NS_ENSURE_SUCCESS(rv, rv);
// now append our extension.
@ -2361,9 +2352,9 @@ nsresult nsExternalAppHandler::CreateFailedTransfer() {
if (!mFinalFileDestination) {
// If we don't have a download directory we're kinda screwed but it's OK
// we'll still report the error via the prompter.
nsCOMPtr<nsIFile> pseudoFile;
rv = GetDownloadDirectory(getter_AddRefs(pseudoFile), true);
NS_ENSURE_SUCCESS(rv, rv);
auto res = GetDownloadDirectory(true);
if (res.isErr()) return res.unwrapErr();
nsCOMPtr<nsIFile> pseudoFile = res.unwrap();
// Append the default suggested filename. If the user restarts the transfer
// we will re-trigger a filename check anyway to ensure that it is unique.
@ -2588,7 +2579,9 @@ NS_IMETHODIMP nsExternalAppHandler::SetDownloadToLaunch(
if (aNewFileLocation) {
fileToUse = aNewFileLocation;
} else {
(void)GetDownloadDirectory(getter_AddRefs(fileToUse));
auto res = GetDownloadDirectory();
if (res.isErr()) return res.unwrapErr();
fileToUse = res.unwrap();
if (mSuggestedFileName.IsEmpty()) {
// Keep using the leafname of the temp file, since we're just starting a