chrome/browser/prefs/chrome_pref_service_factory.h

   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 CHROME_BROWSER_PREFS_CHROME_PREF_SERVICE_FACTORY_H_
   6 #define CHROME_BROWSER_PREFS_CHROME_PREF_SERVICE_FACTORY_H_
   7
   8 #include "base/memory/ref_counted.h"
   9 #include "base/memory/scoped_ptr.h"
  10
  11 namespace base {
  12 class DictionaryValue;
  13 class FilePath;
  14 class SequencedTaskRunner;
  15 class Time;
  16 }
  17
  18 namespace policy {
  19 class PolicyService;
  20 }
  21
  22 namespace user_prefs {
  23 class PrefRegistrySyncable;
  24 }
  25
  26 class ManagedUserSettingsService;
  27 class PrefHashStore;
  28 class PrefRegistry;
  29 class PrefRegistrySimple;
  30 class PrefService;
  31 class PrefServiceSyncable;
  32 class PrefStore;
  33 class Profile;
  34
  35 namespace chrome_prefs {
  36
  37 namespace internals {
  38
  39 extern const char kSettingsEnforcementTrialName[];
  40 extern const char kSettingsEnforcementGroupNoEnforcement[];
  41 extern const char kSettingsEnforcementGroupEnforceOnload[];
  42 extern const char kSettingsEnforcementGroupEnforceAlways[];
  43 extern const char kSettingsEnforcementGroupEnforceAlwaysWithExtensions[];
  44
  45 }  // namespace internals
  46
  47 // Factory methods that create and initialize a new instance of a
  48 // PrefService for Chrome with the applicable PrefStores. The
  49 // |pref_filename| points to the user preference file. This is the
  50 // usual way to create a new PrefService.
  51 // |extension_pref_store| is used as the source for extension-controlled
  52 // preferences and may be NULL.
  53 // |policy_service| is used as the source for mandatory or recommended
  54 // policies.
  55 // |pref_registry| keeps the list of registered prefs and their default values.
  56 // If |async| is true, asynchronous version is used.
  57 // Notifies using PREF_INITIALIZATION_COMPLETED in the end. Details is set to
  58 // the created PrefService or NULL if creation has failed. Note, it is
  59 // guaranteed that in asynchronous version initialization happens after this
  60 // function returned.
  61
  62 scoped_ptr<PrefService> CreateLocalState(
  63     const base::FilePath& pref_filename,
  64     base::SequencedTaskRunner* pref_io_task_runner,
  65     policy::PolicyService* policy_service,
  66     const scoped_refptr<PrefRegistry>& pref_registry,
  67     bool async);
  68
  69 scoped_ptr<PrefServiceSyncable> CreateProfilePrefs(
  70     const base::FilePath& pref_filename,
  71     base::SequencedTaskRunner* pref_io_task_runner,
  72     policy::PolicyService* policy_service,
  73     ManagedUserSettingsService* managed_user_settings,
  74     const scoped_refptr<PrefStore>& extension_prefs,
  75     const scoped_refptr<user_prefs::PrefRegistrySyncable>& pref_registry,
  76     bool async);
  77
  78 // Schedules verification of the path resolution of the preferences file under
  79 // |profile_path|.
  80 void SchedulePrefsFilePathVerification(const base::FilePath& profile_path);
  81
  82 // Call before startup tasks kick in to disable delays in
  83 // chrome_prefs::Schedule*() methods and ignore presence of a domain when
  84 // determining the active SettingsEnforcement group. For testing only.
  85 void DisableDelaysAndDomainCheckForTesting();
  86
  87 // Schedules an update check for all PrefHashStores, stores whose version
  88 // doesn't match the latest version will then be updated. Clears all pref hash
  89 // state on platforms that don't yet support a pref hash store.
  90 void SchedulePrefHashStoresUpdateCheck(
  91     const base::FilePath& initial_profile_path);
  92
  93 // Resets the contents of the preference hash store for the profile at
  94 // |profile_path|.
  95 void ResetPrefHashStore(const base::FilePath& profile_path);
  96
  97 // Initializes the preferences for the profile at |profile_path| with the
  98 // preference values in |master_prefs|. Returns true on success.
  99 bool InitializePrefsFromMasterPrefs(
 100     const base::FilePath& profile_path,
 101     const base::DictionaryValue& master_prefs);
 102
 103 // Retrieves the time of the last preference reset event, if any, for the
 104 // provided profile. If no reset has occurred, returns a null |Time|.
 105 base::Time GetResetTime(Profile* profile);
 106
 107 // Clears the time of the last preference reset event, if any, for the provided
 108 // profile.
 109 void ClearResetTime(Profile* profile);
 110
 111 // Register local state prefs used by chrome preference system.
 112 void RegisterPrefs(PrefRegistrySimple* registry);
 113
 114 // Register user prefs used by chrome preference system.
 115 void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
 116
 117 }  // namespace chrome_prefs
 118
 119 #endif  // CHROME_BROWSER_PREFS_CHROME_PREF_SERVICE_FACTORY_H_