IndexedDB 2.0: Encapsulate cursor iteration parameters for easy future expansion.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / client / IDBConnectionToServer.h
1 /*
2  * Copyright (C) 2015, 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 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBConnectionProxy.h"
31 #include "IDBConnectionToServerDelegate.h"
32 #include "IDBResourceIdentifier.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/Ref.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36
37 namespace WebCore {
38
39 class IDBCursorInfo;
40 class IDBDatabase;
41 class IDBError;
42 class IDBObjectStoreInfo;
43 class IDBResultData;
44 class IDBValue;
45 class SecurityOrigin;
46
47 struct IDBGetAllRecordsData;
48 struct IDBGetRecordData;
49 struct IDBIterateCursorData;
50
51 namespace IDBClient {
52
53 class IDBConnectionToServer : public ThreadSafeRefCounted<IDBConnectionToServer> {
54 public:
55     WEBCORE_EXPORT static Ref<IDBConnectionToServer> create(IDBConnectionToServerDelegate&);
56
57     uint64_t identifier() const;
58
59     IDBConnectionProxy& proxy();
60
61     void deleteDatabase(const IDBRequestData&);
62     WEBCORE_EXPORT void didDeleteDatabase(const IDBResultData&);
63
64     void openDatabase(const IDBRequestData&);
65     WEBCORE_EXPORT void didOpenDatabase(const IDBResultData&);
66
67     void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
68     WEBCORE_EXPORT void didCreateObjectStore(const IDBResultData&);
69
70     void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
71     WEBCORE_EXPORT void didDeleteObjectStore(const IDBResultData&);
72
73     void renameObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& newName);
74     WEBCORE_EXPORT void didRenameObjectStore(const IDBResultData&);
75
76     void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
77     WEBCORE_EXPORT void didClearObjectStore(const IDBResultData&);
78
79     void createIndex(const IDBRequestData&, const IDBIndexInfo&);
80     WEBCORE_EXPORT void didCreateIndex(const IDBResultData&);
81
82     void deleteIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName);
83     WEBCORE_EXPORT void didDeleteIndex(const IDBResultData&);
84
85     void renameIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
86     WEBCORE_EXPORT void didRenameIndex(const IDBResultData&);
87
88     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, const IndexedDB::ObjectStoreOverwriteMode);
89     WEBCORE_EXPORT void didPutOrAdd(const IDBResultData&);
90
91     void getRecord(const IDBRequestData&, const IDBGetRecordData&);
92     WEBCORE_EXPORT void didGetRecord(const IDBResultData&);
93
94     void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&);
95     WEBCORE_EXPORT void didGetAllRecords(const IDBResultData&);
96
97     void getCount(const IDBRequestData&, const IDBKeyRangeData&);
98     WEBCORE_EXPORT void didGetCount(const IDBResultData&);
99
100     void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
101     WEBCORE_EXPORT void didDeleteRecord(const IDBResultData&);
102
103     void openCursor(const IDBRequestData&, const IDBCursorInfo&);
104     WEBCORE_EXPORT void didOpenCursor(const IDBResultData&);
105
106     void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&);
107     WEBCORE_EXPORT void didIterateCursor(const IDBResultData&);
108
109     void commitTransaction(const IDBResourceIdentifier& transactionIdentifier);
110     WEBCORE_EXPORT void didCommitTransaction(const IDBResourceIdentifier& transactionIdentifier, const IDBError&);
111
112     void didFinishHandlingVersionChangeTransaction(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier&);
113
114     void abortTransaction(const IDBResourceIdentifier& transactionIdentifier);
115     WEBCORE_EXPORT void didAbortTransaction(const IDBResourceIdentifier& transactionIdentifier, const IDBError&);
116
117     WEBCORE_EXPORT void fireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier, uint64_t requestedVersion);
118     void didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier);
119
120     WEBCORE_EXPORT void didStartTransaction(const IDBResourceIdentifier& transactionIdentifier, const IDBError&);
121
122     WEBCORE_EXPORT void didCloseFromServer(uint64_t databaseConnectionIdentifier, const IDBError&);
123     void confirmDidCloseFromServer(uint64_t databaseConnectionIdentifier);
124
125     WEBCORE_EXPORT void connectionToServerLost(const IDBError&);
126
127     WEBCORE_EXPORT void notifyOpenDBRequestBlocked(const IDBResourceIdentifier& requestIdentifier, uint64_t oldVersion, uint64_t newVersion);
128     void openDBRequestCancelled(const IDBRequestData&);
129
130     void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&);
131
132     void databaseConnectionClosed(uint64_t databaseConnectionIdentifier);
133
134     // To be used when an IDBOpenDBRequest gets a new database connection, optionally with a
135     // versionchange transaction, but the page is already torn down.
136     void abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier);
137
138     void getAllDatabaseNames(const SecurityOrigin& mainFrameOrigin, const SecurityOrigin& openingOrigin, std::function<void (const Vector<String>&)>);
139     WEBCORE_EXPORT void didGetAllDatabaseNames(uint64_t callbackID, const Vector<String>& databaseNames);
140
141 private:
142     IDBConnectionToServer(IDBConnectionToServerDelegate&);
143
144     Ref<IDBConnectionToServerDelegate> m_delegate;
145
146     HashMap<uint64_t, std::function<void (const Vector<String>&)>> m_getAllDatabaseNamesCallbacks;
147
148     std::unique_ptr<IDBConnectionProxy> m_proxy;
149 };
150
151 } // namespace IDBClient
152 } // namespace WebCore
153
154 #endif // ENABLE(INDEXED_DATABASE)