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