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