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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_WEBAPPS_BROWSER_BANNERS_APP_BANNER_SETTINGS_HELPER_H_
#define COMPONENTS_WEBAPPS_BROWSER_BANNERS_APP_BANNER_SETTINGS_HELPER_H_
#include <optional>
#include <set>
#include <string>
#include "base/time/time.h"
namespace content {
class BrowserContext;
class WebContents;
} // namespace content
class GURL;
namespace webapps {
struct InstallBannerConfig;
// Utility class to record banner events for the given package or start url.
//
// These events are used to decide when banners should be shown, using a
// heuristic based on how many different days in a recent period of time (for
// example the past two weeks) the banner could have been shown, when it was
// last shown, when it was last blocked, and when it was last installed (for
// ServiceWorker style apps - native apps can query whether the app was
// installed directly).
//
// The desired effect is to have banners appear once a user has demonstrated
// an ongoing relationship with the app, and not to pester the user too much.
//
// For most events only the last event is recorded. The exception are the
// could show events. For these a list of the events is maintained. At most
// one event is stored per day, and events outside the window the heuristic
// uses are discarded. Local times are used to enforce these rules, to ensure
// what we count as a day matches what the user perceives to be days.
class AppBannerSettingsHelper {
public:
// An enum containing possible app menu verbiage for installing a web app.
// A Java counterpart will be generated for this enum.
// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.banners
enum AppMenuVerbiage {
APP_MENU_OPTION_UNKNOWN = 0,
APP_MENU_OPTION_MIN = APP_MENU_OPTION_UNKNOWN,
APP_MENU_OPTION_ADD_TO_HOMESCREEN = 1,
APP_MENU_OPTION_INSTALL = 2,
APP_MENU_OPTION_UNIVERSAL_INSTALL = 3,
APP_MENU_OPTION_MAX = APP_MENU_OPTION_UNIVERSAL_INSTALL,
};
// The various types of banner events recorded as timestamps in the app banner
// content setting per origin and package_name_or_start_url pair. This enum
// corresponds to the kBannerEventsKeys array.
// TODO(mariakhomenko): Rename events to reflect that they are used in more
// contexts now.
enum AppBannerEvent {
// Records the first time that a site met the conditions to show a banner.
// Used for computing the MinutesFromFirstVisitToBannerShown metric.
APP_BANNER_EVENT_COULD_SHOW,
// Records the latest time a banner was shown to the user. Used to suppress
// the banner from being shown too often.
APP_BANNER_EVENT_DID_SHOW,
// Records the latest time a banner was dismissed by the user. Used to
// suppress the banner for some time if the user explicitly didn't want it.
APP_BANNER_EVENT_DID_BLOCK,
// Records when a site met the conditions to show an ambient badge.
// Used to suppress the ambient badge from being shown too often.
APP_BANNER_EVENT_COULD_SHOW_AMBIENT_BADGE,
APP_BANNER_EVENT_NUM_EVENTS,
};
static const char kInstantAppsKey[];
AppBannerSettingsHelper() = delete;
AppBannerSettingsHelper(const AppBannerSettingsHelper&) = delete;
AppBannerSettingsHelper& operator=(const AppBannerSettingsHelper&) = delete;
// The content setting basically records a simplified subset of history.
// For privacy reasons this needs to be cleared. The ClearHistoryForURLs
// function removes any information from the banner content settings for the
// given URls.
static void ClearHistoryForURLs(content::BrowserContext* browser_context,
const std::set<GURL>& origin_urls);
// Record a banner installation event, for either a WEB or NATIVE app.
static void RecordBannerInstallEvent(
content::WebContents* web_contents,
const std::string& package_name_or_start_url);
// Record a banner dismissal event, for either a WEB or NATIVE app.
static void RecordBannerDismissEvent(
content::WebContents* web_contents,
const std::string& package_name_or_start_url);
// Record a banner event specified by |event|.
static void RecordBannerEvent(content::WebContents* web_contents,
const GURL& url,
const std::string& identifier,
AppBannerEvent event,
base::Time time);
static void RecordBannerEvent(content::WebContents* web_contents,
const InstallBannerConfig& config,
AppBannerEvent event,
base::Time time);
// Reports whether the app install banner was blocked by the user recently
// enough with respect to |now| that another banner should not yet be shown.
// |package_name_or_start_url| must be non-empty.
static bool WasBannerRecentlyBlocked(
content::WebContents* web_contents,
const GURL& origin_url,
const std::string& package_name_or_start_url,
base::Time now);
// Reports whether the app install banner was ignored by the user recently
// enough with respect to |now| that another banner should not yet be shown.
// |package_name_or_start_url| must be non-empty.
static bool WasBannerRecentlyIgnored(
content::WebContents* web_contents,
const GURL& origin_url,
const std::string& package_name_or_start_url,
base::Time now);
// Get the time that |event| was recorded, or a nullopt if it no dict to
// record yet(such as exceed max num per site) . Exposed for testing.
static std::optional<base::Time> GetSingleBannerEvent(
content::WebContents* web_contents,
const GURL& origin_url,
const std::string& package_name_or_start_url,
AppBannerEvent event);
// Record a UMA statistic measuring the minutes between the first visit to the
// site and the first showing of the banner.
static void RecordMinutesFromFirstVisitToShow(
content::WebContents* web_contents,
const GURL& origin_url,
const std::string& package_name_or_start_url,
base::Time time);
// Set the number of days which dismissing/ignoring the banner should prevent
// a banner from showing.
static void SetDaysAfterDismissAndIgnoreToTrigger(unsigned int dismiss_days,
unsigned int ignore_days);
// Returns whether we are out of |scope|'s animation suppression period and
// can show an animation.
static bool CanShowInstallTextAnimation(content::WebContents* web_contents,
const GURL& scope);
// Records the fact that we've shown an animation for |scope| and updates its
// animation suppression period.
static void RecordInstallTextAnimationShown(
content::WebContents* web_contents,
const GURL& scope);
// Utility class for testing, which sets how long the banner should be
// suppressed after it is dismissed or ignored. The previous configuration
// is restored when this object is destructed.
class ScopedTriggerSettings {
public:
ScopedTriggerSettings() = delete;
ScopedTriggerSettings(unsigned int dismiss_days, unsigned int ignore_days);
ScopedTriggerSettings(const ScopedTriggerSettings&) = delete;
ScopedTriggerSettings& operator=(const ScopedTriggerSettings&) = delete;
virtual ~ScopedTriggerSettings();
private:
unsigned int old_dismiss_, old_ignore_;
};
};
} // namespace webapps
#endif // COMPONENTS_WEBAPPS_BROWSER_BANNERS_APP_BANNER_SETTINGS_HELPER_H_
|
