1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
* Copyright (C) 2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "IDBBackingStore.h"
#include "IDBDatabaseIdentifier.h"
#include "IDBDatabaseInfo.h"
#include "IDBDatabaseNameAndVersion.h"
#include "IDBGetResult.h"
#include "ServerOpenDBRequest.h"
#include "UniqueIDBDatabaseTransaction.h"
#include <wtf/CrossThreadQueue.h>
#include <wtf/CrossThreadTask.h>
#include <wtf/Deque.h>
#include <wtf/Function.h>
#include <wtf/HashCountedSet.h>
#include <wtf/HashSet.h>
#include <wtf/ListHashSet.h>
namespace WebCore {
struct ClientOrigin;
class IDBError;
class IDBGetAllResult;
struct IDBGetRecordData;
class IDBRequestData;
class IDBTransactionInfo;
enum class IDBGetRecordDataType : bool;
namespace IndexedDB {
enum class IndexRecordType : bool;
}
namespace IDBServer {
class IDBConnectionToClient;
class UniqueIDBDatabaseConnection;
class UniqueIDBDatabaseManager;
typedef Function<void(const IDBError&)> ErrorCallback;
typedef Function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
typedef Function<void(const IDBError&, const IDBGetResult&)> GetResultCallback;
typedef Function<void(const IDBError&, const IDBGetAllResult&)> GetAllResultsCallback;
typedef Function<void(const IDBError&, uint64_t)> CountCallback;
class UniqueIDBDatabase : public CanMakeWeakPtr<UniqueIDBDatabase> {
WTF_MAKE_FAST_ALLOCATED;
public:
WEBCORE_EXPORT UniqueIDBDatabase(UniqueIDBDatabaseManager&, const IDBDatabaseIdentifier&);
UniqueIDBDatabase(UniqueIDBDatabase&) = delete;
WEBCORE_EXPORT ~UniqueIDBDatabase();
WEBCORE_EXPORT void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
const IDBDatabaseInfo& info() const;
UniqueIDBDatabaseManager* manager();
const IDBDatabaseIdentifier& identifier() const { return m_identifier; }
enum class SpaceCheckResult : uint8_t {
Unknown,
Pass,
Fail
};
void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void deleteObjectStore(UniqueIDBDatabaseTransaction&, const String& objectStoreName, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void renameObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& newName, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void clearObjectStore(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void createIndex(UniqueIDBDatabaseTransaction&, const IDBIndexInfo&, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void deleteIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, const String& indexName, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void renameIndex(UniqueIDBDatabaseTransaction&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
void putOrAddAfterSpaceCheck(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback, bool isKeyGenerated, const IndexIDToIndexKeyMap&, const IDBObjectStoreInfo&, SpaceCheckResult);
void getRecord(const IDBRequestData&, const IDBGetRecordData&, GetResultCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&, GetAllResultsCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void getCount(const IDBRequestData&, const IDBKeyRangeData&, CountCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void openCursor(const IDBRequestData&, const IDBCursorInfo&, GetResultCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&, GetResultCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback, SpaceCheckResult = SpaceCheckResult::Unknown);
void didFinishHandlingVersionChange(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& transactionIdentifier);
void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
void didFireVersionChangeEvent(UniqueIDBDatabaseConnection&, const IDBResourceIdentifier& requestIdentifier, IndexedDB::ConnectionClosedOnBehalfOfServer);
WEBCORE_EXPORT void openDBRequestCancelled(const IDBResourceIdentifier& requestIdentifier);
void enqueueTransaction(Ref<UniqueIDBDatabaseTransaction>&&);
WEBCORE_EXPORT void handleDelete(IDBConnectionToClient&, const IDBRequestData&);
WEBCORE_EXPORT void immediateClose();
bool hasActiveTransactions() const;
WEBCORE_EXPORT void abortActiveTransactions();
WEBCORE_EXPORT bool tryClose();
WEBCORE_EXPORT String filePath() const;
WEBCORE_EXPORT std::optional<IDBDatabaseNameAndVersion> nameAndVersion() const;
WEBCORE_EXPORT bool hasDataInMemory() const;
WEBCORE_EXPORT void handleLowMemoryWarning();
private:
void handleDatabaseOperations();
void handleCurrentOperation();
void performCurrentOpenOperation();
void performCurrentOpenOperationAfterSpaceCheck(bool isGranted);
void performCurrentDeleteOperation();
enum class RequestType { Delete, Any };
RefPtr<ServerOpenDBRequest> takeNextRunnableRequest(RequestType = RequestType::Any);
void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
bool hasAnyOpenConnections() const;
bool allConnectionsAreClosedOrClosing() const;
void startVersionChangeTransaction();
void maybeNotifyConnectionsOfVersionChange();
void notifyCurrentRequestConnectionClosedOrFiredVersionChangeEvent(uint64_t connectionIdentifier);
void handleTransactions();
RefPtr<UniqueIDBDatabaseTransaction> takeNextRunnableTransaction(bool& hadDeferredTransactions);
void activateTransactionInBackingStore(UniqueIDBDatabaseTransaction&);
void transactionCompleted(RefPtr<UniqueIDBDatabaseTransaction>&&);
void connectionClosedFromServer(UniqueIDBDatabaseConnection&);
void deleteBackingStore();
void didDeleteBackingStore(uint64_t deletedVersion);
void close();
bool isCurrentlyInUse() const;
void clearStalePendingOpenDBRequests();
void clearTransactionsOnConnection(UniqueIDBDatabaseConnection&);
IDBServer* m_server;
WeakPtr<UniqueIDBDatabaseManager> m_manager;
IDBDatabaseIdentifier m_identifier;
ListHashSet<RefPtr<ServerOpenDBRequest>> m_pendingOpenDBRequests;
RefPtr<ServerOpenDBRequest> m_currentOpenDBRequest;
HashSet<IDBResourceIdentifier> m_openDBRequestsForSpaceCheck;
ListHashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
RefPtr<UniqueIDBDatabaseTransaction> m_versionChangeTransaction;
std::unique_ptr<IDBBackingStore> m_backingStore;
std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
std::unique_ptr<IDBDatabaseInfo> m_mostRecentDeletedDatabaseInfo;
Deque<RefPtr<UniqueIDBDatabaseTransaction>> m_pendingTransactions;
HashMap<IDBResourceIdentifier, RefPtr<UniqueIDBDatabaseTransaction>> m_inProgressTransactions;
// The keys into these sets are the object store ID.
// These sets help to decide which transactions can be started and which must be deferred.
HashCountedSet<uint64_t> m_objectStoreTransactionCounts;
HashSet<uint64_t> m_objectStoreWriteTransactions;
HashSet<IDBResourceIdentifier> m_cursorPrefetches;
};
} // namespace IDBServer
} // namespace WebCore
|
