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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
* Copyright (C) 2010 Google 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 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 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.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_INDEXEDDB_IDB_DATABASE_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_INDEXEDDB_IDB_DATABASE_H_
#include <memory>
#include "base/memory/scoped_refptr.h"
#include "third_party/blink/public/mojom/feature_observer/feature_observer.mojom-blink.h"
#include "third_party/blink/renderer/bindings/core/v8/active_script_wrappable.h"
#include "third_party/blink/renderer/bindings/core/v8/string_or_string_sequence.h"
#include "third_party/blink/renderer/bindings/modules/v8/v8_idb_object_store_parameters.h"
#include "third_party/blink/renderer/bindings/modules/v8/v8_idb_transaction_options.h"
#include "third_party/blink/renderer/core/dom/dom_string_list.h"
#include "third_party/blink/renderer/core/execution_context/execution_context_lifecycle_observer.h"
#include "third_party/blink/renderer/modules/event_modules.h"
#include "third_party/blink/renderer/modules/event_target_modules.h"
#include "third_party/blink/renderer/modules/indexeddb/idb_database_callbacks.h"
#include "third_party/blink/renderer/modules/indexeddb/idb_metadata.h"
#include "third_party/blink/renderer/modules/indexeddb/idb_object_store.h"
#include "third_party/blink/renderer/modules/indexeddb/idb_transaction.h"
#include "third_party/blink/renderer/modules/indexeddb/indexed_db.h"
#include "third_party/blink/renderer/modules/indexeddb/web_idb_database.h"
#include "third_party/blink/renderer/modules/indexeddb/web_idb_database_callbacks.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/bindings/script_state.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
#include "third_party/blink/renderer/platform/scheduler/public/frame_or_worker_scheduler.h"
namespace blink {
class DOMException;
class ExceptionState;
class ExecutionContext;
class IDBObservation;
class IDBObserver;
class MODULES_EXPORT IDBDatabase final
: public EventTargetWithInlineData,
public ActiveScriptWrappable<IDBDatabase>,
public ExecutionContextLifecycleObserver {
USING_GARBAGE_COLLECTED_MIXIN(IDBDatabase);
DEFINE_WRAPPERTYPEINFO();
public:
IDBDatabase(
ExecutionContext*,
std::unique_ptr<WebIDBDatabase>,
IDBDatabaseCallbacks*,
v8::Isolate*,
mojo::PendingRemote<mojom::blink::ObservedFeature> connection_lifetime);
~IDBDatabase() override;
void Trace(Visitor*) override;
// Overwrites the database metadata, including object store and index
// metadata. Used to pass metadata to the database when it is opened.
void SetMetadata(const IDBDatabaseMetadata&);
// Overwrites the database's own metadata, but does not change object store
// and index metadata. Used to revert the database's metadata when a
// versionchage transaction is aborted.
void SetDatabaseMetadata(const IDBDatabaseMetadata&);
void TransactionCreated(IDBTransaction*);
void TransactionFinished(const IDBTransaction*);
const String& GetObjectStoreName(int64_t object_store_id) const;
int32_t AddObserver(IDBObserver*,
int64_t transaction_id,
bool include_transaction,
bool no_records,
bool values,
std::bitset<kIDBOperationTypeCount> operation_types);
void RemoveObservers(const Vector<int32_t>& observer_ids);
// Implement the IDL
const String& name() const { return metadata_.name; }
uint64_t version() const { return metadata_.version; }
DOMStringList* objectStoreNames() const;
IDBObjectStore* createObjectStore(const String& name,
const IDBObjectStoreParameters* options,
ExceptionState& exception_state) {
return createObjectStore(name, IDBKeyPath(options->keyPath()),
options->autoIncrement(), exception_state);
}
IDBTransaction* transaction(ScriptState*,
const StringOrStringSequence& store_names,
const String& mode,
ExceptionState&);
IDBTransaction* transaction(ScriptState*,
const StringOrStringSequence& store_names,
const String& mode,
const IDBTransactionOptions* options,
ExceptionState&);
void deleteObjectStore(const String& name, ExceptionState&);
void close();
DEFINE_ATTRIBUTE_EVENT_LISTENER(abort, kAbort)
DEFINE_ATTRIBUTE_EVENT_LISTENER(close, kClose)
DEFINE_ATTRIBUTE_EVENT_LISTENER(error, kError)
DEFINE_ATTRIBUTE_EVENT_LISTENER(versionchange, kVersionchange)
// IDBDatabaseCallbacks
void OnVersionChange(int64_t old_version, int64_t new_version);
void OnAbort(int64_t, DOMException*);
void OnComplete(int64_t);
void OnChanges(const WebIDBDatabaseCallbacks::ObservationIndexMap&,
Vector<Persistent<IDBObservation>> observations,
const WebIDBDatabaseCallbacks::TransactionMap& transactions);
// ScriptWrappable
bool HasPendingActivity() const final;
// ExecutionContextLifecycleObserver
void ContextDestroyed() override;
// EventTarget
const AtomicString& InterfaceName() const override;
ExecutionContext* GetExecutionContext() const override;
bool IsClosePending() const { return close_pending_; }
void ForceClose();
const IDBDatabaseMetadata& Metadata() const { return metadata_; }
void EnqueueEvent(Event*);
int64_t FindObjectStoreId(const String& name) const;
bool ContainsObjectStore(const String& name) const {
return FindObjectStoreId(name) != IDBObjectStoreMetadata::kInvalidId;
}
void RenameObjectStore(int64_t store_id, const String& new_name);
void RevertObjectStoreCreation(int64_t object_store_id);
void RevertObjectStoreMetadata(
scoped_refptr<IDBObjectStoreMetadata> old_metadata);
// Will return nullptr if this database is stopped.
WebIDBDatabase* Backend() const { return backend_.get(); }
static int64_t NextTransactionId();
static int32_t NextObserverId();
static const char kCannotObserveVersionChangeTransaction[];
static const char kIndexDeletedErrorMessage[];
static const char kIndexNameTakenErrorMessage[];
static const char kIsKeyCursorErrorMessage[];
static const char kNoKeyOrKeyRangeErrorMessage[];
static const char kNoSuchIndexErrorMessage[];
static const char kNoSuchObjectStoreErrorMessage[];
static const char kNoValueErrorMessage[];
static const char kNotValidKeyErrorMessage[];
static const char kNotVersionChangeTransactionErrorMessage[];
static const char kObjectStoreDeletedErrorMessage[];
static const char kObjectStoreNameTakenErrorMessage[];
static const char kRequestNotFinishedErrorMessage[];
static const char kSourceDeletedErrorMessage[];
static const char kTransactionFinishedErrorMessage[];
static const char kTransactionInactiveErrorMessage[];
static const char kTransactionReadOnlyErrorMessage[];
static const char kDatabaseClosedErrorMessage[];
protected:
// EventTarget
DispatchEventResult DispatchEventInternal(Event&) override;
private:
IDBObjectStore* createObjectStore(const String& name,
const IDBKeyPath&,
bool auto_increment,
ExceptionState&);
void CloseConnection();
IDBDatabaseMetadata metadata_;
std::unique_ptr<WebIDBDatabase> backend_;
Member<IDBTransaction> version_change_transaction_;
HeapHashMap<int64_t, Member<IDBTransaction>> transactions_;
HeapHashMap<int32_t, Member<IDBObserver>> observers_;
// No interface here, so no need to bind it. This is only for
// lifetime observation of the use of IndexedDB from the browser.
mojo::PendingRemote<mojom::blink::ObservedFeature> connection_lifetime_;
bool close_pending_ = false;
Member<EventQueue> event_queue_;
Member<IDBDatabaseCallbacks> database_callbacks_;
// Maintain the isolate so that all externally allocated memory can be
// registered against it.
v8::Isolate* isolate_;
FrameOrWorkerScheduler::SchedulingAffectingFeatureHandle
feature_handle_for_scheduler_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_INDEXEDDB_IDB_DATABASE_H_
|
