1cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Copyright 2014 The Chromium Authors. All rights reserved. 2cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 3cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// found in the LICENSE file. 4cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 5cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#ifndef CHROME_BROWSER_PREFS_LEVELDB_PREF_STORE_H_ 6cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#define CHROME_BROWSER_PREFS_LEVELDB_PREF_STORE_H_ 7cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 8cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include <set> 9cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include <string> 10cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 11cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/basictypes.h" 12cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/compiler_specific.h" 13cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/files/file_path.h" 14cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 15cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/message_loop/message_loop_proxy.h" 16cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/observer_list.h" 17cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/prefs/persistent_pref_store.h" 18cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/prefs/pref_value_map.h" 19cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "base/timer/timer.h" 20cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 21cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)namespace base { 22cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class DictionaryValue; 23cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class SequencedTaskRunner; 24cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class Value; 25cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)} 26cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 27cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)namespace leveldb { 28cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class DB; 29cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)} 30cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 31cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// A writable PrefStore implementation that is used for user preferences. 32cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class LevelDBPrefStore : public PersistentPrefStore { 33cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) public: 34cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // |sequenced_task_runner| is must be a shutdown-blocking task runner, ideally 35cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // created by GetTaskRunnerForFile() method above. 36cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) LevelDBPrefStore(const base::FilePath& pref_filename, 37cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::SequencedTaskRunner* sequenced_task_runner); 38cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 39cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // PrefStore overrides: 40cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual bool GetValue(const std::string& key, 41cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const base::Value** result) const OVERRIDE; 42cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; 43cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; 44cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual bool HasObservers() const OVERRIDE; 45cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual bool IsInitializationComplete() const OVERRIDE; 46cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 47cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // PersistentPrefStore overrides: 48cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual bool GetMutableValue(const std::string& key, 49cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::Value** result) OVERRIDE; 50cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Takes ownership of value. 51cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void SetValue(const std::string& key, base::Value* value) OVERRIDE; 52cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void SetValueSilently(const std::string& key, 53cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::Value* value) OVERRIDE; 54cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void RemoveValue(const std::string& key) OVERRIDE; 55cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual bool ReadOnly() const OVERRIDE; 56cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual PrefReadError GetReadError() const OVERRIDE; 57cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual PrefReadError ReadPrefs() OVERRIDE; 58cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void ReadPrefsAsync(ReadErrorDelegate* error_delegate) OVERRIDE; 59cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void CommitPendingWrite() OVERRIDE; 60cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void ReportValueChanged(const std::string& key) OVERRIDE; 61cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 62cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) private: 63cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) struct ReadingResults; 64cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) class FileThreadSerializer; 65cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 66cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual ~LevelDBPrefStore(); 67cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 68cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static scoped_ptr<ReadingResults> DoReading(const base::FilePath& path); 69cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static void OpenDB(const base::FilePath& path, 70cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) ReadingResults* reading_results); 71cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void OnStorageRead(scoped_ptr<ReadingResults> reading_results); 72cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 73cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void PersistFromUIThread(); 74cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void RemoveFromUIThread(const std::string& key); 75cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void ScheduleWrite(); 76cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 77cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void SetValueInternal(const std::string& key, 78cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::Value* value, 79cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool notify); 80cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void NotifyObservers(const std::string& key); 81cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void MarkForInsertion(const std::string& key, const std::string& value); 82cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void MarkForDeletion(const std::string& key); 83cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 84cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::FilePath path_; 85cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 86cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const scoped_refptr<base::SequencedTaskRunner> sequenced_task_runner_; 87cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const scoped_refptr<base::SequencedTaskRunner> original_task_runner_; 88cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 89cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) PrefValueMap prefs_; 90cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 91cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool read_only_; 92cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 93cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) ObserverList<PrefStore::Observer, true> observers_; 94cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 95cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) scoped_ptr<ReadErrorDelegate> error_delegate_; 96cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 97cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) bool initialized_; 98cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) PrefReadError read_error_; 99cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 100cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // This object is created on the UI thread right after preferences are loaded 101cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // from disk. A message to delete it is sent to the FILE thread by 102cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // ~LevelDBPrefStore. 103cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) scoped_ptr<FileThreadSerializer> serializer_; 104cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 105cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Changes are accumulated in |keys_to_delete_| and |keys_to_set_| and are 106cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // stored in the database according to |timer_|. 107cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) std::set<std::string> keys_to_delete_; 108cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) std::map<std::string, std::string> keys_to_set_; 109cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::OneShotTimer<LevelDBPrefStore> timer_; 110cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 111cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) base::WeakPtrFactory<LevelDBPrefStore> weak_ptr_factory_; 112cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 113cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(LevelDBPrefStore); 114cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)}; 115cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 116cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#endif // CHROME_BROWSER_PREFS_LEVELDB_PREF_STORE_H_ 117