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
|
// Copyright 2024 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/ui/webui/top_chrome/per_profile_webui_tracker.h"
#include <map>
#include <memory>
#include <set>
#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/webui/top_chrome/webui_contents_preload_state.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_observer.h"
#include "url/gurl.h"
namespace {
// The impl class that implements PerProfileWebUITracker.
// PerProfileWebUITracker is an abstract class so that it can be easily mocked
// in tests.
class PerProfileWebUITrackerImpl : public PerProfileWebUITracker {
public:
PerProfileWebUITrackerImpl() = default;
~PerProfileWebUITrackerImpl() override = default;
explicit PerProfileWebUITrackerImpl(const PerProfileWebUITracker&) = delete;
PerProfileWebUITrackerImpl& operator=(const PerProfileWebUITrackerImpl&) =
delete;
// PerProfileWebUITracker:
void AddWebContents(content::WebContents* web_contents) override;
bool ProfileHasWebUI(Profile* profile, const std::string& webui_url) const override;
bool ProfileHasBackgroundWebUI(Profile* profile,
const std::string& webui_url) const override;
void AddObserver(Observer* observer) override;
void RemoveObserver(Observer* observer) override;
private:
class WebContentsObserver;
// The nested WebContentsObserver notifies the impl about WebContents state
// change using the following functions.
void OnWebContentsDestroyed(content::WebContents* web_contents);
void OnWebContentsOriginChanged(content::WebContents* web_contents,
url::Origin old_origin,
url::Origin new_origin);
void OnWebContentsPrimaryPageChanged(content::WebContents* web_contents);
base::ObserverList<Observer, /*check_empty=*/true> observers_;
// Observers of tracked WebContents.
std::map<raw_ptr<content::WebContents>, std::unique_ptr<WebContentsObserver>>
web_contents_observers_;
// Maintains a multi-set of {profile, origin} pairs. Note that a multi-set is
// used because a profile can have multiple browser windows, each can have a
// WebUI, therefore there can be multiple WebUIs of the same URL under a
// Profile.
std::multiset<std::pair<raw_ptr<content::BrowserContext>, url::Origin>>
profile_origin_set_;
};
// We need an observer instance for each WebContents because methods in
// WebContentsObserver does not provide a pointer to the WebContents itself. If
// we observe WebContents in the tracker class we will be unable to distinguish
// the source WebContents.
class PerProfileWebUITrackerImpl::WebContentsObserver
: public content::WebContentsObserver {
public:
explicit WebContentsObserver(PerProfileWebUITrackerImpl* owner,
content::WebContents* web_contents)
: content::WebContentsObserver(web_contents),
owner_(owner),
web_contents_(web_contents),
origin_(url::Origin::Create(web_contents->GetVisibleURL())) {
// The WebContents can already be navigated to a WebUI.
// Update the owner with the initial origin.
owner_->OnWebContentsOriginChanged(web_contents, url::Origin(), origin_);
}
~WebContentsObserver() override = default;
// content::WebContentsObserver:
void WebContentsDestroyed() override {
// The PrimaryPageChanged() is not called during WebContents destroy,
// so we notify the owner explicitly.
owner_->OnWebContentsOriginChanged(web_contents_, origin_, url::Origin());
owner_->OnWebContentsDestroyed(web_contents_);
}
void PrimaryPageChanged(content::Page&) override {
owner_->OnWebContentsPrimaryPageChanged(web_contents_);
url::Origin new_origin =
url::Origin::Create(web_contents_->GetVisibleURL());
if (new_origin != origin_) {
owner_->OnWebContentsOriginChanged(web_contents_, origin_, new_origin);
origin_ = new_origin;
}
}
private:
raw_ptr<PerProfileWebUITrackerImpl> owner_;
raw_ptr<content::WebContents> web_contents_;
url::Origin origin_;
};
void PerProfileWebUITrackerImpl::AddWebContents(
content::WebContents* web_contents) {
CHECK(web_contents);
CHECK(!web_contents_observers_.contains(web_contents));
web_contents_observers_.emplace(
web_contents, std::make_unique<WebContentsObserver>(this, web_contents));
}
bool PerProfileWebUITrackerImpl::ProfileHasWebUI(Profile* profile,
const std::string& webui_url) const {
url::Origin webui_origin = url::Origin::Create(GURL(webui_url));
return profile_origin_set_.contains({profile, webui_origin});
}
bool PerProfileWebUITrackerImpl::ProfileHasBackgroundWebUI(
Profile* profile,
const std::string& webui_url) const {
url::Origin webui_origin = url::Origin::Create(GURL(webui_url));
for (const auto& [web_contents, _] : web_contents_observers_) {
if (web_contents->GetBrowserContext() != profile ||
web_contents->GetVisibleURL().host() != webui_origin.host()) {
continue;
}
const auto* preload_state =
WebUIContentsPreloadState::FromWebContents(web_contents);
CHECK(preload_state);
if (!preload_state->request_time.has_value()) {
// A background WebUI must be preloaded. Note that the reversed condition
// is not true. A preloaded WebUI can be in the foreground.
CHECK(preload_state->preloaded);
return true;
}
}
return false;
}
void PerProfileWebUITrackerImpl::AddObserver(Observer* observer) {
observers_.AddObserver(observer);
}
void PerProfileWebUITrackerImpl::RemoveObserver(Observer* observer) {
observers_.RemoveObserver(observer);
}
void PerProfileWebUITrackerImpl::OnWebContentsDestroyed(
content::WebContents* web_contents) {
CHECK(web_contents_observers_.contains(web_contents));
web_contents_observers_.erase(web_contents);
for (Observer& observer : observers_) {
observer.OnWebContentsDestroyed(web_contents);
}
}
void PerProfileWebUITrackerImpl::OnWebContentsOriginChanged(
content::WebContents* web_contents,
url::Origin old_origin,
url::Origin new_origin) {
content::BrowserContext* profile = web_contents->GetBrowserContext();
// Opaque origins are about:blank, we don't track them.
if (!old_origin.opaque()) {
auto it = profile_origin_set_.find({profile, old_origin});
CHECK(it != profile_origin_set_.end());
profile_origin_set_.erase(it);
}
if (!new_origin.opaque()) {
profile_origin_set_.emplace(profile, new_origin);
}
}
void PerProfileWebUITrackerImpl::OnWebContentsPrimaryPageChanged(
content::WebContents* web_contents) {
CHECK(web_contents_observers_.contains(web_contents));
for (Observer& observer : observers_) {
observer.OnWebContentsPrimaryPageChanged(web_contents);
}
}
} // namespace
// static
std::unique_ptr<PerProfileWebUITracker> PerProfileWebUITracker::Create() {
return std::make_unique<PerProfileWebUITrackerImpl>();
}
|
