Remove LegacyIDB.
[WebKit-https.git] / Source / WebKit2 / DatabaseProcess / IndexedDB / WebIDBConnectionToClient.h
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 #ifndef WebIDBConnectionToClient_h
27 #define WebIDBConnectionToClient_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "DatabaseToWebProcessConnection.h"
32 #include "MessageSender.h"
33 #include <WebCore/IDBConnectionToClient.h>
34
35 namespace WebCore {
36 class IDBCursorInfo;
37 class IDBIndexInfo;
38 class IDBKeyData;
39 class IDBObjectStoreInfo;
40 class IDBRequestData;
41 class IDBTransactionInfo;
42 class SerializedScriptValue;
43 struct IDBKeyRangeData;
44 }
45
46 namespace WebKit {
47
48 class WebIDBConnectionToClient final : public WebCore::IDBServer::IDBConnectionToClientDelegate, public IPC::MessageSender, public RefCounted<WebIDBConnectionToClient> {
49 public:
50     static Ref<WebIDBConnectionToClient> create(DatabaseToWebProcessConnection&, uint64_t serverConnectionIdentifier);
51
52     virtual ~WebIDBConnectionToClient();
53
54     WebCore::IDBServer::IDBConnectionToClient& connectionToClient();
55     virtual uint64_t identifier() const override final { return m_identifier; }
56     virtual uint64_t messageSenderDestinationID() override final { return m_identifier; }
57
58     // IDBConnectionToClientDelegate
59     virtual void didDeleteDatabase(const WebCore::IDBResultData&) override final;
60     virtual void didOpenDatabase(const WebCore::IDBResultData&) override final;
61     virtual void didAbortTransaction(const WebCore::IDBResourceIdentifier& transactionIdentifier, const WebCore::IDBError&) override final;
62     virtual void didCommitTransaction(const WebCore::IDBResourceIdentifier& transactionIdentifier, const WebCore::IDBError&) override final;
63     virtual void didCreateObjectStore(const WebCore::IDBResultData&) override final;
64     virtual void didDeleteObjectStore(const WebCore::IDBResultData&) override final;
65     virtual void didClearObjectStore(const WebCore::IDBResultData&) override final;
66     virtual void didCreateIndex(const WebCore::IDBResultData&) override final;
67     virtual void didDeleteIndex(const WebCore::IDBResultData&) override final;
68     virtual void didPutOrAdd(const WebCore::IDBResultData&) override final;
69     virtual void didGetRecord(const WebCore::IDBResultData&) override final;
70     virtual void didGetCount(const WebCore::IDBResultData&) override final;
71     virtual void didDeleteRecord(const WebCore::IDBResultData&) override final;
72     virtual void didOpenCursor(const WebCore::IDBResultData&) override final;
73     virtual void didIterateCursor(const WebCore::IDBResultData&) override final;
74
75     virtual void fireVersionChangeEvent(WebCore::IDBServer::UniqueIDBDatabaseConnection&, const WebCore::IDBResourceIdentifier& requestIdentifier, uint64_t requestedVersion) override final;
76     virtual void didStartTransaction(const WebCore::IDBResourceIdentifier& transactionIdentifier, const WebCore::IDBError&) override final;
77     virtual void notifyOpenDBRequestBlocked(const WebCore::IDBResourceIdentifier& requestIdentifier, uint64_t oldVersion, uint64_t newVersion) override final;
78
79     virtual void ref() override { RefCounted<WebIDBConnectionToClient>::ref(); }
80     virtual void deref() override { RefCounted<WebIDBConnectionToClient>::deref(); }
81
82     // Messages received from WebProcess
83     void deleteDatabase(const WebCore::IDBRequestData&);
84     void openDatabase(const WebCore::IDBRequestData&);
85     void abortTransaction(const WebCore::IDBResourceIdentifier&);
86     void commitTransaction(const WebCore::IDBResourceIdentifier&);
87     void didFinishHandlingVersionChangeTransaction(const WebCore::IDBResourceIdentifier&);
88     void createObjectStore(const WebCore::IDBRequestData&, const WebCore::IDBObjectStoreInfo&);
89     void deleteObjectStore(const WebCore::IDBRequestData&, const String& objectStoreName);
90     void clearObjectStore(const WebCore::IDBRequestData&, uint64_t objectStoreIdentifier);
91     void createIndex(const WebCore::IDBRequestData&, const WebCore::IDBIndexInfo&);
92     void deleteIndex(const WebCore::IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName);
93     void putOrAdd(const WebCore::IDBRequestData&, const WebCore::IDBKeyData&, const IPC::DataReference& value, unsigned overwriteMode);
94     void getRecord(const WebCore::IDBRequestData&, const WebCore::IDBKeyRangeData&);
95     void getCount(const WebCore::IDBRequestData&, const WebCore::IDBKeyRangeData&);
96     void deleteRecord(const WebCore::IDBRequestData&, const WebCore::IDBKeyRangeData&);
97     void openCursor(const WebCore::IDBRequestData&, const WebCore::IDBCursorInfo&);
98     void iterateCursor(const WebCore::IDBRequestData&, const WebCore::IDBKeyData&, unsigned long count);
99
100     void establishTransaction(uint64_t databaseConnectionIdentifier, const WebCore::IDBTransactionInfo&);
101     void databaseConnectionClosed(uint64_t databaseConnectionIdentifier);
102     void abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const WebCore::IDBResourceIdentifier& transactionIdentifier);
103     void didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const WebCore::IDBResourceIdentifier& requestIdentifier);
104
105     void disconnectedFromWebProcess();
106
107     void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&);
108
109 private:
110     WebIDBConnectionToClient(DatabaseToWebProcessConnection&, uint64_t serverConnectionIdentifier);
111
112     virtual IPC::Connection* messageSenderConnection() override final;
113
114     Ref<DatabaseToWebProcessConnection> m_connection;
115
116     uint64_t m_identifier;
117     RefPtr<WebCore::IDBServer::IDBConnectionToClient> m_connectionToClient;
118 };
119
120 } // namespace WebKit
121
122 #endif // ENABLE(INDEXED_DATABASE)
123 #endif // WebIDBConnectionToClient_h