Purge PassRefPtr in Modules/webdatabase
[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 #include "DatabaseBasicTypes.h"
30 #include "DatabaseDetails.h"
31 #include "DatabaseError.h"
32 #include <wtf/Assertions.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/Lock.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     friend class WTF::NeverDestroyed<DatabaseManager>;
53 public:
54     WEBCORE_EXPORT static DatabaseManager& singleton();
55
56     WEBCORE_EXPORT void initialize(const String& databasePath);
57     WEBCORE_EXPORT void setClient(DatabaseManagerClient*);
58     String databaseDirectoryPath() const;
59     void setDatabaseDirectoryPath(const String&);
60
61     bool isAvailable();
62     WEBCORE_EXPORT void setIsAvailable(bool);
63
64     // This gets a DatabaseContext for the specified ScriptExecutionContext.
65     // If one doesn't already exist, it will create a new one.
66     RefPtr<DatabaseContext> databaseContextFor(ScriptExecutionContext*);
67
68     // These 2 methods are for DatabaseContext (un)registration, and should only
69     // be called by the DatabaseContext constructor and destructor.
70     void registerDatabaseContext(DatabaseContext*);
71     void unregisterDatabaseContext(DatabaseContext*);
72
73 #if !ASSERT_DISABLED
74     void didConstructDatabaseContext();
75     void didDestructDatabaseContext();
76 #else
77     void didConstructDatabaseContext() { }
78     void didDestructDatabaseContext() { }
79 #endif
80
81     static ExceptionCode exceptionCodeForDatabaseError(DatabaseError);
82
83     RefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, RefPtr<DatabaseCallback>&&, DatabaseError&);
84
85     WEBCORE_EXPORT bool hasOpenDatabases(ScriptExecutionContext*);
86
87     WEBCORE_EXPORT void closeAllDatabases();
88
89     void stopDatabases(ScriptExecutionContext*, DatabaseTaskSynchronizer*);
90
91     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
92
93     bool hasEntryForOrigin(SecurityOrigin*);
94     WEBCORE_EXPORT void origins(Vector<RefPtr<SecurityOrigin>>& result);
95     WEBCORE_EXPORT bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result);
96     WEBCORE_EXPORT DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*);
97
98     WEBCORE_EXPORT unsigned long long usageForOrigin(SecurityOrigin*);
99     WEBCORE_EXPORT unsigned long long quotaForOrigin(SecurityOrigin*);
100
101     WEBCORE_EXPORT void setQuota(SecurityOrigin*, unsigned long long);
102
103     WEBCORE_EXPORT void deleteAllDatabasesImmediately();
104     WEBCORE_EXPORT bool deleteOrigin(SecurityOrigin*);
105     WEBCORE_EXPORT bool deleteDatabase(SecurityOrigin*, const String& name);
106
107 private:
108     class ProposedDatabase {
109     public:
110         ProposedDatabase(DatabaseManager&, SecurityOrigin*,
111             const String& name, const String& displayName, unsigned long estimatedSize);
112         ~ProposedDatabase();
113
114         SecurityOrigin* origin() { return m_origin.get(); }
115         DatabaseDetails& details() { return m_details; }
116
117     private:
118         DatabaseManager& m_manager;
119         RefPtr<SecurityOrigin> m_origin;
120         DatabaseDetails m_details;
121     };
122
123     DatabaseManager();
124     ~DatabaseManager() = delete;
125
126     // This gets a DatabaseContext for the specified ScriptExecutionContext if
127     // it already exist previously. Otherwise, it returns 0.
128     RefPtr<DatabaseContext> existingDatabaseContextFor(ScriptExecutionContext*);
129
130     RefPtr<Database> openDatabaseBackend(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, bool setVersionInNewDatabase, DatabaseError&, String& errorMessage);
131
132     void addProposedDatabase(ProposedDatabase*);
133     void removeProposedDatabase(ProposedDatabase*);
134
135     static void logErrorMessage(ScriptExecutionContext*, const String& message);
136
137     AbstractDatabaseServer* m_server;
138     DatabaseManagerClient* m_client;
139     bool m_databaseIsAvailable;
140
141     // Access to the following fields require locking m_lock below:
142     typedef HashMap<ScriptExecutionContext*, DatabaseContext*> ContextMap;
143     ContextMap m_contextMap;
144 #if !ASSERT_DISABLED
145     int m_databaseContextRegisteredCount;
146     int m_databaseContextInstanceCount;
147 #endif
148     HashSet<ProposedDatabase*> m_proposedDatabases;
149
150     // This mutex protects m_contextMap, and m_proposedDatabases.
151     Lock m_mutex;
152 };
153
154 } // namespace WebCore
155
156 #endif // DatabaseManager_h