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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/extensions/api/settings_private/settings_private_event_router.h"
#include <utility>
#include <vector>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/task/single_thread_task_runner.h"
#include "build/build_config.h"
#include "build/chromeos_buildflags.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/extensions/api/settings_private/generated_prefs.h"
#include "chrome/browser/extensions/api/settings_private/generated_prefs_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/common/extensions/api/settings_private.h"
#include "components/prefs/pref_service.h"
#include "content/public/browser/browser_context.h"
namespace extensions {
SettingsPrivateEventRouter::SettingsPrivateEventRouter(
content::BrowserContext* context)
: context_(context) {
Profile* profile = Profile::FromBrowserContext(context_);
prefs_util_ = std::make_unique<PrefsUtil>(profile);
user_prefs_registrar_.Init(profile->GetPrefs());
local_state_registrar_.Init(g_browser_process->local_state());
EventRouter::Get(context_)->RegisterObserver(
this, api::settings_private::OnPrefsChanged::kEventName);
StartOrStopListeningForPrefsChanges();
}
SettingsPrivateEventRouter::~SettingsPrivateEventRouter() {
DCHECK(!listening_);
}
void SettingsPrivateEventRouter::OnGeneratedPrefChanged(
const std::string& pref_name) {
OnPreferenceChanged(pref_name);
}
void SettingsPrivateEventRouter::Shutdown() {
EventRouter::Get(context_)->UnregisterObserver(this);
if (listening_) {
#if BUILDFLAG(IS_CHROMEOS)
cros_settings_subscription_map_.clear();
#endif
const PrefsUtil::TypedPrefMap& keys = prefs_util_->GetAllowlistedKeys();
settings_private::GeneratedPrefs* generated_prefs =
settings_private::GeneratedPrefsFactory::GetForBrowserContext(context_);
for (const auto& it : keys) {
if (generated_prefs && generated_prefs->HasPref(it.first))
generated_prefs->RemoveObserver(it.first, this);
else if (!prefs_util_->IsCrosSetting(it.first))
FindRegistrarForPref(it.first)->Remove(it.first);
}
}
listening_ = false;
}
void SettingsPrivateEventRouter::OnListenerAdded(
const EventListenerInfo& details) {
// Start listening to events from the PrefChangeRegistrars.
StartOrStopListeningForPrefsChanges();
}
void SettingsPrivateEventRouter::OnListenerRemoved(
const EventListenerInfo& details) {
// Stop listening to events from the PrefChangeRegistrars if there are no
// more listeners.
StartOrStopListeningForPrefsChanges();
}
PrefChangeRegistrar* SettingsPrivateEventRouter::FindRegistrarForPref(
const std::string& pref_name) {
Profile* profile = Profile::FromBrowserContext(context_);
if (prefs_util_->FindServiceForPref(pref_name) == profile->GetPrefs()) {
return &user_prefs_registrar_;
}
return &local_state_registrar_;
}
void SettingsPrivateEventRouter::StartOrStopListeningForPrefsChanges() {
DCHECK(prefs_util_);
EventRouter* event_router = EventRouter::Get(context_);
bool should_listen = event_router->HasEventListener(
api::settings_private::OnPrefsChanged::kEventName);
settings_private::GeneratedPrefs* generated_prefs =
settings_private::GeneratedPrefsFactory::GetForBrowserContext(context_);
if (should_listen && !listening_) {
const PrefsUtil::TypedPrefMap& keys = prefs_util_->GetAllowlistedKeys();
for (const auto& it : keys) {
std::string pref_name = it.first;
if (prefs_util_->IsCrosSetting(pref_name)) {
#if BUILDFLAG(IS_CHROMEOS)
base::CallbackListSubscription subscription =
ash::CrosSettings::Get()->AddSettingsObserver(
pref_name.c_str(),
base::BindRepeating(
&SettingsPrivateEventRouter::OnPreferenceChanged,
base::Unretained(this), pref_name));
cros_settings_subscription_map_.insert(
make_pair(pref_name, std::move(subscription)));
#endif
} else if (generated_prefs && generated_prefs->HasPref(pref_name)) {
generated_prefs->AddObserver(pref_name, this);
} else {
FindRegistrarForPref(it.first)->Add(
pref_name, base::BindRepeating(
&SettingsPrivateEventRouter::OnPreferenceChanged,
base::Unretained(this)));
}
}
} else if (!should_listen && listening_) {
const PrefsUtil::TypedPrefMap& keys = prefs_util_->GetAllowlistedKeys();
for (const auto& it : keys) {
if (prefs_util_->IsCrosSetting(it.first)) {
#if BUILDFLAG(IS_CHROMEOS)
cros_settings_subscription_map_.erase(it.first);
#endif
} else if (generated_prefs && generated_prefs->HasPref(it.first)) {
generated_prefs->RemoveObserver(it.first, this);
} else {
FindRegistrarForPref(it.first)->Remove(it.first);
}
}
}
listening_ = should_listen;
}
void SettingsPrivateEventRouter::OnPreferenceChanged(
const std::string& pref_name) {
// This posts an asynchronous task to ensure that all pref stores are updated,
// as |prefs_util_->GetPref()| relies on this information to determine if a
// preference is controlled by e.g. extensions.
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&SettingsPrivateEventRouter::SendPrefChange,
weak_ptr_factory_.GetWeakPtr(), pref_name));
}
void SettingsPrivateEventRouter::SendPrefChange(const std::string& pref_name) {
EventRouter* event_router = EventRouter::Get(context_);
if (!event_router->HasEventListener(
api::settings_private::OnPrefsChanged::kEventName)) {
return;
}
std::optional<api::settings_private::PrefObject> pref_object =
prefs_util_->GetPref(pref_name);
std::vector<api::settings_private::PrefObject> prefs;
if (pref_object)
prefs.push_back(std::move(*pref_object));
auto args(api::settings_private::OnPrefsChanged::Create(prefs));
std::unique_ptr<Event> extension_event =
std::make_unique<Event>(events::SETTINGS_PRIVATE_ON_PREFS_CHANGED,
api::settings_private::OnPrefsChanged::kEventName,
std::move(args), context_);
event_router->BroadcastEvent(std::move(extension_event));
}
std::unique_ptr<SettingsPrivateEventRouter> SettingsPrivateEventRouter::Create(
content::BrowserContext* context) {
return std::make_unique<SettingsPrivateEventRouter>(context);
}
} // namespace extensions
|