c79f537b7dd25310b7d8ed0ef8564332d4eab010
[WebKit-https.git] / Source / WebCore / storage / IDBFactoryBackendImpl.cpp
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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "IDBFactoryBackendImpl.h"
31
32 #include "DOMStringList.h"
33 #include "IDBDatabaseBackendImpl.h"
34 #include "IDBDatabaseException.h"
35 #include "IDBLevelDBBackingStore.h"
36 #include "IDBObjectStoreBackendImpl.h"
37 #include "IDBSQLiteBackingStore.h"
38 #include "IDBTransactionCoordinator.h"
39 #include "SecurityOrigin.h"
40 #include <wtf/Threading.h>
41 #include <wtf/UnusedParam.h>
42
43 #if ENABLE(INDEXED_DATABASE)
44
45 namespace WebCore {
46
47 static String computeFileIdentifier(SecurityOrigin* securityOrigin, IDBFactoryBackendInterface::BackingStoreType type)
48 {
49     return securityOrigin->databaseIdentifier() + String::format("@%d", type);
50 }
51
52 static String computeUniqueIdentifier(const String& name, SecurityOrigin* securityOrigin, IDBFactoryBackendInterface::BackingStoreType type)
53 {
54     return computeFileIdentifier(securityOrigin, type) + name;
55 }
56
57 IDBFactoryBackendImpl::IDBFactoryBackendImpl()
58     : m_transactionCoordinator(IDBTransactionCoordinator::create())
59 {
60 }
61
62 IDBFactoryBackendImpl::~IDBFactoryBackendImpl()
63 {
64 }
65
66 void IDBFactoryBackendImpl::removeIDBDatabaseBackend(const String& uniqueIdentifier)
67 {
68     ASSERT(m_databaseBackendMap.contains(uniqueIdentifier));
69     m_databaseBackendMap.remove(uniqueIdentifier);
70 }
71
72 void IDBFactoryBackendImpl::addIDBBackingStore(const String& fileIdentifier, IDBBackingStore* backingStore)
73 {
74     ASSERT(!m_backingStoreMap.contains(fileIdentifier));
75     m_backingStoreMap.set(fileIdentifier, backingStore);
76 }
77
78 void IDBFactoryBackendImpl::removeIDBBackingStore(const String& fileIdentifier)
79 {
80     ASSERT(m_backingStoreMap.contains(fileIdentifier));
81     m_backingStoreMap.remove(fileIdentifier);
82 }
83
84 void IDBFactoryBackendImpl::open(const String& name, PassRefPtr<IDBCallbacks> callbacks, PassRefPtr<SecurityOrigin> securityOrigin, Frame*, const String& dataDir, int64_t maximumSize, BackingStoreType backingStoreType)
85 {
86     if (backingStoreType == DefaultBackingStore)
87         backingStoreType = SQLiteBackingStore; // FIXME: DefaultBackingStore is confusing; get rid of it.
88
89     const String fileIdentifier = computeFileIdentifier(securityOrigin.get(), backingStoreType);
90     const String uniqueIdentifier = computeUniqueIdentifier(name, securityOrigin.get(), backingStoreType);
91
92     IDBDatabaseBackendMap::iterator it = m_databaseBackendMap.find(uniqueIdentifier);
93     if (it != m_databaseBackendMap.end()) {
94         callbacks->onSuccess(it->second);
95         return;
96     }
97
98     // FIXME: Everything from now on should be done on another thread.
99
100     RefPtr<IDBBackingStore> backingStore;
101     IDBBackingStoreMap::iterator it2 = m_backingStoreMap.find(fileIdentifier);
102     if (it2 != m_backingStoreMap.end() && (backingStoreType == it2->second->backingStoreType()))
103         backingStore = it2->second;
104     else {
105
106 #if ENABLE(LEVELDB)
107         if (backingStoreType == LevelDBBackingStore) {
108             bool hasSQLBackingStore = IDBSQLiteBackingStore::backingStoreExists(securityOrigin.get(), name, dataDir);
109
110             // LayoutTests: SQLite backing store may not exist on disk but may exist in cache.
111             String cachedSqliteBackingStoreIdentifier = computeFileIdentifier(securityOrigin.get(), SQLiteBackingStore);
112             if (!hasSQLBackingStore && (m_backingStoreMap.end() != m_backingStoreMap.find(cachedSqliteBackingStoreIdentifier)))
113                 hasSQLBackingStore = true;
114
115             if (hasSQLBackingStore) {
116                 bool migrationSucceeded = migrateFromSQLiteToLevelDB(name, securityOrigin.get(), dataDir, maximumSize);
117                 (void)migrationSucceeded; // FIXME: When migration is actually implemented, we need error handling here.
118             }
119         }
120 #endif
121
122         if (backingStoreType == SQLiteBackingStore)
123             backingStore = IDBSQLiteBackingStore::open(securityOrigin.get(), dataDir, maximumSize, fileIdentifier, this);
124 #if ENABLE(LEVELDB)
125         else if (backingStoreType == LevelDBBackingStore)
126             backingStore = IDBLevelDBBackingStore::open(securityOrigin.get(), dataDir, maximumSize, fileIdentifier, this);
127 #endif
128         if (!backingStore) {
129             callbacks->onError(IDBDatabaseError::create(IDBDatabaseException::UNKNOWN_ERR, "Internal error."));
130             return;
131         }
132     }
133
134     RefPtr<IDBDatabaseBackendImpl> databaseBackend = IDBDatabaseBackendImpl::create(name, backingStore.get(), m_transactionCoordinator.get(), this, uniqueIdentifier);
135     callbacks->onSuccess(databaseBackend.get());
136     m_databaseBackendMap.set(uniqueIdentifier, databaseBackend.get());
137 }
138
139 #if ENABLE(LEVELDB)
140
141 static bool migrateObjectStores(PassRefPtr<IDBBackingStore> fromBackingStore, int64_t fromDatabaseId, PassRefPtr<IDBBackingStore> toBackingStore, int64_t toDatabaseId)
142 {
143     Vector<int64_t> fromObjStoreIds, toObjStoreIds;
144     Vector<String> fromObjStoreNames, toObjStoreNames;
145     Vector<String> fromKeyPaths, toKeyPaths;
146     Vector<bool> fromAutoIncrement, toAutoIncrement;
147
148     // Migrate objectStores. Check to see if the object store already exists in the target.
149     fromBackingStore->getObjectStores(fromDatabaseId, fromObjStoreIds, fromObjStoreNames, fromKeyPaths, fromAutoIncrement);
150
151     toBackingStore->getObjectStores(toDatabaseId, toObjStoreIds, toObjStoreNames, toKeyPaths, toAutoIncrement);
152
153     for (unsigned i = 0; i < fromObjStoreIds.size(); i++) {
154         if (toObjStoreNames.contains(fromObjStoreNames[i]))
155             continue;
156
157         int64_t assignedObjectStoreId = -1;
158
159         RefPtr<IDBBackingStore::Transaction> trans = toBackingStore->createTransaction();
160         trans->begin();
161
162         if (!toBackingStore->createObjectStore(toDatabaseId, fromObjStoreNames[i], fromKeyPaths[i], fromAutoIncrement[i], assignedObjectStoreId))
163             return false;
164
165         RefPtr<IDBBackingStore::Cursor> cursor = fromBackingStore->openObjectStoreCursor(fromDatabaseId, fromObjStoreIds[i], 0, IDBCursor::NEXT);
166         if (cursor) {
167             do {
168                 RefPtr<IDBKey> key = cursor->key();
169                 RefPtr<IDBBackingStore::ObjectStoreRecordIdentifier> recordIdentifier = toBackingStore->createInvalidRecordIdentifier();
170
171                 if (!toBackingStore->putObjectStoreRecord(toDatabaseId, assignedObjectStoreId, *(key.get()), cursor->value(), recordIdentifier.get()))
172                     return false;
173
174             } while (cursor->continueFunction());
175         }
176
177         // Populate any/all indexes for this objectstore.
178         Vector<int64_t> idxIds;
179         Vector<String> idxNames;
180         Vector<String> idxKeyPaths;
181         Vector<bool> idxUnique;
182         fromBackingStore->getIndexes(fromDatabaseId, fromObjStoreIds[i], idxIds, idxNames, idxKeyPaths, idxUnique);
183         for (unsigned j = 0; j < idxIds.size(); j++) {
184             int64_t indexId = -1;
185
186             if (!toBackingStore->createIndex(toDatabaseId, assignedObjectStoreId, idxNames[j], idxKeyPaths[j], idxUnique[j], indexId))
187                 return false;
188
189             if (!IDBObjectStoreBackendImpl::populateIndex(*toBackingStore, toDatabaseId, assignedObjectStoreId, indexId, fromKeyPaths[i]))
190                 return false;
191         }
192
193         trans->commit();
194     }
195
196     return true;
197 }
198 #endif // #if ENABLE(LEVELDB)
199
200 bool IDBFactoryBackendImpl::migrateFromSQLiteToLevelDB(const String& name, SecurityOrigin* securityOrigin, const String& dataDir, int64_t maximumSize)
201 {
202 #if ENABLE(LEVELDB)
203     String fromUniqueIdentifier = computeUniqueIdentifier(name, securityOrigin, SQLiteBackingStore);
204     String fromFileIdentifier = computeFileIdentifier(securityOrigin, SQLiteBackingStore);
205     String toUniqueIdentifier = computeUniqueIdentifier(name, securityOrigin, LevelDBBackingStore);
206     String toFileIdentifier = computeFileIdentifier(securityOrigin, LevelDBBackingStore);
207     RefPtr<IDBTransactionCoordinator> transactionCoordinator = IDBTransactionCoordinator::create();
208     RefPtr<IDBBackingStore> fromBackingStore;
209     RefPtr<IDBDatabaseBackendImpl> fromDatabaseBackend;
210     RefPtr<IDBBackingStore> toBackingStore;
211
212
213     // Open "From" backing store and backend. When running LayoutTests, the
214     // "from" database may be cached in this class instance, so look for it there first.
215     IDBBackingStoreMap::iterator it = m_backingStoreMap.find(fromFileIdentifier);
216     if (it != m_backingStoreMap.end())
217         fromBackingStore = it->second;
218     else
219         fromBackingStore = IDBSQLiteBackingStore::open(securityOrigin, dataDir, maximumSize, fromFileIdentifier, this);
220
221     if (!fromBackingStore)
222         return false;
223
224     IDBDatabaseBackendMap::iterator it2 = m_databaseBackendMap.find(fromUniqueIdentifier);
225     if (it2 != m_databaseBackendMap.end())
226         fromDatabaseBackend = it2->second;
227     else {
228         fromDatabaseBackend = IDBDatabaseBackendImpl::create(name, fromBackingStore.get(), transactionCoordinator.get(), this, fromUniqueIdentifier);
229         m_databaseBackendMap.set(fromUniqueIdentifier, fromDatabaseBackend.get());
230     }
231
232     if (!fromDatabaseBackend)
233         return false;
234
235     // Open "To" database. First find out if it already exists -- this will determine if
236     // it is safe to call IDBLevelDBBackingStore::extractIDBDatabaseMetaData.
237     it = m_backingStoreMap.find(toFileIdentifier);
238     if (it != m_backingStoreMap.end())
239         toBackingStore = it->second;
240     else
241         toBackingStore = IDBLevelDBBackingStore::open(securityOrigin, dataDir, maximumSize, toFileIdentifier, this);
242
243     if (!toBackingStore)
244         return false;
245
246
247     String toDatabaseName = fromDatabaseBackend->name();
248     String toDatabaseVersion = fromDatabaseBackend->version();
249     int64_t toDatabaseId = -1;
250
251     if (!toBackingStore->extractIDBDatabaseMetaData(toDatabaseName, toDatabaseVersion, toDatabaseId)) {
252         if (!toBackingStore->setIDBDatabaseMetaData(toDatabaseName, toDatabaseVersion, toDatabaseId, true))
253             return false;
254     }
255
256     return migrateObjectStores(fromBackingStore, fromDatabaseBackend->id(), toBackingStore, toDatabaseId);
257
258 #endif // ENABLE(LEVELDB)
259     return false;
260 }
261
262 } // namespace WebCore
263
264 #endif // ENABLE(INDEXED_DATABASE)