Initial refactoring of database functionality into the manager and server.
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / AbstractDatabase.h
1 /*
2  * Copyright (C) 2011 Google 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 AbstractDatabase_h
30 #define AbstractDatabase_h
31
32 #if ENABLE(SQL_DATABASE)
33
34 #include "DatabaseBasicTypes.h"
35 #include "SQLiteDatabase.h"
36 #include <wtf/Forward.h>
37 #include <wtf/ThreadSafeRefCounted.h>
38 #include <wtf/text/WTFString.h>
39
40 #if !LOG_DISABLED || !ERROR_DISABLED
41 #include "SecurityOrigin.h"
42 #endif
43
44 namespace WebCore {
45
46 class DatabaseAuthorizer;
47 class DatabaseContext;
48 class ScriptExecutionContext;
49 class SecurityOrigin;
50
51 class AbstractDatabase : public ThreadSafeRefCounted<AbstractDatabase> {
52 public:
53     virtual ~AbstractDatabase();
54
55     virtual String version() const;
56
57     bool opened() const { return m_opened; }
58     bool isNew() const { return m_new; }
59     bool isSyncDatabase() const { return m_isSyncDatabase; }
60
61     virtual ScriptExecutionContext* scriptExecutionContext() const;
62     virtual SecurityOrigin* securityOrigin() const;
63     virtual String stringIdentifier() const;
64     virtual String displayName() const;
65     virtual unsigned long estimatedSize() const;
66     virtual String fileName() const;
67     SQLiteDatabase& sqliteDatabase() { return m_sqliteDatabase; }
68
69     unsigned long long maximumSize() const;
70     void incrementalVacuumIfNeeded();
71     void interrupt();
72     bool isInterrupted();
73
74     void disableAuthorizer();
75     void enableAuthorizer();
76     void setAuthorizerReadOnly();
77     void setAuthorizerPermissions(int permissions);
78     bool lastActionChangedDatabase();
79     bool lastActionWasInsert();
80     void resetDeletes();
81     bool hadDeletes();
82     void resetAuthorizer();
83
84     virtual void markAsDeletedAndClose() = 0;
85     virtual void closeImmediately() = 0;
86
87     DatabaseContext* databaseContext() const { return m_databaseContext; }
88
89 protected:
90     friend class ChangeVersionWrapper;
91     friend class SQLStatement;
92     friend class SQLStatementSync;
93     friend class SQLTransactionSync;
94     friend class SQLTransaction;
95
96     enum DatabaseType {
97         AsyncDatabase,
98         SyncDatabase
99     };
100
101     AbstractDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion,
102                      const String& displayName, unsigned long estimatedSize, DatabaseType);
103
104     void closeDatabase();
105
106     virtual bool performOpenAndVerify(bool shouldSetVersionInNewDatabase, ExceptionCode&, String& errorMessage);
107
108     bool getVersionFromDatabase(String& version, bool shouldCacheVersion = true);
109     bool setVersionInDatabase(const String& version, bool shouldCacheVersion = true);
110     void setExpectedVersion(const String&);
111     const String& expectedVersion() const { return m_expectedVersion; }
112     String getCachedVersion()const;
113     void setCachedVersion(const String&);
114     bool getActualVersionForTransaction(String& version);
115
116     void logErrorMessage(const String& message);
117
118     void reportOpenDatabaseResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
119     void reportChangeVersionResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
120     void reportStartTransactionResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
121     void reportCommitTransactionResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
122     void reportExecuteStatementResult(int errorSite, int webSqlErrorCode, int sqliteErrorCode);
123     void reportVacuumDatabaseResult(int sqliteErrorCode);
124
125     static const char* databaseInfoTableName();
126
127     RefPtr<SecurityOrigin> m_contextThreadSecurityOrigin;
128     RefPtr<ScriptExecutionContext> m_scriptExecutionContext;
129     DatabaseContext* m_databaseContext; // Owned by m_scriptExecutionContext.
130
131     String m_name;
132     String m_expectedVersion;
133     String m_displayName;
134     unsigned long m_estimatedSize;
135     String m_filename;
136
137 #if !LOG_DISABLED || !ERROR_DISABLED
138     String databaseDebugName() const { return m_contextThreadSecurityOrigin->toString() + "::" + m_name; }
139 #endif
140
141 private:
142     DatabaseGuid m_guid;
143     bool m_opened;
144     bool m_new;
145     const bool m_isSyncDatabase;
146
147     SQLiteDatabase m_sqliteDatabase;
148
149     RefPtr<DatabaseAuthorizer> m_databaseAuthorizer;
150 };
151
152 } // namespace WebCore
153
154 #endif // ENABLE(SQL_DATABASE)
155
156 #endif // AbstractDatabase_h