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