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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_PRIVACY_SANDBOX_PRIVACY_SANDBOX_PROMPT_HELPER_H_
#define CHROME_BROWSER_UI_PRIVACY_SANDBOX_PRIVACY_SANDBOX_PROMPT_HELPER_H_
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
namespace content {
class WebContents;
}
class Profile;
// Helper class which watches |web_contents| to determine whether there is an
// appropriate opportunity to show the PrivacySandboxPrompt. Consults with the
// PrivacySandboxService to determine what type of prompt, if any, to show.
// When an appropriate time is determined, calls Show() directly to the
// PrivacySandboxPrompt.
class PrivacySandboxPromptHelper
: public content::WebContentsObserver,
public content::WebContentsUserData<PrivacySandboxPromptHelper> {
public:
PrivacySandboxPromptHelper(const PrivacySandboxPromptHelper&) = delete;
PrivacySandboxPromptHelper& operator=(const PrivacySandboxPromptHelper&) =
delete;
~PrivacySandboxPromptHelper() override;
// Returns whether |profile| needs to be shown a Privacy Sandbox prompt. If
// this returns false, there is no need to create this helper.
static bool ProfileRequiresPrompt(Profile* profile);
private:
friend class content::WebContentsUserData<PrivacySandboxPromptHelper>;
friend class PrivacySandboxPromptHelperBrowserTest;
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
PromptOpensOnNtp);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
PromptOpensAboutBlank);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
PromptOpensOnSettings);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
PromptOpensOnHistory);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
NoPromptNonDefaultNtp);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
NoPromptSync);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
NoPromptProfileSetup);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
UnsuitableUrl);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
SinglePromptPerBrowser);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptHelperWithParamBrowserTest,
MultipleBrowserWindows);
FRIEND_TEST_ALL_PREFIXES(
PrivacySandboxPromptHelperWithSearchEngineChoiceEnabledBrowserTest,
NoPromptWhenSearchEngineChoiceDialogIsDisplayed);
FRIEND_TEST_ALL_PREFIXES(
PrivacySandboxPromptNonNormalBrowserFeatureDisabledBrowserTest,
NonNormalBrowserShowsPrompt);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptNonNormalBrowserTest,
NoPromptInSmallBrowser);
FRIEND_TEST_ALL_PREFIXES(PrivacySandboxPromptNonNormalBrowserTest,
NoPromptInLargeBrowser);
// Contains all the events that the helper goes through when attempting to
// show a Privacy Sandbox prompt. Must be kept in sync with the
// SettingsPrivacySandboxPromptHelperEvent enum in histograms/enums.xml.
enum class SettingsPrivacySandboxPromptHelperEvent {
kCreated = 0,
kPromptNotRequired = 1,
kNonTopFrameNavigation = 2,
kAboutBlankOpened = 3,
kUrlNotSuitable = 4,
kSyncSetupInProgress = 5,
kSigninDialogShown = 6,
kPromptAlreadyExistsForBrowser = 7,
kWindowTooSmall = 8,
kPromptShown = 9,
kSearchEngineChoiceDialogShown = 10,
kNonNormalBrowser = 11,
// Add values above this line with a corresponding label in
// tools/metrics/histograms/enums.xml
kMaxValue = kNonNormalBrowser,
};
explicit PrivacySandboxPromptHelper(content::WebContents* web_contents);
// contents::WebContentsObserver:
void DidFinishNavigation(
content::NavigationHandle* navigation_handle) override;
Profile* profile();
WEB_CONTENTS_USER_DATA_KEY_DECL();
};
#endif // CHROME_BROWSER_UI_PRIVACY_SANDBOX_PRIVACY_SANDBOX_PROMPT_HELPER_H_
|
