2011-06-28 Hans Wennborg <hans@chromium.org>
[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     ASSERT(backingStoreType != DefaultBackingStore);
87
88     const String fileIdentifier = computeFileIdentifier(securityOrigin.get(), backingStoreType);
89     const String uniqueIdentifier = computeUniqueIdentifier(name, securityOrigin.get(), backingStoreType);
90
91     IDBDatabaseBackendMap::iterator it = m_databaseBackendMap.find(uniqueIdentifier);
92     if (it != m_databaseBackendMap.end()) {
93         callbacks->onSuccess(it->second);
94         return;
95     }
96
97     // FIXME: Everything from now on should be done on another thread.
98
99 #if ENABLE(LEVELDB)
100     if (backingStoreType == LevelDBBackingStore) {
101         bool hasSQLBackingStore = IDBSQLiteBackingStore::backingStoreExists(securityOrigin.get(), name, dataDir);
102
103         // LayoutTests: SQLite backing store may not exist on disk but may exist in cache.
104         String cachedSqliteBackingStoreIdentifier = computeFileIdentifier(securityOrigin.get(), SQLiteBackingStore);
105         if (!hasSQLBackingStore && (m_backingStoreMap.end() != m_backingStoreMap.find(cachedSqliteBackingStoreIdentifier)))
106             hasSQLBackingStore = true;
107
108         if (hasSQLBackingStore) {
109             bool migrationSucceeded = migrateFromSQLiteToLevelDB(name, securityOrigin.get(), dataDir, maximumSize);
110             UNUSED_PARAM(migrationSucceeded); // FIXME: When migration is actually implemented, we need error handling here.
111         }
112     }
113 #endif
114
115     RefPtr<IDBBackingStore> backingStore;
116     IDBBackingStoreMap::iterator it2 = m_backingStoreMap.find(fileIdentifier);
117     if (it2 != m_backingStoreMap.end() && (backingStoreType == it2->second->backingStoreType()))
118         backingStore = it2->second;
119     else {
120         if (backingStoreType == SQLiteBackingStore)
121             backingStore = IDBSQLiteBackingStore::open(securityOrigin.get(), dataDir, maximumSize, fileIdentifier, this);
122 #if ENABLE(LEVELDB)
123         else if (backingStoreType == LevelDBBackingStore)
124             backingStore = IDBLevelDBBackingStore::open(securityOrigin.get(), dataDir, maximumSize, fileIdentifier, this);
125 #endif
126         if (!backingStore) {
127             callbacks->onError(IDBDatabaseError::create(IDBDatabaseException::UNKNOWN_ERR, "Internal error."));
128             return;
129         }
130     }
131
132     RefPtr<IDBDatabaseBackendImpl> databaseBackend = IDBDatabaseBackendImpl::create(name, backingStore.get(), m_transactionCoordinator.get(), this, uniqueIdentifier);
133     callbacks->onSuccess(databaseBackend.get());
134     m_databaseBackendMap.set(uniqueIdentifier, databaseBackend.get());
135 }
136
137 #if ENABLE(LEVELDB)
138
139 static bool migrateObjectStores(PassRefPtr<IDBBackingStore> fromBackingStore, int64_t fromDatabaseId, PassRefPtr<IDBBackingStore> toBackingStore, int64_t toDatabaseId)
140 {
141     Vector<int64_t> fromObjStoreIds, toObjStoreIds;
142     Vector<String> fromObjStoreNames, toObjStoreNames;
143     Vector<String> fromKeyPaths, toKeyPaths;
144     Vector<bool> fromAutoIncrement, toAutoIncrement;
145
146     // Migrate objectStores. Check to see if the object store already exists in the target.
147     fromBackingStore->getObjectStores(fromDatabaseId, fromObjStoreIds, fromObjStoreNames, fromKeyPaths, fromAutoIncrement);
148
149     toBackingStore->getObjectStores(toDatabaseId, toObjStoreIds, toObjStoreNames, toKeyPaths, toAutoIncrement);
150
151     for (unsigned i = 0; i < fromObjStoreIds.size(); i++) {
152         if (toObjStoreNames.contains(fromObjStoreNames[i]))
153             continue;
154
155         int64_t assignedObjectStoreId = -1;
156
157         RefPtr<IDBBackingStore::Transaction> trans = toBackingStore->createTransaction();
158         trans->begin();
159
160         if (!toBackingStore->createObjectStore(toDatabaseId, fromObjStoreNames[i], fromKeyPaths[i], fromAutoIncrement[i], assignedObjectStoreId))
161             return false;
162
163         RefPtr<IDBBackingStore::Cursor> cursor = fromBackingStore->openObjectStoreCursor(fromDatabaseId, fromObjStoreIds[i], 0, IDBCursor::NEXT);
164         if (cursor) {
165             do {
166                 RefPtr<IDBKey> key = cursor->key();
167                 RefPtr<IDBBackingStore::ObjectStoreRecordIdentifier> recordIdentifier = toBackingStore->createInvalidRecordIdentifier();
168
169                 if (!toBackingStore->putObjectStoreRecord(toDatabaseId, assignedObjectStoreId, *(key.get()), cursor->value(), recordIdentifier.get()))
170                     return false;
171
172             } while (cursor->continueFunction());
173         }
174
175         // Populate any/all indexes for this objectstore.
176         Vector<int64_t> idxIds;
177         Vector<String> idxNames;
178         Vector<String> idxKeyPaths;
179         Vector<bool> idxUnique;
180         fromBackingStore->getIndexes(fromDatabaseId, fromObjStoreIds[i], idxIds, idxNames, idxKeyPaths, idxUnique);
181         for (unsigned j = 0; j < idxIds.size(); j++) {
182             int64_t indexId = -1;
183
184             if (!toBackingStore->createIndex(toDatabaseId, assignedObjectStoreId, idxNames[j], idxKeyPaths[j], idxUnique[j], indexId))
185                 return false;
186
187             if (!IDBObjectStoreBackendImpl::populateIndex(*toBackingStore, toDatabaseId, assignedObjectStoreId, indexId, fromKeyPaths[i]))
188                 return false;
189         }
190
191         trans->commit();
192     }
193
194     return true;
195 }
196 #endif // #if ENABLE(LEVELDB)
197
198 bool IDBFactoryBackendImpl::migrateFromSQLiteToLevelDB(const String& name, SecurityOrigin* securityOrigin, const String& dataDir, int64_t maximumSize)
199 {
200 #if ENABLE(LEVELDB)
201     String fromUniqueIdentifier = computeUniqueIdentifier(name, securityOrigin, SQLiteBackingStore);
202     String fromFileIdentifier = computeFileIdentifier(securityOrigin, SQLiteBackingStore);
203     String toUniqueIdentifier = computeUniqueIdentifier(name, securityOrigin, LevelDBBackingStore);
204     String toFileIdentifier = computeFileIdentifier(securityOrigin, LevelDBBackingStore);
205     RefPtr<IDBTransactionCoordinator> transactionCoordinator = IDBTransactionCoordinator::create();
206     RefPtr<IDBBackingStore> fromBackingStore;
207     RefPtr<IDBDatabaseBackendImpl> fromDatabaseBackend;
208     RefPtr<IDBBackingStore> toBackingStore;
209
210
211     // Open "From" backing store and backend. When running LayoutTests, the
212     // "from" database may be cached in this class instance, so look for it there first.
213     IDBBackingStoreMap::iterator it = m_backingStoreMap.find(fromFileIdentifier);
214     if (it != m_backingStoreMap.end())
215         fromBackingStore = it->second;
216     else
217         fromBackingStore = IDBSQLiteBackingStore::open(securityOrigin, dataDir, maximumSize, fromFileIdentifier, this);
218
219     if (!fromBackingStore)
220         return false;
221
222     IDBDatabaseBackendMap::iterator it2 = m_databaseBackendMap.find(fromUniqueIdentifier);
223     if (it2 != m_databaseBackendMap.end())
224         fromDatabaseBackend = it2->second;
225     else {
226         fromDatabaseBackend = IDBDatabaseBackendImpl::create(name, fromBackingStore.get(), transactionCoordinator.get(), this, fromUniqueIdentifier);
227         m_databaseBackendMap.set(fromUniqueIdentifier, fromDatabaseBackend.get());
228     }
229
230     if (!fromDatabaseBackend)
231         return false;
232
233     // Open "To" database. First find out if it already exists -- this will determine if
234     // it is safe to call IDBLevelDBBackingStore::extractIDBDatabaseMetaData.
235     it = m_backingStoreMap.find(toFileIdentifier);
236     if (it != m_backingStoreMap.end())
237         toBackingStore = it->second;
238     else
239         toBackingStore = IDBLevelDBBackingStore::open(securityOrigin, dataDir, maximumSize, toFileIdentifier, this);
240
241     if (!toBackingStore)
242         return false;
243
244
245     String toDatabaseName = fromDatabaseBackend->name();
246     String toDatabaseVersion = fromDatabaseBackend->version();
247     int64_t toDatabaseId = -1;
248
249     if (!toBackingStore->extractIDBDatabaseMetaData(toDatabaseName, toDatabaseVersion, toDatabaseId)) {
250         if (!toBackingStore->setIDBDatabaseMetaData(toDatabaseName, toDatabaseVersion, toDatabaseId, true))
251             return false;
252     }
253
254     return migrateObjectStores(fromBackingStore, fromDatabaseBackend->id(), toBackingStore, toDatabaseId);
255
256 #endif // ENABLE(LEVELDB)
257     return false;
258 }
259
260 } // namespace WebCore
261
262 #endif // ENABLE(INDEXED_DATABASE)