The GC should be in a thread
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBDatabase.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 "Dictionary.h"
31 #include "EventTarget.h"
32 #include "ExceptionCode.h"
33 #include "IDBActiveDOMObject.h"
34 #include "IDBConnectionProxy.h"
35 #include "IDBConnectionToServer.h"
36 #include "IDBDatabaseInfo.h"
37 #include "IDBKeyPath.h"
38 #include "IDBTransactionMode.h"
39
40 namespace WebCore {
41
42 class DOMStringList;
43 class IDBObjectStore;
44 class IDBOpenDBRequest;
45 class IDBResultData;
46 class IDBTransaction;
47 class IDBTransactionInfo;
48 struct EventNames;
49
50 class IDBDatabase : public ThreadSafeRefCounted<IDBDatabase>, public EventTargetWithInlineData, public IDBActiveDOMObject {
51 public:
52     static Ref<IDBDatabase> create(ScriptExecutionContext&, IDBClient::IDBConnectionProxy&, const IDBResultData&);
53
54     virtual ~IDBDatabase();
55
56     // IDBDatabase IDL
57     const String name() const;
58     uint64_t version() const;
59     RefPtr<DOMStringList> objectStoreNames() const;
60
61     struct ObjectStoreParameters {
62         Optional<IDBKeyPath> keyPath;
63         bool autoIncrement;
64     };
65
66     ExceptionOr<Ref<IDBObjectStore>> createObjectStore(const String& name, ObjectStoreParameters&&);
67
68     using StringOrVectorOfStrings = WTF::Variant<String, Vector<String>>;
69     ExceptionOr<Ref<IDBTransaction>> transaction(StringOrVectorOfStrings&& storeNames, IDBTransactionMode);
70     ExceptionOr<void> deleteObjectStore(const String& name);
71     void close();
72
73     void renameObjectStore(IDBObjectStore&, const String& newName);
74     void renameIndex(IDBIndex&, const String& newName);
75
76     // EventTarget
77     EventTargetInterface eventTargetInterface() const final { return IDBDatabaseEventTargetInterfaceType; }
78     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
79     void refEventTarget() final { ThreadSafeRefCounted<IDBDatabase>::ref(); }
80     void derefEventTarget() final { ThreadSafeRefCounted<IDBDatabase>::deref(); }
81
82     using ThreadSafeRefCounted<IDBDatabase>::ref;
83     using ThreadSafeRefCounted<IDBDatabase>::deref;
84
85     const char* activeDOMObjectName() const final;
86     bool canSuspendForDocumentSuspension() const final;
87     void stop() final;
88
89     const IDBDatabaseInfo& info() const { return m_info; }
90     uint64_t databaseConnectionIdentifier() const { return m_databaseConnectionIdentifier; }
91
92     Ref<IDBTransaction> startVersionChangeTransaction(const IDBTransactionInfo&, IDBOpenDBRequest&);
93     void didStartTransaction(IDBTransaction&);
94
95     void willCommitTransaction(IDBTransaction&);
96     void didCommitTransaction(IDBTransaction&);
97     void willAbortTransaction(IDBTransaction&);
98     void didAbortTransaction(IDBTransaction&);
99
100     void fireVersionChangeEvent(const IDBResourceIdentifier& requestIdentifier, uint64_t requestedVersion);
101     void didCloseFromServer(const IDBError&);
102     void connectionToServerLost(const IDBError&);
103
104     IDBClient::IDBConnectionProxy& connectionProxy() { return m_connectionProxy.get(); }
105
106     void didCreateIndexInfo(const IDBIndexInfo&);
107     void didDeleteIndexInfo(const IDBIndexInfo&);
108
109     bool isClosingOrClosed() const { return m_closePending || m_closedInServer; }
110
111     bool dispatchEvent(Event&) final;
112
113     bool hasPendingActivity() const final;
114
115 private:
116     IDBDatabase(ScriptExecutionContext&, IDBClient::IDBConnectionProxy&, const IDBResultData&);
117
118     void didCommitOrAbortTransaction(IDBTransaction&);
119
120     void maybeCloseInServer();
121
122     Ref<IDBClient::IDBConnectionProxy> m_connectionProxy;
123     IDBDatabaseInfo m_info;
124     uint64_t m_databaseConnectionIdentifier { 0 };
125
126     bool m_closePending { false };
127     bool m_closedInServer { false };
128
129     RefPtr<IDBTransaction> m_versionChangeTransaction;
130     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_activeTransactions;
131     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_committingTransactions;
132     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_abortingTransactions;
133     
134     const EventNames& m_eventNames; // Need to cache this so we can use it from GC threads.
135 };
136
137 } // namespace WebCore
138
139 #endif // ENABLE(INDEXED_DATABASE)