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
|
// 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.
#ifndef CONTENT_BROWSER_BTM_BTM_SERVICE_IMPL_H_
#define CONTENT_BROWSER_BTM_BTM_SERVICE_IMPL_H_
#include "base/functional/bind.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list_types.h"
#include "base/run_loop.h"
#include "base/task/sequenced_task_runner.h"
#include "base/threading/sequence_bound.h"
#include "base/types/pass_key.h"
#include "content/browser/btm/btm_storage.h"
#include "content/browser/btm/btm_utils.h"
#include "content/common/content_export.h"
#include "content/public/browser/browsing_data_filter_builder.h"
#include "content/public/browser/btm_redirect_info.h"
#include "content/public/browser/btm_service.h"
namespace content {
class BrowserContext;
class BrowserContextImpl;
class PersistentRepeatingTimer;
// `BtmServiceImpl` is intentionally *not* exposed in the Content API — we only
// want other `//content` code (such as the BTM implementation) to access it, as
// `BtmServiceImpl` is an implementation detail that `//content` embedders
// shouldn't know about.
class CONTENT_EXPORT BtmServiceImpl : public BtmService {
public:
using StatefulBounceCallback = base::RepeatingCallback<void(const GURL&)>;
using RecordBounceCallback =
base::RepeatingCallback<void(const BtmRedirectInfo& redirect,
const BtmRedirectChainInfo& chain)>;
BtmServiceImpl(base::PassKey<BrowserContextImpl>, BrowserContext* context);
~BtmServiceImpl() override;
static BtmServiceImpl* Get(BrowserContext* context);
base::SequenceBound<BtmStorage>* storage() { return &storage_; }
void RecordBounceForTesting(const BtmRedirectInfo& redirect,
const BtmRedirectChainInfo& chain,
StatefulBounceCallback stateful_bounce_callback) {
RecordBounce(stateful_bounce_callback, redirect, chain);
}
BtmCookieMode GetCookieMode() const;
void RemoveEvents(const base::Time& delete_begin,
const base::Time& delete_end,
network::mojom::ClearDataFilterPtr filter,
const BtmEventRemovalType type);
// This allows for deletion of state for sites deemed eligible when evaluated
// with no grace period.
void DeleteEligibleSitesImmediately(DeletedSitesCallback callback) override;
// Processes a redirect chain to identify and record bounces. The main
// entrypoint for the BTM feature to act on navigations.
void HandleRedirectChain(std::vector<BtmRedirectInfoPtr> redirects,
BtmRedirectChainInfoPtr chain,
StatefulBounceCallback stateful_bounce_callback);
void RecordUserActivationForTesting(const GURL& url) override;
void DidSiteHaveUserActivationSince(
const GURL& url,
base::Time bound,
CheckUserActivationCallback callback) const override;
// This allows unit-testing the metrics recording without instantiating
// BtmService. Just calls the internal RecordRedirectMetrics function.
static void RecordRedirectMetricsForTesting(
const BtmRedirectInfo& redirect,
const BtmRedirectChainInfo& chain);
void SetStorageClockForTesting(base::Clock* clock) {
DCHECK(storage_);
storage_.AsyncCall(&BtmStorage::SetClockForTesting).WithArgs(clock);
}
void OnTimerFiredForTesting() { OnTimerFired(); }
#if BUILDFLAG(IS_FUCHSIA) && defined(IS_WEB_ENGINE)
void WaitForFuchsiaCleanupForTesting() { fuchsia_cleanup_loop_.Run(); }
#endif
void AddObserver(Observer* observer) override;
void RemoveObserver(const Observer* observer) override;
void AddOpenSite(const std::string& site) {
if (open_sites_.contains(site)) {
open_sites_.at(site)++;
} else {
open_sites_.insert({site, 1});
}
}
void RemoveOpenSite(const std::string& site) {
CHECK(open_sites_.contains(site));
if (open_sites_.contains(site)) {
open_sites_.at(site)--;
if (open_sites_.at(site) == 0) {
open_sites_.erase(site);
}
}
}
// Notify Observers that a stateful bounce took place in `web_contents`.
void NotifyStatefulBounce(WebContents* web_contents);
private:
std::unique_ptr<PersistentRepeatingTimer> CreateTimer();
// Processes redirects to identify and record bounces.
void HandleRedirects(std::vector<BtmRedirectInfoPtr> redirects,
BtmRedirectChainInfoPtr chain,
StatefulBounceCallback stateful_bounce_callback,
std::pair<std::set<std::string>, std::set<std::string>>
sites_with_protective_events);
void RecordBounce(StatefulBounceCallback stateful_bounce_callback,
const BtmRedirectInfo& redirect,
const BtmRedirectChainInfo& chain);
scoped_refptr<base::SequencedTaskRunner> CreateTaskRunner();
scoped_refptr<base::SequencedTaskRunner> CreateTaskRunnerForResource(
const base::FilePath& path);
void OnTimerFired();
void DeleteBtmEligibleState(DeletedSitesCallback callback,
std::vector<std::string> sites_to_clear);
void RunDeletionTaskOnUIThread(std::vector<std::string> sites_to_clear,
base::OnceClosure callback);
// BtmService overrides:
void RecordBrowserSignIn(std::string_view domain) override;
raw_ptr<BrowserContext> browser_context_;
// The persisted timer controlling how often incidental state is cleared.
// This timer is null if the BTM feature isn't enabled with a valid TimeDelta
// given for its `timer_delay` parameter.
// See base/time/time_delta_from_string.h for how that param should be given.
std::unique_ptr<PersistentRepeatingTimer> repeating_timer_;
base::SequenceBound<BtmStorage> storage_;
base::ObserverList<Observer> observers_;
// A map from site (eTLD+1) to the number of tabs that have that site open.
// Used to avoid clearing state for sites that are currently in use.
std::map<std::string, int> open_sites_;
#if BUILDFLAG(IS_FUCHSIA) && defined(IS_WEB_ENGINE)
// If running on WebEngine on Fuchsia, any existing BTM database file is
// asynchronously deleted. This RunLoop allows tests to wait for the
// deletion to complete.
//
// TODO: crbug.com/434764000 - delete this once we are confident any leftover
// database files have been removed on WebEngine on Fuchsia.
base::RunLoop fuchsia_cleanup_loop_;
#endif
base::WeakPtrFactory<BtmServiceImpl> weak_factory_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_BTM_BTM_SERVICE_IMPL_H_
|
