Refactor data passed along for a "GetRecord" request.
[WebKit-https.git] / Source / WebKit2 / WebProcess / Databases / IndexedDB / WebIDBConnectionToServer.cpp
1 /*
2  * Copyright (C) 2016 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 #include "config.h"
27 #include "WebIDBConnectionToServer.h"
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "DataReference.h"
32 #include "DatabaseToWebProcessConnectionMessages.h"
33 #include "NetworkConnectionToWebProcessMessages.h"
34 #include "NetworkProcessConnection.h"
35 #include "WebIDBConnectionToClientMessages.h"
36 #include "WebIDBResult.h"
37 #include "WebProcess.h"
38 #include "WebToDatabaseProcessConnection.h"
39 #include <WebCore/IDBConnectionToServer.h>
40 #include <WebCore/IDBCursorInfo.h>
41 #include <WebCore/IDBDatabaseException.h>
42 #include <WebCore/IDBError.h>
43 #include <WebCore/IDBIndexInfo.h>
44 #include <WebCore/IDBKeyRangeData.h>
45 #include <WebCore/IDBObjectStoreInfo.h>
46 #include <WebCore/IDBOpenDBRequest.h>
47 #include <WebCore/IDBRequestData.h>
48 #include <WebCore/IDBResourceIdentifier.h>
49 #include <WebCore/IDBResultData.h>
50 #include <WebCore/IDBTransactionInfo.h>
51 #include <WebCore/IDBValue.h>
52
53 using namespace WebCore;
54
55 namespace WebKit {
56
57 Ref<WebIDBConnectionToServer> WebIDBConnectionToServer::create()
58 {
59     return adoptRef(*new WebIDBConnectionToServer);
60 }
61
62 WebIDBConnectionToServer::WebIDBConnectionToServer()
63 {
64     relaxAdoptionRequirement();
65
66     m_isOpenInServer = sendSync(Messages::DatabaseToWebProcessConnection::EstablishIDBConnectionToServer(), m_identifier);
67     m_connectionToServer = IDBClient::IDBConnectionToServer::create(*this);
68 }
69
70 WebIDBConnectionToServer::~WebIDBConnectionToServer()
71 {
72     if (m_isOpenInServer)
73         send(Messages::DatabaseToWebProcessConnection::RemoveIDBConnectionToServer(m_identifier));
74 }
75
76 IPC::Connection* WebIDBConnectionToServer::messageSenderConnection()
77 {
78     return &WebProcess::singleton().webToDatabaseProcessConnection()->connection();
79 }
80
81 IDBClient::IDBConnectionToServer& WebIDBConnectionToServer::coreConnectionToServer()
82 {
83     return *m_connectionToServer;
84 }
85
86 void WebIDBConnectionToServer::deleteDatabase(const IDBRequestData& requestData)
87 {
88     send(Messages::WebIDBConnectionToClient::DeleteDatabase(requestData));
89 }
90
91 void WebIDBConnectionToServer::openDatabase(const IDBRequestData& requestData)
92 {
93     send(Messages::WebIDBConnectionToClient::OpenDatabase(requestData));
94 }
95
96 void WebIDBConnectionToServer::abortTransaction(const IDBResourceIdentifier& transactionIdentifier)
97 {
98     send(Messages::WebIDBConnectionToClient::AbortTransaction(transactionIdentifier));
99 }
100
101 void WebIDBConnectionToServer::commitTransaction(const IDBResourceIdentifier& transactionIdentifier)
102 {
103     send(Messages::WebIDBConnectionToClient::CommitTransaction(transactionIdentifier));
104 }
105
106 void WebIDBConnectionToServer::didFinishHandlingVersionChangeTransaction(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier)
107 {
108     send(Messages::WebIDBConnectionToClient::DidFinishHandlingVersionChangeTransaction(databaseConnectionIdentifier, transactionIdentifier));
109 }
110
111 void WebIDBConnectionToServer::createObjectStore(const IDBRequestData& requestData, const IDBObjectStoreInfo& info)
112 {
113     send(Messages::WebIDBConnectionToClient::CreateObjectStore(requestData, info));
114 }
115
116 void WebIDBConnectionToServer::deleteObjectStore(const IDBRequestData& requestData, const String& objectStoreName)
117 {
118     send(Messages::WebIDBConnectionToClient::DeleteObjectStore(requestData, objectStoreName));
119 }
120
121 void WebIDBConnectionToServer::clearObjectStore(const IDBRequestData& requestData, uint64_t objectStoreIdentifier)
122 {
123     send(Messages::WebIDBConnectionToClient::ClearObjectStore(requestData, objectStoreIdentifier));
124 }
125
126 void WebIDBConnectionToServer::createIndex(const IDBRequestData& requestData, const IDBIndexInfo& info)
127 {
128     send(Messages::WebIDBConnectionToClient::CreateIndex(requestData, info));
129 }
130
131 void WebIDBConnectionToServer::deleteIndex(const IDBRequestData& requestData, uint64_t objectStoreIdentifier, const String& indexName)
132 {
133     send(Messages::WebIDBConnectionToClient::DeleteIndex(requestData, objectStoreIdentifier, indexName));
134 }
135
136 void WebIDBConnectionToServer::putOrAdd(const IDBRequestData& requestData, const IDBKeyData& keyData, const IDBValue& value, const IndexedDB::ObjectStoreOverwriteMode mode)
137 {
138     send(Messages::WebIDBConnectionToClient::PutOrAdd(requestData, keyData, value, static_cast<unsigned>(mode)));
139 }
140
141 void WebIDBConnectionToServer::getRecord(const IDBRequestData& requestData, const IDBGetRecordData& getRecordData)
142 {
143     send(Messages::WebIDBConnectionToClient::GetRecord(requestData, getRecordData));
144 }
145
146 void WebIDBConnectionToServer::getCount(const IDBRequestData& requestData, const IDBKeyRangeData& range)
147 {
148     send(Messages::WebIDBConnectionToClient::GetCount(requestData, range));
149 }
150
151 void WebIDBConnectionToServer::deleteRecord(const IDBRequestData& requestData, const IDBKeyRangeData& range)
152 {
153     send(Messages::WebIDBConnectionToClient::DeleteRecord(requestData, range));
154 }
155
156 void WebIDBConnectionToServer::openCursor(const IDBRequestData& requestData, const IDBCursorInfo& info)
157 {
158     send(Messages::WebIDBConnectionToClient::OpenCursor(requestData, info));
159 }
160
161 void WebIDBConnectionToServer::iterateCursor(const IDBRequestData& requestData, const IDBKeyData& key, unsigned long count)
162 {
163     send(Messages::WebIDBConnectionToClient::IterateCursor(requestData, key, count));
164 }
165
166 void WebIDBConnectionToServer::establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo& info)
167 {
168     send(Messages::WebIDBConnectionToClient::EstablishTransaction(databaseConnectionIdentifier, info));
169 }
170
171 void WebIDBConnectionToServer::databaseConnectionClosed(uint64_t databaseConnectionIdentifier)
172 {
173     send(Messages::WebIDBConnectionToClient::DatabaseConnectionClosed(databaseConnectionIdentifier));
174 }
175
176 void WebIDBConnectionToServer::abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier)
177 {
178     send(Messages::WebIDBConnectionToClient::AbortOpenAndUpgradeNeeded(databaseConnectionIdentifier, transactionIdentifier));
179 }
180
181 void WebIDBConnectionToServer::didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier)
182 {
183     send(Messages::WebIDBConnectionToClient::DidFireVersionChangeEvent(databaseConnectionIdentifier, requestIdentifier));
184 }
185
186 void WebIDBConnectionToServer::openDBRequestCancelled(const IDBRequestData& requestData)
187 {
188     send(Messages::WebIDBConnectionToClient::OpenDBRequestCancelled(requestData));
189 }
190
191 void WebIDBConnectionToServer::confirmDidCloseFromServer(uint64_t databaseConnectionIdentifier)
192 {
193     send(Messages::WebIDBConnectionToClient::ConfirmDidCloseFromServer(databaseConnectionIdentifier));
194 }
195
196 void WebIDBConnectionToServer::getAllDatabaseNames(const WebCore::SecurityOriginData& topOrigin, const WebCore::SecurityOriginData& openingOrigin, uint64_t callbackID)
197 {
198     send(Messages::WebIDBConnectionToClient::GetAllDatabaseNames(m_identifier, topOrigin, openingOrigin, callbackID));
199 }
200
201 void WebIDBConnectionToServer::didDeleteDatabase(const IDBResultData& result)
202 {
203     m_connectionToServer->didDeleteDatabase(result);
204 }
205
206 void WebIDBConnectionToServer::didOpenDatabase(const IDBResultData& result)
207 {
208     m_connectionToServer->didOpenDatabase(result);
209 }
210
211 void WebIDBConnectionToServer::didAbortTransaction(const IDBResourceIdentifier& transactionIdentifier, const IDBError& error)
212 {
213     m_connectionToServer->didAbortTransaction(transactionIdentifier, error);
214 }
215
216 void WebIDBConnectionToServer::didCommitTransaction(const IDBResourceIdentifier& transactionIdentifier, const IDBError& error)
217 {
218     m_connectionToServer->didCommitTransaction(transactionIdentifier, error);
219 }
220
221 void WebIDBConnectionToServer::didCreateObjectStore(const IDBResultData& result)
222 {
223     m_connectionToServer->didCreateObjectStore(result);
224 }
225
226 void WebIDBConnectionToServer::didDeleteObjectStore(const IDBResultData& result)
227 {
228     m_connectionToServer->didDeleteObjectStore(result);
229 }
230
231 void WebIDBConnectionToServer::didClearObjectStore(const IDBResultData& result)
232 {
233     m_connectionToServer->didClearObjectStore(result);
234 }
235
236 void WebIDBConnectionToServer::didCreateIndex(const IDBResultData& result)
237 {
238     m_connectionToServer->didCreateIndex(result);
239 }
240
241 void WebIDBConnectionToServer::didDeleteIndex(const IDBResultData& result)
242 {
243     m_connectionToServer->didDeleteIndex(result);
244 }
245
246 void WebIDBConnectionToServer::didPutOrAdd(const IDBResultData& result)
247 {
248     m_connectionToServer->didPutOrAdd(result);
249 }
250
251 static void preregisterSandboxExtensionsIfNecessary(const WebIDBResult& result)
252 {
253     auto resultType = result.resultData().type();
254     if (resultType != IDBResultType::GetRecordSuccess && resultType != IDBResultType::OpenCursorSuccess && resultType != IDBResultType::IterateCursorSuccess) {
255         ASSERT(resultType == IDBResultType::Error);
256         return;
257     }
258
259     const auto& filePaths = result.resultData().getResult().value().blobFilePaths();
260
261 #if ENABLE(SANDBOX_EXTENSIONS)
262     ASSERT(filePaths.size() == result.handles().size());
263 #endif
264
265     if (!filePaths.isEmpty())
266         WebProcess::singleton().networkConnection().connection().send(Messages::NetworkConnectionToWebProcess::PreregisterSandboxExtensionsForOptionallyFileBackedBlob(filePaths, result.handles()), 0);
267 }
268
269 void WebIDBConnectionToServer::didGetRecord(const WebIDBResult& result)
270 {
271     preregisterSandboxExtensionsIfNecessary(result);
272     m_connectionToServer->didGetRecord(result.resultData());
273 }
274
275 void WebIDBConnectionToServer::didGetCount(const IDBResultData& result)
276 {
277     m_connectionToServer->didGetCount(result);
278 }
279
280 void WebIDBConnectionToServer::didDeleteRecord(const IDBResultData& result)
281 {
282     m_connectionToServer->didDeleteRecord(result);
283 }
284
285 void WebIDBConnectionToServer::didOpenCursor(const WebIDBResult& result)
286 {
287     preregisterSandboxExtensionsIfNecessary(result);
288     m_connectionToServer->didOpenCursor(result.resultData());
289 }
290
291 void WebIDBConnectionToServer::didIterateCursor(const WebIDBResult& result)
292 {
293     preregisterSandboxExtensionsIfNecessary(result);
294     m_connectionToServer->didIterateCursor(result.resultData());
295 }
296
297 void WebIDBConnectionToServer::fireVersionChangeEvent(uint64_t uniqueDatabaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier, uint64_t requestedVersion)
298 {
299     m_connectionToServer->fireVersionChangeEvent(uniqueDatabaseConnectionIdentifier, requestIdentifier, requestedVersion);
300 }
301
302 void WebIDBConnectionToServer::didStartTransaction(const IDBResourceIdentifier& transactionIdentifier, const IDBError& error)
303 {
304     m_connectionToServer->didStartTransaction(transactionIdentifier, error);
305 }
306
307 void WebIDBConnectionToServer::didCloseFromServer(uint64_t databaseConnectionIdentifier, const IDBError& error)
308 {
309     m_connectionToServer->didCloseFromServer(databaseConnectionIdentifier, error);
310 }
311
312 void WebIDBConnectionToServer::notifyOpenDBRequestBlocked(const IDBResourceIdentifier& requestIdentifier, uint64_t oldVersion, uint64_t newVersion)
313 {
314     m_connectionToServer->notifyOpenDBRequestBlocked(requestIdentifier, oldVersion, newVersion);
315 }
316
317 void WebIDBConnectionToServer::didGetAllDatabaseNames(uint64_t callbackID, const Vector<String>& databaseNames)
318 {
319     m_connectionToServer->didGetAllDatabaseNames(callbackID, databaseNames);
320 }
321
322 void WebIDBConnectionToServer::connectionToServerLost()
323 {
324     m_connectionToServer->connectionToServerLost({ WebCore::IDBDatabaseException::UnknownError, ASCIILiteral("An internal error was encountered in the Indexed Database server") });
325 }
326
327 } // namespace WebKit
328
329 #endif // ENABLE(INDEXED_DATABASE)