File: web_app_pref_guardrails.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (396 lines) | stat: -rw-r--r-- 14,738 bytes parent folder | download | duplicates (6)
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
// Copyright 2023 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/web_applications/web_app_pref_guardrails.h"

#include <optional>
#include <string>
#include <string_view>

#include "base/check.h"
#include "base/json/values_util.h"
#include "base/strings/strcat.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/web_applications/web_app_constants.h"
#include "chrome/common/chrome_features.h"
#include "chrome/common/pref_names.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_service.h"
#include "components/prefs/scoped_user_pref_update.h"
#include "components/webapps/browser/features.h"
#include "components/webapps/common/web_app_id.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/common/content_features.h"

namespace web_app {

namespace {

// Returns whether the time occurred within X days.
bool TimeOccurredWithinDays(std::optional<base::Time> time, int days) {
  return time && (base::Time::Now() - time.value()).InDays() < days;
}

const base::Value::Dict* GetWebAppDictionary(const PrefService* pref_service,
                                             const webapps::AppId& app_id) {
  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
  const base::Value::Dict& web_apps_prefs =
      pref_service->GetDict(prefs::kWebAppsPreferences);

  return web_apps_prefs.FindDict(app_id);
}

base::Value::Dict& UpdateWebAppDictionary(
    ScopedDictPrefUpdate& web_apps_prefs_update,
    const webapps::AppId& app_id) {
  DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
  return *web_apps_prefs_update->EnsureDict(app_id);
}

}  // namespace

std::optional<int> GetIntWebAppPref(const PrefService* pref_service,
                                    const webapps::AppId& app_id,
                                    std::string_view path) {
  const base::Value::Dict* web_app_prefs =
      GetWebAppDictionary(pref_service, app_id);
  if (!web_app_prefs) {
    return std::nullopt;
  }
  return web_app_prefs->FindIntByDottedPath(path);
}

std::optional<base::Time> GetTimeWebAppPref(const PrefService* pref_service,
                                            const webapps::AppId& app_id,
                                            std::string_view path) {
  const auto* web_app_prefs = GetWebAppDictionary(pref_service, app_id);
  if (!web_app_prefs) {
    return std::nullopt;
  }
  const base::Value* time_value = web_app_prefs->FindByDottedPath(path);
  if (!time_value) {
    return std::nullopt;
  }
  return base::ValueToTime(time_value);
}

// static
WebAppPrefGuardrails WebAppPrefGuardrails::GetForDesktopInstallIph(
    PrefService* pref_service) {
  return WebAppPrefGuardrails(pref_service, web_app::kIphGuardrails,
                              web_app::kIphPrefNames,
                              /*max_days_to_store_guardrails=*/std::nullopt);
}

// static
WebAppPrefGuardrails WebAppPrefGuardrails::GetForMlInstallPrompt(
    PrefService* pref_service) {
  return WebAppPrefGuardrails(
      pref_service, web_app::kMlPromoGuardrails, web_app::kMlPromoPrefNames,
      webapps::features::kMaxDaysForMLPromotionGuardrailStorage.Get());
}

// static
WebAppPrefGuardrails WebAppPrefGuardrails::GetForNavigationCapturingIph(
    PrefService* pref_service) {
  return WebAppPrefGuardrails(
      pref_service, web_app::kIPHNavigationCapturingGuardrails,
      web_app::kIPHNavigationCapturingPrefNames,
      features::kNavigationCapturingIPHGuardrailStorageDuration.Get());
}

// static
void WebAppPrefGuardrails::RegisterProfilePrefs(
    user_prefs::PrefRegistrySyncable* registry) {
  registry->RegisterDictionaryPref(prefs::kWebAppsPreferences);
  registry->RegisterDictionaryPref(prefs::kWebAppsAppAgnosticIphState);
  registry->RegisterDictionaryPref(prefs::kWebAppsAppAgnosticMlState);
  registry->RegisterDictionaryPref(
      prefs::kWebAppsAppAgnosticIPHLinkCapturingState);
}

WebAppPrefGuardrails::~WebAppPrefGuardrails() = default;

void WebAppPrefGuardrails::RecordIgnore(const webapps::AppId& app_id,
                                        base::Time time) {
  // The ignore pref keys not being passed is an indication that ignore
  // guardrails need not be measured.
  if (pref_names_->last_ignore_time_name.empty() ||
      pref_names_->not_accepted_count_name.empty()) {
    return;
  }

  if (guardrail_data_->app_specific_mute_after_ignore_days.has_value()) {
    UpdateAppSpecificNotAcceptedPrefs(app_id, time,
                                      pref_names_->last_ignore_time_name);
  }

  if (guardrail_data_->global_mute_after_ignore_days.has_value()) {
    UpdateGlobalNotAcceptedPrefs(time, pref_names_->last_ignore_time_name);
  }
}

void WebAppPrefGuardrails::RecordDismiss(const webapps::AppId& app_id,
                                         base::Time time) {
  // The dismiss pref keys not being passed is an indication that dismiss
  // guardrails need not be measured.
  if (pref_names_->last_dismiss_time_name.empty() ||
      pref_names_->not_accepted_count_name.empty()) {
    return;
  }

  if (guardrail_data_->app_specific_mute_after_dismiss_days.has_value()) {
    UpdateAppSpecificNotAcceptedPrefs(app_id, time,
                                      pref_names_->last_dismiss_time_name);
  }

  if (guardrail_data_->global_mute_after_dismiss_days.has_value()) {
    UpdateGlobalNotAcceptedPrefs(time, pref_names_->last_dismiss_time_name);
  }
}

void WebAppPrefGuardrails::RecordAccept(const webapps::AppId& app_id) {
  UpdateIntWebAppPref(app_id, pref_names_->not_accepted_count_name, 0);

  ScopedDictPrefUpdate update(pref_service_,
                              std::string(pref_names_->global_pref_name));
  update->Set(pref_names_->not_accepted_count_name, 0);

  if (!pref_names_->all_blocked_time_name.empty()) {
    update->Remove(pref_names_->all_blocked_time_name);
  }
}

bool WebAppPrefGuardrails::IsBlockedByGuardrails(const webapps::AppId& app_id) {
  // Since IsBlockedByGuardrails() is called every time to do a check, this is a
  // good place to reset guardrail blocks if any.
  if (ShouldResetGlobalGuardrails()) {
    ResetGlobalGuardrails(app_id);
  }

  std::optional<std::string> app_block_reason = IsAppBlocked(app_id);
  if (app_block_reason.has_value()) {
    ScopedDictPrefUpdate global_update(
        pref_service_, std::string(pref_names_->global_pref_name));
    LogGlobalBlockReason(global_update, app_block_reason.value());
    return true;
  }

  std::optional<std::string> global_block_reason = IsGloballyBlocked();
  if (global_block_reason.has_value()) {
    ScopedDictPrefUpdate global_update(
        pref_service_, std::string(pref_names_->global_pref_name));
    LogGlobalBlockReason(global_update, global_block_reason.value());
    if (global_block_reason == "global_not_accept_count_exceeded" &&
        !pref_names_->all_blocked_time_name.empty() && !IsGlobalBlockActive()) {
      global_update->Set(pref_names_->all_blocked_time_name,
                         base::TimeToValue(base::Time::Now()));
    }
    return true;
  }

  return false;
}

WebAppPrefGuardrails::WebAppPrefGuardrails(
    PrefService* pref_service,
    const GuardrailData& guardrail_data,
    const GuardrailPrefNames& guardrail_pref_names,
    std::optional<int> max_days_to_store_guardrails)
    : pref_service_(pref_service),
      guardrail_data_(guardrail_data),
      pref_names_(guardrail_pref_names),
      max_days_to_store_guardrails_(max_days_to_store_guardrails) {}

std::optional<std::string> WebAppPrefGuardrails::IsAppBlocked(
    const webapps::AppId& app_id) {
  // Block if user ignored the action for the app N+ times.
  if (guardrail_data_->app_specific_not_accept_count.has_value()) {
    int app_ignored_count =
        GetIntWebAppPref(pref_service_, app_id,
                         pref_names_->not_accepted_count_name)
            .value_or(0);
    if (app_ignored_count >= guardrail_data_->app_specific_not_accept_count) {
      return base::StrCat({"app_specific_not_accept_count_exceeded:", app_id});
    }
  }

  // Block if user ignored the action for the app within N days.
  if (guardrail_data_->app_specific_mute_after_ignore_days.has_value()) {
    auto app_last_ignore = GetTimeWebAppPref(
        pref_service_, app_id, pref_names_->last_ignore_time_name);

    if (TimeOccurredWithinDays(
            app_last_ignore,
            *guardrail_data_->app_specific_mute_after_ignore_days)) {
      return base::StrCat({"app_specific_ignore_days_hit:", app_id});
    }
  }

  // Block if the user dismissed the action for the app within N days.
  if (guardrail_data_->app_specific_mute_after_dismiss_days.has_value()) {
    auto app_last_dismiss_time = GetTimeWebAppPref(
        pref_service_, app_id, pref_names_->last_dismiss_time_name);

    if (TimeOccurredWithinDays(
            app_last_dismiss_time,
            *guardrail_data_->app_specific_mute_after_dismiss_days)) {
      return base::StrCat({"app_specific_dismiss_days_hit:", app_id});
    }
  }

  return std::nullopt;
}

std::optional<std::string> WebAppPrefGuardrails::IsGloballyBlocked() {
  const base::Value::Dict& dict =
      pref_service_->GetDict(pref_names_->global_pref_name);

  // Block if user ignored the action last N+ times for any app.
  int global_ignored_count =
      dict.FindInt(pref_names_->not_accepted_count_name).value_or(0);
  if (global_ignored_count >= guardrail_data_->global_not_accept_count) {
    return "global_not_accept_count_exceeded";
  }

  // Block if user ignored the action for any app within N days.
  if (guardrail_data_->global_mute_after_ignore_days.has_value()) {
    auto global_last_ignore =
        base::ValueToTime(dict.Find(pref_names_->last_ignore_time_name));

    if (TimeOccurredWithinDays(
            global_last_ignore,
            *guardrail_data_->global_mute_after_ignore_days)) {
      return "global_ignore_days_hit";
    }
  }

  // Block if user dismissed the action for any app within N days.
  if (guardrail_data_->global_mute_after_dismiss_days.has_value()) {
    auto global_last_dismiss =
        base::ValueToTime(dict.Find(pref_names_->last_dismiss_time_name));

    if (TimeOccurredWithinDays(
            global_last_dismiss,
            *guardrail_data_->global_mute_after_dismiss_days)) {
      return "global_dismiss_days_hit";
    }
  }
  return std::nullopt;
}

void WebAppPrefGuardrails::UpdateAppSpecificNotAcceptedPrefs(
    const webapps::AppId& app_id,
    base::Time time,
    std::string_view time_path) {
  // TODO(b/313491176): Optimize so that a single ScopedPrefUpdate call takes
  // place instead of 2. Break this up into seaparate functions that increment
  // the integer pref and sset the time pref, and tkaes in a reference to
  // ScopedDictPrefUpdate.
  std::optional<int> ignored_count = GetIntWebAppPref(
      pref_service_, app_id, pref_names_->not_accepted_count_name);
  int new_count = base::saturated_cast<int>(1 + ignored_count.value_or(0));

  UpdateIntWebAppPref(app_id, pref_names_->not_accepted_count_name, new_count);
  UpdateTimeWebAppPref(app_id, time_path, time);
}

void WebAppPrefGuardrails::UpdateGlobalNotAcceptedPrefs(
    base::Time time,
    std::string_view time_path) {
  // TODO(b/313491176): Optimize so that a single ScopedPrefUpdate call takes
  // place instead of 2. Break this up into seaparate functions that increment
  // the integer pref and sset the time pref, and tkaes in a reference to
  // ScopedDictPrefUpdate.
  ScopedDictPrefUpdate update(pref_service_,
                              std::string(pref_names_->global_pref_name));
  int global_count =
      update->FindInt(pref_names_->not_accepted_count_name).value_or(0);
  update->Set(pref_names_->not_accepted_count_name,
              base::saturated_cast<int>(global_count + 1));
  update->Set(time_path, base::TimeToValue(time));
}

bool WebAppPrefGuardrails::ShouldResetGlobalGuardrails() {
  CHECK(!pref_names_->global_pref_name.empty());
  if (!IsGlobalBlockActive()) {
    return false;
  }

  // If max_days_to_store_guardrails_ is not set, then guardrails need not be
  // reset.
  if (!max_days_to_store_guardrails_.has_value()) {
    return false;
  }

  const base::Value::Dict& dict =
      pref_service_->GetDict(pref_names_->global_pref_name);
  const base::Value* value =
      dict.FindByDottedPath(pref_names_->all_blocked_time_name);
  if (!value) {
    return false;
  }

  std::optional<base::Time> last_blocked_time = base::ValueToTime(value);

  // We only want to clear the guardrails if max_days_to_store_guardrails_ is
  // crossed.
  return !TimeOccurredWithinDays(last_blocked_time,
                                 *max_days_to_store_guardrails_);
}

void WebAppPrefGuardrails::ResetGlobalGuardrails(const webapps::AppId& app_id) {
  ScopedDictPrefUpdate update(pref_service_,
                              std::string(pref_names_->global_pref_name));
  if (!pref_names_->all_blocked_time_name.empty()) {
    update->Remove(pref_names_->all_blocked_time_name);
  }

  if (!pref_names_->block_reason_name.empty()) {
    update->Remove(pref_names_->block_reason_name);
  }

  update->Set(pref_names_->not_accepted_count_name, 0);
}

bool WebAppPrefGuardrails::IsGlobalBlockActive() {
  CHECK(!pref_names_->global_pref_name.empty());
  if (pref_names_->all_blocked_time_name.empty()) {
    return false;
  }
  const base::Value::Dict& dict =
      pref_service_->GetDict(pref_names_->global_pref_name);
  return dict.contains(pref_names_->all_blocked_time_name);
}

void WebAppPrefGuardrails::LogGlobalBlockReason(
    ScopedDictPrefUpdate& global_update,
    const std::string& reason) {
  if (pref_names_->block_reason_name.empty() ||
      pref_names_->global_pref_name.empty()) {
    return;
  }

  global_update->Set(pref_names_->block_reason_name, reason);
}

void WebAppPrefGuardrails::UpdateTimeWebAppPref(const webapps::AppId& app_id,
                                                std::string_view path,
                                                base::Time value) {
  ScopedDictPrefUpdate update(pref_service_, prefs::kWebAppsPreferences);

  auto& web_app_prefs = UpdateWebAppDictionary(update, app_id);
  web_app_prefs.SetByDottedPath(path, base::TimeToValue(value));
}

void WebAppPrefGuardrails::UpdateIntWebAppPref(const webapps::AppId& app_id,
                                               std::string_view path,
                                               int value) {
  ScopedDictPrefUpdate update(pref_service_, prefs::kWebAppsPreferences);

  base::Value::Dict& web_app_prefs = UpdateWebAppDictionary(update, app_id);
  web_app_prefs.SetByDottedPath(path, value);
}

}  // namespace web_app