14004b309910ab5a20e6396f391ec3b48f04a1ef
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / SQLiteIDBBackingStore.h
1 /*
2  * Copyright (C) 2016 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 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBBackingStore.h"
31 #include "IDBDatabaseIdentifier.h"
32 #include "IDBDatabaseInfo.h"
33 #include "IDBResourceIdentifier.h"
34 #include "SQLiteIDBTransaction.h"
35 #include <JavaScriptCore/Strong.h>
36 #include <wtf/HashMap.h>
37
38 namespace WebCore {
39
40 class IndexKey;
41 class SQLiteDatabase;
42 class SQLiteStatement;
43
44 namespace IDBServer {
45
46 class SQLiteIDBCursor;
47
48 class SQLiteIDBBackingStore : public IDBBackingStore {
49     WTF_MAKE_FAST_ALLOCATED;
50 public:
51     SQLiteIDBBackingStore(const IDBDatabaseIdentifier&, const String& databaseRootDirectory, IDBBackingStoreTemporaryFileHandler&, uint64_t quota);
52     
53     ~SQLiteIDBBackingStore() final;
54
55     IDBError getOrEstablishDatabaseInfo(IDBDatabaseInfo&) final;
56
57     IDBError beginTransaction(const IDBTransactionInfo&) final;
58     IDBError abortTransaction(const IDBResourceIdentifier& transactionIdentifier) final;
59     IDBError commitTransaction(const IDBResourceIdentifier& transactionIdentifier) final;
60     IDBError createObjectStore(const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&) final;
61     IDBError deleteObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier) final;
62     IDBError renameObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const String& newName) final;
63     IDBError clearObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier) final;
64     IDBError createIndex(const IDBResourceIdentifier& transactionIdentifier, const IDBIndexInfo&) final;
65     IDBError deleteIndex(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier) final;
66     IDBError renameIndex(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName) final;
67     IDBError keyExistsInObjectStore(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, bool& keyExists) final;
68     IDBError deleteRange(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&) final;
69     IDBError addRecord(const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&, const IDBKeyData&, const IDBValue&) final;
70     IDBError getRecord(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyRangeData&, IDBGetRecordDataType, IDBGetResult& outValue) final;
71     IDBError getAllRecords(const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&, IDBGetAllResult& outValue) final;
72     IDBError getIndexRecord(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, IndexedDB::IndexRecordType, const IDBKeyRangeData&, IDBGetResult& outValue) final;
73     IDBError getCount(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const IDBKeyRangeData&, uint64_t& outCount) final;
74     IDBError generateKeyNumber(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t& keyNumber) final;
75     IDBError revertGeneratedKeyNumber(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, uint64_t keyNumber) final;
76     IDBError maybeUpdateKeyGeneratorNumber(const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, double newKeyNumber) final;
77     IDBError openCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBCursorInfo&, IDBGetResult& outResult) final;
78     IDBError iterateCursor(const IDBResourceIdentifier& transactionIdentifier, const IDBResourceIdentifier& cursorIdentifier, const IDBIterateCursorData&, IDBGetResult& outResult) final;
79     bool prefetchCursor(const IDBResourceIdentifier&, const IDBResourceIdentifier&) final;
80
81     IDBObjectStoreInfo* infoForObjectStore(uint64_t objectStoreIdentifier) final;
82     void deleteBackingStore() final;
83
84     void setQuota(uint64_t quota) final { m_quota = quota; }
85
86     bool supportsSimultaneousTransactions() final { return false; }
87     bool isEphemeral() final { return false; }
88
89     void unregisterCursor(SQLiteIDBCursor&);
90
91     String fullDatabaseDirectory() const;
92
93     IDBBackingStoreTemporaryFileHandler& temporaryFileHandler() const { return m_temporaryFileHandler; }
94
95     IDBError getBlobRecordsForObjectStoreRecord(int64_t objectStoreRecord, Vector<String>& blobURLs, PAL::SessionID&, Vector<String>& blobFilePaths);
96
97     static String databaseNameFromEncodedFilename(const String&);
98
99 private:
100     String filenameForDatabaseName() const;
101     String fullDatabasePath() const;
102
103     uint64_t quotaForOrigin() const;
104     uint64_t maximumSize() const;
105
106     bool ensureValidRecordsTable();
107     bool ensureValidIndexRecordsTable();
108     bool ensureValidIndexRecordsIndex();
109     bool ensureValidBlobTables();
110     std::unique_ptr<IDBDatabaseInfo> createAndPopulateInitialDatabaseInfo();
111     std::unique_ptr<IDBDatabaseInfo> extractExistingDatabaseInfo();
112
113     IDBError deleteRecord(SQLiteIDBTransaction&, int64_t objectStoreID, const IDBKeyData&);
114     IDBError uncheckedGetKeyGeneratorValue(int64_t objectStoreID, uint64_t& outValue);
115     IDBError uncheckedSetKeyGeneratorValue(int64_t objectStoreID, uint64_t value);
116
117     IDBError updateAllIndexesForAddRecord(const IDBObjectStoreInfo&, const IDBKeyData&, const ThreadSafeDataBuffer& value, int64_t recordID);
118     IDBError updateOneIndexForAddRecord(const IDBIndexInfo&, const IDBKeyData&, const ThreadSafeDataBuffer& value, int64_t recordID);
119     IDBError uncheckedPutIndexKey(const IDBIndexInfo&, const IDBKeyData& keyValue, const IndexKey&, int64_t recordID);
120     IDBError uncheckedPutIndexRecord(int64_t objectStoreID, int64_t indexID, const IDBKeyData& keyValue, const IDBKeyData& indexKey, int64_t recordID);
121     IDBError uncheckedHasIndexRecord(const IDBIndexInfo&, const IDBKeyData&, bool& hasRecord);
122     IDBError uncheckedGetIndexRecordForOneKey(int64_t indexeID, int64_t objectStoreID, IndexedDB::IndexRecordType, const IDBKeyData&, IDBGetResult&);
123
124     IDBError deleteUnusedBlobFileRecords(SQLiteIDBTransaction&);
125
126     IDBError getAllObjectStoreRecords(const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&, IDBGetAllResult& outValue);
127     IDBError getAllIndexRecords(const IDBResourceIdentifier& transactionIdentifier, const IDBGetAllRecordsData&, IDBGetAllResult& outValue);
128
129     void closeSQLiteDB();
130
131     enum class SQL : size_t {
132         CreateObjectStoreInfo,
133         CreateObjectStoreKeyGenerator,
134         DeleteObjectStoreInfo,
135         DeleteObjectStoreKeyGenerator,
136         DeleteObjectStoreRecords,
137         DeleteObjectStoreIndexInfo,
138         DeleteObjectStoreIndexRecords,
139         DeleteObjectStoreBlobRecords,
140         RenameObjectStore,
141         ClearObjectStoreRecords,
142         ClearObjectStoreIndexRecords,
143         CreateIndexInfo,
144         DeleteIndexInfo,
145         HasIndexRecord,
146         PutIndexRecord,
147         GetIndexRecordForOneKey,
148         DeleteIndexRecords,
149         RenameIndex,
150         KeyExistsInObjectStore,
151         GetUnusedBlobFilenames,
152         DeleteUnusedBlobs,
153         GetObjectStoreRecordID,
154         DeleteBlobRecord,
155         DeleteObjectStoreRecord,
156         DeleteObjectStoreIndexRecord,
157         AddObjectStoreRecord,
158         AddBlobRecord,
159         BlobFilenameForBlobURL,
160         AddBlobFilename,
161         GetBlobURL,
162         GetKeyGeneratorValue,
163         SetKeyGeneratorValue,
164         GetAllKeyRecordsLowerOpenUpperOpen,
165         GetAllKeyRecordsLowerOpenUpperClosed,
166         GetAllKeyRecordsLowerClosedUpperOpen,
167         GetAllKeyRecordsLowerClosedUpperClosed,
168         GetValueRecordsLowerOpenUpperOpen,
169         GetValueRecordsLowerOpenUpperClosed,
170         GetValueRecordsLowerClosedUpperOpen,
171         GetValueRecordsLowerClosedUpperClosed,
172         GetKeyRecordsLowerOpenUpperOpen,
173         GetKeyRecordsLowerOpenUpperClosed,
174         GetKeyRecordsLowerClosedUpperOpen,
175         GetKeyRecordsLowerClosedUpperClosed,
176         Count
177     };
178
179     SQLiteStatement* cachedStatement(SQL, const char*);
180     SQLiteStatement* cachedStatementForGetAllObjectStoreRecords(const IDBGetAllRecordsData&);
181
182     std::unique_ptr<SQLiteStatement> m_cachedStatements[static_cast<int>(SQL::Count)];
183
184     JSC::VM& vm();
185     JSC::JSGlobalObject& globalObject();
186     void initializeVM();
187
188     IDBDatabaseIdentifier m_identifier;
189     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
190     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfoBeforeVersionChange;
191
192     std::unique_ptr<SQLiteDatabase> m_sqliteDB;
193
194     HashMap<IDBResourceIdentifier, std::unique_ptr<SQLiteIDBTransaction>> m_transactions;
195     HashMap<IDBResourceIdentifier, SQLiteIDBCursor*> m_cursors;
196
197     String m_absoluteDatabaseDirectory;
198
199     RefPtr<JSC::VM> m_vm;
200     JSC::Strong<JSC::JSGlobalObject> m_globalObject;
201
202     IDBBackingStoreTemporaryFileHandler& m_temporaryFileHandler;
203     
204     uint64_t m_quota;
205 };
206
207 } // namespace IDBServer
208 } // namespace WebCore
209
210 #endif // ENABLE(INDEXED_DATABASE)