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