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(DATABASE)
32
33#include "ExceptionCode.h"
34#include "SQLStatement.h"
35#include <wtf/Deque.h>
36#include <wtf/Forward.h>
37#include <wtf/ThreadSafeRefCounted.h>
38#include <wtf/Vector.h>
39
40namespace WebCore {
41
42class Database;
43class SQLError;
44class SQLiteTransaction;
45class SQLStatementCallback;
46class SQLStatementErrorCallback;
47class SQLTransaction;
48class SQLTransactionCallback;
49class SQLTransactionErrorCallback;
50class SQLValue;
51class VoidCallback;
52
53class SQLTransactionWrapper : public ThreadSafeRefCounted<SQLTransactionWrapper> {
54public:
55    virtual ~SQLTransactionWrapper() { }
56    virtual bool performPreflight(SQLTransaction*) = 0;
57    virtual bool performPostflight(SQLTransaction*) = 0;
58
59    virtual SQLError* sqlError() const = 0;
60};
61
62class SQLTransaction : public ThreadSafeRefCounted<SQLTransaction> {
63public:
64    static PassRefPtr<SQLTransaction> create(Database*, PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>,
65                                             PassRefPtr<VoidCallback>, PassRefPtr<SQLTransactionWrapper>, bool readOnly = false);
66
67    ~SQLTransaction();
68
69    void executeSQL(const String& sqlStatement, const Vector<SQLValue>& arguments,
70                    PassRefPtr<SQLStatementCallback>, PassRefPtr<SQLStatementErrorCallback>, ExceptionCode&);
71
72    void lockAcquired();
73    bool performNextStep();
74    void performPendingCallback();
75
76    Database* database() { return m_database.get(); }
77    bool isReadOnly() { return m_readOnly; }
78    void notifyDatabaseThreadIsShuttingDown();
79
80private:
81    SQLTransaction(Database*, PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>,
82                   PassRefPtr<VoidCallback>, PassRefPtr<SQLTransactionWrapper>, bool readOnly);
83
84    typedef void (SQLTransaction::*TransactionStepMethod)();
85    TransactionStepMethod m_nextStep;
86
87    void enqueueStatement(PassRefPtr<SQLStatement>);
88
89    void checkAndHandleClosedOrInterruptedDatabase();
90
91    void acquireLock();
92    void openTransactionAndPreflight();
93    void deliverTransactionCallback();
94    void scheduleToRunStatements();
95    void runStatements();
96    void getNextStatement();
97    bool runCurrentStatement();
98    void handleCurrentStatementError();
99    void deliverStatementCallback();
100    void deliverQuotaIncreaseCallback();
101    void postflightAndCommit();
102    void deliverSuccessCallback();
103    void cleanupAfterSuccessCallback();
104    void handleTransactionError(bool inCallback);
105    void deliverTransactionErrorCallback();
106    void cleanupAfterTransactionErrorCallback();
107
108#if !LOG_DISABLED
109    static const char* debugStepName(TransactionStepMethod);
110#endif
111
112    RefPtr<SQLStatement> m_currentStatement;
113
114    bool m_executeSqlAllowed;
115
116    RefPtr<Database> m_database;
117    RefPtr<SQLTransactionWrapper> m_wrapper;
118    SQLCallbackWrapper<SQLTransactionCallback> m_callbackWrapper;
119    SQLCallbackWrapper<VoidCallback> m_successCallbackWrapper;
120    SQLCallbackWrapper<SQLTransactionErrorCallback> m_errorCallbackWrapper;
121    RefPtr<SQLError> m_transactionError;
122    bool m_shouldRetryCurrentStatement;
123    bool m_modifiedDatabase;
124    bool m_lockAcquired;
125    bool m_readOnly;
126
127    Mutex m_statementMutex;
128    Deque<RefPtr<SQLStatement> > m_statementQueue;
129
130    OwnPtr<SQLiteTransaction> m_sqliteTransaction;
131};
132
133} // namespace WebCore
134
135#endif
136
137#endif // SQLTransaction_h
138