f7b88a27f85cb0cc60520324b7c37bbc24abbbee
[WebKit-https.git] / WebCore / storage / Database.h
1 /*
2  * Copyright (C) 2007, 2008 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
29 #ifndef Database_h
30 #define Database_h
31
32 #if ENABLE(DATABASE)
33 #include "PlatformString.h"
34 #include "SecurityOrigin.h"
35 #include "SQLiteDatabase.h"
36 #include "SQLTransaction.h"
37 #include "StringHash.h"
38 #include "Timer.h"
39 #include "VoidCallback.h"
40
41 #include <wtf/Forward.h>
42 #include <wtf/HashSet.h>
43 #include <wtf/PassRefPtr.h>
44 #include <wtf/RefPtr.h>
45 #include <wtf/Deque.h>
46 #else
47 #include "PlatformString.h"
48 #endif
49
50 #if ENABLE(DATABASE)
51 namespace WebCore {
52
53 class DatabaseAuthorizer;
54 class DatabaseCallback;
55 class DatabaseThread;
56 class ScriptExecutionContext;
57 class SQLResultSet;
58 class SQLTransactionCallback;
59 class SQLTransactionClient;
60 class SQLTransactionCoordinator;
61 class SQLTransactionErrorCallback;
62 class SQLValue;
63
64 typedef int ExceptionCode;
65
66 class Database : public ThreadSafeShared<Database> {
67     friend class DatabaseTransactionTask;
68     friend class SQLStatement;
69     friend class SQLTransaction;
70 public:
71     static void setIsAvailable(bool);
72     static bool isAvailable();
73
74     ~Database();
75
76 // Direct support for the DOM API
77     static PassRefPtr<Database> openDatabase(ScriptExecutionContext* context, const String& name,
78                                              const String& expectedVersion, const String& displayName,
79                                              unsigned long estimatedSize, PassRefPtr<DatabaseCallback> creationCallback,
80                                              ExceptionCode&);
81     String version() const;
82     void changeVersion(const String& oldVersion, const String& newVersion,
83                        PassRefPtr<SQLTransactionCallback> callback, PassRefPtr<SQLTransactionErrorCallback> errorCallback,
84                        PassRefPtr<VoidCallback> successCallback);
85     void transaction(PassRefPtr<SQLTransactionCallback> callback, PassRefPtr<SQLTransactionErrorCallback> errorCallback,
86                      PassRefPtr<VoidCallback> successCallback, bool readOnly);
87
88 // Internal engine support
89     static const String& databaseInfoTableName();
90
91     void disableAuthorizer();
92     void enableAuthorizer();
93     void setAuthorizerReadOnly();
94
95     Vector<String> tableNames();
96
97     ScriptExecutionContext* scriptExecutionContext() const { return m_scriptExecutionContext.get(); }
98     SecurityOrigin* securityOrigin() const;
99     String stringIdentifier() const;
100     String displayName() const;
101     unsigned long estimatedSize() const;
102     String fileName() const;
103
104     bool getVersionFromDatabase(String&);
105     bool setVersionInDatabase(const String&);
106     void setExpectedVersion(const String&);
107     bool versionMatchesExpected() const;
108
109     void markAsDeletedAndClose();
110     bool deleted() const { return m_deleted; }
111
112     enum ClosePolicy { DoNotRemoveDatabaseFromContext, RemoveDatabaseFromContext };
113     void close(ClosePolicy);
114     bool opened() const { return m_opened; }
115
116     void stop();
117     bool stopped() const { return m_stopped; }
118
119     bool isNew() const { return m_new; }
120
121     unsigned long long databaseSize() const;
122     unsigned long long maximumSize() const;
123
124 // Called from DatabaseThread, must be prepared to work on the background thread
125     void resetAuthorizer();
126     void performPolicyChecks();
127
128     bool performOpenAndVerify(ExceptionCode&);
129
130     Vector<String> performGetTableNames();
131     void performCreationCallback();
132
133     SQLTransactionClient* transactionClient() const;
134     SQLTransactionCoordinator* transactionCoordinator() const;
135
136 private:
137     Database(ScriptExecutionContext* context, const String& name,
138              const String& expectedVersion, const String& displayName,
139              unsigned long estimatedSize, PassRefPtr<DatabaseCallback> creationCallback);
140
141     bool openAndVerifyVersion(ExceptionCode&);
142
143     void scheduleTransaction();
144     void scheduleTransactionCallback(SQLTransaction*);
145     void scheduleTransactionStep(SQLTransaction* transaction, bool immediately = false);
146
147     Deque<RefPtr<SQLTransaction> > m_transactionQueue;
148     Mutex m_transactionInProgressMutex;
149     bool m_transactionInProgress;
150     bool m_isTransactionQueueEnabled;
151
152     static void deliverPendingCallback(void*);
153
154     RefPtr<ScriptExecutionContext> m_scriptExecutionContext;
155     RefPtr<SecurityOrigin> m_mainThreadSecurityOrigin;
156     RefPtr<SecurityOrigin> m_databaseThreadSecurityOrigin;
157     String m_name;
158     int m_guid;
159     String m_expectedVersion;
160     String m_displayName;
161     unsigned long m_estimatedSize;
162     String m_filename;
163
164     bool m_deleted;
165
166     bool m_stopped;
167
168     bool m_opened;
169
170     bool m_new;
171
172     SQLiteDatabase m_sqliteDatabase;
173     RefPtr<DatabaseAuthorizer> m_databaseAuthorizer;
174
175     RefPtr<DatabaseCallback> m_creationCallback;
176
177 #ifndef NDEBUG
178     String databaseDebugName() const { return m_mainThreadSecurityOrigin->toString() + "::" + m_name; }
179 #endif
180 };
181
182 } // namespace WebCore
183
184 #else
185
186 namespace WebCore {
187 class Database : public ThreadSafeShared<Database> {
188 public:
189     static const String& databaseInfoTableName();
190 };
191 } // namespace WebCore
192
193 #endif // ENABLE(DATABASE)
194
195 #endif // Database_h