Split openDatabase() between front and back end work.
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / DatabaseManager.h
1 /*
2  * Copyright (C) 2012 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DatabaseManager_h
27 #define DatabaseManager_h
28
29 #if ENABLE(SQL_DATABASE)
30
31 #include "DatabaseBasicTypes.h"
32 #include "DatabaseDetails.h"
33 #include "DatabaseError.h"
34 #include <wtf/Assertions.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/Threading.h>
38
39 namespace WebCore {
40
41 class AbstractDatabaseServer;
42 class Database;
43 class DatabaseBackend;
44 class DatabaseCallback;
45 class DatabaseContext;
46 class DatabaseManagerClient;
47 class DatabaseSync;
48 class DatabaseTaskSynchronizer;
49 class SecurityOrigin;
50 class ScriptExecutionContext;
51
52 class DatabaseManager {
53     WTF_MAKE_NONCOPYABLE(DatabaseManager); WTF_MAKE_FAST_ALLOCATED;
54 public:
55     static DatabaseManager& manager();
56
57     void initialize(const String& databasePath);
58     void setClient(DatabaseManagerClient*);
59     String databaseDirectoryPath() const;
60     void setDatabaseDirectoryPath(const String&);
61
62     bool isAvailable();
63     void setIsAvailable(bool);
64
65     // This gets a DatabaseContext for the specified ScriptExecutionContext.
66     // If one doesn't already exist, it will create a new one.
67     PassRefPtr<DatabaseContext> databaseContextFor(ScriptExecutionContext*);
68
69     // These 2 methods are for DatabaseContext (un)registration, and should only
70     // be called by the DatabaseContext constructor and destructor.
71     void registerDatabaseContext(DatabaseContext*);
72     void unregisterDatabaseContext(DatabaseContext*);
73
74 #if !ASSERT_DISABLED
75     void didConstructDatabaseContext();
76     void didDestructDatabaseContext();
77 #else
78     void didConstructDatabaseContext() { }
79     void didDestructDatabaseContext() { }
80 #endif
81
82     static ExceptionCode exceptionCodeForDatabaseError(DatabaseError);
83
84     PassRefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, DatabaseError&);
85     PassRefPtr<DatabaseSync> openDatabaseSync(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, DatabaseError&);
86
87     bool hasOpenDatabases(ScriptExecutionContext*);
88     void stopDatabases(ScriptExecutionContext*, DatabaseTaskSynchronizer*);
89
90     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
91
92 #if !PLATFORM(CHROMIUM)
93     bool hasEntryForOrigin(SecurityOrigin*);
94     void origins(Vector<RefPtr<SecurityOrigin> >& result);
95     bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result);
96     DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*);
97
98     unsigned long long usageForOrigin(SecurityOrigin*);
99     unsigned long long quotaForOrigin(SecurityOrigin*);
100
101     void setQuota(SecurityOrigin*, unsigned long long);
102
103     void deleteAllDatabases();
104     bool deleteOrigin(SecurityOrigin*);
105     bool deleteDatabase(SecurityOrigin*, const String& name);
106
107     // From a secondary thread, must be thread safe with its data
108     void scheduleNotifyDatabaseChanged(SecurityOrigin*, const String& name);
109
110     void databaseChanged(DatabaseBackend*);
111
112 #else // PLATFORM(CHROMIUM)
113     void closeDatabasesImmediately(const String& originIdentifier, const String& name);
114 #endif // PLATFORM(CHROMIUM)
115
116     void interruptAllDatabasesForContext(ScriptExecutionContext*);
117
118     unsigned long long getMaxSizeForDatabase(const DatabaseBackend*);
119
120 private:
121     DatabaseManager();
122     ~DatabaseManager() { }
123
124     // This gets a DatabaseContext for the specified ScriptExecutionContext if
125     // it already exist previously. Otherwise, it returns 0.
126     PassRefPtr<DatabaseContext> existingDatabaseContextFor(ScriptExecutionContext*);
127
128     PassRefPtr<DatabaseBackend> openDatabaseBackend(ScriptExecutionContext*,
129         DatabaseType, const String& name, const String& expectedVersion, const String& displayName,
130         unsigned long estimatedSize, bool setVersionInNewDatabase, DatabaseError&, String& errorMessage);
131
132     static void logErrorMessage(ScriptExecutionContext*, const String& message);
133
134     AbstractDatabaseServer* m_server;
135     DatabaseManagerClient* m_client;
136     bool m_databaseIsAvailable;
137
138     // Access to the following fields require locking m_contextMapLock:
139     typedef HashMap<ScriptExecutionContext*, DatabaseContext*> ContextMap;
140     ContextMap m_contextMap;
141 #if !ASSERT_DISABLED
142     int m_databaseContextRegisteredCount;
143     int m_databaseContextInstanceCount;
144 #endif
145     Mutex m_contextMapLock;
146 };
147
148 } // namespace WebCore
149
150 #endif // ENABLE(SQL_DATABASE)
151
152 #endif // DatabaseManager_h