Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / SQLTransaction.h
1 /*
2  * Copyright (C) 2007, 2013 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 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
29 #pragma once
30
31 #include "ExceptionOr.h"
32 #include "SQLCallbackWrapper.h"
33 #include "SQLTransactionBackend.h"
34 #include "SQLTransactionStateMachine.h"
35 #include "SQLValue.h"
36 #include <wtf/Deque.h>
37 #include <wtf/Lock.h>
38 #include <wtf/Optional.h>
39
40 namespace WebCore {
41
42 class Database;
43 class SQLError;
44 class SQLStatementCallback;
45 class SQLStatementErrorCallback;
46 class SQLTransactionBackend;
47 class SQLTransactionCallback;
48 class SQLTransactionErrorCallback;
49 class VoidCallback;
50
51 class SQLTransactionWrapper : public ThreadSafeRefCounted<SQLTransactionWrapper> {
52 public:
53     virtual ~SQLTransactionWrapper() = default;
54     virtual bool performPreflight(SQLTransaction&) = 0;
55     virtual bool performPostflight(SQLTransaction&) = 0;
56     virtual SQLError* sqlError() const = 0;
57     virtual void handleCommitFailedAfterPostflight(SQLTransaction&) = 0;
58 };
59
60 class SQLTransaction : public ThreadSafeRefCounted<SQLTransaction>, public SQLTransactionStateMachine<SQLTransaction> {
61 public:
62     static Ref<SQLTransaction> create(Ref<Database>&&, RefPtr<SQLTransactionCallback>&&, RefPtr<VoidCallback>&& successCallback, RefPtr<SQLTransactionErrorCallback>&&, RefPtr<SQLTransactionWrapper>&&, bool readOnly);
63     ~SQLTransaction();
64
65     ExceptionOr<void> executeSql(const String& sqlStatement, std::optional<Vector<SQLValue>>&& arguments, RefPtr<SQLStatementCallback>&&, RefPtr<SQLStatementErrorCallback>&&);
66
67     void lockAcquired();
68     void performNextStep();
69     void performPendingCallback();
70
71     Database& database() { return m_database; }
72     bool isReadOnly() const { return m_readOnly; }
73     void notifyDatabaseThreadIsShuttingDown();
74
75     // APIs called from the backend published via SQLTransaction:
76     void requestTransitToState(SQLTransactionState);
77
78 private:
79     friend class SQLTransactionBackend;
80
81     SQLTransaction(Ref<Database>&&, RefPtr<SQLTransactionCallback>&&, RefPtr<VoidCallback>&& successCallback, RefPtr<SQLTransactionErrorCallback>&&, RefPtr<SQLTransactionWrapper>&&, bool readOnly);
82
83     void enqueueStatement(std::unique_ptr<SQLStatement>);
84
85     void checkAndHandleClosedDatabase();
86
87     void clearCallbackWrappers();
88
89     void scheduleCallback(void (SQLTransaction::*)());
90
91     // State Machine functions:
92     StateFunction stateFunctionFor(SQLTransactionState) override;
93     void computeNextStateAndCleanupIfNeeded();
94
95     // State functions:
96     void acquireLock();
97     void openTransactionAndPreflight();
98     void runStatements();
99     void cleanupAndTerminate();
100     void cleanupAfterTransactionErrorCallback();
101     void deliverTransactionCallback();
102     void deliverTransactionErrorCallback();
103     void deliverStatementCallback();
104     void deliverQuotaIncreaseCallback();
105     void deliverSuccessCallback();
106
107     NO_RETURN_DUE_TO_ASSERT void unreachableState();
108
109     void getNextStatement();
110     bool runCurrentStatement();
111     void handleCurrentStatementError();
112     void handleTransactionError();
113     void postflightAndCommit();
114
115     void acquireOriginLock();
116     void releaseOriginLockIfNeeded();
117
118 #if !LOG_DISABLED
119     static const char* debugStepName(void (SQLTransaction::*)());
120 #endif
121
122     Ref<Database> m_database;
123     SQLCallbackWrapper<SQLTransactionCallback> m_callbackWrapper;
124     SQLCallbackWrapper<VoidCallback> m_successCallbackWrapper;
125     SQLCallbackWrapper<SQLTransactionErrorCallback> m_errorCallbackWrapper;
126
127     RefPtr<SQLTransactionWrapper> m_wrapper;
128
129     void (SQLTransaction::*m_nextStep)();
130
131     bool m_executeSqlAllowed { false };
132     RefPtr<SQLError> m_transactionError;
133
134     bool m_shouldRetryCurrentStatement { false };
135     bool m_modifiedDatabase { false };
136     bool m_lockAcquired { false };
137     bool m_readOnly { false };
138     bool m_hasVersionMismatch { false };
139
140     Lock m_statementMutex;
141     Deque<std::unique_ptr<SQLStatement>> m_statementQueue;
142
143     std::unique_ptr<SQLStatement> m_currentStatement;
144
145     std::unique_ptr<SQLiteTransaction> m_sqliteTransaction;
146     RefPtr<OriginLock> m_originLock;
147
148     SQLTransactionBackend m_backend;
149 };
150
151 } // namespace WebCore