Source/WebCore/storage/SQLTransaction.h

   1 /*
   2  * Copyright (C) 2007 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28 #ifndef SQLTransaction_h
  29 #define SQLTransaction_h
  30
  31 #if ENABLE(SQL_DATABASE)
  32
  33 #include "SQLStatement.h"
  34 #include <wtf/Deque.h>
  35 #include <wtf/Forward.h>
  36 #include <wtf/ThreadSafeRefCounted.h>
  37 #include <wtf/Vector.h>
  38
  39 namespace WebCore {
  40
  41 class Database;
  42 class SQLError;
  43 class SQLiteTransaction;
  44 class SQLStatementCallback;
  45 class SQLStatementErrorCallback;
  46 class SQLTransaction;
  47 class SQLTransactionCallback;
  48 class SQLTransactionErrorCallback;
  49 class SQLValue;
  50 class VoidCallback;
  51
  52 typedef int ExceptionCode;
  53
  54 class SQLTransactionWrapper : public ThreadSafeRefCounted<SQLTransactionWrapper> {
  55 public:
  56     virtual ~SQLTransactionWrapper() { }
  57     virtual bool performPreflight(SQLTransaction*) = 0;
  58     virtual bool performPostflight(SQLTransaction*) = 0;
  59     virtual SQLError* sqlError() const = 0;
  60     virtual void handleCommitFailedAfterPostflight(SQLTransaction*) = 0;
  61 };
  62
  63 class SQLTransaction : public ThreadSafeRefCounted<SQLTransaction> {
  64 public:
  65     static PassRefPtr<SQLTransaction> create(Database*, PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>,
  66                                              PassRefPtr<VoidCallback>, PassRefPtr<SQLTransactionWrapper>, bool readOnly = false);
  67
  68     ~SQLTransaction();
  69
  70     void executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments,
  71                     PassRefPtr<SQLStatementCallback>, PassRefPtr<SQLStatementErrorCallback>, ExceptionCode&);
  72
  73     void lockAcquired();
  74     bool performNextStep();
  75     void performPendingCallback();
  76
  77     Database* database() { return m_database.get(); }
  78     bool isReadOnly() { return m_readOnly; }
  79     void notifyDatabaseThreadIsShuttingDown();
  80
  81 private:
  82     SQLTransaction(Database*, PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>,
  83                    PassRefPtr<VoidCallback>, PassRefPtr<SQLTransactionWrapper>, bool readOnly);
  84
  85     typedef void (SQLTransaction::*TransactionStepMethod)();
  86     TransactionStepMethod m_nextStep;
  87
  88     void enqueueStatement(PassRefPtr<SQLStatement>);
  89
  90     void checkAndHandleClosedOrInterruptedDatabase();
  91
  92     void acquireLock();
  93     void openTransactionAndPreflight();
  94     void deliverTransactionCallback();
  95     void scheduleToRunStatements();
  96     void runStatements();
  97     void getNextStatement();
  98     bool runCurrentStatement();
  99     void handleCurrentStatementError();
 100     void deliverStatementCallback();
 101     void deliverQuotaIncreaseCallback();
 102     void postflightAndCommit();
 103     void deliverSuccessCallback();
 104     void cleanupAfterSuccessCallback();
 105     void handleTransactionError(bool inCallback);
 106     void deliverTransactionErrorCallback();
 107     void cleanupAfterTransactionErrorCallback();
 108
 109 #if !ENABLE(TIZEN_LOG)
 110 #if !LOG_DISABLED
 111     static const char* debugStepName(TransactionStepMethod);
 112 #endif
 113 #else
 114     static const char* debugStepName(TransactionStepMethod);
 115 #endif
 116
 117     RefPtr<SQLStatement> m_currentStatement;
 118
 119     bool m_executeSqlAllowed;
 120
 121     RefPtr<Database> m_database;
 122     RefPtr<SQLTransactionWrapper> m_wrapper;
 123     SQLCallbackWrapper<SQLTransactionCallback> m_callbackWrapper;
 124     SQLCallbackWrapper<VoidCallback> m_successCallbackWrapper;
 125     SQLCallbackWrapper<SQLTransactionErrorCallback> m_errorCallbackWrapper;
 126     RefPtr<SQLError> m_transactionError;
 127     bool m_shouldRetryCurrentStatement;
 128     bool m_modifiedDatabase;
 129     bool m_lockAcquired;
 130     bool m_readOnly;
 131     bool m_hasVersionMismatch;
 132
 133     Mutex m_statementMutex;
 134     Deque<RefPtr<SQLStatement> > m_statementQueue;
 135
 136     OwnPtr<SQLiteTransaction> m_sqliteTransaction;
 137 };
 138
 139 } // namespace WebCore
 140
 141 #endif
 142
 143 #endif // SQLTransaction_h