Per darin, back out the fix for Bug #132517 because it is causing

an extra copy of prefs.js to get generated every time you quit the app.
This commit is contained in:
scott%scott-macgregor.org 2003-12-20 22:29:03 +00:00
Родитель 5be467455e
Коммит 5fa2d26357
3 изменённых файлов: 235 добавлений и 115 удалений

Просмотреть файл

@ -497,7 +497,6 @@ nsresult nsPrefService::WritePrefFile(nsIFile* aFile)
NS_LINEBREAK
NS_LINEBREAK;
nsCOMPtr<nsIOutputStream> outStreamSink;
nsCOMPtr<nsIOutputStream> outStream;
PRUint32 writeAmount;
nsresult rv;
@ -514,23 +513,25 @@ nsresult nsPrefService::WritePrefFile(nsIFile* aFile)
#endif
// execute a "safe" save by saving through a tempfile
nsSafeSaveFile safeSave;
nsCOMPtr<nsIFile> tempFile;
rv = safeSave.Init(aFile, getter_AddRefs(tempFile));
PRInt32 numCopies = 1;
mRootBranch->GetIntPref("backups.number_of_prefs_copies", &numCopies);
nsSafeSaveFile safeSave(aFile, numCopies);
rv = safeSave.CreateBackup(nsSafeSaveFile::kPurgeNone);
if (NS_FAILED(rv))
return rv;
rv = NS_NewLocalFileOutputStream(getter_AddRefs(outStreamSink), tempFile);
if (NS_FAILED(rv))
return rv;
rv = NS_NewBufferedOutputStream(getter_AddRefs(outStream), outStreamSink, 4096);
if (NS_FAILED(rv))
return rv;
char** valueArray = (char **)PR_Calloc(sizeof(char *), gHashTable.entryCount);
if (!valueArray)
return NS_ERROR_OUT_OF_MEMORY;
rv = NS_NewLocalFileOutputStream(getter_AddRefs(outStream), aFile);
if (NS_FAILED(rv))
return rv;
// write out the file header
rv = outStream->Write(outHeader, sizeof(outHeader) - 1, &writeAmount);
pref_saveArgs saveArgs;
saveArgs.prefArray = valueArray;
saveArgs.saveTypes = SAVE_ALL;
@ -549,10 +550,6 @@ nsresult nsPrefService::WritePrefFile(nsIFile* aFile)
/* Sort the preferences to make a readable file on disk */
NS_QuickSort(valueArray, gHashTable.entryCount, sizeof(char *), pref_CompareStrings, NULL);
// write out the file header
rv = outStream->Write(outHeader, sizeof(outHeader) - 1, &writeAmount);
char** walker = valueArray;
for (PRUint32 valueIdx = 0; valueIdx < gHashTable.entryCount; valueIdx++, walker++) {
if (*walker) {
@ -569,19 +566,15 @@ nsresult nsPrefService::WritePrefFile(nsIFile* aFile)
PR_Free(valueArray);
outStream->Close();
PRInt64 tempLL;
PRUint32 oldFileSize, newFileSize;
(void)aFile->GetFileSize(&tempLL); // All impls return 0 for size on failure.
LL_L2UI(oldFileSize, tempLL);
(void)tempFile->GetFileSize(&tempLL);
LL_L2UI(newFileSize, tempLL);
// As long as we have succeeded, move the temp file to the actual file.
// But, if the new file is only 1/2 the size of the old file (dataloss),
// pass TRUE for aBackupTarget, leaving the old file on disk.
safeSave.OnSaveFinished(NS_SUCCEEDED(rv),
oldFileSize && ((newFileSize << 1) <= oldFileSize));
// if save failed replace the original file from backup
if (NS_FAILED(rv)) {
nsresult rv2;
rv2 = safeSave.RestoreFromBackup();
if (NS_SUCCEEDED(rv2)) {
// we failed to write the file, but managed to restore the previous one...
rv = NS_OK;
}
}
if (NS_SUCCEEDED(rv))
gDirty = PR_FALSE;
return rv;

Просмотреть файл

@ -38,92 +38,207 @@
#include "nsSafeSaveFile.h"
nsresult nsSafeSaveFile::Init(nsIFile *aTargetFile, nsIFile **aTempFile)
nsSafeSaveFile::nsSafeSaveFile(nsIFile *aTargetFile, PRInt32 aNumBackupCopies)
: mBackupNameLen(0),
mBackupCount(aNumBackupCopies)
{
NS_ASSERTION(aTargetFile, "null pointer");
NS_ASSERTION(aTempFile, "null pointer");
*aTempFile = nsnull;
nsresult rv;
rv = aTargetFile->Exists(&mTargetFileExists);
if (NS_FAILED(rv)) {
NS_ERROR("Can't tell if target file exists");
mTargetFileExists = PR_TRUE; // Safer to assume it exists - we just do more work.
}
nsCOMPtr<nsIFile> tempResult;
rv = aTargetFile->Clone(getter_AddRefs(tempResult));
if (NS_SUCCEEDED(rv) && mTargetFileExists) {
PRUint32 perm;
if (NS_FAILED(aTargetFile->GetPermissions(&perm))) {
NS_ERROR("Can't get permissions of target file");
perm = 0700;
}
rv = tempResult->CreateUnique(nsIFile::NORMAL_FILE_TYPE, perm);
}
if (NS_SUCCEEDED(rv)) {
NS_ADDREF(*aTempFile = tempResult);
nsCAutoString targetFileName;
const char * temp;
nsresult rv;
// determine if the target file currently exists
// if the target file doesn't exist this object does nothing
if (NS_FAILED(aTargetFile->Exists(&mTargetFileExists)))
mTargetFileExists = PR_FALSE;
if (!mTargetFileExists)
return;
// determine the actual filename (less the extension)
rv = aTargetFile->GetNativeLeafName(targetFileName);
if (NS_FAILED(rv)) // yikes! out of memory
return;
// keep a reference to the file that will be saved
mTargetFile = aTargetFile;
mTempFile = tempResult;
}
return rv;
}
nsresult nsSafeSaveFile::OnSaveFinished(PRBool aSaveSucceeded, PRBool aBackupTarget)
{
nsresult rv = NS_OK;
if (aSaveSucceeded) {
NS_ENSURE_STATE(mTargetFile && mTempFile);
// determine the file name (less the extension)
temp = strrchr(targetFileName.get(), '.');
if (temp)
mBackupNameLen = temp - targetFileName.get();
else
mBackupNameLen = targetFileName.Length();
if (!mTargetFileExists) {
// If the target file did not exist when we were initialized, then the
// temp file we gave out was actually a reference to the target file.
// since we succeeded in writing to the temp file (and hence succeeded
// in writing to the target file), there is nothing more to do.
#ifdef DEBUG
PRBool equal;
if (NS_FAILED(mTargetFile->Equals(mTempFile, &equal)) || !equal)
NS_ERROR("mTempFile not equal to mTargetFile");
#endif
return NS_OK;
}
// save the name of the backup file and its length
mBackupFileName = Substring(targetFileName, 0, mBackupNameLen) + NS_LITERAL_CSTRING(".bak");
mBackupNameLen = mBackupFileName.Length();
nsCAutoString targetFilename;
rv = mTargetFile->GetNativeLeafName(targetFilename);
if (aBackupTarget) {
// Create a copy of the target before we overwrite it
nsCAutoString backupFilename(targetFilename);
PRInt32 pos = backupFilename.RFindChar('.');
if (pos != -1)
backupFilename.Truncate(pos);
backupFilename.Append(NS_LITERAL_CSTRING(".bak"));
// Find a unique name for the backup by using CreateUnique
nsCOMPtr<nsIFile> uniqueFile;
rv = mTargetFile->Clone(getter_AddRefs(uniqueFile));
if (NS_SUCCEEDED(rv)) {
rv = uniqueFile->SetNativeLeafName(backupFilename);
if (NS_SUCCEEDED(rv)) {
rv = uniqueFile->CreateUnique(nsIFile::NORMAL_FILE_TYPE, 0600);
if (NS_SUCCEEDED(rv)) {
uniqueFile->GetNativeLeafName(backupFilename);
uniqueFile->Remove(PR_FALSE);
// Finally, move the target to the backup
mTargetFile->MoveToNative(nsnull, backupFilename);
}
}
}
}
// create a new file object that points to our backup file... this isn't
// absolutely necessary, but it does allow us to easily transistion to a
// model where all .bak are stored in a single directory if so desired.
rv = aTargetFile->Clone(getter_AddRefs(mBackupFile));
if (NS_SUCCEEDED(rv))
rv = mTempFile->MoveToNative(nsnull, targetFilename); // This will replace target
}
else {
NS_ENSURE_STATE(mTempFile);
rv = mTempFile->Remove(PR_FALSE);
}
return rv;
mBackupFile->SetNativeLeafName(mBackupFileName);
}
nsSafeSaveFile::~nsSafeSaveFile(void)
{
// if the target file didn't exist nothing was backed up
if (mTargetFileExists && mBackupFile) {
// if no backups desired, remove the backup file
if (mBackupCount == 0) {
mBackupFile->Remove(PR_FALSE);
}
}
}
nsresult nsSafeSaveFile::CreateBackup(PurgeBackupType aPurgeType)
{
nsCOMPtr<nsIFile> backupParent;
nsresult rv, rv2;
PRBool bExists;
// if the target file doesn't exist there is nothing to backup
if (!mTargetFileExists)
return NS_OK;
// if a backup file currently exists... do the right thing
if (mBackupFile && NS_SUCCEEDED(mBackupFile->Exists(&bExists)) && bExists) {
rv = ManageRedundantBackups();
if (NS_FAILED(rv))
return rv;
}
// and finally, copy the file (preserves file permissions)
rv2 = NS_OK;
do {
rv = mTargetFile->CopyToNative(nsnull, mBackupFileName);
if (NS_SUCCEEDED(rv))
break;
switch (rv) {
case NS_ERROR_FILE_DISK_FULL: // Mac
case NS_ERROR_FILE_TOO_BIG: // Windows
case NS_ERROR_FILE_NO_DEVICE_SPACE: // Who knows...
if (aPurgeType == kPurgeNone) {
return rv;
} if (aPurgeType == kPurgeOne) {
aPurgeType = kPurgeNone;
}
rv2 = PurgeOldestRedundantBackup();
break;
default:
return rv;
break;
}
} while (rv2 == NS_OK);
return rv;
}
nsresult nsSafeSaveFile::RestoreFromBackup(void)
{
nsCOMPtr<nsIFile> parentDir;
nsCAutoString fileName;
nsresult rv;
// if the target file didn't initially exist there is nothing to restore from
if (!mTargetFileExists)
return NS_ERROR_FILE_NOT_FOUND;
if (!mBackupFile)
return NS_ERROR_NOT_INITIALIZED;
rv = mTargetFile->GetNativeLeafName(fileName);
if (NS_FAILED(rv)) // yikes! out of memory
return rv;
// Ugh, copy only takes a directory and a name, lets "unpackage" our target file...
rv = mTargetFile->GetParent(getter_AddRefs(parentDir));
if (NS_FAILED(rv))
return rv;
// kill the target... it's bad anyway
mTargetFile->Remove(PR_FALSE);
// and finally, copy the file (preserves file permissions)
rv = mBackupFile->CopyToNative(parentDir, fileName);
return rv;
}
nsresult nsSafeSaveFile::ManageRedundantBackups(void)
{
nsCOMPtr<nsIFile> backupFile;
nsCAutoString fileName;
nsresult rv;
PRBool bExists;
rv = mBackupFile->Clone(getter_AddRefs(backupFile));
if (NS_FAILED(rv)) // yikes! out of memory, probably best to not continue
return rv;
if (mBackupCount > 0) {
// kill the (oldest) backup copy, if necessary
fileName = mBackupFileName;
if (mBackupCount > 1)
fileName.AppendInt(mBackupCount - 1);
backupFile->SetNativeLeafName(fileName);
}
// remove the file as determined by the logic above
backupFile->Remove(PR_FALSE);
// bump any redundant backups up one (i.e. bak -> bak1, bak1 -> bak2, etc.)
if (mBackupCount > 1) {
PRInt32 backupCount = mBackupCount;
fileName = mBackupFileName;
while (--backupCount > 0) {
if (backupCount > 1)
fileName.AppendInt(backupCount - 1);
backupFile->SetNativeLeafName(fileName);
backupFile->Exists(&bExists);
if (bExists) {
fileName.Truncate(mBackupNameLen);
fileName.AppendInt(backupCount);
// fail silently because it's not important enough to bail on the save for
backupFile->MoveToNative(0, fileName);
}
fileName.Truncate(mBackupNameLen);
};
}
return NS_OK;
}
nsresult nsSafeSaveFile::PurgeOldestRedundantBackup(void)
{
nsCOMPtr<nsIFile> backupFile;
nsCAutoString fileName;
nsresult rv;
if (!mBackupFile)
return NS_ERROR_NULL_POINTER;
rv = mBackupFile->Clone(getter_AddRefs(backupFile));
if (NS_FAILED(rv)) // yikes! out of memory, probably best to not continue
return rv;
// if no redundant backups, nothing to delete
if (mBackupCount <= 1)
return NS_ERROR_FILE_NOT_FOUND;
PRInt32 backupCount = mBackupCount;
fileName = mBackupFileName;
while (--backupCount > 0) {
fileName.AppendInt(backupCount);
backupFile->SetNativeLeafName(fileName);
rv = backupFile->Remove(PR_FALSE);
if (NS_SUCCEEDED(rv)) {
return NS_OK;
}
fileName.Truncate(mBackupNameLen);
};
return NS_ERROR_FILE_NOT_FOUND;
}

Просмотреть файл

@ -41,15 +41,27 @@
class nsSafeSaveFile {
public:
nsSafeSaveFile() {}
~nsSafeSaveFile() {}
enum PurgeBackupType {
kPurgeNone = 0, kPurgeOne = 1, kPurgeAll = 2
};
nsresult Init(nsIFile *aTargetFile, nsIFile **aTempFile);
nsresult OnSaveFinished(PRBool aSaveSucceeded, PRBool aBackupTarget);
nsSafeSaveFile(nsIFile *aTargetFile, PRInt32 aNumBackupCopies = 0);
virtual ~nsSafeSaveFile(void);
nsresult CreateBackup(PurgeBackupType aPurgeType);
nsresult RestoreFromBackup(void);
protected:
nsSafeSaveFile(void) {};
nsresult ManageRedundantBackups(void);
nsresult PurgeOldestRedundantBackup(void);
private:
nsCOMPtr<nsIFile> mTargetFile;
PRBool mTargetFileExists;
nsCOMPtr<nsIFile> mTempFile;
nsCOMPtr<nsIFile> mBackupFile;
nsCString mBackupFileName; // native charset
PRInt32 mBackupNameLen;
PRInt32 mBackupCount;
};