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
|
// 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 COMPONENTS_PERMISSIONS_PERMISSION_HATS_TRIGGER_HELPER_H_
#define COMPONENTS_PERMISSIONS_PERMISSION_HATS_TRIGGER_HELPER_H_
#include <map>
#include <utility>
#include "components/keyed_service/core/keyed_service.h"
#include "components/permissions/permission_util.h"
#include "constants.h"
namespace user_prefs {
class PrefRegistrySyncable;
} // namespace user_prefs
class PrefService;
namespace permissions {
constexpr char kTrueStr[] = "true";
constexpr char kFalseStr[] = "false";
constexpr char kOnPromptAppearing[] = "OnPromptAppearing";
constexpr char kOnPromptResolved[] = "OnPromptResolved";
// A static class that handles permission HaTS survey trigger configuration and
// evaluation.
class PermissionHatsTriggerHelper {
// Key-value mapping type for a HaTS survey's product specific bits data.
typedef std::map<std::string, bool> SurveyBitsData;
// Key-value mapping type for HaTS survey's product specific string data.
typedef std::map<std::string, std::string> SurveyStringData;
public:
enum OneTimePermissionPromptsDecidedBucket {
BUCKET_0_1, // 0-1
BUCKET_2_3, // 2-3
BUCKET_4_5, // 4-5
BUCKET_6_10, // 6-10
BUCKET_11_20, // 11-20
BUCKET_GT20 // >20
};
struct PromptParametersForHaTS {
PromptParametersForHaTS(
permissions::RequestType request_type,
absl::optional<permissions::PermissionAction> action,
permissions::PermissionPromptDisposition prompt_disposition,
permissions::PermissionPromptDispositionReason
prompt_disposition_reason,
permissions::PermissionRequestGestureType gesture_type,
const std::string& channel,
const std::string& survey_display_time,
absl::optional<base::TimeDelta> prompt_display_duration,
OneTimePermissionPromptsDecidedBucket one_time_prompts_decided_bucket,
absl::optional<GURL> gurl);
PromptParametersForHaTS(const PromptParametersForHaTS& other);
~PromptParametersForHaTS();
permissions::RequestType request_type;
absl::optional<permissions::PermissionAction> action;
permissions::PermissionPromptDisposition prompt_disposition;
permissions::PermissionPromptDispositionReason prompt_disposition_reason;
permissions::PermissionRequestGestureType gesture_type;
std::string channel;
std::string survey_display_time;
absl::optional<base::TimeDelta> prompt_display_duration;
OneTimePermissionPromptsDecidedBucket one_time_prompts_decided_bucket;
std::string url;
};
struct SurveyProductSpecificData {
public:
~SurveyProductSpecificData();
static SurveyProductSpecificData PopulateFrom(
PromptParametersForHaTS prompt_parameters);
const SurveyBitsData survey_bits_data;
const SurveyStringData survey_string_data;
private:
explicit SurveyProductSpecificData(SurveyBitsData survey_bits_data,
SurveyStringData survey_string_data);
};
~PermissionHatsTriggerHelper() = delete;
PermissionHatsTriggerHelper(const PermissionHatsTriggerHelper&) = delete;
PermissionHatsTriggerHelper& operator=(const PermissionHatsTriggerHelper&) =
delete;
static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
static bool ArePromptTriggerCriteriaSatisfied(
PromptParametersForHaTS prompt_parameters,
const std::string& trigger_name_base);
static OneTimePermissionPromptsDecidedBucket GetOneTimePromptsDecidedBucket(
PrefService* pref_service);
// Increments the count representing the one time permission prompts seen by
// the user.
static void IncrementOneTimePermissionPromptsDecidedIfApplicable(
ContentSettingsType type,
PrefService* profile);
// Bucketing used to categorize users by how many one time permission they
// have decided.
static std::string GetOneTimePromptsDecidedBucketString(
OneTimePermissionPromptsDecidedBucket bucket);
// Returns a vector containing pairs of <trigger_name, trigger_id>
// The trigger_name is a unique name used by the HaTS service integration, and
// the trigger_id is an ID that specifies a survey in the Listnr backend.
static std::vector<std::pair<std::string, std::string>>&
GetPermissionPromptTriggerIdPairs(const std::string& trigger_name_base);
// Returns the trigger name and probability corresponding to a specific
// request type. Returns empty value if there is a configuration error or the
// passed request type is not configured.
static absl::optional<std::pair<std::string, double>>
GetPermissionPromptTriggerNameAndProbabilityForRequestType(
const std::string& trigger_name_base,
const std::string& request_type);
static void SetIsTest();
};
} // namespace permissions
#endif // COMPONENTS_PERMISSIONS_PERMISSION_HATS_TRIGGER_HELPER_H_
|
