2a30680f679b6b5681395ba2925421c8b12dd9c8
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / client / IDBDatabaseImpl.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 #ifndef IDBDatabaseImpl_h
27 #define IDBDatabaseImpl_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBConnectionToServer.h"
32 #include "IDBDatabase.h"
33 #include "IDBDatabaseInfo.h"
34
35 namespace WebCore {
36
37 class IDBResultData;
38 class IDBTransaction;
39 class IDBTransactionInfo;
40
41 namespace IDBClient {
42
43 class IDBTransaction;
44
45 class IDBDatabase : public WebCore::IDBDatabase {
46 public:
47     static Ref<IDBDatabase> create(ScriptExecutionContext&, IDBConnectionToServer&, const IDBResultData&);
48
49     virtual ~IDBDatabase();
50
51     // IDBDatabase IDL
52     virtual const String name() const override final;
53     virtual uint64_t version() const override final;
54     virtual RefPtr<DOMStringList> objectStoreNames() const override final;
55
56     virtual RefPtr<WebCore::IDBObjectStore> createObjectStore(const String& name, const Dictionary&, ExceptionCode&) override final;
57     virtual RefPtr<WebCore::IDBObjectStore> createObjectStore(const String& name, const IDBKeyPath&, bool autoIncrement, ExceptionCode&) override final;
58     virtual RefPtr<WebCore::IDBTransaction> transaction(ScriptExecutionContext*, const Vector<String>&, const String& mode, ExceptionCode&) override final;
59     virtual RefPtr<WebCore::IDBTransaction> transaction(ScriptExecutionContext*, const String&, const String& mode, ExceptionCode&) override final;
60     virtual void deleteObjectStore(const String& name, ExceptionCode&) override final;
61     virtual void close() override final;
62
63     // EventTarget
64     virtual EventTargetInterface eventTargetInterface() const override final { return IDBDatabaseEventTargetInterfaceType; }
65     virtual ScriptExecutionContext* scriptExecutionContext() const override final { return ActiveDOMObject::scriptExecutionContext(); }
66     virtual void refEventTarget() override final { ref(); }
67     virtual void derefEventTarget() override final { deref(); }
68
69     virtual const char* activeDOMObjectName() const override final;
70     virtual bool canSuspendForPageCache() const override final;
71
72     const IDBDatabaseInfo& info() const { return m_info; }
73     uint64_t databaseConnectionIdentifier() const { return m_databaseConnectionIdentifier; }
74
75     Ref<IDBTransaction> startVersionChangeTransaction(const IDBTransactionInfo&);
76     void didStartTransaction(IDBTransaction&);
77
78     void willCommitTransaction(IDBTransaction&);
79     void didCommitTransaction(IDBTransaction&);
80     void willAbortTransaction(IDBTransaction&);
81     void didAbortTransaction(IDBTransaction&);
82
83     void fireVersionChangeEvent(uint64_t requestedVersion);
84
85     IDBConnectionToServer& serverConnection() { return m_serverConnection.get(); }
86
87     void didCreateIndexInfo(const IDBIndexInfo&);
88
89 private:
90     IDBDatabase(ScriptExecutionContext&, IDBConnectionToServer&, const IDBResultData&);
91
92     void didCommitOrAbortTransaction(IDBTransaction&);
93
94     void maybeCloseInServer();
95
96     Ref<IDBConnectionToServer> m_serverConnection;
97     IDBDatabaseInfo m_info;
98     uint64_t m_databaseConnectionIdentifier { 0 };
99
100     bool m_closePending { false };
101     bool m_closedInServer { false };
102
103     RefPtr<IDBTransaction> m_versionChangeTransaction;
104     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_activeTransactions;
105     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_committingTransactions;
106     HashMap<IDBResourceIdentifier, RefPtr<IDBTransaction>> m_abortingTransactions;
107 };
108
109 } // namespace IDBClient
110 } // namespace WebCore
111
112 #endif // ENABLE(INDEXED_DATABASE)
113 #endif // IDBDatabaseImpl_h