Modern IDB: Move all IDB DOM object management from IDBConnectionToServer to IDBConne...
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBDatabase.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 "Dictionary.h"
31 #include "EventTarget.h"
32 #include "ExceptionCode.h"
33 #include "IDBConnectionProxy.h"
34 #include "IDBConnectionToServer.h"
35 #include "IDBDatabaseInfo.h"
36
37 namespace WebCore {
38
39 class DOMStringList;
40 class IDBObjectStore;
41 class IDBOpenDBRequest;
42 class IDBResultData;
43 class IDBTransaction;
44 class IDBTransactionInfo;
45
46 class IDBDatabase : public ThreadSafeRefCounted<IDBDatabase>, public EventTargetWithInlineData, public ActiveDOMObject {
47 public:
48     static Ref<IDBDatabase> create(ScriptExecutionContext&, IDBClient::IDBConnectionProxy&, const IDBResultData&);
49
50     virtual ~IDBDatabase();
51
52     // IDBDatabase IDL
53     const String name() const;
54     uint64_t version() const;
55     RefPtr<DOMStringList> objectStoreNames() const;
56
57     RefPtr<IDBObjectStore> createObjectStore(const String& name, const Dictionary&, ExceptionCodeWithMessage&);
58     RefPtr<IDBObjectStore> createObjectStore(const String& name, const IDBKeyPath&, bool autoIncrement, ExceptionCodeWithMessage&);
59     RefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const Vector<String>&, const String& mode, ExceptionCodeWithMessage&);
60     RefPtr<IDBTransaction> transaction(ScriptExecutionContext*, const String&, const String& mode, ExceptionCodeWithMessage&);
61     void deleteObjectStore(const String& name, ExceptionCodeWithMessage&);
62     void close();
63
64     // EventTarget
65     EventTargetInterface eventTargetInterface() const final { return IDBDatabaseEventTargetInterfaceType; }
66     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
67     void refEventTarget() final { ThreadSafeRefCounted<IDBDatabase>::ref(); }
68     void derefEventTarget() final { ThreadSafeRefCounted<IDBDatabase>::deref(); }
69
70     using ThreadSafeRefCounted<IDBDatabase>::ref;
71     using ThreadSafeRefCounted<IDBDatabase>::deref;
72
73     const char* activeDOMObjectName() const final;
74     bool canSuspendForDocumentSuspension() const final;
75     void stop() final;
76
77     const IDBDatabaseInfo& info() const { return m_info; }
78     uint64_t databaseConnectionIdentifier() const { return m_databaseConnectionIdentifier; }
79
80     Ref<IDBTransaction> startVersionChangeTransaction(const IDBTransactionInfo&, IDBOpenDBRequest&);
81     void didStartTransaction(IDBTransaction&);
82
83     void willCommitTransaction(IDBTransaction&);
84     void didCommitTransaction(IDBTransaction&);
85     void willAbortTransaction(IDBTransaction&);
86     void didAbortTransaction(IDBTransaction&);
87
88     void fireVersionChangeEvent(const IDBResourceIdentifier& requestIdentifier, uint64_t requestedVersion);
89
90     IDBClient::IDBConnectionProxy& connectionProxy() { return m_connectionProxy.get(); }
91
92     // FIXME: Remove the need for this accessor.
93     IDBClient::IDBConnectionToServer& serverConnection() { return m_connectionProxy->connectionToServer(); }
94
95     void didCreateIndexInfo(const IDBIndexInfo&);
96     void didDeleteIndexInfo(const IDBIndexInfo&);
97
98     bool isClosingOrClosed() const { return m_closePending || m_closedInServer; }
99
100     bool dispatchEvent(Event&) final;
101
102     bool hasPendingActivity() const final;
103
104     ThreadIdentifier originThreadID() const { return m_originThreadID; }
105
106 private:
107     IDBDatabase(ScriptExecutionContext&, IDBClient::IDBConnectionProxy&, const IDBResultData&);
108
109     void didCommitOrAbortTransaction(IDBTransaction&);
110
111     void maybeCloseInServer();
112
113     Ref<IDBClient::IDBConnectionProxy> m_connectionProxy;
114     IDBDatabaseInfo m_info;
115     uint64_t m_databaseConnectionIdentifier { 0 };
116
117     bool m_closePending { false };
118     bool m_closedInServer { false };
119
120     RefPtr<IDBTransaction> m_versionChangeTransaction;
121     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_activeTransactions;
122     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_committingTransactions;
123     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_abortingTransactions;
124
125     ThreadIdentifier m_originThreadID { currentThread() };
126 };
127
128 } // namespace WebCore
129
130 #endif // ENABLE(INDEXED_DATABASE)