12b430e33b9491c29c336fb411aa75d4503d42ac
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / 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(SQL_DATABASE)
33
34 #include "AbstractDatabase.h"
35 #include "PlatformString.h"
36
37 #include <wtf/Deque.h>
38 #include <wtf/Forward.h>
39
40 namespace WebCore {
41
42 class DatabaseCallback;
43 class ScriptExecutionContext;
44 class SecurityOrigin;
45 class SQLTransaction;
46 class SQLTransactionCallback;
47 class SQLTransactionClient;
48 class SQLTransactionCoordinator;
49 class SQLTransactionErrorCallback;
50 class SQLTransactionWrapper;
51 class VoidCallback;
52
53 typedef int ExceptionCode;
54
55 class Database : public AbstractDatabase {
56 public:
57     virtual ~Database();
58
59     // Direct support for the DOM API
60     static PassRefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName,
61                                              unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
62     virtual String version() const;
63     void changeVersion(const String& oldVersion, const String& newVersion, PassRefPtr<SQLTransactionCallback>,
64                        PassRefPtr<SQLTransactionErrorCallback>, PassRefPtr<VoidCallback> successCallback);
65     void transaction(PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>, PassRefPtr<VoidCallback> successCallback);
66     void readTransaction(PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>, PassRefPtr<VoidCallback> successCallback);
67
68     // Internal engine support
69     Vector<String> tableNames();
70
71     virtual SecurityOrigin* securityOrigin() const;
72
73     virtual void markAsDeletedAndClose();
74     bool deleted() const { return m_deleted; }
75
76     void close();
77     virtual void closeImmediately();
78
79     unsigned long long databaseSize() const;
80     unsigned long long maximumSize() const;
81
82     void scheduleTransactionCallback(SQLTransaction*);
83     void scheduleTransactionStep(SQLTransaction*, bool immediately = false);
84
85     SQLTransactionClient* transactionClient() const;
86     SQLTransactionCoordinator* transactionCoordinator() const;
87
88 private:
89     class DatabaseOpenTask;
90     class DatabaseCloseTask;
91     class DatabaseTransactionTask;
92     class DatabaseTableNamesTask;
93
94     Database(ScriptExecutionContext*, const String& name, const String& expectedVersion,
95              const String& displayName, unsigned long estimatedSize);
96     void runTransaction(PassRefPtr<SQLTransactionCallback>, PassRefPtr<SQLTransactionErrorCallback>,
97                         PassRefPtr<VoidCallback> successCallback, PassRefPtr<SQLTransactionWrapper>, bool readOnly);
98
99     bool openAndVerifyVersion(bool setVersionInNewDatabase, ExceptionCode&, String& errorMessage);
100     virtual bool performOpenAndVerify(bool setVersionInNewDatabase, ExceptionCode&, String& errorMessage);
101
102     void inProgressTransactionCompleted();
103     void scheduleTransaction();
104
105     Vector<String> performGetTableNames();
106
107     static void deliverPendingCallback(void*);
108
109     Deque<RefPtr<SQLTransaction> > m_transactionQueue;
110     Mutex m_transactionInProgressMutex;
111     bool m_transactionInProgress;
112     bool m_isTransactionQueueEnabled;
113
114     RefPtr<SecurityOrigin> m_databaseThreadSecurityOrigin;
115
116     bool m_deleted;
117 };
118
119 } // namespace WebCore
120
121 #endif // ENABLE(SQL_DATABASE)
122
123 #endif // Database_h