File: settings_clear_browsing_data_handler.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (478 lines) | stat: -rw-r--r-- 19,420 bytes parent folder | download | duplicates (2)
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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
// Copyright 2015 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/ui/webui/settings/settings_clear_browsing_data_handler.h"

#include <stddef.h>

#include <algorithm>
#include <vector>

#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/values.h"
#include "chrome/browser/browsing_data/browsing_data_important_sites_util.h"
#include "chrome/browser/browsing_data/chrome_browsing_data_remover_constants.h"
#include "chrome/browser/browsing_data/counters/browsing_data_counter_factory.h"
#include "chrome/browser/browsing_data/counters/browsing_data_counter_utils.h"
#include "chrome/browser/history/web_history_service_factory.h"
#include "chrome/browser/search_engines/template_url_service_factory.h"
#include "chrome/browser/signin/identity_manager_factory.h"
#include "chrome/browser/sync/sync_service_factory.h"
#include "chrome/browser/sync/sync_ui_util.h"
#include "chrome/browser/ui/browser_finder.h"
#include "chrome/browser/ui/browser_window/public/browser_window_features.h"
#include "chrome/browser/ui/hats/trust_safety_sentiment_service.h"
#include "chrome/browser/ui/hats/trust_safety_sentiment_service_factory.h"
#include "chrome/browser/ui/toasts/api/toast_id.h"
#include "chrome/browser/ui/toasts/toast_controller.h"
#include "chrome/browser/ui/toasts/toast_features.h"
#include "chrome/browser/ui/views/frame/browser_view.h"
#include "chrome/common/channel_info.h"
#include "chrome/common/chrome_features.h"
#include "chrome/common/url_constants.h"
#include "chrome/grit/branded_strings.h"
#include "chrome/grit/generated_resources.h"
#include "components/browsing_data/content/browsing_data_helper.h"
#include "components/browsing_data/core/browsing_data_utils.h"
#include "components/browsing_data/core/cookie_or_cache_deletion_choice.h"
#include "components/browsing_data/core/history_notice_utils.h"
#include "components/browsing_data/core/pref_names.h"
#include "components/history/core/common/pref_names.h"
#include "components/prefs/pref_member.h"
#include "components/prefs/pref_service.h"
#include "components/search_engines/search_engine_type.h"
#include "components/search_engines/template_url_service.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "content/public/browser/browsing_data_filter_builder.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_ui.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/text/bytes_formatting.h"

using BrowsingDataType = browsing_data::BrowsingDataType;

namespace {

const int kMaxTimesHistoryNoticeShown = 1;

// TODO(msramek): Get the list of deletion preferences from the JS side.
// TODO(crbug.com/397187800): Remove basic and password counters when
// kDbdRevampDesktop is launched.
std::vector<std::string> GetAdvancedCounterPrefs() {
  std::vector<std::string> counter_prefs_advanced = {
      browsing_data::prefs::kDeleteBrowsingHistory,
      browsing_data::prefs::kDeleteCache,
      browsing_data::prefs::kDeleteCookies,
      browsing_data::prefs::kDeleteDownloadHistory,
      browsing_data::prefs::kDeleteFormData,
      browsing_data::prefs::kDeleteHostedAppsData,
      browsing_data::prefs::kDeleteSiteSettings,
  };

  if (!base::FeatureList::IsEnabled(features::kDbdRevampDesktop)) {
    counter_prefs_advanced.push_back(browsing_data::prefs::kDeletePasswords);
  }

  return counter_prefs_advanced;
}

std::vector<std::string> GetBasicCounterPrefs() {
  std::vector<std::string> counter_prefs_basic = {};

  if (!base::FeatureList::IsEnabled(features::kDbdRevampDesktop)) {
    counter_prefs_basic.push_back(browsing_data::prefs::kDeleteCacheBasic);
  }

  return counter_prefs_basic;
}

}  // namespace

namespace settings {

// ClearBrowsingDataHandler ----------------------------------------------------

ClearBrowsingDataHandler::ClearBrowsingDataHandler(content::WebUI* webui,
                                                   Profile* profile)
    : profile_(profile),
      sync_service_(SyncServiceFactory::GetForProfile(profile_)),
      show_history_deletion_dialog_(false) {}

ClearBrowsingDataHandler::~ClearBrowsingDataHandler() = default;

void ClearBrowsingDataHandler::RegisterMessages() {
  web_ui()->RegisterMessageCallback(
      "clearBrowsingData",
      base::BindRepeating(&ClearBrowsingDataHandler::HandleClearBrowsingData,
                          base::Unretained(this)));

  web_ui()->RegisterMessageCallback(
      "initializeClearBrowsingData",
      base::BindRepeating(&ClearBrowsingDataHandler::HandleInitialize,
                          base::Unretained(this)));
  web_ui()->RegisterMessageCallback(
      "getSyncState",
      base::BindRepeating(&ClearBrowsingDataHandler::HandleGetSyncState,
                          base::Unretained(this)));
  web_ui()->RegisterMessageCallback(
      "restartClearBrowsingDataCounters",
      base::BindRepeating(&ClearBrowsingDataHandler::HandleRestartCounters,
                          base::Unretained(this)));
}

void ClearBrowsingDataHandler::OnJavascriptAllowed() {
  if (sync_service_) {
    sync_service_observation_.Observe(sync_service_.get());
  }

  dse_service_observation_.Observe(
      TemplateURLServiceFactory::GetForProfile(profile_));

  DCHECK(counters_basic_.empty());
  DCHECK(counters_advanced_.empty());
  for (const std::string& pref : GetBasicCounterPrefs()) {
    AddCounter(BrowsingDataCounterFactory::GetForProfileAndPref(profile_, pref),
               browsing_data::ClearBrowsingDataTab::BASIC);
  }
  for (const std::string& pref : GetAdvancedCounterPrefs()) {
    AddCounter(BrowsingDataCounterFactory::GetForProfileAndPref(profile_, pref),
               browsing_data::ClearBrowsingDataTab::ADVANCED);
  }
}

void ClearBrowsingDataHandler::OnJavascriptDisallowed() {
  dse_service_observation_.Reset();
  sync_service_observation_.Reset();
  weak_ptr_factory_.InvalidateWeakPtrs();
  counters_basic_.clear();
  counters_advanced_.clear();
}

void ClearBrowsingDataHandler::HandleClearBrowsingDataForTest() {
  // HandleClearBrowsingData takes in a ListValue as its only parameter. The
  // ListValue must contain four values: web_ui callback ID, a list of data
  // types that the user cleared from the clear browsing data UI and time period
  // of the data to be cleared.

  base::Value::List data_types;
  data_types.Append("browser.clear_data.browsing_history");

  base::Value::List list_args;
  list_args.Append("webui_callback_id");
  list_args.Append(std::move(data_types));
  list_args.Append(1);
  HandleClearBrowsingData(list_args);
}

void ClearBrowsingDataHandler::HandleClearBrowsingData(
    const base::Value::List& args_list) {
  CHECK_EQ(3U, args_list.size());
  std::string webui_callback_id = args_list[0].GetString();

  PrefService* prefs = profile_->GetPrefs();
  uint64_t remove_mask = 0;
  uint64_t origin_mask = 0;
  std::vector<BrowsingDataType> data_type_vector;

  CHECK(args_list[1].is_list());
  const base::Value::List& data_type_list = args_list[1].GetList();
  auto* sentiment_service = TrustSafetySentimentServiceFactory::GetForProfile(
      Profile::FromWebUI(web_ui()));
  for (const base::Value& type : data_type_list) {
    const std::string pref_name = type.GetString();
    std::optional<BrowsingDataType> data_type =
        browsing_data::GetDataTypeFromDeletionPreference(pref_name);
    CHECK(data_type);
    data_type_vector.push_back(*data_type);

    switch (*data_type) {
      case BrowsingDataType::HISTORY:
        if (prefs->GetBoolean(prefs::kAllowDeletingBrowserHistory)) {
          remove_mask |= chrome_browsing_data_remover::DATA_TYPE_HISTORY;
        }
        break;
      case BrowsingDataType::DOWNLOADS:
        if (prefs->GetBoolean(prefs::kAllowDeletingBrowserHistory)) {
          remove_mask |= content::BrowsingDataRemover::DATA_TYPE_DOWNLOADS;
        }
        break;
      case BrowsingDataType::CACHE:
        remove_mask |= content::BrowsingDataRemover::DATA_TYPE_CACHE;
        break;
      case BrowsingDataType::SITE_DATA:
        remove_mask |= chrome_browsing_data_remover::DATA_TYPE_SITE_DATA;
        origin_mask |=
            content::BrowsingDataRemover::ORIGIN_TYPE_UNPROTECTED_WEB;
        break;
      case BrowsingDataType::PASSWORDS:
        remove_mask |= chrome_browsing_data_remover::DATA_TYPE_PASSWORDS;
        remove_mask |=
            chrome_browsing_data_remover::DATA_TYPE_ACCOUNT_PASSWORDS;
        break;
      case BrowsingDataType::FORM_DATA:
        remove_mask |= chrome_browsing_data_remover::DATA_TYPE_FORM_DATA;
        break;
      case BrowsingDataType::SITE_SETTINGS:
        remove_mask |= chrome_browsing_data_remover::DATA_TYPE_CONTENT_SETTINGS;
        break;
      case BrowsingDataType::HOSTED_APPS_DATA:
        remove_mask |= chrome_browsing_data_remover::DATA_TYPE_SITE_DATA;
        origin_mask |= content::BrowsingDataRemover::ORIGIN_TYPE_PROTECTED_WEB;
        break;
      case BrowsingDataType::TABS:
        // Tab closure is not implemented yet.
        NOTIMPLEMENTED();
        break;
    }

    // Inform the T&S sentiment service that this datatype was cleared.
    if (sentiment_service) {
      sentiment_service->ClearedBrowsingData(*data_type);
    }
  }

  base::flat_set<BrowsingDataType> data_types(std::move(data_type_vector));

  // Record the deletion of cookies and cache.
  browsing_data::CookieOrCacheDeletionChoice choice =
      browsing_data::CookieOrCacheDeletionChoice::kNeitherCookiesNorCache;
  if (data_types.find(BrowsingDataType::SITE_DATA) != data_types.end()) {
    choice =
        data_types.find(BrowsingDataType::CACHE) != data_types.end()
            ? browsing_data::CookieOrCacheDeletionChoice::kBothCookiesAndCache
            : browsing_data::CookieOrCacheDeletionChoice::kOnlyCookies;
  } else if (data_types.find(BrowsingDataType::CACHE) != data_types.end()) {
    choice = browsing_data::CookieOrCacheDeletionChoice::kOnlyCache;
  }

  UMA_HISTOGRAM_ENUMERATION(
      "History.ClearBrowsingData.UserDeletedCookieOrCacheFromDialog", choice);

  browsing_data::RecordDeleteBrowsingDataAction(
      browsing_data::DeleteBrowsingDataAction::kClearBrowsingDataDialog);

  int period_selected = args_list[2].GetInt();

  content::BrowsingDataRemover* remover = profile_->GetBrowsingDataRemover();

  base::OnceCallback<void(uint64_t)> callback = base::BindOnce(
      &ClearBrowsingDataHandler::OnClearingTaskFinished,
      weak_ptr_factory_.GetWeakPtr(), webui_callback_id, std::move(data_types));
  browsing_data::TimePeriod time_period =
      static_cast<browsing_data::TimePeriod>(period_selected);

  browsing_data_important_sites_util::Remove(
      remove_mask, origin_mask, time_period,
      content::BrowsingDataFilterBuilder::Create(
          content::BrowsingDataFilterBuilder::Mode::kPreserve),
      remover, std::move(callback));
}

void ClearBrowsingDataHandler::OnClearingTaskFinished(
    const std::string& webui_callback_id,
    const base::flat_set<BrowsingDataType>& data_types,
    uint64_t failed_data_types) {
  PrefService* prefs = profile_->GetPrefs();
  int history_notice_shown_times = prefs->GetInteger(
      browsing_data::prefs::kClearBrowsingDataHistoryNoticeShownTimes);

  // When the deletion is complete, we might show an additional dialog with
  // a notice about other forms of browsing history. This is the case if
  const bool show_history_notice =
      // 1. The dialog is relevant for the user.
      show_history_deletion_dialog_ &&
      // 2. The notice has been shown less than |kMaxTimesHistoryNoticeShown|.
      history_notice_shown_times < kMaxTimesHistoryNoticeShown &&
      // 3. The selected data types contained browsing history.
      data_types.find(BrowsingDataType::HISTORY) != data_types.end();

  if (show_history_notice) {
    // Increment the preference.
    prefs->SetInteger(
        browsing_data::prefs::kClearBrowsingDataHistoryNoticeShownTimes,
        history_notice_shown_times + 1);
  }

  bool show_passwords_notice =
      (failed_data_types & chrome_browsing_data_remover::DATA_TYPE_PASSWORDS);

  base::Value::Dict result;
  result.Set("showHistoryNotice", show_history_notice);
  result.Set("showPasswordsNotice", show_passwords_notice);

  if (toast_features::IsEnabled(toast_features::kClearBrowsingDataToast)) {
    tabs::TabInterface* tab =
        tabs::TabInterface::MaybeGetFromContents(web_ui()->GetWebContents());
    if (tab && tab->IsActivated()) {
      CHECK(tab->GetBrowserWindowInterface());
      ToastController* const toast_controller =
          tab->GetBrowserWindowInterface()->GetFeatures().toast_controller();
      if (toast_controller) {
        toast_controller->MaybeShowToast(
            ToastParams(ToastId::kClearBrowsingData));
      }
    }
  }

  ResolveJavascriptCallback(base::Value(webui_callback_id), result);
}

void ClearBrowsingDataHandler::HandleInitialize(const base::Value::List& args) {
  AllowJavascript();
  const base::Value& callback_id = args[0];

  // Needed because WebUI doesn't handle renderer crashes. See crbug.com/610450.
  weak_ptr_factory_.InvalidateWeakPtrs();

  UpdateSyncState();
  RefreshHistoryNotice();

  // Restart the counters each time the dialog is reopened.
  //
  // TODO(crbug.com/331925113): Since each Clear Browsing Data dialog execution
  // commits the time selection to prefs, we may read it back from there.
  // However, it would be safer if the "initializeClearBrowsingData" delivered
  // the actual initial selection from the UI.
  PrefService* prefs = profile_->GetPrefs();
  auto initial_period_basic = static_cast<browsing_data::TimePeriod>(
      prefs->GetInteger(browsing_data::prefs::kDeleteTimePeriodBasic));
  auto initial_period_advanced = static_cast<browsing_data::TimePeriod>(
      prefs->GetInteger(browsing_data::prefs::kDeleteTimePeriod));
  RestartCounters(true /* basic */, initial_period_basic);
  RestartCounters(false /* basic */, initial_period_advanced);

  ResolveJavascriptCallback(callback_id, base::Value() /* Promise<void> */);
}

void ClearBrowsingDataHandler::HandleGetSyncState(
    const base::Value::List& args) {
  AllowJavascript();
  const base::Value& callback_id = args[0];
  ResolveJavascriptCallback(callback_id, CreateSyncStateEvent());
}

void ClearBrowsingDataHandler::HandleRestartCounters(
    const base::Value::List& args) {
  AllowJavascript();
  CHECK_EQ(2U, args.size());
  RestartCounters(args[0].GetBool() /* basic */,
                  static_cast<browsing_data::TimePeriod>(args[1].GetInt()));
}

void ClearBrowsingDataHandler::OnStateChanged(syncer::SyncService* sync) {
  UpdateSyncState();
}

void ClearBrowsingDataHandler::UpdateSyncState() {
  FireWebUIListener("update-sync-state", CreateSyncStateEvent());
}

base::Value::Dict ClearBrowsingDataHandler::CreateSyncStateEvent() {
  signin::IdentityManager* identity_manager =
      IdentityManagerFactory::GetForProfile(profile_);
  base::Value::Dict event;
  event.Set("signedIn", identity_manager && identity_manager->HasPrimaryAccount(
                                                signin::ConsentLevel::kSignin));
  event.Set("syncConsented",
            identity_manager && identity_manager->HasPrimaryAccount(
                                    signin::ConsentLevel::kSync));
  event.Set("syncingHistory", sync_service_ &&
                                  sync_service_->IsSyncFeatureActive() &&
                                  sync_service_->GetActiveDataTypes().Has(
                                      syncer::HISTORY_DELETE_DIRECTIVES));
  event.Set("shouldShowCookieException",
            browsing_data_counter_utils::ShouldShowCookieException(profile_));

  event.Set("isNonGoogleDse", false);
  const TemplateURLService* template_url_service =
      TemplateURLServiceFactory::GetForProfile(profile_);
  const TemplateURL* dse = template_url_service->GetDefaultSearchProvider();
  if (dse && dse->GetEngineType(template_url_service->search_terms_data()) !=
                 SearchEngineType::SEARCH_ENGINE_GOOGLE) {
    // Non-Google DSE. Prepopulated DSEs have an ID > 0.
    event.Set("isNonGoogleDse", true);
    event.Set(
        "nonGoogleSearchHistoryString",
        (dse->prepopulate_id() > 0)
            ? l10n_util::GetStringFUTF16(
                  IDS_SETTINGS_CLEAR_NON_GOOGLE_SEARCH_HISTORY_PREPOPULATED_DSE,
                  dse->short_name())
            : l10n_util::GetStringUTF16(
                  IDS_SETTINGS_CLEAR_NON_GOOGLE_SEARCH_HISTORY_NON_PREPOPULATED_DSE));
  }
  return event;
}

void ClearBrowsingDataHandler::RefreshHistoryNotice() {
  // If the dialog with history notice has been shown less than
  // |kMaxTimesHistoryNoticeShown| times, we might have to show it when the
  // user deletes history. Find out if the conditions are met.
  int notice_shown_times = profile_->GetPrefs()->GetInteger(
      browsing_data::prefs::kClearBrowsingDataHistoryNoticeShownTimes);

  if (notice_shown_times < kMaxTimesHistoryNoticeShown) {
    browsing_data::ShouldPopupDialogAboutOtherFormsOfBrowsingHistory(
        sync_service_, WebHistoryServiceFactory::GetForProfile(profile_),
        chrome::GetChannel(),
        base::BindOnce(&ClearBrowsingDataHandler::UpdateHistoryDeletionDialog,
                       weak_ptr_factory_.GetWeakPtr()));
  }
}

void ClearBrowsingDataHandler::UpdateHistoryDeletionDialog(bool show) {
  // This is used by OnClearingTaskFinished (when the deletion finishes).
  show_history_deletion_dialog_ = show;
}

void ClearBrowsingDataHandler::AddCounter(
    std::unique_ptr<browsing_data::BrowsingDataCounter> counter,
    browsing_data::ClearBrowsingDataTab tab) {
  DCHECK(counter);
  counter->InitWithoutPeriodPref(
      profile_->GetPrefs(), tab, base::Time(),
      base::BindRepeating(&ClearBrowsingDataHandler::UpdateCounterText,
                          base::Unretained(this)));

  ((tab == browsing_data::ClearBrowsingDataTab::BASIC) ? counters_basic_
                                                       : counters_advanced_)
      .push_back(std::move(counter));
}

void ClearBrowsingDataHandler::UpdateCounterText(
    std::unique_ptr<browsing_data::BrowsingDataCounter::Result> result) {
  FireWebUIListener(
      "browsing-data-counter-text-update",
      base::Value(result->source()->GetPrefName()),
      base::Value(browsing_data_counter_utils::GetChromeCounterTextFromResult(
          result.get(), profile_)));
}

void ClearBrowsingDataHandler::RestartCounters(
    bool basic,
    browsing_data::TimePeriod time_period) {
  // Updating the begin time of a counter automatically forces a restart.
  for (const auto& counter : (basic ? counters_basic_ : counters_advanced_)) {
    counter->SetBeginTime(browsing_data::CalculateBeginDeleteTime(time_period));
  }
}

void ClearBrowsingDataHandler::HandleTimePeriodChanged(
    const std::string& pref_name) {
  PrefService* prefs = profile_->GetPrefs();
  int period = prefs->GetInteger(pref_name);

  browsing_data::TimePeriod time_period =
      static_cast<browsing_data::TimePeriod>(period);
  browsing_data::RecordTimePeriodChange(time_period);
}

void ClearBrowsingDataHandler::OnTemplateURLServiceChanged() {
  UpdateSyncState();
}

}  // namespace settings