Source/WebKit2/DatabaseProcess/IndexedDB/sqlite/UniqueIDBDatabaseBackingStoreSQLite.h

   1 /*
   2  * Copyright (C) 2013 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 #ifndef UniqueIDBDatabaseBackingStoreSQLite_h
  27 #define UniqueIDBDatabaseBackingStoreSQLite_h
  28
  29 #if ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)
  30
  31 #include "UniqueIDBDatabase.h"
  32 #include "UniqueIDBDatabaseBackingStore.h"
  33 #include <wtf/OwnPtr.h>
  34 #include <wtf/PassRefPtr.h>
  35 #include <wtf/text/WTFString.h>
  36
  37 namespace WebCore {
  38 class SQLiteDatabase;
  39 struct IDBDatabaseMetadata;
  40 }
  41
  42 namespace WebKit {
  43
  44 class SQLiteIDBTransaction;
  45
  46 class UniqueIDBDatabaseBackingStoreSQLite final : public UniqueIDBDatabaseBackingStore {
  47 public:
  48     static PassRefPtr<UniqueIDBDatabaseBackingStore> create(const UniqueIDBDatabaseIdentifier& identifier, const String& databaseDirectory)
  49     {
  50         return adoptRef(new UniqueIDBDatabaseBackingStoreSQLite(identifier, databaseDirectory));
  51     }
  52
  53     virtual ~UniqueIDBDatabaseBackingStoreSQLite();
  54
  55     virtual std::unique_ptr<WebCore::IDBDatabaseMetadata> getOrEstablishMetadata() override;
  56
  57     virtual bool establishTransaction(const IDBTransactionIdentifier&, const Vector<int64_t>& objectStoreIDs, WebCore::IndexedDB::TransactionMode) override;
  58     virtual bool beginTransaction(const IDBTransactionIdentifier&) override;
  59     virtual bool commitTransaction(const IDBTransactionIdentifier&) override;
  60     virtual bool resetTransaction(const IDBTransactionIdentifier&) override;
  61     virtual bool rollbackTransaction(const IDBTransactionIdentifier&) override;
  62
  63     virtual bool changeDatabaseVersion(const IDBTransactionIdentifier&, uint64_t newVersion) override;
  64     virtual bool createObjectStore(const IDBTransactionIdentifier&, const WebCore::IDBObjectStoreMetadata&) override;
  65     virtual bool deleteObjectStore(const IDBTransactionIdentifier&, int64_t objectStoreID) override;
  66     virtual bool clearObjectStore(const IDBTransactionIdentifier&, int64_t objectStoreID) override;
  67
  68     virtual PassRefPtr<WebCore::IDBKey> generateKey(const IDBTransactionIdentifier&, int64_t objectStoreID) override;
  69     virtual bool keyExistsInObjectStore(const IDBTransactionIdentifier&, int64_t objectStoreID, const WebCore::IDBKey&, bool& keyExists) override;
  70     virtual bool putRecord(const IDBTransactionIdentifier&, int64_t objectStoreID, const WebCore::IDBKey&, const uint8_t* valueBuffer, size_t valueSize) override;
  71     virtual bool updateKeyGenerator(const IDBTransactionIdentifier&, int64_t objectStoreId, const WebCore::IDBKey&, bool checkCurrent) override;
  72
  73     virtual bool getKeyRecordFromObjectStore(const IDBTransactionIdentifier&, int64_t objectStoreID, const WebCore::IDBKey&, RefPtr<WebCore::SharedBuffer>& result) override;
  74     virtual bool getKeyRangeRecordFromObjectStore(const IDBTransactionIdentifier&, int64_t objectStoreID, const WebCore::IDBKeyRange&, RefPtr<WebCore::SharedBuffer>& result, RefPtr<WebCore::IDBKey>& resultKey) override;
  75
  76 private:
  77     UniqueIDBDatabaseBackingStoreSQLite(const UniqueIDBDatabaseIdentifier&, const String& databaseDirectory);
  78
  79     std::unique_ptr<WebCore::SQLiteDatabase> openSQLiteDatabaseAtPath(const String&);
  80     std::unique_ptr<WebCore::IDBDatabaseMetadata> extractExistingMetadata();
  81     std::unique_ptr<WebCore::IDBDatabaseMetadata> createAndPopulateInitialMetadata();
  82
  83     int collate(int aLength, const void* a, int bLength, const void* b);
  84
  85     UniqueIDBDatabaseIdentifier m_identifier;
  86     String m_absoluteDatabaseDirectory;
  87
  88     std::unique_ptr<WebCore::SQLiteDatabase> m_sqliteDB;
  89
  90     HashMap<IDBTransactionIdentifier, std::unique_ptr<SQLiteIDBTransaction>> m_transactions;
  91 };
  92
  93 } // namespace WebKit
  94
  95 #endif // ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)
  96 #endif // UniqueIDBDatabaseBackingStoreSQLite_h