Change DatabaseContext lookup to be thread-safe.
[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 "AbstractDatabaseServer.h"
32 #include "DatabaseBasicTypes.h"
33 #include <wtf/Assertions.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/Threading.h>
37
38 namespace WebCore {
39
40 class AbstractDatabaseServer;
41 class Database;
42 class DatabaseCallback;
43 class DatabaseContext;
44 class DatabaseManagerClient;
45 class DatabaseSync;
46 class DatabaseTaskSynchronizer;
47 class SecurityOrigin;
48 class ScriptExecutionContext;
49
50 class DatabaseManager {
51     WTF_MAKE_NONCOPYABLE(DatabaseManager); WTF_MAKE_FAST_ALLOCATED;
52 public:
53     static DatabaseManager& manager();
54
55     void initialize(const String& databasePath);
56     void setClient(DatabaseManagerClient*);
57     String databaseDirectoryPath() const;
58     void setDatabaseDirectoryPath(const String&);
59
60     bool isAvailable();
61     void setIsAvailable(bool);
62
63     // This gets a DatabaseContext for the specified ScriptExecutionContext.
64     // If one doesn't already exist, it will create a new one.
65     PassRefPtr<DatabaseContext> databaseContextFor(ScriptExecutionContext*);
66
67     // These 2 methods are for DatabaseContext (un)registration, and should only
68     // be called by the DatabaseContext constructor and destructor.
69     void registerDatabaseContext(DatabaseContext*);
70     void unregisterDatabaseContext(DatabaseContext*);
71
72 #if !ASSERT_DISABLED
73     void didConstructDatabaseContext();
74     void didDestructDatabaseContext();
75 #else
76     void didConstructDatabaseContext() { }
77     void didDestructDatabaseContext() { }
78 #endif
79
80     PassRefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
81     PassRefPtr<DatabaseSync> openDatabaseSync(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
82
83     bool hasOpenDatabases(ScriptExecutionContext*);
84     void stopDatabases(ScriptExecutionContext*, DatabaseTaskSynchronizer*);
85
86     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
87
88 #if !PLATFORM(CHROMIUM)
89     bool hasEntryForOrigin(SecurityOrigin*);
90     void origins(Vector<RefPtr<SecurityOrigin> >& result);
91     bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result);
92     DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*);
93
94     unsigned long long usageForOrigin(SecurityOrigin*);
95     unsigned long long quotaForOrigin(SecurityOrigin*);
96
97     void setQuota(SecurityOrigin*, unsigned long long);
98
99     void deleteAllDatabases();
100     bool deleteOrigin(SecurityOrigin*);
101     bool deleteDatabase(SecurityOrigin*, const String& name);
102
103     // From a secondary thread, must be thread safe with its data
104     void scheduleNotifyDatabaseChanged(SecurityOrigin*, const String& name);
105
106     void databaseChanged(AbstractDatabase*);
107
108 #else // PLATFORM(CHROMIUM)
109     void closeDatabasesImmediately(const String& originIdentifier, const String& name);
110 #endif // PLATFORM(CHROMIUM)
111
112     void interruptAllDatabasesForContext(ScriptExecutionContext*);
113
114     bool canEstablishDatabase(ScriptExecutionContext*, const String& name, const String& displayName, unsigned long estimatedSize);
115     void addOpenDatabase(AbstractDatabase*);
116     void removeOpenDatabase(AbstractDatabase*);
117
118     void setDatabaseDetails(SecurityOrigin*, const String& name, const String& displayName, unsigned long estimatedSize);
119     unsigned long long getMaxSizeForDatabase(const AbstractDatabase*);
120
121 private:
122     DatabaseManager();
123     ~DatabaseManager() { }
124
125     // This gets a DatabaseContext for the specified ScriptExecutionContext if
126     // it already exist previously. Otherwise, it returns 0.
127     PassRefPtr<DatabaseContext> existingDatabaseContextFor(ScriptExecutionContext*);
128
129     AbstractDatabaseServer* m_server;
130     DatabaseManagerClient* m_client;
131     bool m_databaseIsAvailable;
132
133     // Access to the following fields require locking m_contextMapLock:
134     typedef HashMap<ScriptExecutionContext*, DatabaseContext*> ContextMap;
135     ContextMap m_contextMap;
136 #if !ASSERT_DISABLED
137     int m_databaseContextRegisteredCount;
138     int m_databaseContextInstanceCount;
139 #endif
140     Mutex m_contextMapLock;
141 };
142
143 } // namespace WebCore
144
145 #endif // ENABLE(SQL_DATABASE)
146
147 #endif // DatabaseManager_h