IndexedDB: Allow createIndex/createObjectStore to be asynchronous
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBBackingStore.h
1 /*
2  * Copyright (C) 2011 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 IDBBackingStore_h
27 #define IDBBackingStore_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBCursor.h"
32 #include "IDBMetadata.h"
33 #include "LevelDBTransaction.h"
34 #include <wtf/OwnPtr.h>
35 #include <wtf/RefCounted.h>
36
37 namespace WebCore {
38
39 class LevelDBComparator;
40 class LevelDBDatabase;
41 class LevelDBTransaction;
42 class IDBFactoryBackendImpl;
43 class IDBKey;
44 class IDBKeyRange;
45 class SecurityOrigin;
46
47 class IDBBackingStore : public RefCounted<IDBBackingStore> {
48 public:
49     class Transaction;
50
51     virtual ~IDBBackingStore();
52     static PassRefPtr<IDBBackingStore> open(SecurityOrigin*, const String& pathBase, const String& fileIdentifier, IDBFactoryBackendImpl*);
53
54     virtual Vector<String> getDatabaseNames();
55     virtual bool getIDBDatabaseMetaData(const String& name, IDBDatabaseMetadata*, bool& success) WARN_UNUSED_RETURN;
56     virtual bool createIDBDatabaseMetaData(const String& name, const String& version, int64_t intVersion, int64_t& rowId);
57     virtual bool updateIDBDatabaseMetaData(IDBBackingStore::Transaction*, int64_t rowId, const String& version);
58     virtual bool updateIDBDatabaseIntVersion(IDBBackingStore::Transaction*, int64_t rowId, int64_t intVersion);
59     virtual bool deleteDatabase(const String& name);
60
61     void getObjectStores(int64_t databaseId, IDBDatabaseMetadata::ObjectStoreMap*);
62     virtual bool createObjectStore(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const String& name, const IDBKeyPath&, bool autoIncrement);
63     virtual bool deleteObjectStore(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId) WARN_UNUSED_RETURN;
64
65     class RecordIdentifier {
66         WTF_MAKE_NONCOPYABLE(RecordIdentifier);
67     public:
68         RecordIdentifier(const Vector<char>& primaryKey, int64_t version) : m_primaryKey(primaryKey), m_version(version) { ASSERT(!primaryKey.isEmpty()); }
69         RecordIdentifier() : m_primaryKey(), m_version(-1) { }
70
71         const Vector<char> primaryKey() const { return m_primaryKey; }
72         int64_t version() const { return m_version; }
73         void reset(const Vector<char>& primaryKey, int64_t version) { m_primaryKey = primaryKey; m_version = version; }
74
75     private:
76         Vector<char> m_primaryKey; // FIXME: Make it more clear that this is the *encoded* version of the key.
77         int64_t m_version;
78     };
79
80     virtual bool getRecord(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const IDBKey&, Vector<uint8_t>& record) WARN_UNUSED_RETURN;
81     virtual bool putRecord(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const IDBKey&, const Vector<uint8_t>& value, RecordIdentifier*) WARN_UNUSED_RETURN;
82     virtual void clearObjectStore(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId);
83     virtual void deleteRecord(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const RecordIdentifier&);
84     virtual bool getKeyGeneratorCurrentNumber(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t& currentNumber) WARN_UNUSED_RETURN;
85     virtual bool maybeUpdateKeyGeneratorCurrentNumber(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t newState, bool checkCurrent) WARN_UNUSED_RETURN;
86     virtual bool keyExistsInObjectStore(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const IDBKey&, RecordIdentifier* foundRecordIdentifier, bool& found) WARN_UNUSED_RETURN;
87
88     virtual bool createIndex(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const String& name, const IDBKeyPath&, bool isUnique, bool isMultiEntry);
89     virtual void deleteIndex(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId);
90     virtual void putIndexDataForRecord(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey&, const RecordIdentifier&);
91     virtual bool getPrimaryKeyViaIndex(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey&, RefPtr<IDBKey>& primaryKey) WARN_UNUSED_RETURN;
92     virtual bool keyExistsInIndex(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey& indexKey, RefPtr<IDBKey>& foundPrimaryKey, bool& exists) WARN_UNUSED_RETURN;
93
94     class Cursor : public RefCounted<Cursor> {
95     public:
96         enum IteratorState {
97             Ready = 0,
98             Seek
99         };
100
101         struct CursorOptions {
102             Vector<char> lowKey;
103             bool lowOpen;
104             Vector<char> highKey;
105             bool highOpen;
106             bool forward;
107             bool unique;
108         };
109
110         PassRefPtr<IDBKey> key() const { return m_currentKey; }
111         bool continueFunction(const IDBKey* = 0, IteratorState = Seek);
112         bool advance(unsigned long);
113         bool firstSeek();
114
115         virtual PassRefPtr<Cursor> clone() = 0;
116         virtual PassRefPtr<IDBKey> primaryKey() const { return m_currentKey; }
117         virtual const Vector<uint8_t>& value() const = 0;
118         virtual const RecordIdentifier& recordIdentifier() const { return m_recordIdentifier; }
119         virtual ~Cursor() { }
120         virtual bool loadCurrentRow() = 0;
121
122     protected:
123         Cursor(LevelDBTransaction* transaction, const CursorOptions& cursorOptions)
124             : m_transaction(transaction)
125             , m_cursorOptions(cursorOptions)
126         {
127         }
128         explicit Cursor(const IDBBackingStore::Cursor* other);
129
130         bool isPastBounds() const;
131         bool haveEnteredRange() const;
132
133         LevelDBTransaction* m_transaction;
134         const CursorOptions m_cursorOptions;
135         OwnPtr<LevelDBIterator> m_iterator;
136         RefPtr<IDBKey> m_currentKey;
137         IDBBackingStore::RecordIdentifier m_recordIdentifier;
138     };
139
140     virtual PassRefPtr<Cursor> openObjectStoreKeyCursor(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const IDBKeyRange*, IDBCursor::Direction);
141     virtual PassRefPtr<Cursor> openObjectStoreCursor(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, const IDBKeyRange*, IDBCursor::Direction);
142     virtual PassRefPtr<Cursor> openIndexKeyCursor(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKeyRange*, IDBCursor::Direction);
143     virtual PassRefPtr<Cursor> openIndexCursor(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKeyRange*, IDBCursor::Direction);
144
145     class Transaction {
146     public:
147         explicit Transaction(IDBBackingStore*);
148         void begin();
149         bool commit();
150         void rollback();
151         void reset() { m_backingStore = 0; m_transaction = 0; }
152
153         static LevelDBTransaction* levelDBTransactionFrom(Transaction* transaction)
154         {
155             return static_cast<Transaction*>(transaction)->m_transaction.get();
156         }
157
158     private:
159         IDBBackingStore* m_backingStore;
160         RefPtr<LevelDBTransaction> m_transaction;
161     };
162
163 protected:
164     IDBBackingStore(const String& identifier, IDBFactoryBackendImpl*, PassOwnPtr<LevelDBDatabase>);
165
166     // Should only used for mocking.
167     IDBBackingStore();
168
169 private:
170     bool findKeyInIndex(IDBBackingStore::Transaction*, int64_t databaseId, int64_t objectStoreId, int64_t indexId, const IDBKey&, Vector<char>& foundEncodedPrimaryKey, bool& found);
171     void getIndexes(int64_t databaseId, int64_t objectStoreId, IDBObjectStoreMetadata::IndexMap*);
172
173     String m_identifier;
174     RefPtr<IDBFactoryBackendImpl> m_factory;
175     OwnPtr<LevelDBDatabase> m_db;
176     OwnPtr<LevelDBComparator> m_comparator;
177
178 };
179
180 } // namespace WebCore
181
182 #endif // ENABLE(INDEXED_DATABASE)
183
184 #endif // IDBBackingStore_h