Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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
/**
Class for handling Berkeley Mailbox stores.
*/
#include "prlog.h"
#include "msgCore.h"
#include "nsMsgBrkMBoxStore.h"
#include "nsIMsgFolder.h"
#include "nsMsgFolderFlags.h"
#include "nsMsgMessageFlags.h"
#include "nsIMsgLocalMailFolder.h"
#include "nsIInputStream.h"
#include "nsIInputStreamPump.h"
#include "nsCOMArray.h"
#include "nsIFile.h"
#include "nsIDirectoryEnumerator.h"
#include "nsIMsgHdr.h"
#include "nsNetUtil.h"
#include "nsIMsgDatabase.h"
#include "nsNativeCharsetUtils.h"
#include "nsMsgUtils.h"
#include "nsIDBFolderInfo.h"
#include "nsMsgLocalFolderHdrs.h"
#include "nsMailHeaders.h"
#include "nsParseMailbox.h"
#include "nsIMsgFolderCompactor.h"
#include "nsIPrefService.h"
#include "nsIPrefBranch.h"
#include "nsPrintfCString.h"
#include "nsQuarantinedOutputStream.h"
#include "MboxMsgInputStream.h"
#include "MboxMsgOutputStream.h"
#include "mozilla/Logging.h"
#include "mozilla/Preferences.h"
#include "mozilla/SlicedInputStream.h"
#include "mozilla/RefCounted.h"
#include "prprf.h"
#include <cstdlib> // for std::abs(int/long)
#include <cmath> // for std::abs(float/double)
mozilla::LazyLogModule gMboxLog("mbox");
using mozilla::LogLevel;
/*
* MboxScanner is a helper class for implementing
* nsMsgBrkMBoxStore::AsyncScan().
*
* It derives from nsIStreamListener purely as an implementation detail,
* using itself as a listener to handle async streaming of message data.
* nsIStreamListener shouldn't be considered part of the public interface.
*
* It keeps a self reference, which will be released when the operation is
* finished. So the caller doesn't need to hold onto it.
*/
class MboxScanner : public nsIStreamListener {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSISTREAMLISTENER
NS_DECL_NSIREQUESTOBSERVER
// If BeginScan() is successful, a reference-counted pointer to
// scanListener will be held until the scan completes.
nsresult BeginScan(nsIFile* mboxFile, nsIStoreScanListener* scanListener);
private:
virtual ~MboxScanner() {}
nsCOMPtr<nsIStoreScanListener> mScanListener;
RefPtr<MboxScanner> mKungFuDeathGrip;
RefPtr<MboxMsgInputStream> mMboxStream;
// Pump to use a sync stream as async.
nsCOMPtr<nsIInputStreamPump> mPump;
};
NS_IMPL_ISUPPORTS(MboxScanner, nsIStreamListener)
nsresult MboxScanner::BeginScan(nsIFile* mboxFile,
nsIStoreScanListener* scanListener) {
MOZ_ASSERT(scanListener);
MOZ_ASSERT(!mKungFuDeathGrip);
MOZ_ASSERT(!mScanListener);
mScanListener = scanListener;
// Open the raw mbox file for reading.
nsCOMPtr<nsIInputStream> raw;
nsresult rv = NS_NewLocalFileInputStream(getter_AddRefs(raw), mboxFile);
NS_ENSURE_SUCCESS(rv, rv);
// Start reading first message async.
// Note: The pump doesn't close the stream when complete.
// This is important because we want to use Continue() to move on to
// the next message.
RefPtr<MboxMsgInputStream> mboxStream = new MboxMsgInputStream(raw);
mMboxStream = mboxStream;
nsCOMPtr<nsIInputStreamPump> pump;
rv = NS_NewInputStreamPump(getter_AddRefs(pump), mboxStream.forget());
NS_ENSURE_SUCCESS(rv, rv);
mPump = pump;
// Stream the first message asynchronously, using ourselves as listener.
// Our OnStartRequest/OnDataAvailable/OnStopRequest handlers will sort
// out streaming subsequent messages, and invoke the callbacks in the
// nsIStoreScanListener we're feeding messages to.
//
// NOTE for future simplification: rather than streaming individual
// messages via MboxMsgInputStream() here and chaining up subsequent
// messages as we go, maybe it'd be simpler to just stream the entire
// mbox in raw form?
// Then, in our OnDataAvailable handler we could feed the data directly
// into an MboxParser and drain it into the nsIStoreScanListener methods.
// This would avoid the extra abstraction of MboxMsgInputStream.
// To do that, MboxParser (currently internal to MboxMsgInputStream)
// would have to be tidied up and made public.
rv = mPump->AsyncRead(this);
NS_ENSURE_SUCCESS(rv, rv);
// We're up and running. Hold ourself in existence until scan is complete.
mKungFuDeathGrip = this;
return NS_OK;
}
NS_IMETHODIMP MboxScanner::OnStartRequest(nsIRequest* req) {
nsresult rv;
size_t msgOffset = mMboxStream->MsgOffset();
if (msgOffset == 0) {
rv = mScanListener->OnStartScan();
if (NS_FAILED(rv)) {
return rv; // This will cancel the request.
}
if (mMboxStream->IsNullMessage()) {
// Special corner case: we've already started the async request, but
// it turns out it's an empty mbox file. In that case we just want the
// scanlistener to see OnStartScan() and OnStopScan() and nothing else.
// But we're already in the middle of the async request, so ditch the
// mboxStream now, to indicate it's all over.
mMboxStream->Close();
mMboxStream = nullptr;
return NS_OK;
}
}
nsAutoCString token;
token.AppendInt((uint64_t)msgOffset);
rv = mScanListener->OnStartMessage(token);
if (NS_FAILED(rv)) {
return rv;
}
return mScanListener->OnStartRequest(req);
}
NS_IMETHODIMP MboxScanner::OnDataAvailable(nsIRequest* req,
nsIInputStream* stream,
uint64_t offset, uint32_t count) {
if (!mMboxStream) {
// It was an empty mbox, so don't call scanlistener.
return NS_OK;
}
return mScanListener->OnDataAvailable(req, stream, offset, count);
}
NS_IMETHODIMP MboxScanner::OnStopRequest(nsIRequest* req, nsresult status) {
if (mMboxStream) {
mScanListener->OnStopRequest(req, status);
bool more = false;
if (NS_SUCCEEDED(status)) {
// Kick off the next message, if any.
nsresult rv = mMboxStream->Continue(more);
if (NS_SUCCEEDED(rv) && more) {
RefPtr<MboxMsgInputStream> stream = mMboxStream;
nsresult rv =
NS_NewInputStreamPump(getter_AddRefs(mPump), stream.forget());
if (NS_SUCCEEDED(rv)) {
rv = mPump->AsyncRead(this);
}
}
if (NS_FAILED(rv)) {
// Stop here, and make sure OnStopScan() hears about the fail.
more = false;
status = rv;
}
}
// If we're not starting a new message, close the mbox.
if (!more) {
mMboxStream->Close();
mMboxStream = nullptr;
}
}
// If we're not starting another message, we're done!
// `status` indicates if the operation as a whole finished or failed.
if (!mMboxStream) {
// Tell the listener the overall operation is now done.
mScanListener->OnStopScan(status);
// Time to evaporate.
mKungFuDeathGrip = nullptr;
}
return NS_OK;
}
/*
* nsMsgBrkMBoxStore implementation.
*/
nsMsgBrkMBoxStore::nsMsgBrkMBoxStore() {}
nsMsgBrkMBoxStore::~nsMsgBrkMBoxStore() {}
NS_IMPL_ISUPPORTS(nsMsgBrkMBoxStore, nsIMsgPluggableStore)
NS_IMETHODIMP nsMsgBrkMBoxStore::DiscoverSubFolders(nsIMsgFolder* aParentFolder,
bool aDeep) {
NS_ENSURE_ARG_POINTER(aParentFolder);
nsCOMPtr<nsIFile> path;
nsresult rv = aParentFolder->GetFilePath(getter_AddRefs(path));
if (NS_FAILED(rv)) return rv;
bool exists;
path->Exists(&exists);
if (!exists) {
rv = path->Create(nsIFile::DIRECTORY_TYPE, 0755);
NS_ENSURE_SUCCESS(rv, rv);
}
return AddSubFolders(aParentFolder, path, aDeep);
}
NS_IMETHODIMP nsMsgBrkMBoxStore::CreateFolder(nsIMsgFolder* aParent,
const nsAString& aFolderName,
nsIMsgFolder** aResult) {
NS_ENSURE_ARG_POINTER(aParent);
NS_ENSURE_ARG_POINTER(aResult);
if (aFolderName.IsEmpty()) return NS_MSG_ERROR_INVALID_FOLDER_NAME;
nsCOMPtr<nsIFile> path;
nsCOMPtr<nsIMsgFolder> child;
nsresult rv = aParent->GetFilePath(getter_AddRefs(path));
if (NS_FAILED(rv)) return rv;
// Get a directory based on our current path.
rv = CreateDirectoryForFolder(path);
if (NS_FAILED(rv)) return rv;
// Now we have a valid directory or we have returned.
// Make sure the new folder name is valid
nsAutoString safeFolderName(aFolderName);
NS_MsgHashIfNecessary(safeFolderName);
path->Append(safeFolderName);
bool exists;
path->Exists(&exists);
if (exists) // check this because localized names are different from disk
// names
return NS_MSG_FOLDER_EXISTS;
rv = path->Create(nsIFile::NORMAL_FILE_TYPE, 0600);
NS_ENSURE_SUCCESS(rv, rv);
// GetFlags and SetFlags in AddSubfolder will fail because we have no db at
// this point but mFlags is set.
rv = aParent->AddSubfolder(safeFolderName, getter_AddRefs(child));
if (!child || NS_FAILED(rv)) {
path->Remove(false);
return rv;
}
// Create an empty database for this mail folder, set its name from the user
nsCOMPtr<nsIMsgDBService> msgDBService =
do_GetService("@mozilla.org/msgDatabase/msgDBService;1", &rv);
if (msgDBService) {
nsCOMPtr<nsIMsgDatabase> unusedDB;
rv = msgDBService->OpenFolderDB(child, true, getter_AddRefs(unusedDB));
if (rv == NS_MSG_ERROR_FOLDER_SUMMARY_MISSING)
rv = msgDBService->CreateNewDB(child, getter_AddRefs(unusedDB));
if ((NS_SUCCEEDED(rv) || rv == NS_MSG_ERROR_FOLDER_SUMMARY_OUT_OF_DATE) &&
unusedDB) {
// need to set the folder name
nsCOMPtr<nsIDBFolderInfo> folderInfo;
rv = unusedDB->GetDBFolderInfo(getter_AddRefs(folderInfo));
if (NS_SUCCEEDED(rv)) folderInfo->SetMailboxName(safeFolderName);
unusedDB->SetSummaryValid(true);
unusedDB->Close(true);
aParent->UpdateSummaryTotals(true);
} else {
path->Remove(false);
rv = NS_MSG_CANT_CREATE_FOLDER;
}
}
child.forget(aResult);
return rv;
}
// Get the current attributes of the mbox file, corrected for caching
void nsMsgBrkMBoxStore::GetMailboxModProperties(nsIMsgFolder* aFolder,
int64_t* aSize,
uint32_t* aDate) {
// We'll simply return 0 on errors.
*aDate = 0;
*aSize = 0;
nsCOMPtr<nsIFile> pathFile;
nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile));
NS_ENSURE_SUCCESS_VOID(rv);
rv = pathFile->GetFileSize(aSize);
if (NS_FAILED(rv)) return; // expected result for virtual folders
PRTime lastModTime;
rv = pathFile->GetLastModifiedTime(&lastModTime);
NS_ENSURE_SUCCESS_VOID(rv);
*aDate = (uint32_t)(lastModTime / PR_MSEC_PER_SEC);
}
NS_IMETHODIMP nsMsgBrkMBoxStore::HasSpaceAvailable(nsIMsgFolder* aFolder,
int64_t aSpaceRequested,
bool* aResult) {
NS_ENSURE_ARG_POINTER(aResult);
NS_ENSURE_ARG_POINTER(aFolder);
nsCOMPtr<nsIFile> pathFile;
nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile));
NS_ENSURE_SUCCESS(rv, rv);
bool allow4GBfolders =
mozilla::Preferences::GetBool("mailnews.allowMboxOver4GB", true);
if (!allow4GBfolders) {
// Allow the mbox to only reach 0xFFC00000 = 4 GiB - 4 MiB.
int64_t fileSize;
rv = pathFile->GetFileSize(&fileSize);
NS_ENSURE_SUCCESS(rv, rv);
*aResult = ((fileSize + aSpaceRequested) < 0xFFC00000LL);
if (!*aResult) return NS_ERROR_FILE_TOO_BIG;
}
*aResult = DiskSpaceAvailableInStore(pathFile, aSpaceRequested);
if (!*aResult) return NS_ERROR_FILE_NO_DEVICE_SPACE;
return NS_OK;
}
static bool gGotGlobalPrefs = false;
static int32_t gTimeStampLeeway = 60;
NS_IMETHODIMP nsMsgBrkMBoxStore::IsSummaryFileValid(nsIMsgFolder* aFolder,
nsIMsgDatabase* aDB,
bool* aResult) {
NS_ENSURE_ARG_POINTER(aFolder);
NS_ENSURE_ARG_POINTER(aDB);
NS_ENSURE_ARG_POINTER(aResult);
// We only check local folders for db validity.
nsCOMPtr<nsIMsgLocalMailFolder> localFolder(do_QueryInterface(aFolder));
if (!localFolder) {
*aResult = true;
return NS_OK;
}
nsCOMPtr<nsIFile> pathFile;
nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIDBFolderInfo> folderInfo;
rv = aDB->GetDBFolderInfo(getter_AddRefs(folderInfo));
NS_ENSURE_SUCCESS(rv, rv);
int64_t folderSize;
uint32_t folderDate;
int32_t numUnreadMessages;
*aResult = false;
folderInfo->GetNumUnreadMessages(&numUnreadMessages);
folderInfo->GetFolderSize(&folderSize);
folderInfo->GetFolderDate(&folderDate);
int64_t fileSize = 0;
uint32_t actualFolderTimeStamp = 0;
GetMailboxModProperties(aFolder, &fileSize, &actualFolderTimeStamp);
if (folderSize == fileSize && numUnreadMessages >= 0) {
if (!folderSize) {
*aResult = true;
return NS_OK;
}
if (!gGotGlobalPrefs) {
nsCOMPtr<nsIPrefBranch> pPrefBranch(
do_GetService(NS_PREFSERVICE_CONTRACTID));
if (pPrefBranch) {
rv = pPrefBranch->GetIntPref("mail.db_timestamp_leeway",
&gTimeStampLeeway);
gGotGlobalPrefs = true;
}
}
// if those values are ok, check time stamp
if (gTimeStampLeeway == 0)
*aResult = folderDate == actualFolderTimeStamp;
else
*aResult = std::abs((int32_t)(actualFolderTimeStamp - folderDate)) <=
gTimeStampLeeway;
}
return NS_OK;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::SetSummaryFileValid(nsIMsgFolder* aFolder,
nsIMsgDatabase* aDB,
bool aValid) {
NS_ENSURE_ARG_POINTER(aFolder);
NS_ENSURE_ARG_POINTER(aDB);
// We only need to do this for local folders.
nsCOMPtr<nsIMsgLocalMailFolder> localFolder(do_QueryInterface(aFolder));
if (!localFolder) return NS_OK;
nsCOMPtr<nsIFile> pathFile;
nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIDBFolderInfo> folderInfo;
rv = aDB->GetDBFolderInfo(getter_AddRefs(folderInfo));
NS_ENSURE_SUCCESS(rv, rv);
bool exists;
pathFile->Exists(&exists);
if (!exists) return NS_MSG_ERROR_FOLDER_MISSING;
if (aValid) {
uint32_t actualFolderTimeStamp;
int64_t fileSize;
GetMailboxModProperties(aFolder, &fileSize, &actualFolderTimeStamp);
folderInfo->SetFolderSize(fileSize);
folderInfo->SetFolderDate(actualFolderTimeStamp);
} else {
folderInfo->SetVersion(0); // that ought to do the trick.
}
aDB->Commit(nsMsgDBCommitType::kLargeCommit);
return rv;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::DeleteFolder(nsIMsgFolder* folder) {
NS_ENSURE_ARG_POINTER(folder);
// Delete mbox file.
nsCOMPtr<nsIFile> pathFile;
nsresult rv = folder->GetFilePath(getter_AddRefs(pathFile));
NS_ENSURE_SUCCESS(rv, rv);
bool mboxExists = false;
pathFile->Exists(&mboxExists);
if (mboxExists) {
rv = pathFile->Remove(false);
NS_ENSURE_SUCCESS(rv, rv);
}
// Delete any subfolders (.sbd-suffixed directories).
AddDirectorySeparator(pathFile);
bool subdirExists = false;
pathFile->Exists(&subdirExists);
if (subdirExists) {
rv = pathFile->Remove(true);
NS_ENSURE_SUCCESS(rv, rv);
}
return NS_OK;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::RenameFolder(nsIMsgFolder* aFolder,
const nsAString& aNewName,
nsIMsgFolder** aNewFolder) {
NS_ENSURE_ARG_POINTER(aFolder);
NS_ENSURE_ARG_POINTER(aNewFolder);
uint32_t numChildren;
aFolder->GetNumSubFolders(&numChildren);
nsString existingName;
aFolder->GetName(existingName);
nsCOMPtr<nsIFile> oldPathFile;
nsresult rv = aFolder->GetFilePath(getter_AddRefs(oldPathFile));
if (NS_FAILED(rv)) return rv;
nsCOMPtr<nsIMsgFolder> parentFolder;
rv = aFolder->GetParent(getter_AddRefs(parentFolder));
if (!parentFolder) return NS_ERROR_NULL_POINTER;
nsCOMPtr<nsIFile> oldSummaryFile;
rv = aFolder->GetSummaryFile(getter_AddRefs(oldSummaryFile));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIFile> dirFile;
oldPathFile->Clone(getter_AddRefs(dirFile));
if (numChildren > 0) {
rv = CreateDirectoryForFolder(dirFile);
NS_ENSURE_SUCCESS(rv, rv);
}
nsAutoString safeName(aNewName);
NS_MsgHashIfNecessary(safeName);
nsAutoCString oldLeafName;
oldPathFile->GetNativeLeafName(oldLeafName);
nsCOMPtr<nsIFile> parentPathFile;
parentFolder->GetFilePath(getter_AddRefs(parentPathFile));
NS_ENSURE_SUCCESS(rv, rv);
bool isDirectory = false;
parentPathFile->IsDirectory(&isDirectory);
if (!isDirectory) {
nsAutoString leafName;
parentPathFile->GetLeafName(leafName);
leafName.AppendLiteral(FOLDER_SUFFIX);
rv = parentPathFile->SetLeafName(leafName);
NS_ENSURE_SUCCESS(rv, rv);
}
aFolder->ForceDBClosed();
// save off dir name before appending .msf
rv = oldPathFile->MoveTo(nullptr, safeName);
if (NS_FAILED(rv)) return rv;
nsString dbName(safeName);
dbName.AppendLiteral(SUMMARY_SUFFIX);
oldSummaryFile->MoveTo(nullptr, dbName);
if (numChildren > 0) {
// rename "*.sbd" directory
nsAutoString newNameDirStr(safeName);
newNameDirStr.AppendLiteral(FOLDER_SUFFIX);
dirFile->MoveTo(nullptr, newNameDirStr);
}
return parentFolder->AddSubfolder(safeName, aNewFolder);
}
NS_IMETHODIMP nsMsgBrkMBoxStore::CopyFolder(
nsIMsgFolder* aSrcFolder, nsIMsgFolder* aDstFolder, bool aIsMoveFolder,
nsIMsgWindow* aMsgWindow, nsIMsgCopyServiceListener* aListener,
const nsAString& aNewName) {
NS_ENSURE_ARG_POINTER(aSrcFolder);
NS_ENSURE_ARG_POINTER(aDstFolder);
nsAutoString folderName;
if (aNewName.IsEmpty())
aSrcFolder->GetName(folderName);
else
folderName.Assign(aNewName);
nsAutoString safeFolderName(folderName);
NS_MsgHashIfNecessary(safeFolderName);
nsCOMPtr<nsIMsgLocalMailFolder> localSrcFolder(do_QueryInterface(aSrcFolder));
nsCOMPtr<nsIMsgDatabase> srcDB;
if (localSrcFolder)
localSrcFolder->GetDatabaseWOReparse(getter_AddRefs(srcDB));
bool summaryValid = !!srcDB;
srcDB = nullptr;
aSrcFolder->ForceDBClosed();
nsCOMPtr<nsIFile> oldPath;
nsresult rv = aSrcFolder->GetFilePath(getter_AddRefs(oldPath));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIFile> summaryFile;
GetSummaryFileLocation(oldPath, getter_AddRefs(summaryFile));
nsCOMPtr<nsIFile> newPath;
rv = aDstFolder->GetFilePath(getter_AddRefs(newPath));
NS_ENSURE_SUCCESS(rv, rv);
bool newPathIsDirectory = false;
newPath->IsDirectory(&newPathIsDirectory);
if (!newPathIsDirectory) {
AddDirectorySeparator(newPath);
rv = newPath->Create(nsIFile::DIRECTORY_TYPE, 0700);
if (rv == NS_ERROR_FILE_ALREADY_EXISTS) rv = NS_OK;
NS_ENSURE_SUCCESS(rv, rv);
}
nsCOMPtr<nsIFile> origPath;
oldPath->Clone(getter_AddRefs(origPath));
// copying necessary for aborting.... if failure return
rv = oldPath->CopyTo(newPath, safeFolderName);
NS_ENSURE_SUCCESS(rv, rv); // Will fail if a file by that name exists
// Copy to dir can fail if filespec does not exist. If copy fails, we test
// if the filespec exist or not, if it does not that's ok, we continue
// without copying it. If it fails and filespec exist and is not zero sized
// there is real problem
// Copy the file to the new dir
nsAutoString dbName(safeFolderName);
dbName.AppendLiteral(SUMMARY_SUFFIX);
rv = summaryFile->CopyTo(newPath, dbName);
if (NS_FAILED(rv)) // Test if the copy is successful
{
// Test if the filespec has data
bool exists;
int64_t fileSize;
summaryFile->Exists(&exists);
summaryFile->GetFileSize(&fileSize);
if (exists && fileSize > 0)
NS_ENSURE_SUCCESS(rv, rv); // Yes, it should have worked !
// else case is filespec is zero sized, no need to copy it,
// not an error
}
nsCOMPtr<nsIMsgFolder> newMsgFolder;
rv = aDstFolder->AddSubfolder(safeFolderName, getter_AddRefs(newMsgFolder));
NS_ENSURE_SUCCESS(rv, rv);
// linux and mac are not good about maintaining the file stamp when copying
// folders around. So if the source folder db is good, set the dest db as
// good too.
nsCOMPtr<nsIMsgDatabase> destDB;
if (summaryValid) {
nsAutoString folderLeafName;
origPath->GetLeafName(folderLeafName);
newPath->Append(folderLeafName);
nsCOMPtr<nsIMsgDBService> msgDBService =
do_GetService("@mozilla.org/msgDatabase/msgDBService;1", &rv);
NS_ENSURE_SUCCESS(rv, rv);
rv = msgDBService->OpenMailDBFromFile(newPath, newMsgFolder, false, true,
getter_AddRefs(destDB));
if (rv == NS_MSG_ERROR_FOLDER_SUMMARY_OUT_OF_DATE && destDB)
destDB->SetSummaryValid(true);
}
newMsgFolder->SetPrettyName(folderName);
uint32_t flags;
aSrcFolder->GetFlags(&flags);
newMsgFolder->SetFlags(flags);
bool changed = false;
rv = aSrcFolder->MatchOrChangeFilterDestination(newMsgFolder, true, &changed);
if (changed) aSrcFolder->AlertFilterChanged(aMsgWindow);
nsTArray<RefPtr<nsIMsgFolder>> subFolders;
rv = aSrcFolder->GetSubFolders(subFolders);
NS_ENSURE_SUCCESS(rv, rv);
// Copy subfolders to the new location
nsresult copyStatus = NS_OK;
nsCOMPtr<nsIMsgLocalMailFolder> localNewFolder(
do_QueryInterface(newMsgFolder, &rv));
if (NS_SUCCEEDED(rv)) {
for (nsIMsgFolder* folder : subFolders) {
copyStatus =
localNewFolder->CopyFolderLocal(folder, false, aMsgWindow, aListener);
// Test if the call succeeded, if not we have to stop recursive call
if (NS_FAILED(copyStatus)) {
// Copy failed we have to notify caller to handle the error and stop
// moving the folders. In case this happens to the topmost level of
// recursive call, then we just need to break from the while loop and
// go to error handling code.
if (!aIsMoveFolder) return copyStatus;
break;
}
}
}
if (aIsMoveFolder && NS_SUCCEEDED(copyStatus)) {
if (localNewFolder) {
nsCOMPtr<nsISupports> srcSupport(do_QueryInterface(aSrcFolder));
localNewFolder->OnCopyCompleted(srcSupport, true);
}
// Notify the "folder" that was dragged and dropped has been created. No
// need to do this for its subfolders. isMoveFolder will be true for folder.
aDstFolder->NotifyFolderAdded(newMsgFolder);
nsCOMPtr<nsIMsgFolder> msgParent;
aSrcFolder->GetParent(getter_AddRefs(msgParent));
aSrcFolder->SetParent(nullptr);
if (msgParent) {
// The files have already been moved, so delete storage false
msgParent->PropagateDelete(aSrcFolder, false);
oldPath->Remove(false); // berkeley mailbox
aSrcFolder->DeleteStorage();
nsCOMPtr<nsIFile> parentPath;
rv = msgParent->GetFilePath(getter_AddRefs(parentPath));
NS_ENSURE_SUCCESS(rv, rv);
AddDirectorySeparator(parentPath);
nsCOMPtr<nsIDirectoryEnumerator> children;
parentPath->GetDirectoryEntries(getter_AddRefs(children));
bool more;
// checks if the directory is empty or not
if (children && NS_SUCCEEDED(children->HasMoreElements(&more)) && !more)
parentPath->Remove(true);
}
} else {
// This is the case where the copy of a subfolder failed.
// We have to delete the newDirectory tree to make a "rollback".
// Someone should add a popup to warn the user that the move was not
// possible.
if (aIsMoveFolder && NS_FAILED(copyStatus)) {
nsCOMPtr<nsIMsgFolder> msgParent;
newMsgFolder->ForceDBClosed();
newMsgFolder->GetParent(getter_AddRefs(msgParent));
newMsgFolder->SetParent(nullptr);
if (msgParent) {
msgParent->PropagateDelete(newMsgFolder, false);
newMsgFolder->DeleteStorage();
AddDirectorySeparator(newPath);
newPath->Remove(true); // berkeley mailbox
}
return NS_ERROR_FAILURE;
}
}
return NS_OK;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::GetNewMsgOutputStream(nsIMsgFolder* aFolder,
nsIMsgDBHdr** aNewMsgHdr,
nsIOutputStream** aResult) {
bool quarantining = false;
nsCOMPtr<nsIPrefBranch> prefBranch(do_GetService(NS_PREFSERVICE_CONTRACTID));
if (prefBranch) {
prefBranch->GetBoolPref("mailnews.downloadToTempFile", &quarantining);
}
nsCOMPtr<nsIOutputStream> rawMboxStream;
nsresult rv = InternalGetNewMsgOutputStream(aFolder, aNewMsgHdr,
getter_AddRefs(rawMboxStream));
NS_ENSURE_SUCCESS(rv, rv);
// Wrap raw stream in one which will handle "From " separator and escaping
// etc...
// We want rawMboxStream to be closed when mboxStream is closed.
RefPtr<MboxMsgOutputStream> mboxStream =
new MboxMsgOutputStream(rawMboxStream, true);
if (!quarantining) {
// Caller will write directly(ish) to mbox.
mboxStream.forget(aResult);
return NS_OK;
}
// Quarantining is on, so we want to write the new message to a temp file
// and let the virus checker have at it before we append it to the mbox.
// We'll wrap the mboxStream with an nsQuarantinedOutputStream and return
// that.
RefPtr<nsQuarantinedOutputStream> qStream =
new nsQuarantinedOutputStream(mboxStream);
qStream.forget(aResult);
return NS_OK;
}
nsresult nsMsgBrkMBoxStore::InternalGetNewMsgOutputStream(
nsIMsgFolder* aFolder, nsIMsgDBHdr** aNewMsgHdr,
nsIOutputStream** aResult) {
NS_ENSURE_ARG_POINTER(aFolder);
NS_ENSURE_ARG_POINTER(aNewMsgHdr);
NS_ENSURE_ARG_POINTER(aResult);
nsresult rv;
// First, check the OutstandingStreams set to make sure we're not already
// writing to this folder. If so, we'll abort and roll back the previous one
// before issuing a new stream.
// NOTE: in theory, we could have multiple writes going if we were using
// Quarantining. But in practice the protocol => folder interfaces assume a
// single message at a time.
nsAutoCString folderURI;
rv = aFolder->GetURI(folderURI);
NS_ENSURE_SUCCESS(rv, rv);
auto existing = m_OutstandingStreams.lookup(folderURI);
if (existing) {
// boooo....
MOZ_LOG(gMboxLog, LogLevel::Error,
("Already writing to folder '%s'", folderURI.get()));
NS_WARNING(
nsPrintfCString("Already writing to folder '%s'", folderURI.get())
.get());
// Close the old stream - this will roll back everything it's written so
// far.
existing->value()->Close();
m_OutstandingStreams.remove(existing);
}
nsCOMPtr<nsIFile> mboxFile;
rv = aFolder->GetFilePath(getter_AddRefs(mboxFile));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIMsgDatabase> db;
aFolder->GetMsgDatabase(getter_AddRefs(db));
if (!db && !*aNewMsgHdr) NS_WARNING("no db, and no message header");
bool exists = false;
mboxFile->Exists(&exists);
if (!exists) {
rv = mboxFile->Create(nsIFile::NORMAL_FILE_TYPE, 0600);
NS_ENSURE_SUCCESS(rv, rv);
}
// We want to create a buffered stream.
// Borrowed the code from MsgNewBufferedFileOutputStream, but
// note that the permission bit ought to be 0600.
// no group read nor other read.
// Enlarge the buffer four times from the default.
// We need to seek to the end, and that is done later in this
// function.
{
nsCOMPtr<nsIOutputStream> stream;
rv = NS_NewLocalFileOutputStream(getter_AddRefs(stream), mboxFile,
PR_WRONLY | PR_CREATE_FILE | PR_APPEND,
00600);
if (NS_SUCCEEDED(rv)) {
// 2**16 buffer size for good performance in 2024
rv = NS_NewBufferedOutputStream(aResult, stream.forget(), 65536);
}
}
if (NS_FAILED(rv)) {
nsAutoCString uri;
aFolder->GetURI(uri);
MOZ_LOG(gMboxLog, LogLevel::Error,
("failed opening offline store for %s", uri.get()));
}
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsISeekableStream> seekable(do_QueryInterface(*aResult, &rv));
NS_ENSURE_SUCCESS(rv, rv);
rv = seekable->Seek(nsISeekableStream::NS_SEEK_END, 0);
NS_ENSURE_SUCCESS(rv, rv);
if (db && !*aNewMsgHdr) {
// Lazy caller wants us to crate a new msgHdr for them.
db->CreateNewHdr(nsMsgKey_None, aNewMsgHdr);
}
if (*aNewMsgHdr) {
int64_t filePos;
rv = seekable->Tell(&filePos);
NS_ENSURE_SUCCESS(rv, rv);
nsCString storeToken = nsPrintfCString("%" PRId64, filePos);
(*aNewMsgHdr)->SetStringProperty("storeToken", storeToken);
(*aNewMsgHdr)->SetMessageOffset(filePos);
MOZ_LOG(gMboxLog, LogLevel::Info,
("nsMsgBrkMBoxStore::InternalGetNewMsgOutputStream(): %s "
"filePos=%" PRIi64 "",
mboxFile->HumanReadablePath().get(), filePos));
}
// Up and running. Add the folder to the OutstandingStreams set.
MOZ_ALWAYS_TRUE(m_OutstandingStreams.putNew(folderURI, *aResult));
return NS_OK;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::DiscardNewMessage(nsIOutputStream* aOutputStream,
nsIMsgDBHdr* aNewHdr) {
NS_ENSURE_ARG_POINTER(aOutputStream);
NS_ENSURE_ARG_POINTER(aNewHdr);
nsresult rv = NS_OK;
MOZ_LOG(gMboxLog, LogLevel::Info, ("nsMsgBrkMBoxStore::DiscardNewMessage()"));
// nsISafeOutputStream only writes upon finish(), so no cleanup required.
rv = aOutputStream->Close();
NS_ENSURE_SUCCESS(rv, rv);
// Remove the folder from the OutstandingStreams set.
// The stream object may hang around a bit longer than we'd like,
// but it'll get cleared out on the next use of GetNewMsgOutputStream()
// on the same folder.
if (aNewHdr) {
nsCOMPtr<nsIMsgFolder> folder;
rv = aNewHdr->GetFolder(getter_AddRefs(folder));
NS_ENSURE_SUCCESS(rv, rv);
nsAutoCString folderURI;
rv = folder->GetURI(folderURI);
NS_ENSURE_SUCCESS(rv, rv);
m_OutstandingStreams.remove(folderURI);
}
return NS_OK;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::FinishNewMessage(nsIOutputStream* aOutputStream,
nsIMsgDBHdr* aNewHdr) {
NS_ENSURE_ARG_POINTER(aOutputStream);
nsresult rv;
MOZ_LOG(gMboxLog, LogLevel::Info, ("nsMsgBrkMBoxStore::FinishNewMessage()"));
// We are always dealing with nsISafeOutputStream.
// It requires an explicit commit, or the data will be discarded.
nsCOMPtr<nsISafeOutputStream> safe = do_QueryInterface(aOutputStream);
MOZ_ASSERT(safe);
// Commit the write.
rv = safe->Finish();
NS_ENSURE_SUCCESS(rv, rv);
// Remove from the OutstandingStreams set.
// That's OK. The stream object might hang around for a while, but it's
// already been committed, and the next GetNewMsgOutputStream() on the
// same folder will clear it from m_OutstandingStreams.
if (aNewHdr) {
nsCOMPtr<nsIMsgFolder> folder;
rv = aNewHdr->GetFolder(getter_AddRefs(folder));
NS_ENSURE_SUCCESS(rv, rv);
nsAutoCString folderURI;
rv = folder->GetURI(folderURI);
NS_ENSURE_SUCCESS(rv, rv);
m_OutstandingStreams.remove(folderURI);
}
return NS_OK;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::MoveNewlyDownloadedMessage(nsIMsgDBHdr* aNewHdr,
nsIMsgFolder* aDestFolder,
bool* aResult) {
NS_ENSURE_ARG_POINTER(aNewHdr);
NS_ENSURE_ARG_POINTER(aDestFolder);
NS_ENSURE_ARG_POINTER(aResult);
*aResult = false;
return NS_OK;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::GetMsgInputStream(nsIMsgFolder* aMsgFolder,
const nsACString& aMsgToken,
nsIInputStream** aResult) {
NS_ENSURE_ARG_POINTER(aMsgFolder);
NS_ENSURE_ARG_POINTER(aResult);
MOZ_ASSERT(!aMsgToken.IsEmpty());
uint64_t offset = ParseUint64Str(PromiseFlatCString(aMsgToken).get());
nsCOMPtr<nsIFile> mboxFile;
nsresult rv = aMsgFolder->GetFilePath(getter_AddRefs(mboxFile));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIInputStream> rawMboxStream;
rv = NS_NewLocalFileInputStream(getter_AddRefs(rawMboxStream), mboxFile);
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsISeekableStream> seekable(do_QueryInterface(rawMboxStream));
rv = seekable->Seek(PR_SEEK_SET, offset);
NS_ENSURE_SUCCESS(rv, rv);
// Stream to return a single message, hiding all "From "-separator guff.
RefPtr<MboxMsgInputStream> msgStream = new MboxMsgInputStream(rawMboxStream);
msgStream.forget(aResult);
return NS_OK;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::DeleteMessages(
const nsTArray<RefPtr<nsIMsgDBHdr>>& aHdrArray) {
return ChangeFlags(aHdrArray, nsMsgMessageFlags::Expunged, true);
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::CopyMessages(bool isMove,
const nsTArray<RefPtr<nsIMsgDBHdr>>& aHdrArray,
nsIMsgFolder* aDstFolder,
nsTArray<RefPtr<nsIMsgDBHdr>>& aDstHdrs,
nsITransaction** aUndoAction, bool* aCopyDone) {
NS_ENSURE_ARG_POINTER(aDstFolder);
NS_ENSURE_ARG_POINTER(aCopyDone);
aDstHdrs.Clear();
*aUndoAction = nullptr;
// We return false to indicate there's no shortcut. The calling code will
// just have to perform the copy the hard way.
*aCopyDone = false;
return NS_OK;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::GetSupportsCompaction(bool* aSupportsCompaction) {
NS_ENSURE_ARG_POINTER(aSupportsCompaction);
*aSupportsCompaction = true;
return NS_OK;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::AsyncScan(nsIMsgFolder* folder,
nsIStoreScanListener* scanListener) {
nsCOMPtr<nsIFile> mboxPath;
nsresult rv = folder->GetFilePath(getter_AddRefs(mboxPath));
NS_ENSURE_SUCCESS(rv, rv);
// Fire and forget. MboxScanner will hold itself in existence until finished.
RefPtr<MboxScanner> scanner(new MboxScanner());
return scanner->BeginScan(mboxPath, scanListener);
}
nsresult nsMsgBrkMBoxStore::GetOutputStream(
nsIMsgDBHdr* aHdr, nsCOMPtr<nsIOutputStream>& outputStream) {
nsCOMPtr<nsIMsgFolder> folder;
nsresult rv = aHdr->GetFolder(getter_AddRefs(folder));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIFile> mboxFile;
rv = folder->GetFilePath(getter_AddRefs(mboxFile));
NS_ENSURE_SUCCESS(rv, rv);
rv = MsgGetFileStream(mboxFile, getter_AddRefs(outputStream));
NS_ENSURE_SUCCESS(rv, rv);
return rv;
}
void nsMsgBrkMBoxStore::SetDBValid(nsIMsgDBHdr* aHdr) {
nsCOMPtr<nsIMsgFolder> folder;
aHdr->GetFolder(getter_AddRefs(folder));
if (folder) {
nsCOMPtr<nsIMsgDatabase> db;
folder->GetMsgDatabase(getter_AddRefs(db));
if (db) SetSummaryFileValid(folder, db, true);
}
}
NS_IMETHODIMP nsMsgBrkMBoxStore::ChangeFlags(
const nsTArray<RefPtr<nsIMsgDBHdr>>& aHdrArray, uint32_t aFlags,
bool aSet) {
if (aHdrArray.IsEmpty()) return NS_ERROR_INVALID_ARG;
nsCOMPtr<nsIOutputStream> outputStream;
nsresult rv = GetOutputStream(aHdrArray[0], outputStream);
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsISeekableStream> seekable(do_QueryInterface(outputStream, &rv));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIMsgDBHdr> msgHdr;
for (auto msgHdr : aHdrArray) {
// Work out the flags we want to write.
uint32_t flags = 0;
(void)msgHdr->GetFlags(&flags);
flags &= ~(nsMsgMessageFlags::RuntimeOnly | nsMsgMessageFlags::Offline);
if (aSet) {
flags |= aFlags;
} else {
flags &= ~aFlags;
}
// Rewrite flags into X-Mozilla-Status headers.
uint64_t msgOffset;
rv = msgHdr->GetMessageOffset(&msgOffset);
NS_ENSURE_SUCCESS(rv, rv);
seekable->Seek(nsISeekableStream::NS_SEEK_SET, msgOffset);
NS_ENSURE_SUCCESS(rv, rv);
rv = RewriteMsgFlags(seekable, flags);
if (NS_FAILED(rv)) {
break;
}
}
outputStream->Close();
SetDBValid(aHdrArray[0]);
return NS_OK;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::ChangeKeywords(
const nsTArray<RefPtr<nsIMsgDBHdr>>& aHdrArray, const nsACString& aKeywords,
bool aAdd) {
if (aHdrArray.IsEmpty()) return NS_ERROR_INVALID_ARG;
nsTArray<nsCString> keywordsToAdd;
nsTArray<nsCString> keywordsToRemove;
if (aAdd) {
ParseString(aKeywords, ' ', keywordsToAdd);
} else {
ParseString(aKeywords, ' ', keywordsToRemove);
}
// Get the (possibly-cached) seekable & writable stream for this mbox.
nsCOMPtr<nsIOutputStream> output;
nsresult rv = GetOutputStream(aHdrArray[0], output);
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsISeekableStream> seekable(do_QueryInterface(output, &rv));
NS_ENSURE_SUCCESS(rv, rv);
for (auto msgHdr : aHdrArray) {
uint64_t msgStart;
msgHdr->GetMessageOffset(&msgStart);
seekable->Seek(nsISeekableStream::NS_SEEK_SET, msgStart);
NS_ENSURE_SUCCESS(rv, rv);
bool notEnoughRoom;
rv = ChangeKeywordsHelper(seekable, keywordsToAdd, keywordsToRemove,
notEnoughRoom);
NS_ENSURE_SUCCESS(rv, rv);
if (notEnoughRoom) {
// The growKeywords property indicates that the X-Mozilla-Keys header
// doesn't have enough space, and should be rebuilt during the next
// folder compaction.
msgHdr->SetUint32Property("growKeywords", 1);
}
}
output->Close();
SetDBValid(aHdrArray[0]);
return NS_OK;
}
NS_IMETHODIMP nsMsgBrkMBoxStore::GetStoreType(nsACString& aType) {
aType.AssignLiteral("mbox");
return NS_OK;
}
// Iterates over the files in the "path" directory, and adds subfolders to
// parent for each mailbox file found.
nsresult nsMsgBrkMBoxStore::AddSubFolders(nsIMsgFolder* parent,
nsCOMPtr<nsIFile>& path, bool deep) {
nsresult rv;
nsCOMPtr<nsIFile> tmp; // at top level so we can safely assign to path
bool isDirectory;
path->IsDirectory(&isDirectory);
if (!isDirectory) {
rv = path->Clone(getter_AddRefs(tmp));
path = tmp;
NS_ENSURE_SUCCESS(rv, rv);
nsAutoString leafName;
path->GetLeafName(leafName);
leafName.AppendLiteral(FOLDER_SUFFIX);
path->SetLeafName(leafName);
path->IsDirectory(&isDirectory);
}
if (!isDirectory) return NS_OK;
// first find out all the current subfolders and files, before using them
// while creating new subfolders; we don't want to modify and iterate the same
// directory at once.
nsCOMArray<nsIFile> currentDirEntries;
nsCOMPtr<nsIDirectoryEnumerator> directoryEnumerator;
rv = path->GetDirectoryEntries(getter_AddRefs(directoryEnumerator));
NS_ENSURE_SUCCESS(rv, rv);
bool hasMore;
while (NS_SUCCEEDED(directoryEnumerator->HasMoreElements(&hasMore)) &&
hasMore) {
nsCOMPtr<nsIFile> currentFile;
rv = directoryEnumerator->GetNextFile(getter_AddRefs(currentFile));
if (NS_SUCCEEDED(rv) && currentFile) {
currentDirEntries.AppendObject(currentFile);
}
}
// add the folders
int32_t count = currentDirEntries.Count();
for (int32_t i = 0; i < count; ++i) {
nsCOMPtr<nsIFile> currentFile(currentDirEntries[i]);
nsAutoString leafName;
currentFile->GetLeafName(leafName);
// here we should handle the case where the current file is a .sbd directory
// w/o a matching folder file, or a directory w/o the name .sbd
if (nsShouldIgnoreFile(leafName, currentFile)) continue;
nsCOMPtr<nsIMsgFolder> child;
rv = parent->AddSubfolder(leafName, getter_AddRefs(child));
if (NS_FAILED(rv) && rv != NS_MSG_FOLDER_EXISTS) {
return rv;
}
if (child) {
nsString folderName;
child->GetName(folderName); // try to get it from cache/db
if (folderName.IsEmpty()) child->SetPrettyName(leafName);
if (deep) {
nsCOMPtr<nsIFile> path;
rv = child->GetFilePath(getter_AddRefs(path));
NS_ENSURE_SUCCESS(rv, rv);
rv = AddSubFolders(child, path, true);
NS_ENSURE_SUCCESS(rv, rv);
}
}
}
return rv == NS_MSG_FOLDER_EXISTS ? NS_OK : rv;
}
/* Finds the directory associated with this folder. That is if the path is
c:\Inbox, it will return c:\Inbox.sbd if it succeeds. If that path doesn't
currently exist then it will create it. Path is strictly an out parameter.
*/
nsresult nsMsgBrkMBoxStore::CreateDirectoryForFolder(nsIFile* path) {
nsresult rv = NS_OK;
bool pathIsDirectory = false;
path->IsDirectory(&pathIsDirectory);
if (!pathIsDirectory) {
// If the current path isn't a directory, add directory separator
// and test it out.
nsAutoString leafName;
path->GetLeafName(leafName);
leafName.AppendLiteral(FOLDER_SUFFIX);
rv = path->SetLeafName(leafName);
if (NS_FAILED(rv)) return rv;
// If that doesn't exist, then we have to create this directory
pathIsDirectory = false;
path->IsDirectory(&pathIsDirectory);
if (!pathIsDirectory) {
bool pathExists;
path->Exists(&pathExists);
// If for some reason there's a file with the directory separator
// then we are going to fail.
rv = pathExists ? NS_MSG_COULD_NOT_CREATE_DIRECTORY
: path->Create(nsIFile::DIRECTORY_TYPE, 0700);
}
}
return rv;
}
NS_IMETHODIMP
nsMsgBrkMBoxStore::SliceStream(nsIInputStream* inStream, uint64_t start,
uint32_t length, nsIInputStream** result) {
nsCOMPtr<nsIInputStream> in(inStream);
RefPtr<mozilla::SlicedInputStream> slicedStream =
new mozilla::SlicedInputStream(in.forget(), start, uint64_t(length));
slicedStream.forget(result);
return NS_OK;
}
// For mbox store, we'll just use mbox file size as our estimate.
NS_IMETHODIMP nsMsgBrkMBoxStore::EstimateFolderSize(nsIMsgFolder* folder,
int64_t* size) {
MOZ_ASSERT(size);
*size = 0;
bool isServer = false;
nsresult rv = folder->GetIsServer(&isServer);
NS_ENSURE_SUCCESS(rv, rv);
if (isServer) {
return NS_OK;
}
nsCOMPtr<nsIFile> file;
rv = folder->GetFilePath(getter_AddRefs(file));
NS_ENSURE_SUCCESS(rv, rv);
rv = file->GetFileSize(size);
NS_ENSURE_SUCCESS(rv, rv);
return NS_OK;
}