Initial refactoring of database functionality into the manager and server.
[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/PassRefPtr.h>
34
35 namespace WebCore {
36
37 class AbstractDatabaseServer;
38 class Database;
39 class DatabaseCallback;
40 class DatabaseManagerClient;
41 class DatabaseSync;
42 class DatabaseTaskSynchronizer;
43 class SecurityOrigin;
44 class ScriptExecutionContext;
45
46 class DatabaseManager {
47     WTF_MAKE_NONCOPYABLE(DatabaseManager); WTF_MAKE_FAST_ALLOCATED;
48 public:
49     static DatabaseManager& manager();
50
51     void initialize(const String& databasePath);
52     void setClient(DatabaseManagerClient*);
53     String databaseDirectoryPath() const;
54     void setDatabaseDirectoryPath(const String&);
55
56     bool isAvailable();
57     void setIsAvailable(bool);
58
59     PassRefPtr<Database> openDatabase(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
60     PassRefPtr<DatabaseSync> openDatabaseSync(ScriptExecutionContext*, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
61
62     bool hasOpenDatabases(ScriptExecutionContext*);
63     void setHasOpenDatabases(ScriptExecutionContext*);
64     void stopDatabases(ScriptExecutionContext*, DatabaseTaskSynchronizer*);
65
66     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
67
68 #if !PLATFORM(CHROMIUM)
69     bool hasEntryForOrigin(SecurityOrigin*);
70     void origins(Vector<RefPtr<SecurityOrigin> >& result);
71     bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result);
72     DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*);
73
74     unsigned long long usageForOrigin(SecurityOrigin*);
75     unsigned long long quotaForOrigin(SecurityOrigin*);
76
77     void setQuota(SecurityOrigin*, unsigned long long);
78
79     void deleteAllDatabases();
80     bool deleteOrigin(SecurityOrigin*);
81     bool deleteDatabase(SecurityOrigin*, const String& name);
82
83     // From a secondary thread, must be thread safe with its data
84     void scheduleNotifyDatabaseChanged(SecurityOrigin*, const String& name);
85
86     void databaseChanged(AbstractDatabase*);
87
88 #else // PLATFORM(CHROMIUM)
89     void closeDatabasesImmediately(const String& originIdentifier, const String& name);
90 #endif // PLATFORM(CHROMIUM)
91
92     void interruptAllDatabasesForContext(const ScriptExecutionContext*);
93
94     bool canEstablishDatabase(ScriptExecutionContext*, const String& name, const String& displayName, unsigned long estimatedSize);
95     void addOpenDatabase(AbstractDatabase*);
96     void removeOpenDatabase(AbstractDatabase*);
97
98     void setDatabaseDetails(SecurityOrigin*, const String& name, const String& displayName, unsigned long estimatedSize);
99     unsigned long long getMaxSizeForDatabase(const AbstractDatabase*);
100
101 private:
102     DatabaseManager();
103     ~DatabaseManager() { }
104
105     AbstractDatabaseServer* m_server;
106     DatabaseManagerClient* m_client;
107     bool m_databaseIsAvailable;
108 };
109
110 } // namespace WebCore
111
112 #endif // ENABLE(SQL_DATABASE)
113
114 #endif // DatabaseManager_h