Source/WebCore:
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / UniqueIDBDatabase.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 UniqueIDBDatabase_h
27 #define UniqueIDBDatabase_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBBackingStore.h"
32 #include "IDBDatabaseIdentifier.h"
33 #include "IDBDatabaseInfo.h"
34 #include "IDBServerOperation.h"
35 #include "Timer.h"
36 #include "UniqueIDBDatabaseConnection.h"
37 #include "UniqueIDBDatabaseTransaction.h"
38 #include <wtf/Deque.h>
39 #include <wtf/HashSet.h>
40 #include <wtf/Ref.h>
41 #include <wtf/ThreadSafeRefCounted.h>
42
43 namespace WebCore {
44
45 class IDBError;
46 class IDBRequestData;
47
48 namespace IDBServer {
49
50 class IDBConnectionToClient;
51 class IDBServer;
52
53 typedef std::function<void(const IDBError&)> ErrorCallback;
54
55 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
56 public:
57     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
58     {
59         return adoptRef(*new UniqueIDBDatabase(server, identifier));
60     }
61
62     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
63
64     const IDBDatabaseInfo& info() const;
65     IDBServer& server() { return m_server; }
66
67     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
68     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
69     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
70
71 private:
72     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
73     
74     void handleOpenDatabaseOperations();
75     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
76     bool hasAnyOpenConnections() const;
77
78     void startVersionChangeTransaction();
79     void notifyConnectionsOfVersionChange();
80
81     uint64_t storeCallback(ErrorCallback);
82     
83     // Database thread operations
84     void openBackingStore(const IDBDatabaseIdentifier&);
85     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
86
87     // Main thread callbacks
88     void didOpenBackingStore(const IDBDatabaseInfo&);
89     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&);
90
91     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
92
93     void invokeTransactionScheduler();
94     void transactionSchedulingTimerFired();
95
96     IDBServer& m_server;
97     IDBDatabaseIdentifier m_identifier;
98     
99     Deque<Ref<IDBServerOperation>> m_pendingOpenDatabaseOperations;
100
101     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
102     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
103
104     RefPtr<IDBServerOperation> m_versionChangeOperation;
105     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
106     UniqueIDBDatabaseTransaction* m_versionChangeTransaction { nullptr };
107
108     std::unique_ptr<IDBBackingStore> m_backingStore;
109     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
110
111     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
112
113     Timer m_transactionSchedulingTimer;
114 };
115
116 } // namespace IDBServer
117 } // namespace WebCore
118
119 #endif // ENABLE(INDEXED_DATABASE)
120 #endif // UniqueIDBDatabase_h