58b97b68710aaba45d2dccd9ec0116aa2d9c14d2
[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 "IDBIdentifier.h"
32 #include "UniqueIDBDatabaseIdentifier.h"
33 #include <WebCore/IDBDatabaseBackend.h>
34 #include <WebCore/IndexedDB.h>
35 #include <functional>
36 #include <wtf/Deque.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace WebCore {
43 class SharedBuffer;
44
45 struct IDBDatabaseMetadata;
46 struct IDBKeyData;
47 }
48
49 namespace WebKit {
50
51 class AsyncRequest;
52 class AsyncTask;
53 class DatabaseProcessIDBConnection;
54 class UniqueIDBDatabaseBackingStore;
55
56 struct SecurityOriginData;
57
58 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
59 public:
60     static PassRefPtr<UniqueIDBDatabase> create(const UniqueIDBDatabaseIdentifier& identifier)
61     {
62         return adoptRef(new UniqueIDBDatabase(identifier));
63     }
64
65     ~UniqueIDBDatabase();
66
67     const UniqueIDBDatabaseIdentifier& identifier() const { return m_identifier; }
68
69     void registerConnection(DatabaseProcessIDBConnection&);
70     void unregisterConnection(DatabaseProcessIDBConnection&);
71
72     void getOrEstablishIDBDatabaseMetadata(std::function<void(bool, const WebCore::IDBDatabaseMetadata&)> completionCallback);
73
74     void openTransaction(const IDBIdentifier& transactionIdentifier, const Vector<int64_t>& objectStoreIDs, WebCore::IndexedDB::TransactionMode, std::function<void(bool)> successCallback);
75     void beginTransaction(const IDBIdentifier& transactionIdentifier, std::function<void(bool)> successCallback);
76     void commitTransaction(const IDBIdentifier& transactionIdentifier, std::function<void(bool)> successCallback);
77     void resetTransaction(const IDBIdentifier& transactionIdentifier, std::function<void(bool)> successCallback);
78     void rollbackTransaction(const IDBIdentifier& transactionIdentifier, std::function<void(bool)> successCallback);
79
80     void changeDatabaseVersion(const IDBIdentifier& transactionIdentifier, uint64_t newVersion, std::function<void(bool)> successCallback);
81     void createObjectStore(const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&, std::function<void(bool)> successCallback);
82     void deleteObjectStore(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, std::function<void(bool)> successCallback);
83     void clearObjectStore(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, std::function<void(bool)> successCallback);
84     void createIndex(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBIndexMetadata&, std::function<void(bool)> successCallback);
85     void deleteIndex(const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID, std::function<void(bool)> successCallback);
86
87     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);
88     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);
89
90     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, uint32_t, const String&)> callback);
91     void cursorAdvance(const IDBIdentifier& cursorIdentifier, uint64_t count, std::function<void(WebCore::IDBKeyData, WebCore::IDBKeyData, PassRefPtr<WebCore::SharedBuffer>, uint32_t, const String&)> callback);
92     void cursorIterate(const IDBIdentifier& cursorIdentifier, const WebCore::IDBKeyData&, std::function<void(WebCore::IDBKeyData, WebCore::IDBKeyData, PassRefPtr<WebCore::SharedBuffer>, uint32_t, const String&)> callback);
93
94 private:
95     UniqueIDBDatabase(const UniqueIDBDatabaseIdentifier&);
96
97     UniqueIDBDatabaseIdentifier m_identifier;
98
99     bool m_inMemory;
100     String m_databaseRelativeDirectory;
101
102     HashSet<RefPtr<DatabaseProcessIDBConnection>> m_connections;
103     HashMap<uint64_t, RefPtr<AsyncRequest>> m_databaseRequests;
104
105     String absoluteDatabaseDirectory() const;
106
107     void postDatabaseTask(std::unique_ptr<AsyncTask>);
108     void shutdown();
109
110     // Method that attempts to make legal filenames from all legal database names
111     String filenameForDatabaseName() const;
112
113     // Returns a string that is appropriate for use as a unique filename
114     String databaseFilenameIdentifier(const SecurityOriginData&) const;
115
116     // Returns true if this origin can use the same databases as the given origin.
117     bool canShareDatabases(const SecurityOriginData&, const SecurityOriginData&) const;
118
119     void postTransactionOperation(const IDBIdentifier& transactionIdentifier, std::unique_ptr<AsyncTask>, std::function<void(bool)> successCallback);
120     
121     // To be called from the database workqueue thread only
122     void performNextDatabaseTask();
123     void postMainThreadTask(std::unique_ptr<AsyncTask>);
124     void openBackingStoreAndReadMetadata(const UniqueIDBDatabaseIdentifier&, const String& databaseDirectory);
125     void openBackingStoreTransaction(const IDBIdentifier& transactionIdentifier, const Vector<int64_t>& objectStoreIDs, WebCore::IndexedDB::TransactionMode);
126     void beginBackingStoreTransaction(const IDBIdentifier&);
127     void commitBackingStoreTransaction(const IDBIdentifier&);
128     void resetBackingStoreTransaction(const IDBIdentifier&);
129     void rollbackBackingStoreTransaction(const IDBIdentifier&);
130
131     void changeDatabaseVersionInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, uint64_t newVersion);
132     void createObjectStoreInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&);
133     void deleteObjectStoreInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID);
134     void clearObjectStoreInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID);
135     void createIndexInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, const WebCore::IDBIndexMetadata&);
136     void deleteIndexInBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, int64_t objectStoreID, int64_t indexID);
137     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);
138     void getRecordFromBackingStore(uint64_t requestID, const IDBIdentifier& transactionIdentifier, const WebCore::IDBObjectStoreMetadata&, int64_t indexID, const WebCore::IDBKeyRangeData&, WebCore::IndexedDB::CursorType);
139     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&);
140     void advanceCursorInBackingStore(uint64_t requestID, const IDBIdentifier& cursorIdentifier, uint64_t count);
141     void iterateCursorInBackingStore(uint64_t requestID, const IDBIdentifier& cursorIdentifier, const WebCore::IDBKeyData&);
142
143     void shutdownBackingStore();
144
145     // Callbacks from the database workqueue thread, to be performed on the main thread only
146     void performNextMainThreadTask();
147     void didOpenBackingStoreAndReadMetadata(const WebCore::IDBDatabaseMetadata&, bool success);
148     void didCompleteTransactionOperation(const IDBIdentifier& transactionIdentifier, bool success);
149     void didChangeDatabaseVersion(uint64_t requestID, bool success);
150     void didCreateObjectStore(uint64_t requestID, bool success);
151     void didDeleteObjectStore(uint64_t requestID, bool success);
152     void didClearObjectStore(uint64_t requestID, bool success);
153     void didCreateIndex(uint64_t requestID, bool success);
154     void didDeleteIndex(uint64_t requestID, bool success);
155     void didPutRecordInBackingStore(uint64_t requestID, const WebCore::IDBKeyData&, uint32_t errorCode, const String& errorMessage);
156     void didGetRecordFromBackingStore(uint64_t requestID, const WebCore::IDBGetResult&, uint32_t errorCode, const String& errorMessage);
157     void didOpenCursorInBackingStore(uint64_t requestID, int64_t cursorID, uint32_t errorCode, const String& errorMessage);
158     void didAdvanceCursorInBackingStore(uint64_t requestID, const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, const Vector<char>&, uint32_t errorCode, const String& errorMessage);
159     void didIterateCursorInBackingStore(uint64_t requestID, const WebCore::IDBKeyData&, const WebCore::IDBKeyData&, const Vector<char>&, uint32_t errorCode, const String& errorMessage);
160     void didShutdownBackingStore();
161     void didCompleteBoolRequest(uint64_t requestID, bool success);
162
163     bool m_acceptingNewRequests;
164
165     Deque<RefPtr<AsyncRequest>> m_pendingMetadataRequests;
166     HashMap<IDBIdentifier, RefPtr<AsyncRequest>> m_pendingTransactionRequests;
167     HashMap<uint64_t, RefPtr<AsyncRequest>> m_pendingDatabaseTasks;
168
169     std::unique_ptr<WebCore::IDBDatabaseMetadata> m_metadata;
170     bool m_didGetMetadataFromBackingStore;
171
172     RefPtr<UniqueIDBDatabaseBackingStore> m_backingStore;
173
174     Deque<std::unique_ptr<AsyncTask>> m_databaseTasks;
175     Mutex m_databaseTaskMutex;
176
177     Deque<std::unique_ptr<AsyncTask>> m_mainThreadTasks;
178     Mutex m_mainThreadTaskMutex;
179 };
180
181 } // namespace WebKit
182
183 #endif // ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)
184 #endif // UniqueIDBDatabase_h