OLD | NEW |
(Empty) | |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. |
| 4 |
| 5 #ifndef WEBKIT_DOM_STORAGE_DOM_STORAGE_DATABASE_H_ |
| 6 #define WEBKIT_DOM_STORAGE_DOM_STORAGE_DATABASE_H_ |
| 7 |
| 8 #include <map> |
| 9 |
| 10 #include "base/file_path.h" |
| 11 #include "base/gtest_prod_util.h" |
| 12 #include "base/memory/scoped_ptr.h" |
| 13 #include "base/nullable_string16.h" |
| 14 #include "base/string16.h" |
| 15 #include "sql/connection.h" |
| 16 |
| 17 namespace dom_storage { |
| 18 |
| 19 // Represents a SQLite based backing for DOM storage data. This |
| 20 // class is designed to be used on a single thread. |
| 21 class DomStorageDatabase { |
| 22 public: |
| 23 explicit DomStorageDatabase(const FilePath& file_path); |
| 24 |
| 25 typedef std::map<string16, NullableString16> ValuesMap; |
| 26 |
| 27 // Reads all the key, value pairs stored in the database and returns |
| 28 // them. |result| is assumed to be empty and any duplicate keys will |
| 29 // be overwritten. If the database exists on disk then it will be |
| 30 // opened. If it does not exist then it will not be created and |
| 31 // |result| will be unmodified. |
| 32 void ReadAllValues(ValuesMap* result); |
| 33 |
| 34 // Updates the backing database. Will remove all keys before updating |
| 35 // the database if |clear_all_first| is set. Then all entries in |
| 36 // |changes| will be examined - keys mapped to a null NullableString16 |
| 37 // will be removed and all others will be inserted/updated as appropriate. |
| 38 bool CommitChanges(bool clear_all_first, const ValuesMap& changes); |
| 39 |
| 40 private: |
| 41 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, SimpleOpenAndClose); |
| 42 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, TestLazyOpenIsLazy); |
| 43 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, |
| 44 TestUpgradesV1TableToV2); |
| 45 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, TestIsOpen); |
| 46 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, SimpleRead); |
| 47 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, SimpleWrite); |
| 48 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, WriteWithClear); |
| 49 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, UpgradeFromV1ToV2NoData); |
| 50 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, |
| 51 UpgradeFromV1ToV2WithData); |
| 52 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, |
| 53 TestOpenCloseDataPreserved); |
| 54 FRIEND_TEST_ALL_PREFIXES(DomStorageDatabaseTest, TestSimpleRemoveOneValue); |
| 55 |
| 56 // Open the database at file_path_ if it exists already and creates it if |
| 57 // |create_if_needed| is true. |
| 58 // Ensures we are at the correct database version and creates or updates |
| 59 // tables as necessary. Returns false on failure. |
| 60 bool LazyOpen(bool create_if_needed); |
| 61 |
| 62 // Creates the ItemTable at the current version of the database. |
| 63 bool CreateTable(); |
| 64 bool CreateTableV2(); |
| 65 |
| 66 // Version 1 -> 2 migrated the value column in the ItemTable from a TEXT |
| 67 // to a BLOB. Exisitng data is preserved. |
| 68 bool UpgradeVersion1To2IfNeeded(); |
| 69 |
| 70 void Close(); |
| 71 bool IsOpen() const { return db_.get() ? db_->is_open() : false; } |
| 72 |
| 73 // Path to the database on disk. |
| 74 FilePath file_path_; |
| 75 scoped_ptr<sql::Connection> db_; |
| 76 }; |
| 77 |
| 78 } // namespace dom_storage |
| 79 |
| 80 #endif // WEBKIT_DOM_STORAGE_DOM_STORAGE_DATABASE_H_ |
OLD | NEW |