2005-11-08 05:16:15 +03:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
2012-05-21 15:12:37 +04:00
|
|
|
/* 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/. */
|
2005-11-08 05:16:15 +03:00
|
|
|
|
2010-06-01 16:38:00 +04:00
|
|
|
#ifndef MOZSTORAGEHELPER_H
|
|
|
|
#define MOZSTORAGEHELPER_H
|
2005-11-08 05:16:15 +03:00
|
|
|
|
2009-05-13 01:08:49 +04:00
|
|
|
#include "nsAutoPtr.h"
|
|
|
|
|
2005-11-08 05:16:15 +03:00
|
|
|
#include "mozIStorageConnection.h"
|
2008-10-14 02:45:40 +04:00
|
|
|
#include "mozIStorageStatement.h"
|
2012-07-27 18:03:27 +04:00
|
|
|
#include "nsError.h"
|
2005-11-08 05:16:15 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This class wraps a transaction inside a given C++ scope, guaranteeing that
|
|
|
|
* the transaction will be completed even if you have an exception or
|
|
|
|
* return early.
|
|
|
|
*
|
|
|
|
* aCommitOnComplete controls whether the transaction is committed or rolled
|
|
|
|
* back when it goes out of scope. A common use is to create an instance with
|
|
|
|
* commitOnComplete = FALSE (rollback), then call Commit on this object manually
|
|
|
|
* when your function completes successfully.
|
|
|
|
*
|
|
|
|
* Note that nested transactions are not supported by sqlite, so if a transaction
|
|
|
|
* is already in progress, this object does nothing. Note that in this case,
|
|
|
|
* you may not get the transaction type you ask for, and you won't be able
|
|
|
|
* to rollback.
|
|
|
|
*/
|
|
|
|
class mozStorageTransaction
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
mozStorageTransaction(mozIStorageConnection* aConnection,
|
2011-09-29 10:19:26 +04:00
|
|
|
bool aCommitOnComplete,
|
2012-08-22 19:56:38 +04:00
|
|
|
int32_t aType = mozIStorageConnection::TRANSACTION_DEFERRED)
|
2005-11-08 05:16:15 +03:00
|
|
|
: mConnection(aConnection),
|
2011-10-17 18:59:28 +04:00
|
|
|
mHasTransaction(false),
|
2005-11-08 05:16:15 +03:00
|
|
|
mCommitOnComplete(aCommitOnComplete),
|
2011-10-17 18:59:28 +04:00
|
|
|
mCompleted(false)
|
2005-11-08 05:16:15 +03:00
|
|
|
{
|
2008-10-25 00:50:01 +04:00
|
|
|
// We won't try to get a transaction if one is already in progress.
|
|
|
|
if (mConnection)
|
|
|
|
mHasTransaction = NS_SUCCEEDED(mConnection->BeginTransactionAs(aType));
|
2005-11-08 05:16:15 +03:00
|
|
|
}
|
|
|
|
~mozStorageTransaction()
|
|
|
|
{
|
2007-06-14 08:58:52 +04:00
|
|
|
if (mConnection && mHasTransaction && ! mCompleted) {
|
2005-11-08 05:16:15 +03:00
|
|
|
if (mCommitOnComplete)
|
|
|
|
mConnection->CommitTransaction();
|
|
|
|
else
|
|
|
|
mConnection->RollbackTransaction();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Commits the transaction if one is in progress. If one is not in progress,
|
|
|
|
* this is a NOP since the actual owner of the transaction outside of our
|
|
|
|
* scope is in charge of finally comitting or rolling back the transaction.
|
|
|
|
*/
|
|
|
|
nsresult Commit()
|
|
|
|
{
|
2007-06-14 08:58:52 +04:00
|
|
|
if (!mConnection || mCompleted)
|
|
|
|
return NS_OK; // no connection, or already done
|
2011-10-17 18:59:28 +04:00
|
|
|
mCompleted = true;
|
2005-11-08 05:16:15 +03:00
|
|
|
if (! mHasTransaction)
|
|
|
|
return NS_OK; // transaction not ours, ignore
|
2009-05-13 20:53:57 +04:00
|
|
|
nsresult rv = mConnection->CommitTransaction();
|
|
|
|
if (NS_SUCCEEDED(rv))
|
2011-10-17 18:59:28 +04:00
|
|
|
mHasTransaction = false;
|
2009-05-13 20:53:57 +04:00
|
|
|
|
|
|
|
return rv;
|
2005-11-08 05:16:15 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Rolls back the transaction in progress. You should only call this function
|
|
|
|
* if this object has a real transaction (HasTransaction() = true) because
|
|
|
|
* otherwise, there is no transaction to roll back.
|
|
|
|
*/
|
|
|
|
nsresult Rollback()
|
|
|
|
{
|
2007-06-14 08:58:52 +04:00
|
|
|
if (!mConnection || mCompleted)
|
|
|
|
return NS_OK; // no connection, or already done
|
2011-10-17 18:59:28 +04:00
|
|
|
mCompleted = true;
|
2005-11-08 05:16:15 +03:00
|
|
|
if (! mHasTransaction)
|
|
|
|
return NS_ERROR_FAILURE;
|
2008-12-09 01:14:14 +03:00
|
|
|
|
|
|
|
// It is possible that a rollback will return busy, so we busy wait...
|
|
|
|
nsresult rv = NS_OK;
|
|
|
|
do {
|
|
|
|
rv = mConnection->RollbackTransaction();
|
|
|
|
if (rv == NS_ERROR_STORAGE_BUSY)
|
|
|
|
(void)PR_Sleep(PR_INTERVAL_NO_WAIT);
|
|
|
|
} while (rv == NS_ERROR_STORAGE_BUSY);
|
|
|
|
|
2009-05-13 20:53:57 +04:00
|
|
|
if (NS_SUCCEEDED(rv))
|
2011-10-17 18:59:28 +04:00
|
|
|
mHasTransaction = false;
|
2009-05-13 20:53:57 +04:00
|
|
|
|
2008-12-09 01:14:14 +03:00
|
|
|
return rv;
|
2005-11-08 05:16:15 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns whether this object wraps a real transaction. False means that
|
|
|
|
* this object doesn't do anything because there was already a transaction in
|
|
|
|
* progress when it was created.
|
|
|
|
*/
|
2011-09-29 10:19:26 +04:00
|
|
|
bool HasTransaction()
|
2005-11-08 05:16:15 +03:00
|
|
|
{
|
|
|
|
return mHasTransaction;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This sets the default action (commit or rollback) when this object goes
|
|
|
|
* out of scope.
|
|
|
|
*/
|
2011-09-29 10:19:26 +04:00
|
|
|
void SetDefaultAction(bool aCommitOnComplete)
|
2005-11-08 05:16:15 +03:00
|
|
|
{
|
|
|
|
mCommitOnComplete = aCommitOnComplete;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
nsCOMPtr<mozIStorageConnection> mConnection;
|
2011-09-29 10:19:26 +04:00
|
|
|
bool mHasTransaction;
|
|
|
|
bool mCommitOnComplete;
|
|
|
|
bool mCompleted;
|
2005-11-08 05:16:15 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This class wraps a statement so that it is guaraneed to be reset when
|
|
|
|
* this object goes out of scope.
|
|
|
|
*
|
|
|
|
* Note that this always just resets the statement. If the statement doesn't
|
|
|
|
* need resetting, the reset operation is inexpensive.
|
|
|
|
*/
|
2008-07-01 05:03:29 +04:00
|
|
|
class NS_STACK_CLASS mozStorageStatementScoper
|
2005-11-08 05:16:15 +03:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
mozStorageStatementScoper(mozIStorageStatement* aStatement)
|
|
|
|
: mStatement(aStatement)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
~mozStorageStatementScoper()
|
|
|
|
{
|
|
|
|
if (mStatement)
|
|
|
|
mStatement->Reset();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Call this to make the statement not reset. You might do this if you know
|
|
|
|
* that the statement has been reset.
|
|
|
|
*/
|
|
|
|
void Abandon()
|
|
|
|
{
|
2012-07-30 18:20:58 +04:00
|
|
|
mStatement = nullptr;
|
2005-11-08 05:16:15 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
nsCOMPtr<mozIStorageStatement> mStatement;
|
|
|
|
};
|
|
|
|
|
2012-01-06 03:46:35 +04:00
|
|
|
// Use this to make queries uniquely identifiable in telemetry
|
|
|
|
// statistics, especially PRAGMAs. We don't include __LINE__ so that
|
|
|
|
// queries are stable in the face of source code changes.
|
|
|
|
#define MOZ_STORAGE_UNIQUIFY_QUERY_STR "/* " __FILE__ " */ "
|
|
|
|
|
2010-06-01 16:38:00 +04:00
|
|
|
#endif /* MOZSTORAGEHELPER_H */
|