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