Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
#ifndef mozilla_dom_cache_FileUtilsImpl_h
#define mozilla_dom_cache_FileUtilsImpl_h
#include "mozilla/dom/FlippedOnce.h"
#include "mozilla/dom/cache/FileUtils.h"
#include "mozilla/dom/quota/ResultExtensions.h"
namespace mozilla::dom::cache {
template <typename Func>
nsresult BodyTraverseFiles(
const Maybe<CacheDirectoryMetadata>& aDirectoryMetadata, nsIFile& aBodyDir,
const Func& aHandleFileFunc, const bool aCanRemoveFiles,
const bool aTrackQuota) {
// XXX This assertion proves that we can remove aTrackQuota and just check
// aClientMetadata.isSome()
MOZ_DIAGNOSTIC_ASSERT_IF(aTrackQuota, aDirectoryMetadata);
#ifdef MOZ_DIAGNOSTIC_ASSERT_ENABLED
{
nsCOMPtr<nsIFile> parentFile;
nsresult rv = aBodyDir.GetParent(getter_AddRefs(parentFile));
MOZ_DIAGNOSTIC_ASSERT(NS_SUCCEEDED(rv));
MOZ_DIAGNOSTIC_ASSERT(parentFile);
nsAutoCString nativeLeafName;
rv = parentFile->GetNativeLeafName(nativeLeafName);
MOZ_DIAGNOSTIC_ASSERT(NS_SUCCEEDED(rv));
MOZ_DIAGNOSTIC_ASSERT(StringEndsWith(nativeLeafName, "morgue"_ns));
}
#endif
FlippedOnce<true> isEmpty;
QM_TRY(quota::CollectEachFile(
aBodyDir,
[&isEmpty, &aDirectoryMetadata, aTrackQuota, &aHandleFileFunc,
aCanRemoveFiles](const nsCOMPtr<nsIFile>& file) -> Result<Ok, nsresult> {
QM_TRY_INSPECT(const auto& dirEntryKind, quota::GetDirEntryKind(*file));
switch (dirEntryKind) {
case quota::nsIFileKind::ExistsAsDirectory: {
// If it's a directory somehow, try to remove it and move on
DebugOnly<nsresult> result = RemoveNsIFileRecursively(
aDirectoryMetadata, *file, /* aTrackQuota */ false);
MOZ_ASSERT(NS_SUCCEEDED(result));
break;
}
case quota::nsIFileKind::ExistsAsFile: {
nsAutoCString leafName;
QM_TRY(MOZ_TO_RESULT(file->GetNativeLeafName(leafName)));
// Delete all tmp files regardless of known bodies. These are all
// considered orphans.
if (StringEndsWith(leafName, ".tmp"_ns)) {
if (aCanRemoveFiles) {
DebugOnly<nsresult> result =
RemoveNsIFile(aDirectoryMetadata, *file, aTrackQuota);
MOZ_ASSERT(NS_SUCCEEDED(result));
return Ok{};
}
} else {
// Otherwise, it must be a .final file.
QM_WARNONLY_TRY_UNWRAP(
const auto maybeEndingOk,
OkIf(StringEndsWith(leafName, ".final"_ns)));
// If its not, try to remove it and move on.
if (!maybeEndingOk) {
DebugOnly<nsresult> result = RemoveNsIFile(
aDirectoryMetadata, *file, /* aTrackQuota */ false);
MOZ_ASSERT(NS_SUCCEEDED(result));
return Ok{};
}
}
QM_TRY_INSPECT(const bool& fileDeleted,
aHandleFileFunc(*file, leafName));
if (fileDeleted) {
return Ok{};
}
isEmpty.EnsureFlipped();
break;
}
case quota::nsIFileKind::DoesNotExist:
// Ignore files that got removed externally while iterating.
break;
}
return Ok{};
}));
if (isEmpty && aCanRemoveFiles) {
DebugOnly<nsresult> result = RemoveNsIFileRecursively(
aDirectoryMetadata, aBodyDir, /* aTrackQuota */ false);
MOZ_ASSERT(NS_SUCCEEDED(result));
}
return NS_OK;
}
} // namespace mozilla::dom::cache
#endif // mozilla_dom_cache_FileUtilsImpl_h