Split PrefService into PrefService, PrefServiceSimple and PrefServiceSyncable.

chrome/browser/prefs/pref_service.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/prefs/pref_service.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
-#include "base/command_line.h"
 #include "base/file_path.h"
 #include "base/logging.h"
 #include "base/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/default_pref_store.h"
-#include "base/prefs/overlay_user_pref_store.h"
 #include "base/stl_util.h"
 #include "base/string_number_conversions.h"
 #include "base/string_util.h"
 #include "base/value_conversions.h"
 #include "build/build_config.h"
-#include "chrome/browser/browser_process.h"
-#include "chrome/browser/prefs/command_line_pref_store.h"
-#include "chrome/browser/prefs/pref_model_associator.h"
 #include "chrome/browser/prefs/pref_notifier_impl.h"
-#include "chrome/browser/prefs/pref_service_observer.h"
 #include "chrome/browser/prefs/pref_value_store.h"
-#include "chrome/browser/ui/prefs/prefs_tab_helper.h"
 
 using content::BrowserContext;
 
 namespace {
 
-// A helper function for RegisterLocalized*Pref that creates a Value*
-// based on a localized string.  Because we control the values in a
-// locale dll, this should always return a Value of the appropriate
-// type.
-Value* CreateLocaleDefaultValue(base::Value::Type type,
-                                const std::string& resource_string) {
-  DCHECK(!resource_string.empty());
-  switch (type) {
-    case Value::TYPE_BOOLEAN: {
-      if ("true" == resource_string)
-        return Value::CreateBooleanValue(true);
-      if ("false" == resource_string)
-        return Value::CreateBooleanValue(false);
-      break;
-    }
-
-    case Value::TYPE_INTEGER: {
-      int val;
-      base::StringToInt(resource_string, &val);
-      return Value::CreateIntegerValue(val);
-    }
-
-    case Value::TYPE_DOUBLE: {
-      double val;
-      base::StringToDouble(resource_string, &val);
-      return Value::CreateDoubleValue(val);
-    }
-
-    case Value::TYPE_STRING: {
-      return Value::CreateStringValue(resource_string);
-    }
-
-    default: {
-      NOTREACHED() <<
-          "list and dictionary types cannot have default locale values";
-    }
-  }
-  NOTREACHED();
-  return Value::CreateNullValue();
-}
-
 class ReadErrorHandler : public PersistentPrefStore::ReadErrorDelegate {
  public:
   ReadErrorHandler(base::Callback<void(PersistentPrefStore::PrefReadError)> cb)
       : callback_(cb) {}
 
   virtual void OnError(PersistentPrefStore::PrefReadError error) {
     callback_.Run(error);
   }
 
  private:
   base::Callback<void(PersistentPrefStore::PrefReadError)> callback_;
 };
 
 }  // namespace
 
-PrefService* PrefService::CreateIncognitoPrefService(
-    PrefStore* incognito_extension_prefs) {
-  pref_service_forked_ = true;
-  PrefNotifierImpl* pref_notifier = new PrefNotifierImpl();
-  OverlayUserPrefStore* incognito_pref_store =
-      new OverlayUserPrefStore(user_pref_store_.get());
-  PrefsTabHelper::InitIncognitoUserPrefStore(incognito_pref_store);
-  return new PrefService(
-      pref_notifier,
-      pref_value_store_->CloneAndSpecialize(
-          NULL,  // managed
-          incognito_extension_prefs,
-          NULL,  // command_line_prefs
-          incognito_pref_store,
-          NULL,  // recommended
-          default_store_.get(),
-          NULL,  // pref_sync_associator
-          pref_notifier),
-      incognito_pref_store,
-      default_store_.get(),
-      NULL,
-      get_localized_string_method_,
-      read_error_callback_,
-      false);
-}
-
-PrefService::PrefService(
-    PrefNotifierImpl* pref_notifier,
-    PrefValueStore* pref_value_store,
-    PersistentPrefStore* user_prefs,
-    DefaultPrefStore* default_store,
-    PrefModelAssociator* pref_sync_associator,
-    base::Callback<std::string(int)> get_localized_string_method,
-    base::Callback<void(PersistentPrefStore::PrefReadError)>
-        read_error_callback,
-    bool async)
-    : pref_notifier_(pref_notifier),
-      pref_value_store_(pref_value_store),
-      user_pref_store_(user_prefs),
-      default_store_(default_store),
-      pref_sync_associator_(pref_sync_associator),
-      get_localized_string_method_(get_localized_string_method),
-      read_error_callback_(read_error_callback),
-      pref_service_forked_(false) {
-  pref_notifier_->SetPrefService(this);
-  if (pref_sync_associator_.get())
-    pref_sync_associator_->SetPrefService(this);
-  InitFromStorage(async);
-}
-
 PrefService::~PrefService() {
   DCHECK(CalledOnValidThread());
 
   // Reset pointers so accesses after destruction reliably crash.
   pref_value_store_.reset();
   user_pref_store_ = NULL;
   default_store_ = NULL;
-  pref_sync_associator_.reset();
   pref_notifier_.reset();
 }
 
 void PrefService::InitFromStorage(bool async) {
   if (!async) {
     read_error_callback_.Run(user_pref_store_->ReadPrefs());
   } else {
     // Guarantee that initialization happens after this function returned.
     MessageLoop::current()->PostTask(
         FROM_HERE,
         base::Bind(&PersistentPrefStore::ReadPrefsAsync,
                    user_pref_store_.get(),
                    new ReadErrorHandler(read_error_callback_)));
   }
 }
 
 bool PrefService::ReloadPersistentPrefs() {
   return user_pref_store_->ReadPrefs() ==
              PersistentPrefStore::PREF_READ_ERROR_NONE;
 }
 
 void PrefService::CommitPendingWrite() {
   DCHECK(CalledOnValidThread());
   user_pref_store_->CommitPendingWrite();
 }
 
-void PrefService::AddObserver(PrefServiceObserver* observer) {
-  observer_list_.AddObserver(observer);
-}
-
-void PrefService::RemoveObserver(PrefServiceObserver* observer) {
-  observer_list_.RemoveObserver(observer);
-}
-
-bool PrefService::IsSyncing() {
-  return pref_sync_associator_.get() &&
-      pref_sync_associator_->models_associated();
-}
-
-void PrefService::OnIsSyncingChanged() {
-  FOR_EACH_OBSERVER(PrefServiceObserver, observer_list_, OnIsSyncingChanged());
-}
-
-namespace {
-
-// If there's no g_browser_process or no local state, return true (for testing).
-bool IsLocalStatePrefService(PrefService* prefs) {
-  return (!g_browser_process ||
-          !g_browser_process->local_state() ||
-          g_browser_process->local_state() == prefs);
-}
-
-// If there's no g_browser_process, return true (for testing).
-bool IsProfilePrefService(PrefService* prefs) {
-  // TODO(zea): uncomment this once all preferences are only ever registered
-  // with either the local_state's pref service or the profile's pref service.
-  // return (!g_browser_process || g_browser_process->local_state() != prefs);
-  return true;
-}
-
-}  // namespace
-
-// Local State prefs.
-void PrefService::RegisterBooleanPref(const char* path,
-                                      bool default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateBooleanValue(default_value),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterIntegerPref(const char* path, int default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateIntegerValue(default_value),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterDoublePref(const char* path, double default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateDoubleValue(default_value),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterStringPref(const char* path,
-                                     const std::string& default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateStringValue(default_value),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterFilePathPref(const char* path,
-                                       const FilePath& default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateStringValue(default_value.value()),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterListPref(const char* path) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     new ListValue(),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterListPref(const char* path, ListValue* default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     default_value,
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterDictionaryPref(const char* path) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     new DictionaryValue(),
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterDictionaryPref(const char* path,
-                                         DictionaryValue* default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(path,
-                     default_value,
-                     UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterLocalizedBooleanPref(const char* path,
-                                               int locale_default_message_id) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_BOOLEAN,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterLocalizedIntegerPref(const char* path,
-                                               int locale_default_message_id) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_INTEGER,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterLocalizedDoublePref(const char* path,
-                                              int locale_default_message_id) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_DOUBLE,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterLocalizedStringPref(const char* path,
-                                              int locale_default_message_id) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_STRING,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      UNSYNCABLE_PREF);
-}
-
-void PrefService::RegisterInt64Pref(const char* path, int64 default_value) {
-  // If this fails, the pref service in use is a profile pref service, so the
-  // sync status must be provided (see profile pref registration calls below).
-  DCHECK(IsLocalStatePrefService(this));
-  RegisterPreference(
-      path,
-      Value::CreateStringValue(base::Int64ToString(default_value)),
-      UNSYNCABLE_PREF);
-}
-
-// Profile prefs (must use the sync_status variable).
-void PrefService::RegisterBooleanPref(const char* path,
-                                      bool default_value,
-                                      PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateBooleanValue(default_value),
-                     sync_status);
-}
-
-void PrefService::RegisterIntegerPref(const char* path,
-                                      int default_value,
-                                      PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateIntegerValue(default_value),
-                     sync_status);
-}
-
-void PrefService::RegisterDoublePref(const char* path,
-                                     double default_value,
-                                     PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateDoubleValue(default_value),
-                     sync_status);
-}
-
-void PrefService::RegisterStringPref(const char* path,
-                                     const std::string& default_value,
-                                     PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateStringValue(default_value),
-                     sync_status);
-}
-
-void PrefService::RegisterFilePathPref(const char* path,
-                                       const FilePath& default_value,
-                                       PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path,
-                     Value::CreateStringValue(default_value.value()),
-                     sync_status);
-}
-
-void PrefService::RegisterListPref(const char* path,
-                                   PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path, new ListValue(), sync_status);
-}
-
-void PrefService::RegisterListPref(const char* path,
-                                   ListValue* default_value,
-                                   PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path, default_value, sync_status);
-}
-
-void PrefService::RegisterDictionaryPref(const char* path,
-                                         PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path, new DictionaryValue(), sync_status);
-}
-
-void PrefService::RegisterDictionaryPref(const char* path,
-                                         DictionaryValue* default_value,
-                                         PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(path, default_value, sync_status);
-}
-
-void PrefService::RegisterLocalizedBooleanPref(const char* path,
-                                               int locale_default_message_id,
-                                               PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_BOOLEAN,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      sync_status);
-}
-
-void PrefService::RegisterLocalizedIntegerPref(const char* path,
-                                               int locale_default_message_id,
-                                               PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_INTEGER,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      sync_status);
-}
-
-void PrefService::RegisterLocalizedDoublePref(const char* path,
-                                              int locale_default_message_id,
-                                              PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_DOUBLE,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      sync_status);
-}
-
-void PrefService::RegisterLocalizedStringPref(const char* path,
-                                              int locale_default_message_id,
-                                              PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(
-      path,
-      CreateLocaleDefaultValue(
-          Value::TYPE_STRING,
-          get_localized_string_method_.Run(locale_default_message_id)),
-      sync_status);
-}
-
-void PrefService::RegisterInt64Pref(const char* path,
-                                    int64 default_value,
-                                    PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(
-      path,
-      Value::CreateStringValue(base::Int64ToString(default_value)),
-      sync_status);
-}
-
-void PrefService::RegisterUint64Pref(const char* path,
-                                     uint64 default_value,
-                                     PrefSyncStatus sync_status) {
-  DCHECK(IsProfilePrefService(this));
-  RegisterPreference(
-      path,
-      Value::CreateStringValue(base::Uint64ToString(default_value)),
-      sync_status);
-}
-
 bool PrefService::GetBoolean(const char* path) const {
   DCHECK(CalledOnValidThread());
 
   bool result = false;
 
   const base::Value* value = GetPreferenceValue(path);
   if (!value) {
     NOTREACHED() << "Trying to read an unregistered pref: " << path;
     return result;
   }
@@ skipping 191 matching lines @@
 }
 
 void PrefService::RemovePrefObserver(const char* path, PrefObserver* obs) {
   pref_notifier_->RemovePrefObserver(path, obs);
 }
 
 void PrefService::AddPrefInitObserver(base::Callback<void(bool)> obs) {
   pref_notifier_->AddInitObserver(obs);
 }
 
+PrefService::PrefService() {}
+
+void PrefService::Initialize(
+    PrefNotifierImpl* pref_notifier,
+    PrefValueStore* pref_value_store,
+    PersistentPrefStore* user_prefs,
+    DefaultPrefStore* default_store,
+    base::Callback<void(PersistentPrefStore::PrefReadError)>
+        read_error_callback,
+    bool async) {
+  pref_notifier_.reset(pref_notifier);
+  pref_value_store_.reset(pref_value_store);
+  user_pref_store_ = user_prefs;
+  default_store_ = default_store;
+  read_error_callback_ = read_error_callback;
+  pref_notifier_->SetPrefService(this);
+  InitFromStorage(async);
+}
+
 void PrefService::RegisterPreference(const char* path,
-                                     Value* default_value,
-                                     PrefSyncStatus sync_status) {
+                                     Value* default_value) {
   DCHECK(CalledOnValidThread());
 
   // The main code path takes ownership, but most don't. We'll be safe.
   scoped_ptr<Value> scoped_value(default_value);
 
   CHECK(!FindPreference(path)) << "Tried to register duplicate pref " << path;
 
   base::Value::Type orig_type = default_value->GetType();
   DCHECK(orig_type != Value::TYPE_NULL && orig_type != Value::TYPE_BINARY) <<
          "invalid preference type: " << orig_type;
@@ skipping 10 matching lines @@
   } else if (orig_type == base::Value::TYPE_DICTIONARY) {
     const base::DictionaryValue* dict = NULL;
     if (default_value->GetAsDictionary(&dict) && !dict->empty())
       needs_empty_value = true;
   }
   if (needs_empty_value)
     user_pref_store_->MarkNeedsEmptyValue(path);
 
   // Hand off ownership.
   default_store_->SetDefaultValue(path, scoped_value.release());
-
-  // Register with sync if necessary.
-  if (sync_status == SYNCABLE_PREF && pref_sync_associator_.get())
-    pref_sync_associator_->RegisterPref(path);
 }
 
 void PrefService::UnregisterPreference(const char* path) {
   DCHECK(CalledOnValidThread());
 
   PreferenceMap::iterator it = prefs_map_.find(path);
   CHECK(it != prefs_map_.end()) << "Trying to unregister an unregistered pref: "
                                 << path;
 
   prefs_map_.erase(it);
   default_store_->RemoveDefaultValue(path);
-  if (pref_sync_associator_.get() &&
-      pref_sync_associator_->IsPrefRegistered(path)) {
-    pref_sync_associator_->UnregisterPref(path);
-  }
 }
 
 void PrefService::ClearPref(const char* path) {
   DCHECK(CalledOnValidThread());
 
   const Preference* pref = FindPreference(path);
   if (!pref) {
     NOTREACHED() << "Trying to clear an unregistered pref: " << path;
     return;
   }
@@ skipping 114 matching lines @@
   if (pref->GetType() != new_value->GetType()) {
     NOTREACHED() << "Trying to set pref " << path
                  << " of type " << pref->GetType()
                  << " to value of type " << new_value->GetType();
     return;
   }
 
   user_pref_store_->SetValue(path, owned_value.release());
 }
 
-syncer::SyncableService* PrefService::GetSyncableService() {
-  return pref_sync_associator_.get();
-}
-
-void PrefService::UpdateCommandLinePrefStore(CommandLine* command_line) {
-  // If |pref_service_forked_| is true, then this PrefService and the forked
-  // copies will be out of sync.
-  DCHECK(!pref_service_forked_);
-  pref_value_store_->UpdateCommandLinePrefStore(
-      new CommandLinePrefStore(command_line));
+void PrefService::UpdateCommandLinePrefStore(PrefStore* command_line_store) {
+  pref_value_store_->UpdateCommandLinePrefStore(command_line_store);
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 // PrefService::Preference
 
 PrefService::Preference::Preference(const PrefService* service,
                                     const char* name,
                                     base::Value::Type type)
       : name_(name),
         type_(type),
@@ skipping 75 matching lines @@
   const Value* found_value = NULL;
   if (pref_value_store_->GetValue(path, type, &found_value)) {
     DCHECK(found_value->IsType(type));
     return found_value;
   }
 
   // Every registered preference has at least a default value.
   NOTREACHED() << "no valid value found for registered pref " << path;
   return NULL;
 }