OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_PREFS_JSON_PREF_STORE_H_ | 5 #ifndef BASE_PREFS_JSON_PREF_STORE_H_ |
6 #define BASE_PREFS_JSON_PREF_STORE_H_ | 6 #define BASE_PREFS_JSON_PREF_STORE_H_ |
7 | 7 |
8 #include <set> | |
9 #include <string> | 8 #include <string> |
10 | 9 |
11 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
12 #include "base/compiler_specific.h" | 11 #include "base/compiler_specific.h" |
13 #include "base/files/file_path.h" | 12 #include "base/files/file_path.h" |
14 #include "base/files/important_file_writer.h" | |
15 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
16 #include "base/message_loop/message_loop_proxy.h" | 14 #include "base/message_loop/message_loop_proxy.h" |
17 #include "base/observer_list.h" | 15 #include "base/observer_list.h" |
18 #include "base/prefs/base_prefs_export.h" | |
19 #include "base/prefs/persistent_pref_store.h" | 16 #include "base/prefs/persistent_pref_store.h" |
20 | 17 #include "base/prefs/pref_value_map.h" |
21 class PrefFilter; | |
22 | 18 |
23 namespace base { | 19 namespace base { |
24 class DictionaryValue; | 20 class DictionaryValue; |
25 class FilePath; | |
26 class SequencedTaskRunner; | 21 class SequencedTaskRunner; |
27 class SequencedWorkerPool; | |
28 class Value; | 22 class Value; |
29 } | 23 } |
30 | 24 |
25 namespace leveldb { | |
26 class DB; | |
27 } | |
31 | 28 |
32 // A writable PrefStore implementation that is used for user preferences. | 29 // A writable PrefStore implementation that is used for user preferences. |
33 class BASE_PREFS_EXPORT JsonPrefStore | 30 class BASE_PREFS_EXPORT LevelDBPrefStore : public PersistentPrefStore { |
34 : public PersistentPrefStore, | |
35 public base::ImportantFileWriter::DataSerializer { | |
36 public: | 31 public: |
37 // Returns instance of SequencedTaskRunner which guarantees that file | |
38 // operations on the same file will be executed in sequenced order. | |
39 static scoped_refptr<base::SequencedTaskRunner> GetTaskRunnerForFile( | |
40 const base::FilePath& pref_filename, | |
41 base::SequencedWorkerPool* worker_pool); | |
42 | |
43 // |sequenced_task_runner| is must be a shutdown-blocking task runner, ideally | 32 // |sequenced_task_runner| is must be a shutdown-blocking task runner, ideally |
44 // created by GetTaskRunnerForFile() method above. | 33 // created by GetTaskRunnerForFile() method above. |
45 JsonPrefStore(const base::FilePath& pref_filename, | 34 LevelDBPrefStore(const base::FilePath& pref_filename, |
46 base::SequencedTaskRunner* sequenced_task_runner, | 35 base::SequencedTaskRunner* sequenced_task_runner); |
47 scoped_ptr<PrefFilter> pref_filter); | |
48 | 36 |
49 // PrefStore overrides: | 37 // PrefStore overrides: |
50 virtual bool GetValue(const std::string& key, | 38 virtual bool GetValue(const std::string& key, |
51 const base::Value** result) const OVERRIDE; | 39 const base::Value** result) const OVERRIDE; |
52 virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; | 40 virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; |
53 virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; | 41 virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; |
54 virtual bool HasObservers() const OVERRIDE; | 42 virtual bool HasObservers() const OVERRIDE; |
55 virtual bool IsInitializationComplete() const OVERRIDE; | 43 virtual bool IsInitializationComplete() const OVERRIDE; |
56 | 44 |
57 // PersistentPrefStore overrides: | 45 // PersistentPrefStore overrides: |
58 virtual bool GetMutableValue(const std::string& key, | 46 virtual bool GetMutableValue(const std::string& key, |
59 base::Value** result) OVERRIDE; | 47 base::Value** result) OVERRIDE; |
48 // Takes ownership of value. | |
60 virtual void SetValue(const std::string& key, base::Value* value) OVERRIDE; | 49 virtual void SetValue(const std::string& key, base::Value* value) OVERRIDE; |
61 virtual void SetValueSilently(const std::string& key, | 50 virtual void SetValueSilently(const std::string& key, |
62 base::Value* value) OVERRIDE; | 51 base::Value* value) OVERRIDE; |
63 virtual void RemoveValue(const std::string& key) OVERRIDE; | 52 virtual void RemoveValue(const std::string& key) OVERRIDE; |
64 virtual bool ReadOnly() const OVERRIDE; | 53 virtual bool ReadOnly() const OVERRIDE; |
65 virtual PrefReadError GetReadError() const OVERRIDE; | 54 virtual PrefReadError GetReadError() const OVERRIDE; |
66 virtual PrefReadError ReadPrefs() OVERRIDE; | 55 virtual PrefReadError ReadPrefs() OVERRIDE; |
67 virtual void ReadPrefsAsync(ReadErrorDelegate* error_delegate) OVERRIDE; | 56 virtual void ReadPrefsAsync(ReadErrorDelegate* error_delegate) OVERRIDE; |
68 virtual void CommitPendingWrite() OVERRIDE; | 57 virtual void CommitPendingWrite() OVERRIDE; |
69 virtual void ReportValueChanged(const std::string& key) OVERRIDE; | 58 virtual void ReportValueChanged(const std::string& key) OVERRIDE; |
70 | 59 |
71 // This method is called after JSON file has been read. Method takes | 60 void OnStorageRead(leveldb::DB* db, |
72 // ownership of the |value| pointer. Note, this method is used with | 61 scoped_ptr<PrefValueMap> map, |
73 // asynchronous file reading, so class exposes it only for the internal needs. | 62 PrefReadError error, |
74 // (read: do not call it manually). | 63 bool no_dir); |
75 void OnFileRead(base::Value* value_owned, PrefReadError error, bool no_dir); | |
76 | 64 |
77 private: | 65 private: |
78 virtual ~JsonPrefStore(); | 66 virtual ~LevelDBPrefStore(); |
79 | 67 |
80 // ImportantFileWriter::DataSerializer overrides: | 68 void PersistFromUIThread(const std::string& key, base::Value* value); |
81 virtual bool SerializeData(std::string* output) OVERRIDE; | 69 void RemoveFromUIThread(const std::string& key); |
70 | |
71 void NotifyObservers(const std::string& key); | |
82 | 72 |
83 base::FilePath path_; | 73 base::FilePath path_; |
84 const scoped_refptr<base::SequencedTaskRunner> sequenced_task_runner_; | 74 const scoped_refptr<base::SequencedTaskRunner> sequenced_task_runner_; |
75 const scoped_refptr<base::SequencedTaskRunner> original_task_runner_; | |
85 | 76 |
86 scoped_ptr<base::DictionaryValue> prefs_; | 77 PrefValueMap prefs_; |
87 | 78 |
88 bool read_only_; | 79 bool read_only_; |
89 | 80 |
90 // Helper for safely writing pref data. | |
91 base::ImportantFileWriter writer_; | |
92 | |
93 scoped_ptr<PrefFilter> pref_filter_; | |
94 ObserverList<PrefStore::Observer, true> observers_; | 81 ObserverList<PrefStore::Observer, true> observers_; |
95 | 82 |
96 scoped_ptr<ReadErrorDelegate> error_delegate_; | 83 scoped_ptr<ReadErrorDelegate> error_delegate_; |
97 | 84 |
98 bool initialized_; | 85 bool initialized_; |
99 PrefReadError read_error_; | 86 PrefReadError read_error_; |
100 | 87 |
101 std::set<std::string> keys_need_empty_value_; | 88 class FileThreadSerializer; |
89 scoped_ptr<FileThreadSerializer> helper_; | |
Mattias Nissler (ping if slow)
2014/03/05 18:28:15
This should probably be named |serializer_|.
dgrogan
2014/03/06 03:03:40
Done.
| |
102 | 90 |
103 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); | 91 DISALLOW_COPY_AND_ASSIGN(LevelDBPrefStore); |
104 }; | 92 }; |
105 | 93 |
106 #endif // BASE_PREFS_JSON_PREF_STORE_H_ | 94 #endif // BASE_PREFS_JSON_PREF_STORE_H_ |
OLD | NEW |