1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
// Copyright (c) 2010 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_PREFS_PREF_NOTIFIER_H_
#define CHROME_BROWSER_PREFS_PREF_NOTIFIER_H_
#pragma once
#include <string>
#include <vector>
#include "base/hash_tables.h"
#include "base/non_thread_safe.h"
#include "base/observer_list.h"
#include "chrome/common/notification_observer.h"
#include "chrome/common/notification_registrar.h"
class NotificationObserver;
class PrefService;
class PrefValueStore;
class Value;
// Registers observers for particular preferences and sends notifications when
// preference values or sources (i.e., which preference layer controls the
// preference) change.
class PrefNotifier : public NonThreadSafe,
public NotificationObserver {
public:
// PrefStores must be listed here in order from highest to lowest priority.
// MANAGED_PLATFORM contains all managed preference values that are
// provided by a platform-specific policy mechanism (e.g. Windows
// Group Policy).
// DEVICE_MANAGEMENT contains all managed preference values supplied
// by the device management server (cloud policy).
// EXTENSION contains preference values set by extensions.
// COMMAND_LINE contains preference values set by command-line switches.
// USER contains all user-set preference values.
// RECOMMENDED contains all recommended (policy) preference values.
// DEFAULT contains all application default preference values.
// This enum is kept in pref_notifier.h rather than pref_value_store.h in
// order to minimize additional headers needed by the *PrefStore files.
enum PrefStoreType {
// INVALID_STORE is not associated with an actual PrefStore but used as
// an invalid marker, e.g. as a return value.
INVALID_STORE = -1,
MANAGED_PLATFORM_STORE = 0,
DEVICE_MANAGEMENT_STORE,
EXTENSION_STORE,
COMMAND_LINE_STORE,
USER_STORE,
RECOMMENDED_STORE,
DEFAULT_STORE,
PREF_STORE_TYPE_MAX = DEFAULT_STORE
};
// The |service| with which this notifier is associated will be sent as the
// source of any notifications.
PrefNotifier(PrefService* service, PrefValueStore* value_store);
virtual ~PrefNotifier();
// For the given pref_name, fire any observer of the pref if the effective
// value of the pref or the store controlling its value has changed, been
// added, or been removed (but not if it's re-setting the same value it had
// already). |new_store| should be the PrefStoreType of the store reporting
// the change.
void OnPreferenceSet(const char* pref_name,
PrefNotifier::PrefStoreType new_store);
// Convenience method to be called when a preference is set in the
// USER_STORE. See OnPreferenceSet().
void OnUserPreferenceSet(const char* pref_name);
// For the given pref_name, fire any observer of the pref. Virtual so it can
// be mocked for unit testing.
virtual void FireObservers(const char* path);
// If the pref at the given path changes, we call the observer's Observe
// method with PREF_CHANGED.
void AddPrefObserver(const char* path, NotificationObserver* obs);
void RemovePrefObserver(const char* path, NotificationObserver* obs);
protected:
// A map from pref names to a list of observers. Observers get fired in the
// order they are added. These should only be accessed externally for unit
// testing.
typedef ObserverList<NotificationObserver> NotificationObserverList;
typedef base::hash_map<std::string, NotificationObserverList*>
PrefObserverMap;
const PrefObserverMap* pref_observers() { return &pref_observers_; }
private:
// Weak references.
PrefService* pref_service_;
PrefValueStore* pref_value_store_;
NotificationRegistrar registrar_;
PrefObserverMap pref_observers_;
// Called after a policy refresh to notify relevant preference observers.
// |changed_prefs_paths| is the vector of preference paths changed by the
// policy update. It is passed by value and not reference because
// this method is called asynchronously as a callback from another thread.
// Copying the vector guarantees that the vector's lifecycle spans the
// method's invocation.
void FireObserversForRefreshedManagedPrefs(
std::vector<std::string> changed_prefs_paths);
// NotificationObserver methods:
virtual void Observe(NotificationType type,
const NotificationSource& source,
const NotificationDetails& details);
DISALLOW_COPY_AND_ASSIGN(PrefNotifier);
};
#endif // CHROME_BROWSER_PREFS_PREF_NOTIFIER_H_
|
