5f46e2fdbab24b34f9be72d2d412b40019082bc2
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBObjectStore.h
1 /*
2  * Copyright (C) 2015 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 "ActiveDOMObject.h"
31 #include "IDBObjectStoreInfo.h"
32 #include <wtf/HashSet.h>
33
34 namespace JSC {
35 class ExecState;
36 class JSValue;
37 class SlotVisitor;
38 }
39
40 namespace WebCore {
41
42 class DOMStringList;
43 class IDBIndex;
44 class IDBKey;
45 class IDBKeyRange;
46 class IDBRequest;
47 class IDBTransaction;
48
49 struct ExceptionCodeWithMessage;
50 struct IDBKeyRangeData;
51
52 namespace IndexedDB {
53 enum class ObjectStoreOverwriteMode;
54 }
55
56 class IDBObjectStore final : public RefCounted<IDBObjectStore>, public ActiveDOMObject {
57 public:
58     static Ref<IDBObjectStore> create(ScriptExecutionContext&, const IDBObjectStoreInfo&, IDBTransaction&);
59
60     ~IDBObjectStore();
61
62     const String& name() const;
63     const IDBKeyPath& keyPath() const;
64     RefPtr<DOMStringList> indexNames() const;
65     RefPtr<IDBTransaction> transaction();
66     bool autoIncrement() const;
67
68     struct IndexParameters {
69         bool unique;
70         bool multiEntry;
71     };
72
73     RefPtr<IDBRequest> openCursor(ScriptExecutionContext&, IDBKeyRange*, const String& direction, ExceptionCodeWithMessage&);
74     RefPtr<IDBRequest> openCursor(ScriptExecutionContext&, JSC::JSValue key, const String& direction, ExceptionCodeWithMessage&);
75     RefPtr<IDBRequest> get(ScriptExecutionContext&, JSC::JSValue key, ExceptionCodeWithMessage&);
76     RefPtr<IDBRequest> get(ScriptExecutionContext&, IDBKeyRange*, ExceptionCodeWithMessage&);
77     RefPtr<IDBRequest> add(JSC::ExecState&, JSC::JSValue, JSC::JSValue key, ExceptionCodeWithMessage&);
78     RefPtr<IDBRequest> put(JSC::ExecState&, JSC::JSValue, JSC::JSValue key, ExceptionCodeWithMessage&);
79     RefPtr<IDBRequest> deleteFunction(ScriptExecutionContext&, IDBKeyRange*, ExceptionCodeWithMessage&);
80     RefPtr<IDBRequest> deleteFunction(ScriptExecutionContext&, JSC::JSValue key, ExceptionCodeWithMessage&);
81     RefPtr<IDBRequest> clear(ScriptExecutionContext&, ExceptionCodeWithMessage&);
82     RefPtr<IDBIndex> createIndex(ScriptExecutionContext&, const String& name, const IDBKeyPath&, const IndexParameters&, ExceptionCodeWithMessage&);
83     RefPtr<IDBIndex> index(const String& name, ExceptionCodeWithMessage&);
84     void deleteIndex(const String& name, ExceptionCodeWithMessage&);
85     RefPtr<IDBRequest> count(ScriptExecutionContext&, IDBKeyRange*, ExceptionCodeWithMessage&);
86     RefPtr<IDBRequest> count(ScriptExecutionContext&, JSC::JSValue key, ExceptionCodeWithMessage&);
87
88     RefPtr<IDBRequest> putForCursorUpdate(JSC::ExecState&, JSC::JSValue, JSC::JSValue key, ExceptionCodeWithMessage&);
89     RefPtr<IDBRequest> modernDelete(ScriptExecutionContext&, JSC::JSValue key, ExceptionCodeWithMessage&);
90
91     void markAsDeleted();
92     bool isDeleted() const { return m_deleted; }
93
94     const IDBObjectStoreInfo& info() const { return m_info; }
95
96     // FIXME: After removing LegacyIDB and folding abstract/implementation classes together, this will no longer be necessary.
97     IDBTransaction& modernTransaction() { return m_transaction.get(); }
98
99     void rollbackInfoForVersionChangeAbort();
100
101     void visitReferencedIndexes(JSC::SlotVisitor&) const;
102
103 private:
104     IDBObjectStore(ScriptExecutionContext&, const IDBObjectStoreInfo&, IDBTransaction&);
105
106     enum class InlineKeyCheck { Perform, DoNotPerform };
107     RefPtr<IDBRequest> putOrAdd(JSC::ExecState&, JSC::JSValue, RefPtr<IDBKey>, IndexedDB::ObjectStoreOverwriteMode, InlineKeyCheck, ExceptionCodeWithMessage&);
108     RefPtr<IDBRequest> doCount(ScriptExecutionContext&, const IDBKeyRangeData&, ExceptionCodeWithMessage&);
109     RefPtr<IDBRequest> doDelete(ScriptExecutionContext&, IDBKeyRange*, ExceptionCodeWithMessage&);
110
111     const char* activeDOMObjectName() const final;
112     bool canSuspendForDocumentSuspension() const final;
113     bool hasPendingActivity() const final;
114
115     IDBObjectStoreInfo m_info;
116     IDBObjectStoreInfo m_originalInfo;
117     Ref<IDBTransaction> m_transaction;
118
119     bool m_deleted { false };
120
121     mutable Lock m_referencedIndexLock;
122     HashMap<String, std::unique_ptr<IDBIndex>> m_referencedIndexes;
123     HashSet<std::unique_ptr<IDBIndex>> m_deletedIndexes;
124 };
125
126 } // namespace WebCore
127
128 #endif // ENABLE(INDEXED_DATABASE)