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