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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/browser/api/declarative/rules_registry_service.h"
#include <algorithm>
#include <memory>
#include <utility>
#include "base/check_op.h"
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/lazy_instance.h"
#include "base/observer_list.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/render_process_host.h"
#include "extensions/browser/api/declarative_content/content_rules_registry.h"
#include "extensions/browser/api/declarative_webrequest/webrequest_constants.h"
#include "extensions/browser/api/declarative_webrequest/webrequest_rules_registry.h"
#include "extensions/browser/api/extensions_api_client.h"
#include "extensions/browser/api/web_request/extension_web_request_event_router.h"
#include "extensions/browser/extension_util.h"
#include "extensions/common/extension.h"
#include "extensions/common/features/feature.h"
#include "extensions/common/features/feature_provider.h"
namespace extensions {
RulesRegistryService::RulesRegistryService(content::BrowserContext* context)
: browser_context_(context) {
if (browser_context_) {
extension_registry_observation_.Observe(
ExtensionRegistry::Get(browser_context_));
EnsureDefaultRulesRegistriesRegistered();
}
}
RulesRegistryService::~RulesRegistryService() = default;
int RulesRegistryService::GetNextRulesRegistryID() {
return ++current_rules_registry_id_;
}
void RulesRegistryService::Shutdown() {
// Notify the registries.
for (const auto& [_, registry] : rule_registries_) {
registry->OnShutdown();
}
// Release the references to all registries.
rule_registries_.clear();
}
static base::LazyInstance<BrowserContextKeyedAPIFactory<RulesRegistryService>>::
DestructorAtExit g_factory = LAZY_INSTANCE_INITIALIZER;
// static
BrowserContextKeyedAPIFactory<RulesRegistryService>*
RulesRegistryService::GetFactoryInstance() {
return g_factory.Pointer();
}
// static
RulesRegistryService* RulesRegistryService::Get(
content::BrowserContext* context) {
return BrowserContextKeyedAPIFactory<RulesRegistryService>::Get(context);
}
// static
RulesRegistryService* RulesRegistryService::GetIfExists(
content::BrowserContext* context) {
return BrowserContextKeyedAPIFactory<RulesRegistryService>::GetIfExists(
context);
}
void RulesRegistryService::RegisterRulesRegistry(
scoped_refptr<RulesRegistry> rule_registry) {
const std::string event_name(rule_registry->event_name());
RulesRegistryKey key(event_name, rule_registry->id());
DCHECK(!base::Contains(rule_registries_, key));
rule_registries_[key] = rule_registry;
}
scoped_refptr<RulesRegistry> RulesRegistryService::GetRulesRegistry(
int rules_registry_id,
const std::string& event_name) {
RulesRegistryKey key(event_name, rules_registry_id);
RulesRegistryMap::const_iterator i = rule_registries_.find(key);
if (i != rule_registries_.end()) {
return i->second;
}
// We should have attempted creation of the default rule registries at
// construction.
if (!browser_context_ ||
rules_registry_id == rules_registry_ids::kDefaultRulesRegistryID) {
return nullptr;
}
// Only web request rules registries are created for webviews.
DCHECK_EQ(declarative_webrequest_constants::kOnRequest, event_name);
scoped_refptr<RulesRegistry> registry = RegisterWebRequestRulesRegistry(
rules_registry_id, RulesCacheDelegate::Type::kEphemeral);
DCHECK(base::Contains(rule_registries_, key));
return registry;
}
void RulesRegistryService::RemoveRulesRegistriesByID(int rules_registry_id) {
std::set<RulesRegistryKey> registries_to_delete;
for (auto& [key, rule_registry] : rule_registries_) {
if (key.rules_registry_id != rules_registry_id) {
continue;
}
// Modifying a container while iterating over it can lead to badness. So we
// save the keys in another container and delete them in another loop.
registries_to_delete.insert(key);
}
for (const auto& registry : registries_to_delete) {
rule_registries_.erase(registry);
}
}
bool RulesRegistryService::HasAnyRegisteredRules() const {
return std::ranges::any_of(
cache_delegates_,
[](const std::unique_ptr<RulesCacheDelegate>& delegate) {
return delegate->HasRules();
});
}
void RulesRegistryService::AddObserver(Observer* observer) {
DCHECK(observer);
observers_.AddObserver(observer);
}
void RulesRegistryService::RemoveObserver(Observer* observer) {
DCHECK(observer);
observers_.RemoveObserver(observer);
}
void RulesRegistryService::SimulateExtensionUninstalled(
const Extension* extension) {
NotifyRegistriesHelper(&RulesRegistry::OnExtensionUninstalled, extension);
}
bool RulesRegistryService::HasRulesRegistryForTesting(
int rules_registry_id,
const std::string& event_name) {
return base::Contains(rule_registries_,
RulesRegistryKey(event_name, rules_registry_id));
}
void RulesRegistryService::OnUpdateRules() {
// Forward rule updates to observers.
for (auto& observer : observers_)
observer.OnUpdateRules();
}
scoped_refptr<RulesRegistry>
RulesRegistryService::RegisterWebRequestRulesRegistry(
int rules_registry_id,
RulesCacheDelegate::Type cache_delegate_type) {
DCHECK(browser_context_);
DCHECK(!base::Contains(
rule_registries_,
RulesRegistryKey(declarative_webrequest_constants::kOnRequest,
rules_registry_id)));
auto web_request_cache_delegate =
std::make_unique<RulesCacheDelegate>(cache_delegate_type);
auto web_request_rules_registry =
base::MakeRefCounted<WebRequestRulesRegistry>(
browser_context_, web_request_cache_delegate.get(),
rules_registry_id);
web_request_cache_delegate->AddObserver(this);
cache_delegates_.push_back(std::move(web_request_cache_delegate));
RegisterRulesRegistry(web_request_rules_registry);
WebRequestEventRouter::Get(browser_context_)
->RegisterRulesRegistry(browser_context_, rules_registry_id,
web_request_rules_registry);
return web_request_rules_registry;
}
void RulesRegistryService::EnsureDefaultRulesRegistriesRegistered() {
DCHECK(browser_context_);
DCHECK(!base::Contains(
rule_registries_,
RulesRegistryKey(declarative_webrequest_constants::kOnRequest,
rules_registry_ids::kDefaultRulesRegistryID)));
// Only register the default web request rules registry if the
// declarativeWebRequest API is enabled. See crbug.com/693243.
const bool is_api_enabled =
FeatureProvider::GetAPIFeature("declarativeWebRequest")
->IsAvailableToEnvironment(
util::GetBrowserContextId(browser_context_))
.is_available();
if (is_api_enabled) {
// Persist the cache since it pertains to regular pages (i.e. not webviews).
RegisterWebRequestRulesRegistry(rules_registry_ids::kDefaultRulesRegistryID,
RulesCacheDelegate::Type::kPersistent);
}
// Create the ContentRulesRegistry.
DCHECK(!content_rules_registry_);
auto content_rules_cache_delegate = std::make_unique<RulesCacheDelegate>(
RulesCacheDelegate::Type::kPersistent);
scoped_refptr<ContentRulesRegistry> content_rules_registry =
ExtensionsAPIClient::Get()->CreateContentRulesRegistry(
browser_context_, content_rules_cache_delegate.get());
if (content_rules_registry) {
content_rules_cache_delegate->AddObserver(this);
cache_delegates_.push_back(std::move(content_rules_cache_delegate));
RegisterRulesRegistry(content_rules_registry);
content_rules_registry_ = content_rules_registry.get();
}
}
void RulesRegistryService::NotifyRegistriesHelper(
void (RulesRegistry::*notification_callback)(const Extension*),
const Extension* extension) {
RulesRegistryMap::iterator i;
for (i = rule_registries_.begin(); i != rule_registries_.end(); ++i) {
scoped_refptr<RulesRegistry> registry = i->second;
(registry.get()->*notification_callback)(extension);
}
}
void RulesRegistryService::OnExtensionLoaded(
content::BrowserContext* browser_context,
const Extension* extension) {
NotifyRegistriesHelper(&RulesRegistry::OnExtensionLoaded, extension);
}
void RulesRegistryService::OnExtensionUnloaded(
content::BrowserContext* browser_context,
const Extension* extension,
UnloadedExtensionReason reason) {
NotifyRegistriesHelper(&RulesRegistry::OnExtensionUnloaded, extension);
}
void RulesRegistryService::OnExtensionUninstalled(
content::BrowserContext* browser_context,
const Extension* extension,
extensions::UninstallReason reason) {
NotifyRegistriesHelper(&RulesRegistry::OnExtensionUninstalled, extension);
}
} // namespace extensions
|