Rename "managed (mode|user)" to "supervised user" (part 2)

chrome/browser/managed_mode/managed_user_settings_service.h

-// Copyright 2013 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.
-
-#ifndef CHROME_BROWSER_MANAGED_MODE_MANAGED_USER_SETTINGS_SERVICE_H_
-#define CHROME_BROWSER_MANAGED_MODE_MANAGED_USER_SETTINGS_SERVICE_H_
-
-#include <string>
-#include <vector>
-
-#include "base/callback.h"
-#include "base/memory/ref_counted.h"
-#include "base/memory/scoped_ptr.h"
-#include "base/prefs/pref_store.h"
-#include "base/values.h"
-#include "chrome/browser/managed_mode/managed_users.h"
-#include "components/keyed_service/core/keyed_service.h"
-#include "sync/api/syncable_service.h"
-
-class PersistentPrefStore;
-class Profile;
-
-namespace base {
-class FilePath;
-class SequencedTaskRunner;
-}
-
-// This class syncs managed user settings from a server, which are mapped to
-// preferences. The downloaded settings are persisted in a PrefStore (which is
-// not directly hooked up to the PrefService; it's just used internally).
-// Settings are key-value pairs, where the key uniquely identifies the setting.
-// The value is a string containing a JSON serialization of an arbitrary value,
-// which is the value of the setting.
-//
-// There are two kinds of settings handled by this class: Atomic and split
-// settings.
-// Atomic settings consist of a single key (which will be mapped to a pref key)
-// and a single (arbitrary) value.
-// Split settings encode a dictionary value and are stored as multiple Sync
-// items, one for each dictionary entry. The key for each of these Sync items
-// is the key of the split setting, followed by a separator (':') and the key
-// for the dictionary entry. The value of the Sync item is the value of the
-// dictionary entry.
-//
-// As an example, a split setting with key "Moose" and value
-//   {
-//     "foo": "bar",
-//     "baz": "blurp"
-//   }
-// would be encoded as two sync items, one with key "Moose:foo" and value "bar",
-// and one with key "Moose:baz" and value "blurp".
-class ManagedUserSettingsService : public KeyedService,
-                                   public syncer::SyncableService,
-                                   public PrefStore::Observer {
- public:
-  // A callback whose first parameter is a dictionary containing all managed
-  // user settings. If the dictionary is NULL, it means that the service is
-  // inactive, i.e. the user is not managed.
-  typedef base::Callback<void(const base::DictionaryValue*)> SettingsCallback;
-
-  ManagedUserSettingsService();
-  virtual ~ManagedUserSettingsService();
-
-  // Initializes the service by loading its settings from a file underneath the
-  // |profile_path|. File I/O will be serialized via the
-  // |sequenced_task_runner|. If |load_synchronously| is true, the settings will
-  // be loaded synchronously, otherwise asynchronously.
-  void Init(base::FilePath profile_path,
-            base::SequencedTaskRunner* sequenced_task_runner,
-            bool load_synchronously);
-
-  // Initializes the service by loading its settings from the |pref_store|.
-  // Use this method in tests to inject a different PrefStore than the
-  // default one.
-  void Init(scoped_refptr<PersistentPrefStore> pref_store);
-
-  // Adds a callback to be called when managed user settings are initially
-  // available, or when they change.
-  void Subscribe(const SettingsCallback& callback);
-
-  // Activates/deactivates the service. This is called by the ManagedUserService
-  // when it is (de)activated.
-  void SetActive(bool active);
-
-  // Whether managed user settings are available.
-  bool IsReady();
-
-  // Clears all managed user settings and items.
-  void Clear();
-
-  // Constructs a key for a split managed user setting from a prefix and a
-  // variable key.
-  static std::string MakeSplitSettingKey(const std::string& prefix,
-                                         const std::string& key);
-
-  // Uploads an item to the Sync server. Items are the same data structure as
-  // managed user settings (i.e. key-value pairs, as described at the top of
-  // the file), but they are only uploaded (whereas managed user settings are
-  // only downloaded), and never passed to the preference system.
-  // An example of an uploaded item is an access request to a blocked URL.
-  void UploadItem(const std::string& key, scoped_ptr<base::Value> value);
-
-  // Sets the setting with the given |key| to a copy of the given |value|.
-  void SetLocalSettingForTesting(const std::string& key,
-                                 scoped_ptr<base::Value> value);
-
-  // Public for testing.
-  static syncer::SyncData CreateSyncDataForSetting(const std::string& name,
-                                                   const base::Value& value);
-
-  // KeyedService implementation:
-  virtual void Shutdown() OVERRIDE;
-
-  // SyncableService implementation:
-  virtual syncer::SyncMergeResult MergeDataAndStartSyncing(
-      syncer::ModelType type,
-      const syncer::SyncDataList& initial_sync_data,
-      scoped_ptr<syncer::SyncChangeProcessor> sync_processor,
-      scoped_ptr<syncer::SyncErrorFactory> error_handler) OVERRIDE;
-  virtual void StopSyncing(syncer::ModelType type) OVERRIDE;
-  virtual syncer::SyncDataList GetAllSyncData(syncer::ModelType type) const
-      OVERRIDE;
-  virtual syncer::SyncError ProcessSyncChanges(
-      const tracked_objects::Location& from_here,
-      const syncer::SyncChangeList& change_list) OVERRIDE;
-
-  // PrefStore::Observer implementation:
-  virtual void OnPrefValueChanged(const std::string& key) OVERRIDE;
-  virtual void OnInitializationCompleted(bool success) OVERRIDE;
-
- private:
-  base::DictionaryValue* GetOrCreateDictionary(const std::string& key) const;
-  base::DictionaryValue* GetAtomicSettings() const;
-  base::DictionaryValue* GetSplitSettings() const;
-  base::DictionaryValue* GetQueuedItems() const;
-
-  // Returns the dictionary where a given Sync item should be stored, depending
-  // on whether the managed user setting is atomic or split. In case of a split
-  // setting, the split setting prefix of |key| is removed, so that |key| can
-  // be used to update the returned dictionary.
-  base::DictionaryValue* GetDictionaryAndSplitKey(std::string* key) const;
-
-  // Returns a dictionary with all managed user settings if the service is
-  // active, or NULL otherwise.
-  scoped_ptr<base::DictionaryValue> GetSettings();
-
-  // Sends the settings to all subscribers. This method should be called by the
-  // subclass whenever the settings change.
-  void InformSubscribers();
-
-  // Used for persisting the settings. Unlike other PrefStores, this one is not
-  // directly hooked up to the PrefService.
-  scoped_refptr<PersistentPrefStore> store_;
-
-  bool active_;
-
-  // A set of local settings that are fixed and not configured remotely.
-  scoped_ptr<base::DictionaryValue> local_settings_;
-
-  std::vector<SettingsCallback> subscribers_;
-
-  scoped_ptr<syncer::SyncChangeProcessor> sync_processor_;
-  scoped_ptr<syncer::SyncErrorFactory> error_handler_;
-
-  DISALLOW_COPY_AND_ASSIGN(ManagedUserSettingsService);
-};
-
-#endif  // CHROME_BROWSER_MANAGED_MODE_MANAGED_USER_SETTINGS_SERVICE_H_