Unreviewed, roll out http://trac.webkit.org/changeset/187972.
[WebKit-https.git] / Source / WebKit2 / DatabaseProcess / IndexedDB / UniqueIDBDatabase.h
1 /*
2  * Copyright (C) 2013 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef UniqueIDBDatabase_h
27 #define UniqueIDBDatabase_h
28
29 #if ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)
30
31 #include "AsyncRequest.h"
32 #include "IDBIdentifier.h"
33 #include "UniqueIDBDatabaseIdentifier.h"
34 #include <WebCore/IDBDatabaseBackend.h>
35 #include <WebCore/IndexedDB.h>
36 #include <functional>
37 #include <wtf/Deque.h>
38 #include <wtf/HashSet.h>
39 #include <wtf/PassRefPtr.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace IPC {
44 class DataReference;
45 }
46
47 namespace WebCore {
48 class SharedBuffer;
49
50 struct IDBDatabaseMetadata;
51 struct IDBGetResult;
52 struct IDBKeyData;
53 struct IDBKeyRangeData;
54 }
55
56 namespace WebKit {
57
58 class AsyncTask;
59 class DatabaseProcessIDBConnection;
60 class UniqueIDBDatabaseBackingStore;
61
62 struct SecurityOriginData;
63
64 enum class UniqueIDBDatabaseShutdownType {
65     NormalShutdown,
66     DeleteShutdown
67 };
68
69 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
70 public:
71     static Ref<UniqueIDBDatabase> create(const UniqueIDBDatabaseIdentifier& identifier)
72     {
73         return adoptRef(*new UniqueIDBDatabase(identifier));
74     }
75
76     ~UniqueIDBDatabase();
77
78     static String calculateAbsoluteDatabaseFilename(const String& absoluteDatabaseDirectory);
79
80     const UniqueIDBDatabaseIdentifier& identifier() const { return m_identifier; }
81
82     void registerConnection(DatabaseProcessIDBConnection&);
83     void unregisterConnection(DatabaseProcessIDBConnection&);
84
85     void deleteDatabase(std::function<void (bool)> successCallback);
86
87     void getOrEstablishIDBDatabaseMetadata(std::function<void (bool, const WebCore::IDBDatabaseMetadata&)> completionCallback);
88
89     void openTransaction(const IDBIdentifier& transactionIdentifier, const Vector<int64_t>& objectStoreIDs, WebCore::IndexedDB::TransactionMode, std::function<void (bool)> successCallback);
90     void beginTransaction(const IDBIdentifier& transactionIdentifier, std::function<void (bool)> successCallback);
91     void commitTransaction(const IDBIdentifier& transactionIdentifier, std::function<void (bool)> successCallback);
92     void resetTransaction(const IDBIdentifier& transactionIdentifier, std::function<void (bool)> successCallback);
93     void rollbackTransaction(const IDBIdentifier& transactionIdentifier, std::function<void (bool)> successCallback);
94
95     void changeDatabaseVersion(const IDBIdentifier& transactionIdentifier, uint64_t newVersion, std::function<void (bool)> successCallback);
96     void createObjectStore(const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&, std::function<void (bool)> successCallback);
97     void deleteObjectStore(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, std::function<void (bool)> successCallback);
98     void clearObjectStore(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, std::function<void (bool)> successCallback);
99     void createIndex(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBIndexMetadata&, std::function<void (bool)> successCallback);
100     void deleteIndex(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, std::function<void (bool)> successCallback);
101
102     void putRecord(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBKeyData&, const IPC::DataReference& value, int64_t putMode, const Vector<int64_t>& indexIDs, const Vector<Vector<WebCore::IDBKeyData>>& indexKeys, std::function<void (const WebCore::IDBKeyData&, uint32_t, const String&)> callback);
103     void getRecord(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, const WebCore::IDBKeyRangeData&, WebCore::IndexedDB::CursorType, std::function<void (const WebCore::IDBGetResult&, uint32_t, const String&)> callback);
104
105     void openCursor(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, WebCore::IndexedDB::CursorDirection, WebCore::IndexedDB::CursorType, WebCore::IDBDatabaseBackend::TaskType, const WebCore::IDBKeyRangeData&, std::function<void (int64_t, const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, PassRefPtr<WebCore::SharedBuffer>, uint32_t, const String&)> callback);
106     void cursorAdvance(const IDBIdentifier& cursorIdentifier, uint64_t count, std::function<void (const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, PassRefPtr<WebCore::SharedBuffer>, uint32_t, const String&)> callback);
107     void cursorIterate(const IDBIdentifier& cursorIdentifier, const WebCore::IDBKeyData&, std::function<void (const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, PassRefPtr<WebCore::SharedBuffer>, uint32_t, const String&)> callback);
108
109     void count(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, const WebCore::IDBKeyRangeData&, std::function<void (int64_t, uint32_t, const String&)> callback);
110     void deleteRange(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBKeyRangeData&, std::function<void (uint32_t, const String&)> callback);
111
112 private:
113     UniqueIDBDatabase(const UniqueIDBDatabaseIdentifier&);
114
115     UniqueIDBDatabaseIdentifier m_identifier;
116
117     bool m_inMemory;
118     String m_databaseRelativeDirectory;
119
120     HashSet<RefPtr<DatabaseProcessIDBConnection>> m_connections;
121     HashMap<uint64_t, RefPtr<AsyncRequest>> m_databaseRequests;
122
123     String absoluteDatabaseDirectory() const;
124
125     enum class DatabaseTaskType {
126         Normal,
127         Shutdown
128     };
129     void postDatabaseTask(std::unique_ptr<AsyncTask>, DatabaseTaskType = DatabaseTaskType::Normal);
130
131     void shutdown(UniqueIDBDatabaseShutdownType);
132
133     // Method that attempts to make legal filenames from all legal database names
134     String filenameForDatabaseName() const;
135
136     // Returns a string that is appropriate for use as a unique filename
137     String databaseFilenameIdentifier(const SecurityOriginData&) const;
138
139     // Returns true if this origin can use the same databases as the given origin.
140     bool canShareDatabases(const SecurityOriginData&, const SecurityOriginData&) const;
141
142     void postTransactionOperation(const IDBIdentifier& transactionIdentifier, std::unique_ptr<AsyncTask>, std::function<void (bool)> successCallback);
143     
144     // To be called from the database workqueue thread only
145     void performNextDatabaseTask();
146     void postMainThreadTask(std::unique_ptr<AsyncTask>, DatabaseTaskType = DatabaseTaskType::Normal);
147     void openBackingStoreAndReadMetadata(const UniqueIDBDatabaseIdentifier&, const String& databaseDirectory);
148     void openBackingStoreTransaction(const IDBIdentifier& transactionIdentifier, const Vector<int64_t>& objectStoreIDs, WebCore::IndexedDB::TransactionMode);
149     void beginBackingStoreTransaction(const IDBIdentifier&);
150     void commitBackingStoreTransaction(const IDBIdentifier&);
151     void resetBackingStoreTransaction(const IDBIdentifier&);
152     void rollbackBackingStoreTransaction(const IDBIdentifier&);
153
154     void changeDatabaseVersionInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, uint64_t newVersion);
155     void createObjectStoreInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&);
156     void deleteObjectStoreInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID);
157     void clearObjectStoreInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID);
158
159     void createIndexInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBIndexMetadata&);
160     void deleteIndexInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID);
161
162     void putRecordInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&, const WebCore::IDBKeyData&, const Vector<uint8_t>& value, int64_t putMode, const Vector<int64_t>& indexIDs, const Vector<Vector<WebCore::IDBKeyData>>& indexKeys);
163     void getRecordFromBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&, int64_t indexID, const WebCore::IDBKeyRangeData&, WebCore::IndexedDB::CursorType);
164     void openCursorInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, WebCore::IndexedDB::CursorDirection, WebCore::IndexedDB::CursorType, WebCore::IDBDatabaseBackend::TaskType, const WebCore::IDBKeyRangeData&);
165     void advanceCursorInBackingStore(uint64_t requestID, const IDBIdentifier& cursorIdentifier, uint64_t count);
166     void iterateCursorInBackingStore(uint64_t requestID, const IDBIdentifier& cursorIdentifier, const WebCore::IDBKeyData&);
167     void countInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, const WebCore::IDBKeyRangeData&);
168     void deleteRangeInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBKeyRangeData&);
169
170     void shutdownBackingStore(UniqueIDBDatabaseShutdownType, const String& databaseDirectory);
171
172     // Callbacks from the database workqueue thread, to be performed on the main thread only
173     bool performNextMainThreadTask();
174     void didOpenBackingStoreAndReadMetadata(const WebCore::IDBDatabaseMetadata&, bool success);
175     void didCompleteTransactionOperation(const IDBIdentifier& transactionIdentifier, bool success);
176     void didChangeDatabaseVersion(uint64_t requestID, bool success);
177     void didCreateObjectStore(uint64_t requestID, bool success);
178     void didDeleteObjectStore(uint64_t requestID, bool success);
179     void didClearObjectStore(uint64_t requestID, bool success);
180     void didCreateIndex(uint64_t requestID, bool success);
181     void didDeleteIndex(uint64_t requestID, bool success);
182     void didPutRecordInBackingStore(uint64_t requestID, const WebCore::IDBKeyData&, uint32_t errorCode, const String& errorMessage);
183     void didGetRecordFromBackingStore(uint64_t requestID, const WebCore::IDBGetResult&, uint32_t errorCode, const String& errorMessage);
184     void didOpenCursorInBackingStore(uint64_t requestID, int64_t cursorID, const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, const Vector<uint8_t>&, uint32_t errorCode, const String& errorMessage);
185     void didAdvanceCursorInBackingStore(uint64_t requestID, const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, const Vector<uint8_t>&, uint32_t errorCode, const String& errorMessage);
186     void didIterateCursorInBackingStore(uint64_t requestID, const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, const Vector<uint8_t>&, uint32_t errorCode, const String& errorMessage);
187     void didCountInBackingStore(uint64_t requestID, int64_t count, uint32_t errorCode, const String& errorMessage);
188     void didDeleteRangeInBackingStore(uint64_t requestID, uint32_t errorCode, const String& errorMessage);
189
190     void didShutdownBackingStore(UniqueIDBDatabaseShutdownType);
191     void didCompleteBoolRequest(uint64_t requestID, bool success);
192
193     void didEstablishTransaction(const IDBIdentifier& transactionIdentifier, bool success);
194     void didResetTransaction(const IDBIdentifier& transactionIdentifier, bool success);
195     void resetAllTransactions(const DatabaseProcessIDBConnection&);
196     void finalizeRollback(const IDBIdentifier& transactionId);
197
198     bool m_acceptingNewRequests;
199
200     HashMap<const DatabaseProcessIDBConnection*, HashSet<IDBIdentifier>> m_establishedTransactions;
201     Deque<RefPtr<AsyncRequest>> m_pendingMetadataRequests;
202     HashMap<IDBIdentifier, RefPtr<AsyncRequest>> m_pendingTransactionRequests;
203     HashSet<IDBIdentifier> m_pendingTransactionRollbacks;
204     AsyncRequestMap m_pendingDatabaseTasks;
205     RefPtr<AsyncRequest> m_pendingShutdownTask;
206
207     std::unique_ptr<WebCore::IDBDatabaseMetadata> m_metadata;
208     bool m_didGetMetadataFromBackingStore;
209
210     RefPtr<UniqueIDBDatabaseBackingStore> m_backingStore;
211
212     Deque<std::unique_ptr<AsyncTask>> m_databaseTasks;
213     Mutex m_databaseTaskMutex;
214
215     Deque<std::unique_ptr<AsyncTask>> m_mainThreadTasks;
216     Mutex m_mainThreadTaskMutex;
217 };
218
219 } // namespace WebKit
220
221 #endif // ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)
222 #endif // UniqueIDBDatabase_h