38a341811049b178ab4bfd44ddd7a7292800b833
[WebKit-https.git] / WebCore / storage / DatabaseTracker.h
1 /*
2  * Copyright (C) 2007, 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef DatabaseTracker_h
30 #define DatabaseTracker_h
31
32 #if ENABLE(DATABASE)
33
34 #include "PlatformString.h"
35
36 #if !PLATFORM(CHROMIUM)
37 #include "DatabaseDetails.h"
38 #include "SQLiteDatabase.h"
39 #include "StringHash.h"
40 #include <wtf/HashMap.h>
41 #include <wtf/HashSet.h>
42 #include <wtf/OwnPtr.h>
43 #endif // !PLATFORM(CHROMIUM)
44
45 namespace WebCore {
46
47 class Database;
48 class ScriptExecutionContext;
49 class SecurityOrigin;
50
51 #if !PLATFORM(CHROMIUM)
52 class DatabaseTrackerClient;
53 class OriginQuotaManager;
54
55 struct SecurityOriginHash;
56 struct SecurityOriginTraits;
57 #endif // !PLATFORM(CHROMIUM)
58
59 class DatabaseTracker : public Noncopyable {
60 public:
61     static DatabaseTracker& tracker();
62     // FIXME: Due to workers having multiple threads in a single process sharing
63     // a DatabaseTracker, this singleton will have to be synchronized or moved
64     // to TLS.
65
66     bool canEstablishDatabase(ScriptExecutionContext*, const String& name, const String& displayName, unsigned long estimatedSize);
67     void setDatabaseDetails(SecurityOrigin*, const String& name, const String& displayName, unsigned long estimatedSize);
68     String fullPathForDatabase(SecurityOrigin*, const String& name, bool createIfDoesNotExist = true);
69
70     void addOpenDatabase(Database*);
71     void removeOpenDatabase(Database*);
72
73     unsigned long long getMaxSizeForDatabase(const Database*);
74
75 private:
76     DatabaseTracker();
77
78 #if !PLATFORM(CHROMIUM)
79 public:
80     void setDatabaseDirectoryPath(const String&);
81     const String& databaseDirectoryPath() const;
82
83     void origins(Vector<RefPtr<SecurityOrigin> >& result);
84     bool databaseNamesForOrigin(SecurityOrigin*, Vector<String>& result);
85
86     DatabaseDetails detailsForNameAndOrigin(const String&, SecurityOrigin*);
87
88     unsigned long long usageForDatabase(const String&, SecurityOrigin*);
89     unsigned long long usageForOrigin(SecurityOrigin*);
90     unsigned long long quotaForOrigin(SecurityOrigin*);
91     void setQuota(SecurityOrigin*, unsigned long long);
92
93     void deleteAllDatabases();
94     void deleteOrigin(SecurityOrigin*);
95     void deleteDatabase(SecurityOrigin*, const String& name);
96
97     void setClient(DatabaseTrackerClient*);
98
99     // From a secondary thread, must be thread safe with its data
100     void scheduleNotifyDatabaseChanged(SecurityOrigin*, const String& name);
101
102     OriginQuotaManager& originQuotaManager();
103
104
105     bool hasEntryForOrigin(SecurityOrigin*);
106
107 private:
108     String trackerDatabasePath() const;
109     void openTrackerDatabase(bool createIfDoesNotExist);
110
111     String originPath(SecurityOrigin*) const;
112
113     bool hasEntryForDatabase(SecurityOrigin*, const String& databaseIdentifier);
114
115     bool addDatabase(SecurityOrigin*, const String& name, const String& path);
116     void populateOrigins();
117
118     bool deleteDatabaseFile(SecurityOrigin*, const String& name);
119
120     SQLiteDatabase m_database;
121
122     typedef HashMap<RefPtr<SecurityOrigin>, unsigned long long, SecurityOriginHash> QuotaMap;
123     Mutex m_quotaMapGuard;
124     mutable OwnPtr<QuotaMap> m_quotaMap;
125
126     typedef HashSet<Database*> DatabaseSet;
127     typedef HashMap<String, DatabaseSet*> DatabaseNameMap;
128     typedef HashMap<RefPtr<SecurityOrigin>, DatabaseNameMap*, SecurityOriginHash> DatabaseOriginMap;
129
130     Mutex m_openDatabaseMapGuard;
131     mutable OwnPtr<DatabaseOriginMap> m_openDatabaseMap;
132
133     OwnPtr<OriginQuotaManager> m_quotaManager;
134
135     String m_databaseDirectoryPath;
136
137     DatabaseTrackerClient* m_client;
138
139     std::pair<SecurityOrigin*, DatabaseDetails>* m_proposedDatabase;
140
141 #ifndef NDEBUG
142     ThreadIdentifier m_thread;
143 #endif
144
145     static void scheduleForNotification();
146     static void notifyDatabasesChanged(void*);
147 #endif // !PLATFORM(CHROMIUM)
148 };
149
150 } // namespace WebCore
151
152 #endif // ENABLE(DATABASE)
153 #endif // DatabaseTracker_h