944b8300c7e3223bdd344bb5ba81d1c3b14fa162
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBDatabaseBackendImpl.h
1 /*
2  * Copyright (C) 2010 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBDatabaseBackendImpl_h
27 #define IDBDatabaseBackendImpl_h
28
29 #include "IDBCallbacks.h"
30 #include "IDBDatabase.h"
31 #include <stdint.h>
32 #include <wtf/Deque.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/ListHashSet.h>
35
36 #if ENABLE(INDEXED_DATABASE)
37
38 namespace WebCore {
39
40 class IDBBackingStore;
41 class IDBDatabase;
42 class IDBFactoryBackendImpl;
43 class IDBObjectStoreBackendImpl;
44 class IDBTransactionBackendImpl;
45 class IDBTransactionBackendInterface;
46 class IDBTransactionCoordinator;
47
48 class IDBDatabaseBackendImpl : public IDBDatabaseBackendInterface {
49 public:
50     static PassRefPtr<IDBDatabaseBackendImpl> create(const String& name, IDBBackingStore* database, IDBFactoryBackendImpl*, const String& uniqueIdentifier);
51     virtual ~IDBDatabaseBackendImpl();
52
53     PassRefPtr<IDBBackingStore> backingStore() const;
54
55     static const int64_t InvalidId = 0;
56     int64_t id() const { return m_metadata.id; }
57
58     void openConnection(PassRefPtr<IDBCallbacks>, PassRefPtr<IDBDatabaseCallbacks>, int64_t transactionId, int64_t version);
59     void deleteDatabase(PassRefPtr<IDBCallbacks>);
60
61     // IDBDatabaseBackendInterface
62     virtual IDBDatabaseMetadata metadata() const;
63     virtual PassRefPtr<IDBObjectStoreBackendInterface> createObjectStore(int64_t id, const String& name, const IDBKeyPath&, bool autoIncrement, IDBTransactionBackendInterface*, ExceptionCode&);
64     virtual void createObjectStore(int64_t transactionId, int64_t objectStoreId, const String& name, const IDBKeyPath&, bool autoIncrement) { ASSERT_NOT_REACHED(); }
65     virtual void deleteObjectStore(int64_t, IDBTransactionBackendInterface*, ExceptionCode&);
66     virtual void deleteObjectStore(int64_t transactionId, int64_t objectStoreId) { ASSERT_NOT_REACHED(); }
67     // FIXME: Remove this method in https://bugs.webkit.org/show_bug.cgi?id=103923.
68     virtual PassRefPtr<IDBTransactionBackendInterface> createTransaction(int64_t transactionId, const Vector<int64_t>& objectStoreIds, IDBTransaction::Mode);
69     virtual void createTransaction(int64_t transactionId, PassRefPtr<IDBDatabaseCallbacks>, const Vector<int64_t>& objectStoreIds, unsigned short mode);
70     virtual void close(PassRefPtr<IDBDatabaseCallbacks>);
71
72     virtual void commit(int64_t transactionId);
73     virtual void abort(int64_t transactionId);
74
75     virtual void createIndex(int64_t transactionId, int64_t objectStoreId, int64_t indexId, const String& name, const IDBKeyPath&, bool unique, bool multiEntry) { ASSERT_NOT_REACHED(); }
76     virtual void deleteIndex(int64_t transactionId, int64_t objectStoreId, int64_t indexId) { ASSERT_NOT_REACHED(); }
77
78     PassRefPtr<IDBObjectStoreBackendImpl> objectStore(int64_t id);
79     IDBTransactionCoordinator* transactionCoordinator() const { return m_transactionCoordinator.get(); }
80     void transactionStarted(PassRefPtr<IDBTransactionBackendImpl>);
81     void transactionFinished(PassRefPtr<IDBTransactionBackendImpl>);
82     void transactionFinishedAndCompleteFired(PassRefPtr<IDBTransactionBackendImpl>);
83     void transactionFinishedAndAbortFired(PassRefPtr<IDBTransactionBackendImpl>);
84
85     virtual void get(int64_t transactionId, int64_t objectStoreId, int64_t indexId, PassRefPtr<IDBKeyRange>, bool keyOnly, PassRefPtr<IDBCallbacks>) OVERRIDE;
86     virtual void put(int64_t transactionId, int64_t objectStoreId, Vector<uint8_t>* value, PassRefPtr<IDBKey>, PutMode, PassRefPtr<IDBCallbacks>, const Vector<int64_t>& indexIds, const Vector<IndexKeys>&) OVERRIDE;
87     virtual void setIndexKeys(int64_t transactionId, int64_t objectStoreId, PassRefPtr<IDBKey> prpPrimaryKey, const Vector<int64_t>& indexIds, const Vector<IndexKeys>&) OVERRIDE;
88     virtual void setIndexesReady(int64_t transactionId, int64_t objectStoreId, const Vector<int64_t>& indexIds) OVERRIDE;
89     virtual void openCursor(int64_t transactionId, int64_t objectStoreId, int64_t indexId, PassRefPtr<IDBKeyRange>, unsigned short direction, bool keyOnly, TaskType, PassRefPtr<IDBCallbacks>) OVERRIDE;
90     virtual void count(int64_t transactionId, int64_t objectStoreId, int64_t indexId, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>) OVERRIDE;
91     virtual void deleteRange(int64_t transactionId, int64_t objectStoreId, PassRefPtr<IDBKeyRange>, PassRefPtr<IDBCallbacks>) OVERRIDE;
92     virtual void clear(int64_t transactionId, int64_t objectStoreId, PassRefPtr<IDBCallbacks>) OVERRIDE;
93
94 private:
95     IDBDatabaseBackendImpl(const String& name, IDBBackingStore* database, IDBFactoryBackendImpl*, const String& uniqueIdentifier);
96
97     bool openInternal();
98     void runIntVersionChangeTransaction(PassRefPtr<IDBCallbacks>, PassRefPtr<IDBDatabaseCallbacks>, int64_t transactionId, int64_t requestedVersion);
99     void loadObjectStores();
100     size_t connectionCount();
101     void processPendingCalls();
102
103     bool isDeleteDatabaseBlocked();
104     void deleteDatabaseFinal(PassRefPtr<IDBCallbacks>);
105
106     class CreateObjectStoreOperation;
107     class DeleteObjectStoreOperation;
108     class VersionChangeOperation;
109
110     // When a "versionchange" transaction aborts, these restore the back-end object hierarchy.
111     class CreateObjectStoreAbortOperation;
112     class DeleteObjectStoreAbortOperation;
113     class VersionChangeAbortOperation;
114
115     RefPtr<IDBBackingStore> m_backingStore;
116     IDBDatabaseMetadata m_metadata;
117
118     String m_identifier;
119     // This might not need to be a RefPtr since the factory's lifetime is that of the page group, but it's better to be conservitive than sorry.
120     RefPtr<IDBFactoryBackendImpl> m_factory;
121
122     typedef HashMap<int64_t, RefPtr<IDBObjectStoreBackendImpl> > ObjectStoreMap;
123     ObjectStoreMap m_objectStores;
124
125     OwnPtr<IDBTransactionCoordinator> m_transactionCoordinator;
126     RefPtr<IDBTransactionBackendImpl> m_runningVersionChangeTransaction;
127
128     typedef HashMap<int64_t, IDBTransactionBackendImpl*> TransactionMap;
129     TransactionMap m_transactions;
130
131     class PendingOpenCall;
132     Deque<OwnPtr<PendingOpenCall> > m_pendingOpenCalls;
133     OwnPtr<PendingOpenCall> m_pendingSecondHalfOpen;
134
135     class PendingDeleteCall;
136     Deque<OwnPtr<PendingDeleteCall> > m_pendingDeleteCalls;
137
138     typedef ListHashSet<RefPtr<IDBDatabaseCallbacks> > DatabaseCallbacksSet;
139     DatabaseCallbacksSet m_databaseCallbacksSet;
140
141     bool m_closingConnection;
142 };
143
144 } // namespace WebCore
145
146 #endif
147
148 #endif // IDBDatabaseBackendImpl_h