From 6bf0a5cb5034a7e684dcc3500e841785237ce2dd Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 19:32:43 +0200 Subject: Adding upstream version 1:115.7.0. Signed-off-by: Daniel Baumann --- comm/mailnews/local/src/nsMsgBrkMBoxStore.cpp | 1033 +++++++++++++++++++++++++ 1 file changed, 1033 insertions(+) create mode 100644 comm/mailnews/local/src/nsMsgBrkMBoxStore.cpp (limited to 'comm/mailnews/local/src/nsMsgBrkMBoxStore.cpp') diff --git a/comm/mailnews/local/src/nsMsgBrkMBoxStore.cpp b/comm/mailnews/local/src/nsMsgBrkMBoxStore.cpp new file mode 100644 index 0000000000..1f48b7d278 --- /dev/null +++ b/comm/mailnews/local/src/nsMsgBrkMBoxStore.cpp @@ -0,0 +1,1033 @@ +/* -*- 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 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +/** + 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 "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 "nsIMailboxService.h" +#include "nsIMsgFolderCompactor.h" +#include "nsIPrefService.h" +#include "nsIPrefBranch.h" +#include "nsPrintfCString.h" +#include "nsQuarantinedOutputStream.h" +#include "mozilla/Preferences.h" +#include "mozilla/SlicedInputStream.h" +#include "prprf.h" +#include // for std::abs(int/long) +#include // for std::abs(float/double) + +nsMsgBrkMBoxStore::nsMsgBrkMBoxStore() {} + +nsMsgBrkMBoxStore::~nsMsgBrkMBoxStore() {} + +NS_IMPL_ISUPPORTS(nsMsgBrkMBoxStore, nsIMsgPluggableStore) + +NS_IMETHODIMP nsMsgBrkMBoxStore::DiscoverSubFolders(nsIMsgFolder* aParentFolder, + bool aDeep) { + NS_ENSURE_ARG_POINTER(aParentFolder); + + nsCOMPtr 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 path; + nsCOMPtr 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 msgDBService = + do_GetService("@mozilla.org/msgDatabase/msgDBService;1", &rv); + if (msgDBService) { + nsCOMPtr 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 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 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 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 localFolder(do_QueryInterface(aFolder)); + if (!localFolder) { + *aResult = true; + return NS_OK; + } + + nsCOMPtr pathFile; + nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile)); + NS_ENSURE_SUCCESS(rv, rv); + nsCOMPtr 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 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 localFolder(do_QueryInterface(aFolder)); + if (!localFolder) return NS_OK; + + nsCOMPtr pathFile; + nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile)); + NS_ENSURE_SUCCESS(rv, rv); + nsCOMPtr 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* aFolder) { + NS_ENSURE_ARG_POINTER(aFolder); + bool exists; + + // Delete mbox file. + nsCOMPtr pathFile; + nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile)); + NS_ENSURE_SUCCESS(rv, rv); + + exists = false; + pathFile->Exists(&exists); + if (exists) { + rv = pathFile->Remove(false); + NS_ENSURE_SUCCESS(rv, rv); + } + + // Delete any subfolders (.sbd-suffixed directories). + AddDirectorySeparator(pathFile); + exists = false; + pathFile->Exists(&exists); + if (exists) { + 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 oldPathFile; + nsresult rv = aFolder->GetFilePath(getter_AddRefs(oldPathFile)); + if (NS_FAILED(rv)) return rv; + + nsCOMPtr parentFolder; + rv = aFolder->GetParent(getter_AddRefs(parentFolder)); + if (!parentFolder) return NS_ERROR_NULL_POINTER; + + nsCOMPtr oldSummaryFile; + rv = aFolder->GetSummaryFile(getter_AddRefs(oldSummaryFile)); + NS_ENSURE_SUCCESS(rv, rv); + + nsCOMPtr 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 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 localSrcFolder(do_QueryInterface(aSrcFolder)); + nsCOMPtr srcDB; + if (localSrcFolder) + localSrcFolder->GetDatabaseWOReparse(getter_AddRefs(srcDB)); + bool summaryValid = !!srcDB; + srcDB = nullptr; + aSrcFolder->ForceDBClosed(); + + nsCOMPtr oldPath; + nsresult rv = aSrcFolder->GetFilePath(getter_AddRefs(oldPath)); + NS_ENSURE_SUCCESS(rv, rv); + + nsCOMPtr summaryFile; + GetSummaryFileLocation(oldPath, getter_AddRefs(summaryFile)); + + nsCOMPtr 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 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 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 destDB; + if (summaryValid) { + nsAutoString folderLeafName; + origPath->GetLeafName(folderLeafName); + newPath->Append(folderLeafName); + nsCOMPtr 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> subFolders; + rv = aSrcFolder->GetSubFolders(subFolders); + NS_ENSURE_SUCCESS(rv, rv); + + // Copy subfolders to the new location + nsresult copyStatus = NS_OK; + nsCOMPtr 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 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 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 parentPath; + rv = msgParent->GetFilePath(getter_AddRefs(parentPath)); + NS_ENSURE_SUCCESS(rv, rv); + + AddDirectorySeparator(parentPath); + nsCOMPtr 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 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 prefBranch(do_GetService(NS_PREFSERVICE_CONTRACTID)); + if (prefBranch) { + prefBranch->GetBoolPref("mailnews.downloadToTempFile", &quarantining); + } + + if (!quarantining) { + // Caller will write directly to mbox. + return InternalGetNewMsgOutputStream(aFolder, aNewMsgHdr, aResult); + } + + // 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. + nsCOMPtr mboxStream; + nsresult rv = InternalGetNewMsgOutputStream(aFolder, aNewMsgHdr, + getter_AddRefs(mboxStream)); + NS_ENSURE_SUCCESS(rv, rv); + + RefPtr 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); + +#ifdef _DEBUG + NS_ASSERTION(m_streamOutstandingFolder != aFolder, "didn't finish prev msg"); + m_streamOutstandingFolder = aFolder; +#endif + + nsresult rv; + nsCOMPtr mboxFile; + rv = aFolder->GetFilePath(getter_AddRefs(mboxFile)); + NS_ENSURE_SUCCESS(rv, rv); + nsCOMPtr 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); + } + + nsCString URI; + aFolder->GetURI(URI); + nsCOMPtr seekable; + if (m_outputStreams.Get(URI, aResult)) { + seekable = do_QueryInterface(*aResult, &rv); + NS_ENSURE_SUCCESS(rv, rv); + rv = seekable->Seek(nsISeekableStream::NS_SEEK_END, 0); + if (NS_FAILED(rv)) { + m_outputStreams.Remove(URI); + NS_RELEASE(*aResult); + } + } + if (!*aResult) { + rv = MsgGetFileStream(mboxFile, aResult); + NS_ASSERTION(NS_SUCCEEDED(rv), "failed opening offline store for output"); + if (NS_FAILED(rv)) + printf("failed opening offline store for %s\n", URI.get()); + NS_ENSURE_SUCCESS(rv, rv); + seekable = do_QueryInterface(*aResult, &rv); + NS_ENSURE_SUCCESS(rv, rv); + rv = seekable->Seek(nsISeekableStream::NS_SEEK_END, 0); + NS_ENSURE_SUCCESS(rv, rv); + m_outputStreams.InsertOrUpdate(URI, *aResult); + } + int64_t filePos; + seekable->Tell(&filePos); + + if (db && !*aNewMsgHdr) { + db->CreateNewHdr(nsMsgKey_None, aNewMsgHdr); + } + + if (*aNewMsgHdr) { + nsCString storeToken = nsPrintfCString("%" PRId64, filePos); + (*aNewMsgHdr)->SetStringProperty("storeToken", storeToken); + (*aNewMsgHdr)->SetMessageOffset(filePos); + } + return rv; +} + +NS_IMETHODIMP +nsMsgBrkMBoxStore::DiscardNewMessage(nsIOutputStream* aOutputStream, + nsIMsgDBHdr* aNewHdr) { + NS_ENSURE_ARG_POINTER(aOutputStream); + NS_ENSURE_ARG_POINTER(aNewHdr); +#ifdef _DEBUG + m_streamOutstandingFolder = nullptr; +#endif + nsCOMPtr safe = do_QueryInterface(aOutputStream); + if (safe) { + // nsISafeOutputStream only writes upon finish(), so no cleanup required. + return aOutputStream->Close(); + } + // Truncate the mbox back to where we started writing. + uint64_t hdrOffset; + aNewHdr->GetMessageOffset(&hdrOffset); + aOutputStream->Close(); + nsCOMPtr mboxFile; + nsCOMPtr folder; + nsresult rv = aNewHdr->GetFolder(getter_AddRefs(folder)); + NS_ENSURE_SUCCESS(rv, rv); + rv = folder->GetFilePath(getter_AddRefs(mboxFile)); + NS_ENSURE_SUCCESS(rv, rv); + return mboxFile->SetFileSize(hdrOffset); +} + +NS_IMETHODIMP +nsMsgBrkMBoxStore::FinishNewMessage(nsIOutputStream* aOutputStream, + nsIMsgDBHdr* aNewHdr) { + NS_ENSURE_ARG_POINTER(aOutputStream); +#ifdef _DEBUG + m_streamOutstandingFolder = nullptr; +#endif + // Quarantining is implemented using a nsISafeOutputStream. + // It requires an explicit commit, or the data will be discarded. + nsCOMPtr safe = do_QueryInterface(aOutputStream); + if (safe) { + return safe->Finish(); + } + aOutputStream->Close(); + 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) { + MOZ_ASSERT(aMsgFolder); + MOZ_ASSERT(aResult); + MOZ_ASSERT(!aMsgToken.IsEmpty()); + + uint64_t offset = ParseUint64Str(PromiseFlatCString(aMsgToken).get()); + nsCOMPtr mboxFile; + nsresult rv = aMsgFolder->GetFilePath(getter_AddRefs(mboxFile)); + NS_ENSURE_SUCCESS(rv, rv); + nsCOMPtr msgStream; + rv = NS_NewLocalFileInputStream(getter_AddRefs(msgStream), mboxFile); + NS_ENSURE_SUCCESS(rv, rv); + nsCOMPtr seekable(do_QueryInterface(msgStream)); + rv = seekable->Seek(PR_SEEK_SET, offset); + NS_ENSURE_SUCCESS(rv, rv); + msgStream.forget(aResult); + return NS_OK; +} + +NS_IMETHODIMP nsMsgBrkMBoxStore::DeleteMessages( + const nsTArray>& aHdrArray) { + return ChangeFlags(aHdrArray, nsMsgMessageFlags::Expunged, true); +} + +NS_IMETHODIMP +nsMsgBrkMBoxStore::CopyMessages(bool isMove, + const nsTArray>& aHdrArray, + nsIMsgFolder* aDstFolder, + nsTArray>& 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::CompactFolder(nsIMsgFolder* aFolder, + nsIUrlListener* aListener, + nsIMsgWindow* aMsgWindow) { + // Eventually, folder compaction should be managed by nsMsgBrkMBoxStore, but + // for now it's separate (see nsMsgFolderCompactor) and invoked via the + // folder methods Compact() and CompactAll(). + return NS_ERROR_NOT_IMPLEMENTED; +} + +NS_IMETHODIMP nsMsgBrkMBoxStore::RebuildIndex(nsIMsgFolder* aFolder, + nsIMsgDatabase* aMsgDB, + nsIMsgWindow* aMsgWindow, + nsIUrlListener* aListener) { + NS_ENSURE_ARG_POINTER(aFolder); + nsCOMPtr pathFile; + nsresult rv = aFolder->GetFilePath(getter_AddRefs(pathFile)); + if (NS_FAILED(rv)) return rv; + + bool isLocked; + aFolder->GetLocked(&isLocked); + if (isLocked) { + NS_ASSERTION(false, "Could not get folder lock"); + return NS_MSG_FOLDER_BUSY; + } + + nsCOMPtr mailboxService = + do_GetService("@mozilla.org/messenger/mailboxservice;1", &rv); + NS_ENSURE_SUCCESS(rv, rv); + + RefPtr parser = new nsMsgMailboxParser(aFolder); + NS_ENSURE_TRUE(parser, NS_ERROR_OUT_OF_MEMORY); + rv = parser->Init(); + NS_ENSURE_SUCCESS(rv, rv); + + rv = mailboxService->ParseMailbox(aMsgWindow, pathFile, parser, aListener, + nullptr); + if (NS_SUCCEEDED(rv)) ResetForceReparse(aMsgDB); + return rv; +} + +nsresult nsMsgBrkMBoxStore::GetOutputStream( + nsIMsgDBHdr* aHdr, nsCOMPtr& outputStream, + nsCOMPtr& seekableStream, int64_t& restorePos) { + nsCOMPtr folder; + nsresult rv = aHdr->GetFolder(getter_AddRefs(folder)); + NS_ENSURE_SUCCESS(rv, rv); + nsCString URI; + folder->GetURI(URI); + restorePos = -1; + if (m_outputStreams.Get(URI, getter_AddRefs(outputStream))) { + seekableStream = do_QueryInterface(outputStream); + rv = seekableStream->Tell(&restorePos); + if (NS_FAILED(rv)) { + outputStream = nullptr; + m_outputStreams.Remove(URI); + } + } + if (!outputStream) { + nsCOMPtr mboxFile; + rv = folder->GetFilePath(getter_AddRefs(mboxFile)); + NS_ENSURE_SUCCESS(rv, rv); + rv = MsgGetFileStream(mboxFile, getter_AddRefs(outputStream)); + seekableStream = do_QueryInterface(outputStream); + if (NS_SUCCEEDED(rv)) m_outputStreams.InsertOrUpdate(URI, outputStream); + } + return rv; +} + +void nsMsgBrkMBoxStore::SetDBValid(nsIMsgDBHdr* aHdr) { + nsCOMPtr folder; + aHdr->GetFolder(getter_AddRefs(folder)); + if (folder) { + nsCOMPtr db; + folder->GetMsgDatabase(getter_AddRefs(db)); + if (db) SetSummaryFileValid(folder, db, true); + } +} + +NS_IMETHODIMP nsMsgBrkMBoxStore::ChangeFlags( + const nsTArray>& aHdrArray, uint32_t aFlags, + bool aSet) { + if (aHdrArray.IsEmpty()) return NS_ERROR_INVALID_ARG; + + nsCOMPtr outputStream; + nsCOMPtr seekableStream; + int64_t restoreStreamPos; + nsresult rv = GetOutputStream(aHdrArray[0], outputStream, seekableStream, + restoreStreamPos); + NS_ENSURE_SUCCESS(rv, rv); + + nsCOMPtr 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. + nsCOMPtr seekable(do_QueryInterface(outputStream, &rv)); + NS_ENSURE_SUCCESS(rv, rv); + 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; + } + } + if (restoreStreamPos != -1) + seekableStream->Seek(nsISeekableStream::NS_SEEK_SET, restoreStreamPos); + else if (outputStream) + outputStream->Close(); + SetDBValid(aHdrArray[0]); + return NS_OK; +} + +NS_IMETHODIMP nsMsgBrkMBoxStore::ChangeKeywords( + const nsTArray>& aHdrArray, const nsACString& aKeywords, + bool aAdd) { + if (aHdrArray.IsEmpty()) return NS_ERROR_INVALID_ARG; + + nsTArray keywordsToAdd; + nsTArray keywordsToRemove; + if (aAdd) { + ParseString(aKeywords, ' ', keywordsToAdd); + } else { + ParseString(aKeywords, ' ', keywordsToRemove); + } + + // Get the (possibly-cached) seekable & writable stream for this mbox. + nsCOMPtr output; + nsCOMPtr seekable; + int64_t restoreStreamPos; + nsresult rv = + GetOutputStream(aHdrArray[0], output, seekable, restoreStreamPos); + 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); + } + } + + if (restoreStreamPos != -1) { + seekable->Seek(nsISeekableStream::NS_SEEK_SET, restoreStreamPos); + } else if (output) { + 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& path, bool deep) { + nsresult rv; + nsCOMPtr 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 currentDirEntries; + nsCOMPtr directoryEnumerator; + rv = path->GetDirectoryEntries(getter_AddRefs(directoryEnumerator)); + NS_ENSURE_SUCCESS(rv, rv); + + bool hasMore; + while (NS_SUCCEEDED(directoryEnumerator->HasMoreElements(&hasMore)) && + hasMore) { + nsCOMPtr 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 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 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 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 in(inStream); + RefPtr slicedStream = + new mozilla::SlicedInputStream(in.forget(), start, uint64_t(length)); + slicedStream.forget(result); + return NS_OK; +} -- cgit v1.2.3