Modern IDB: Refactor memory objectstore/transaction interation.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / MemoryBackingStoreTransaction.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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef MemoryBackingStoreTransaction_h
27 #define MemoryBackingStoreTransaction_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBDatabaseInfo.h"
32 #include "IDBKeyData.h"
33 #include "IDBTransactionInfo.h"
34 #include "ThreadSafeDataBuffer.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/HashSet.h>
37
38 namespace WebCore {
39 namespace IDBServer {
40
41 class MemoryIDBBackingStore;
42 class MemoryIndex;
43 class MemoryObjectStore;
44
45 typedef HashMap<IDBKeyData, ThreadSafeDataBuffer, IDBKeyDataHash, IDBKeyDataHashTraits> KeyValueMap;
46
47 class MemoryBackingStoreTransaction {
48     friend std::unique_ptr<MemoryBackingStoreTransaction> std::make_unique<MemoryBackingStoreTransaction>(WebCore::IDBServer::MemoryIDBBackingStore&, const WebCore::IDBTransactionInfo&);
49 public:
50     static std::unique_ptr<MemoryBackingStoreTransaction> create(MemoryIDBBackingStore&, const IDBTransactionInfo&);
51
52     ~MemoryBackingStoreTransaction();
53
54     bool isVersionChange() const { return m_info.mode() == IndexedDB::TransactionMode::VersionChange; }
55     bool isWriting() const { return m_info.mode() != IndexedDB::TransactionMode::ReadOnly; }
56     bool isAborting() const { return m_isAborting; }
57
58     const IDBDatabaseInfo& originalDatabaseInfo() const;
59
60     void addNewObjectStore(MemoryObjectStore&);
61     void addExistingObjectStore(MemoryObjectStore&);
62     
63     void recordValueChanged(MemoryObjectStore&, const IDBKeyData&, ThreadSafeDataBuffer*);
64     void objectStoreDeleted(std::unique_ptr<MemoryObjectStore>);
65     void objectStoreCleared(MemoryObjectStore&, std::unique_ptr<KeyValueMap>&&);
66
67     void addNewIndex(MemoryIndex&);
68     void addExistingIndex(MemoryIndex&);
69
70     void abort();
71     void commit();
72
73 private:
74     MemoryBackingStoreTransaction(MemoryIDBBackingStore&, const IDBTransactionInfo&);
75
76     void finish();
77
78     MemoryIDBBackingStore& m_backingStore;
79     IDBTransactionInfo m_info;
80
81     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfo;
82
83     bool m_inProgress { true };
84     bool m_isAborting { false };
85
86     HashSet<MemoryObjectStore*> m_objectStores;
87     HashSet<MemoryObjectStore*> m_versionChangeAddedObjectStores;
88     HashSet<MemoryIndex*> m_indexes;
89     HashSet<MemoryIndex*> m_versionChangeAddedIndexes;
90
91     HashMap<MemoryObjectStore*, uint64_t> m_originalKeyGenerators;
92     HashMap<String, std::unique_ptr<MemoryObjectStore>> m_deletedObjectStores;
93     HashMap<MemoryObjectStore*, std::unique_ptr<KeyValueMap>> m_originalValues;
94     HashMap<MemoryObjectStore*, std::unique_ptr<KeyValueMap>> m_clearedKeyValueMaps;
95 };
96
97 } // namespace IDBServer
98 } // namespace WebCore
99
100 #endif // ENABLE(INDEXED_DATABASE)
101 #endif // MemoryBackingStoreTransaction_h