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