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 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
|
// 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.
#include "components/translate/core/browser/translate_prefs.h"
#include <algorithm>
#include <limits>
#include <map>
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "base/containers/contains.h"
#include "base/feature_list.h"
#include "base/i18n/rtl.h"
#include "base/json/values_util.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/values.h"
#include "build/build_config.h"
#include "components/language/core/browser/accept_languages_service.h"
#include "components/language/core/browser/language_prefs.h"
#include "components/language/core/browser/pref_names.h"
#include "components/language/core/common/language_experiments.h"
#include "components/language/core/common/language_util.h"
#include "components/language/core/common/locale_util.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/strings/grit/components_locale_settings.h"
#include "components/translate/core/browser/translate_download_manager.h"
#include "components/translate/core/browser/translate_pref_names.h"
#include "ui/base/l10n/l10n_util.h"
#include "ui/base/l10n/l10n_util_collator.h"
namespace translate {
namespace {
const int kForceTriggerBackoffThreshold = 4;
// Returns whether or not the given list includes at least one language with
// the same base as the input language.
// For example: "en-US" and "en-UK" share the same base "en".
bool ContainsSameBaseLanguage(const std::vector<std::string>& list,
std::string_view language_code) {
std::string_view base_language = language::ExtractBaseLanguage(language_code);
for (const auto& item : list) {
if (base_language == language::ExtractBaseLanguage(item))
return true;
}
return false;
}
// Merge old always-translate languages from the deprecated pref to the new
// version. Because of crbug/1291356, it's possible that on iOS the client
// started using the new pref without properly migrating and clearing the old
// pref. This function will avoid merging values from the old pref that seem to
// conflict with values already present in the new pref.
void MigrateObsoleteAlwaysTranslateLanguagesPref(PrefService* prefs) {
const base::Value::Dict& deprecated_dictionary =
prefs->GetDict(TranslatePrefs::kPrefAlwaysTranslateListDeprecated);
// Migration is performed only once per client, since the deprecated pref is
// cleared after migration. This will make subsequent calls to migrate no-ops.
if (deprecated_dictionary.empty())
return;
ScopedDictPrefUpdate always_translate_dictionary_update(
prefs, prefs::kPrefAlwaysTranslateList);
base::Value::Dict& always_translate_dictionary =
always_translate_dictionary_update.Get();
for (const auto old_language_pair : deprecated_dictionary) {
// If the old pref's language pair conflicts with any of the new pref's
// language pairs, where either the new pref already specifies behavior
// about always translating from or to the old source language, or always
// translating from the old target language, then skip merging this pair
// into the new pref.
if (std::ranges::any_of(
always_translate_dictionary,
[&old_language_pair](const auto& new_language_pair) {
return old_language_pair.first == new_language_pair.first ||
old_language_pair.first ==
new_language_pair.second.GetString() ||
old_language_pair.second.GetString() ==
new_language_pair.first;
})) {
continue;
}
// If the old pair's source language matches any of the never-translate
// languages, it probably means that this source language was set to never
// be translated after the old pref was deprecated, so avoid this conflict.
if (base::Contains(prefs->GetList(prefs::kBlockedLanguages),
old_language_pair.first)) {
continue;
}
always_translate_dictionary.Set(old_language_pair.first,
old_language_pair.second.GetString());
}
prefs->ClearPref(TranslatePrefs::kPrefAlwaysTranslateListDeprecated);
}
bool IsTranslateLanguage(std::string_view language) {
// Check if |language| is translatable.
TranslateLanguageList* language_list =
TranslateDownloadManager::GetInstance()->language_list();
return language_list && language_list->IsSupportedLanguage(language);
}
} // namespace
// The below properties used to be used but now are deprecated. Don't use them
// since an old profile might have some values there.
//
// * translate_last_denied_time
// * translate_too_often_denied
// * translate_language_blacklist
BASE_FEATURE(kTranslateRecentTarget,
"TranslateRecentTarget",
base::FEATURE_ENABLED_BY_DEFAULT);
BASE_FEATURE(kMigrateAlwaysTranslateLanguagesFix,
"MigrateAlwaysTranslateLanguagesFix",
base::FEATURE_ENABLED_BY_DEFAULT);
TranslateLanguageInfo::TranslateLanguageInfo() = default;
TranslateLanguageInfo::TranslateLanguageInfo(const TranslateLanguageInfo&) =
default;
TranslateLanguageInfo::TranslateLanguageInfo(TranslateLanguageInfo&&) noexcept =
default;
TranslateLanguageInfo& TranslateLanguageInfo::operator=(
const TranslateLanguageInfo&) = default;
TranslateLanguageInfo& TranslateLanguageInfo::operator=(
TranslateLanguageInfo&&) noexcept = default;
TranslatePrefs::TranslatePrefs(PrefService* user_prefs)
: prefs_(user_prefs),
language_prefs_(std::make_unique<language::LanguagePrefs>(user_prefs)) {
MigrateNeverPromptSites();
ResetEmptyBlockedLanguagesToDefaults();
if (base::FeatureList::IsEnabled(kMigrateAlwaysTranslateLanguagesFix))
MigrateObsoleteAlwaysTranslateLanguagesPref(user_prefs);
}
TranslatePrefs::~TranslatePrefs() = default;
// static
std::string TranslatePrefs::MapPreferenceName(const std::string& pref_name) {
if (pref_name == kPrefNeverPromptSitesDeprecated) {
return "translate_site_blocklist";
}
return pref_name;
}
bool TranslatePrefs::IsOfferTranslateEnabled() const {
return prefs_->GetBoolean(prefs::kOfferTranslateEnabled);
}
bool TranslatePrefs::IsTranslateAllowedByPolicy() const {
const PrefService::Preference* const pref =
prefs_->FindPreference(prefs::kOfferTranslateEnabled);
DCHECK(pref);
DCHECK(pref->GetValue()->is_bool());
return pref->GetValue()->GetBool() || !pref->IsManaged();
}
void TranslatePrefs::SetCountry(const std::string& country) {
country_ = country;
}
std::string TranslatePrefs::GetCountry() const {
return country_;
}
void TranslatePrefs::ResetToDefaults() {
ResetBlockedLanguagesToDefault();
ClearNeverPromptSiteList();
ClearAlwaysTranslateLanguagePairs();
prefs_->ClearPref(kPrefTranslateDeniedCount);
prefs_->ClearPref(kPrefTranslateIgnoredCount);
prefs_->ClearPref(kPrefTranslateAcceptedCount);
prefs_->ClearPref(prefs::kPrefTranslateRecentTarget);
force_translate_on_english_for_testing_ = false;
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
prefs_->ClearPref(kPrefTranslateAutoAlwaysCount);
prefs_->ClearPref(kPrefTranslateAutoNeverCount);
#endif
prefs_->ClearPref(prefs::kOfferTranslateEnabled);
}
// static
base::Value::List TranslatePrefs::GetDefaultBlockedLanguages() {
base::Value::List languages;
#if BUILDFLAG(IS_CHROMEOS)
// Preferred languages.
std::string language = language::kFallbackInputMethodLocale;
language::ToTranslateLanguageSynonym(&language);
languages.Append(std::move(language));
#else
// Accept languages.
#pragma GCC diagnostic push
// See comment above the |break;| in the loop just below for why.
#pragma GCC diagnostic ignored "-Wunreachable-code"
for (std::string& language :
base::SplitString(l10n_util::GetStringUTF8(IDS_ACCEPT_LANGUAGES), ",",
base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL)) {
language::ToTranslateLanguageSynonym(&language);
languages.Append(std::move(language));
// crbug.com/958348: The default value for Accept-Language *should* be the
// same as the one for Blocked Languages. However, Accept-Language contains
// English (and more) in addition to the local language in most locales due
// to historical reasons. Exiting early from this loop is a temporary fix
// that allows Blocked Languages to be at least populated with the UI
// language while still allowing Translate to trigger on other languages,
// most importantly English.
// Once the change to remove English from Accept-Language defaults lands,
// this break should be removed to enable the Blocked Language List and the
// Accept-Language list to be initialized to the same values.
break;
#pragma GCC diagnostic pop
}
#endif
std::sort(languages.begin(), languages.end());
languages.erase(std::unique(languages.begin(), languages.end()),
languages.end());
return languages;
}
bool TranslatePrefs::IsBlockedLanguage(std::string_view input_language) const {
std::string canonical_lang(input_language);
language::ToTranslateLanguageSynonym(&canonical_lang);
const base::Value::List& blocked =
prefs_->GetList(translate::prefs::kBlockedLanguages);
return base::Contains(blocked, base::Value(std::move(canonical_lang)));
}
void TranslatePrefs::BlockLanguage(std::string_view input_language) {
DCHECK(!input_language.empty());
// Get the translate version of the string to add to the blocked list.
std::string translate_lang(input_language);
language::ToTranslateLanguageSynonym(&translate_lang);
// Get the Chrome version of the base language.
std::string chrome_lang(l10n_util::GetLanguage(input_language));
language::ToChromeLanguageSynonym(&chrome_lang);
// If neither the translate or Chrome language is a possible accept
// language skip adding to blocked language list.
if (!l10n_util::IsPossibleAcceptLanguage(translate_lang) &&
!l10n_util::IsPossibleAcceptLanguage(chrome_lang)) {
return;
}
if (!IsBlockedLanguage(translate_lang)) {
ScopedListPrefUpdate update(prefs_, translate::prefs::kBlockedLanguages);
update->Append(std::move(translate_lang));
}
// Remove the blocked language from the always translate list if present.
RemoveLanguagePairFromAlwaysTranslateList(input_language);
}
void TranslatePrefs::UnblockLanguage(std::string_view input_language) {
DCHECK(!input_language.empty());
// Never remove last fluent language.
if (GetNeverTranslateLanguages().size() <= 1) {
return;
}
std::string canonical_lang(input_language);
language::ToTranslateLanguageSynonym(&canonical_lang);
ScopedListPrefUpdate update(prefs_, translate::prefs::kBlockedLanguages);
update->EraseValue(base::Value(std::move(canonical_lang)));
}
void TranslatePrefs::ResetEmptyBlockedLanguagesToDefaults() {
if (GetNeverTranslateLanguages().size() == 0) {
ResetBlockedLanguagesToDefault();
}
}
void TranslatePrefs::ResetBlockedLanguagesToDefault() {
prefs_->ClearPref(translate::prefs::kBlockedLanguages);
}
std::vector<std::string> TranslatePrefs::GetNeverTranslateLanguages() const {
const base::Value::List& fluent_languages_value =
prefs_->GetList(translate::prefs::kBlockedLanguages);
std::vector<std::string> languages;
for (const auto& language : fluent_languages_value) {
const std::string* language_as_string = language.GetIfString();
// This needs to be checked here as there can be corrupt entries in the pref
// list which causes a crash.
if (!language_as_string) {
continue;
}
std::string chrome_language{*language_as_string};
language::ToChromeLanguageSynonym(&chrome_language);
languages.push_back(chrome_language);
}
return languages;
}
// Note: the language codes used in the language settings list have the Chrome
// internal format and not the Translate server format.
// To convert from one to the other use util functions
// ToTranslateLanguageSynonym() and ToChromeLanguageSynonym().
void TranslatePrefs::AddToLanguageList(std::string_view input_language,
const bool force_blocked) {
DCHECK(!input_language.empty());
std::string chrome_language(input_language);
language::ToChromeLanguageSynonym(&chrome_language);
std::vector<std::string> languages;
std::vector<std::string> user_selected_languages;
GetLanguageList(&languages);
GetUserSelectedLanguageList(&user_selected_languages);
// We should block the language if the list does not already contain another
// language with the same base language. Policy-forced languages aren't
// counted as "blocking", so only user-selected languages are checked.
const bool should_block =
!ContainsSameBaseLanguage(user_selected_languages, chrome_language);
if (force_blocked || should_block) {
BlockLanguage(input_language);
}
// Add the language to the list.
if (!base::Contains(languages, chrome_language)) {
user_selected_languages.push_back(chrome_language);
language_prefs_->SetUserSelectedLanguagesList(user_selected_languages);
}
}
void TranslatePrefs::RemoveFromLanguageList(std::string_view input_language) {
DCHECK(!input_language.empty());
std::string chrome_language(input_language);
language::ToChromeLanguageSynonym(&chrome_language);
std::vector<std::string> languages;
std::vector<std::string> user_selected_languages;
GetUserSelectedLanguageList(&user_selected_languages);
// Remove the language from the list.
const auto& it = std::ranges::find(user_selected_languages, chrome_language);
if (it != user_selected_languages.end()) {
user_selected_languages.erase(it);
language_prefs_->SetUserSelectedLanguagesList(user_selected_languages);
// We should unblock the language if this was the last one from the same
// language family.
GetLanguageList(&languages);
if (!ContainsSameBaseLanguage(languages, chrome_language)) {
UnblockLanguage(input_language);
// If the recent translate target matches the last language of a family
// being removed, reset the most recent target language so it will not be
// used the next time Translate is triggered.
std::string translate_language(input_language);
language::ToTranslateLanguageSynonym(&translate_language);
if (translate_language == GetRecentTargetLanguage()) {
ResetRecentTargetLanguage();
}
}
}
}
void TranslatePrefs::RearrangeLanguage(
std::string_view language,
const TranslatePrefs::RearrangeSpecifier where,
int offset,
const std::vector<std::string>& enabled_languages) {
// Negative offset is not supported.
DCHECK(!(offset < 1 && (where == kUp || where == kDown)));
std::vector<std::string> languages;
GetUserSelectedLanguageList(&languages);
auto pos = std::ranges::find(languages, language);
if (pos == languages.end())
return;
// Sort the vector of enabled languages for fast lookup.
std::vector<std::string_view> enabled(enabled_languages.begin(),
enabled_languages.end());
std::sort(enabled.begin(), enabled.end());
if (!std::binary_search(enabled.begin(), enabled.end(), language))
return;
switch (where) {
case kTop:
// To avoid code duplication, set |offset| to max int and re-use the logic
// to move |language| up in the list as far as possible.
offset = std::numeric_limits<int>::max();
[[fallthrough]];
case kUp:
if (pos == languages.begin())
return;
while (pos != languages.begin()) {
auto next_pos = pos - 1;
// Skip over non-enabled languages without decrementing |offset|.
// Also skip over languages hidden due to duplication between forced
// and user-selected languages.
if (std::binary_search(enabled.begin(), enabled.end(), *next_pos) &&
!language_prefs_->IsForcedLanguage(*next_pos)) {
// By only checking |offset| when an enabled, non-forced language is
// found, and decrementing |offset| after checking it (instead of
// before), this means that |language| will be moved up the list until
// it has either reached the next enabled language or the top of the
// list.
if (offset <= 0)
break;
--offset;
}
std::swap(*next_pos, *pos);
pos = next_pos;
}
break;
case kDown:
if (pos + 1 == languages.end())
return;
for (auto next_pos = pos + 1; next_pos != languages.end() && offset > 0;
pos = next_pos++) {
// Skip over non-enabled or forced languages without decrementing
// offset. Unlike moving languages up in the list, moving languages down
// in the list stops as soon as |offset| reaches zero, instead of
// continuing to skip non-enabled languages after |offset| has reached
// zero.
if (std::binary_search(enabled.begin(), enabled.end(), *next_pos) &&
!language_prefs_->IsForcedLanguage(*next_pos))
--offset;
std::swap(*next_pos, *pos);
}
break;
case kNone:
return;
default:
NOTREACHED();
}
language_prefs_->SetUserSelectedLanguagesList(languages);
}
void TranslatePrefs::SetLanguageOrder(
const std::vector<std::string>& new_order) {
language_prefs_->SetUserSelectedLanguagesList(new_order);
}
// static
void TranslatePrefs::GetLanguageInfoList(
const std::string& app_locale,
bool translate_allowed,
std::vector<TranslateLanguageInfo>* language_list) {
DCHECK(language_list != nullptr);
if (app_locale.empty()) {
return;
}
language_list->clear();
// Collect the language codes from the supported accept-languages.
std::vector<std::string> language_codes;
l10n_util::GetAcceptLanguagesForLocale(app_locale, &language_codes);
// Collator used to sort display names in the given locale.
UErrorCode error = U_ZERO_ERROR;
std::unique_ptr<icu::Collator> collator(
icu::Collator::createInstance(icu::Locale(app_locale.c_str()), error));
if (U_FAILURE(error)) {
collator.reset();
}
// Map of [display name -> language code].
std::map<std::u16string, std::string,
l10n_util::StringComparator<std::u16string>>
language_map(l10n_util::StringComparator<std::u16string>(collator.get()));
// Build the list of display names and the language map.
for (std::string& code : language_codes) {
language_map[l10n_util::GetDisplayNameForLocale(code, app_locale, false)] =
std::move(code);
}
if (translate_allowed) {
translate::TranslateDownloadManager::RequestLanguageList();
}
// Build the language list from the language map.
for (auto& entry : language_map) {
TranslateLanguageInfo language;
language.code = std::move(entry.second);
std::u16string adjusted_display_name = entry.first;
base::i18n::AdjustStringForLocaleDirection(&adjusted_display_name);
language.display_name = base::UTF16ToUTF8(adjusted_display_name);
std::u16string adjusted_native_display_name =
l10n_util::GetDisplayNameForLocale(language.code, language.code, false);
base::i18n::AdjustStringForLocaleDirection(&adjusted_native_display_name);
language.native_display_name =
base::UTF16ToUTF8(adjusted_native_display_name);
// Extract the base language: if the base language can be translated, then
// even the regional one should be marked as such.
std::string translate_code = language.code;
language::ToTranslateLanguageSynonym(&translate_code);
language.supports_translate =
translate::TranslateDownloadManager::IsSupportedLanguage(
translate_code);
language_list->push_back(std::move(language));
}
}
void TranslatePrefs::GetTranslatableContentLanguages(
const std::string& app_locale,
std::vector<std::string>* codes) {
DCHECK(codes != nullptr);
if (app_locale.empty()) {
return;
}
codes->clear();
// Get the language codes of user content languages.
// Returned in Chrome format.
std::vector<std::string> language_codes;
GetLanguageList(&language_codes);
std::set<std::string> unique_languages;
for (auto& entry : language_codes) {
std::string supports_translate_code = entry;
// Get the language in Translate format.
language::ToTranslateLanguageSynonym(&supports_translate_code);
// Extract the language code, for example for en-US it returns en.
std::string lang_code =
TranslateDownloadManager::GetLanguageCode(supports_translate_code);
// If the language code for a translatable language hasn't yet been added,
// add it to the result list.
if (TranslateDownloadManager::IsSupportedLanguage(lang_code)) {
if (unique_languages.count(lang_code) == 0) {
unique_languages.insert(lang_code);
codes->push_back(lang_code);
}
}
}
}
bool TranslatePrefs::IsSiteOnNeverPromptList(std::string_view site) const {
return prefs_->GetDict(prefs::kPrefNeverPromptSitesWithTime).Find(site);
}
void TranslatePrefs::AddSiteToNeverPromptList(std::string_view site,
base::Time time) {
DCHECK(!site.empty());
AddValueToNeverPromptList(kPrefNeverPromptSitesDeprecated, site);
ScopedDictPrefUpdate update(prefs_, prefs::kPrefNeverPromptSitesWithTime);
update->Set(site, base::TimeToValue(time));
}
void TranslatePrefs::AddSiteToNeverPromptList(std::string_view site) {
AddSiteToNeverPromptList(site, base::Time::Now());
}
void TranslatePrefs::RemoveSiteFromNeverPromptList(std::string_view site) {
DCHECK(!site.empty());
RemoveValueFromNeverPromptList(kPrefNeverPromptSitesDeprecated, site);
ScopedDictPrefUpdate update(prefs_, prefs::kPrefNeverPromptSitesWithTime);
update->Remove(site);
}
std::vector<std::string> TranslatePrefs::GetNeverPromptSitesBetween(
base::Time begin,
base::Time end) const {
std::vector<std::string> result;
const auto& dict = prefs_->GetDict(prefs::kPrefNeverPromptSitesWithTime);
for (const auto entry : dict) {
std::optional<base::Time> time = base::ValueToTime(entry.second);
if (!time) {
// Badly formatted preferences may be synced from the server, see
// https://crbug.com/1295549
LOG(ERROR) << "Preference " << prefs::kPrefNeverPromptSitesWithTime
<< " has invalid format. Ignoring.";
continue;
}
if (begin <= *time && *time < end)
result.push_back(entry.first);
}
return result;
}
void TranslatePrefs::DeleteNeverPromptSitesBetween(base::Time begin,
base::Time end) {
for (auto& site : GetNeverPromptSitesBetween(begin, end))
RemoveSiteFromNeverPromptList(site);
}
bool TranslatePrefs::IsLanguagePairOnAlwaysTranslateList(
std::string_view source_language,
std::string_view target_language) {
const base::Value::Dict& dict =
prefs_->GetDict(prefs::kPrefAlwaysTranslateList);
const std::string* auto_target_lang = dict.FindString(source_language);
if (auto_target_lang && *auto_target_lang == target_language)
return true;
return false;
}
void TranslatePrefs::AddLanguagePairToAlwaysTranslateList(
std::string_view source_language,
std::string_view target_language) {
// Get translate version of language codes.
std::string translate_source_language(source_language);
language::ToTranslateLanguageSynonym(&translate_source_language);
std::string translate_target_language(target_language);
language::ToTranslateLanguageSynonym(&translate_target_language);
if (!IsTranslateLanguage(translate_source_language) ||
!IsTranslateLanguage(translate_target_language)) {
return;
}
ScopedDictPrefUpdate update(prefs_, prefs::kPrefAlwaysTranslateList);
update->Set(translate_source_language, translate_target_language);
// Remove source language from block list if present.
UnblockLanguage(translate_source_language);
}
void TranslatePrefs::RemoveLanguagePairFromAlwaysTranslateList(
std::string_view source_language) {
ScopedDictPrefUpdate update(prefs_, prefs::kPrefAlwaysTranslateList);
// Get translate version of language codes.
std::string translate_source_language(source_language);
language::ToTranslateLanguageSynonym(&translate_source_language);
update->Remove(translate_source_language);
}
std::vector<std::string> TranslatePrefs::GetAlwaysTranslateLanguages() const {
const base::Value::Dict& dict =
prefs_->GetDict(prefs::kPrefAlwaysTranslateList);
std::vector<std::string> languages;
for (auto language_pair : dict) {
std::string chrome_language(language_pair.first);
language::ToChromeLanguageSynonym(&chrome_language);
languages.push_back(chrome_language);
}
return languages;
}
void TranslatePrefs::ClearNeverPromptSiteList() {
prefs_->ClearPref(kPrefNeverPromptSitesDeprecated);
prefs_->ClearPref(prefs::kPrefNeverPromptSitesWithTime);
}
bool TranslatePrefs::HasLanguagePairsToAlwaysTranslate() const {
return !IsDictionaryEmpty(prefs::kPrefAlwaysTranslateList);
}
void TranslatePrefs::ClearAlwaysTranslateLanguagePairs() {
prefs_->ClearPref(prefs::kPrefAlwaysTranslateList);
}
int TranslatePrefs::GetTranslationDeniedCount(std::string_view language) const {
const base::Value::Dict& dict = prefs_->GetDict(kPrefTranslateDeniedCount);
return dict.FindInt(language).value_or(0);
}
void TranslatePrefs::IncrementTranslationDeniedCount(
std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateDeniedCount);
base::Value::Dict& dict = update.Get();
int count = dict.FindInt(language).value_or(0);
if (count < std::numeric_limits<int>::max())
dict.Set(language, count + 1);
}
void TranslatePrefs::ResetTranslationDeniedCount(std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateDeniedCount);
update->Set(language, 0);
}
int TranslatePrefs::GetTranslationIgnoredCount(
std::string_view language) const {
const base::Value::Dict& dict = prefs_->GetDict(kPrefTranslateIgnoredCount);
return dict.FindInt(language).value_or(0);
}
void TranslatePrefs::IncrementTranslationIgnoredCount(
std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateIgnoredCount);
base::Value::Dict& dict = update.Get();
int count = dict.FindInt(language).value_or(0);
if (count < std::numeric_limits<int>::max())
dict.Set(language, count + 1);
}
void TranslatePrefs::ResetTranslationIgnoredCount(std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateIgnoredCount);
update->Set(language, 0);
}
int TranslatePrefs::GetTranslationAcceptedCount(
std::string_view language) const {
const base::Value::Dict& dict = prefs_->GetDict(kPrefTranslateAcceptedCount);
return dict.FindInt(language).value_or(0);
}
void TranslatePrefs::IncrementTranslationAcceptedCount(
std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateAcceptedCount);
base::Value::Dict& dict = update.Get();
int count = dict.FindInt(language).value_or(0);
if (count < std::numeric_limits<int>::max())
dict.Set(language, count + 1);
}
void TranslatePrefs::ResetTranslationAcceptedCount(std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateAcceptedCount);
update->Set(language, 0);
}
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
int TranslatePrefs::GetTranslationAutoAlwaysCount(
std::string_view language) const {
const base::Value::Dict& dict =
prefs_->GetDict(kPrefTranslateAutoAlwaysCount);
return dict.FindInt(language).value_or(0);
}
void TranslatePrefs::IncrementTranslationAutoAlwaysCount(
std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateAutoAlwaysCount);
base::Value::Dict& dict = update.Get();
int count = dict.FindInt(language).value_or(0);
if (count < std::numeric_limits<int>::max())
dict.Set(language, count + 1);
}
void TranslatePrefs::ResetTranslationAutoAlwaysCount(
std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateAutoAlwaysCount);
update->Set(language, 0);
}
int TranslatePrefs::GetTranslationAutoNeverCount(
std::string_view language) const {
const base::Value::Dict& dict = prefs_->GetDict(kPrefTranslateAutoNeverCount);
return dict.FindInt(language).value_or(0);
}
void TranslatePrefs::IncrementTranslationAutoNeverCount(
std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateAutoNeverCount);
base::Value::Dict& dict = update.Get();
int count = dict.FindInt(language).value_or(0);
if (count < std::numeric_limits<int>::max())
dict.Set(language, count + 1);
}
void TranslatePrefs::ResetTranslationAutoNeverCount(std::string_view language) {
ScopedDictPrefUpdate update(prefs_, kPrefTranslateAutoNeverCount);
update->Set(language, 0);
}
#endif // BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
#if BUILDFLAG(IS_ANDROID)
bool TranslatePrefs::GetAppLanguagePromptShown() const {
return prefs_->GetBoolean(language::prefs::kAppLanguagePromptShown);
}
void TranslatePrefs::SetAppLanguagePromptShown() {
prefs_->SetBoolean(language::prefs::kAppLanguagePromptShown, true);
}
#endif // BUILDFLAG(IS_ANDROID)
void TranslatePrefs::GetLanguageList(
std::vector<std::string>* const languages) const {
language_prefs_->GetAcceptLanguagesList(languages);
}
void TranslatePrefs::GetUserSelectedLanguageList(
std::vector<std::string>* const languages) const {
language_prefs_->GetUserSelectedLanguagesList(languages);
}
bool TranslatePrefs::ShouldForceTriggerTranslateOnEnglishPages() {
if (!language::OverrideTranslateTriggerInIndia() &&
!force_translate_on_english_for_testing_) {
return false;
}
return GetForceTriggerOnEnglishPagesCount() < kForceTriggerBackoffThreshold;
}
bool TranslatePrefs::force_translate_on_english_for_testing_ = false;
// static
void TranslatePrefs::SetShouldForceTriggerTranslateOnEnglishPagesForTesting() {
force_translate_on_english_for_testing_ = true;
}
bool TranslatePrefs::CanTranslateLanguage(std::string_view language) {
// Under this experiment, translate English page even though English may be
// blocked.
if (language == "en" && ShouldForceTriggerTranslateOnEnglishPages()) {
return true;
}
return !IsBlockedLanguage(language);
}
bool TranslatePrefs::ShouldAutoTranslate(std::string_view source_language,
std::string* target_language) {
const base::Value::Dict& dict =
prefs_->GetDict(prefs::kPrefAlwaysTranslateList);
const std::string* value = dict.FindString(source_language);
if (!value)
return false;
DCHECK(!value->empty());
target_language->assign(*value);
return true;
}
void TranslatePrefs::SetRecentTargetLanguage(
const std::string& target_language) {
// Get translate version of language code.
std::string translate_target_language(target_language);
language::ToTranslateLanguageSynonym(&translate_target_language);
prefs_->SetString(prefs::kPrefTranslateRecentTarget,
translate_target_language);
}
void TranslatePrefs::ResetRecentTargetLanguage() {
SetRecentTargetLanguage("");
}
std::string TranslatePrefs::GetRecentTargetLanguage() const {
return prefs_->GetString(prefs::kPrefTranslateRecentTarget);
}
int TranslatePrefs::GetForceTriggerOnEnglishPagesCount() const {
return prefs_->GetInteger(kPrefForceTriggerTranslateCount);
}
void TranslatePrefs::ReportForceTriggerOnEnglishPages() {
int current_count = GetForceTriggerOnEnglishPagesCount();
if (current_count != -1 && current_count < std::numeric_limits<int>::max())
prefs_->SetInteger(kPrefForceTriggerTranslateCount, current_count + 1);
}
void TranslatePrefs::ReportAcceptedAfterForceTriggerOnEnglishPages() {
int current_count = GetForceTriggerOnEnglishPagesCount();
if (current_count != -1)
prefs_->SetInteger(kPrefForceTriggerTranslateCount, -1);
}
// static
void TranslatePrefs::RegisterProfilePrefs(
user_prefs::PrefRegistrySyncable* registry) {
registry->RegisterListPref(kPrefNeverPromptSitesDeprecated);
registry->RegisterDictionaryPref(
prefs::kPrefNeverPromptSitesWithTime,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterDictionaryPref(
prefs::kPrefAlwaysTranslateList,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterDictionaryPref(
kPrefTranslateDeniedCount,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterDictionaryPref(kPrefTranslateIgnoredCount);
registry->RegisterDictionaryPref(
kPrefTranslateAcceptedCount,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterStringPref(prefs::kPrefTranslateRecentTarget, "",
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterIntegerPref(
kPrefForceTriggerTranslateCount, 0,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterListPref(translate::prefs::kBlockedLanguages,
TranslatePrefs::GetDefaultBlockedLanguages(),
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_IOS)
registry->RegisterDictionaryPref(
kPrefTranslateAutoAlwaysCount,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
registry->RegisterDictionaryPref(
kPrefTranslateAutoNeverCount,
user_prefs::PrefRegistrySyncable::SYNCABLE_PREF);
#endif
RegisterProfilePrefsForMigration(registry);
}
// static
void TranslatePrefs::RegisterProfilePrefsForMigration(
user_prefs::PrefRegistrySyncable* registry) {
// TODO(crbug.com/40826252): Deprecated 10/2021. Check status of bug before
// removing.
registry->RegisterDictionaryPref(kPrefAlwaysTranslateListDeprecated);
}
void TranslatePrefs::MigrateNeverPromptSites() {
// Migration copies any sites on the deprecated never prompt pref to
// the new version and clears all references to the old one. This will
// make subsequent calls to migrate no-ops.
// Use of ScopedDictPrefUpdate is avoided since a call to its Get() ensures
// that the observers are notified upon destruction no matter if the value was
// changed or not.
base::Value::Dict never_prompt_list =
prefs_->GetDict(prefs::kPrefNeverPromptSitesWithTime).Clone();
ScopedListPrefUpdate deprecated_prompt_list_update(
prefs_, kPrefNeverPromptSitesDeprecated);
base::Value::List& deprecated_list = deprecated_prompt_list_update.Get();
for (auto& site : deprecated_list) {
if (site.is_string() &&
(!never_prompt_list.Find(site.GetString()) ||
!base::ValueToTime(never_prompt_list.Find(site.GetString())))) {
never_prompt_list.Set(site.GetString(),
base::TimeToValue(base::Time::Now()));
}
}
deprecated_list.clear();
prefs_->SetDict(prefs::kPrefNeverPromptSitesWithTime,
std::move(never_prompt_list));
}
bool TranslatePrefs::IsValueOnNeverPromptList(const char* pref_id,
std::string_view value) const {
const base::Value::List& never_prompt_list = prefs_->GetList(pref_id);
for (const base::Value& value_in_list : never_prompt_list) {
if (value_in_list.is_string() && value_in_list.GetString() == value)
return true;
}
return false;
}
void TranslatePrefs::AddValueToNeverPromptList(const char* pref_id,
std::string_view value) {
ScopedListPrefUpdate update(prefs_, pref_id);
base::Value::List& never_prompt_list = update.Get();
if (IsValueOnNeverPromptList(pref_id, value)) {
return;
}
never_prompt_list.Append(value);
}
void TranslatePrefs::RemoveValueFromNeverPromptList(const char* pref_id,
std::string_view value) {
ScopedListPrefUpdate update(prefs_, pref_id);
base::Value::List& never_prompt_list = update.Get();
auto value_to_erase = std::ranges::find_if(
never_prompt_list, [value](const base::Value& value_in_list) {
return value_in_list.is_string() && value_in_list.GetString() == value;
});
if (value_to_erase != never_prompt_list.end())
never_prompt_list.erase(value_to_erase);
}
size_t TranslatePrefs::GetListSize(const char* pref_id) const {
const base::Value::List& never_prompt_list = prefs_->GetList(pref_id);
return never_prompt_list.size();
}
bool TranslatePrefs::IsDictionaryEmpty(const char* pref_id) const {
const base::Value::Dict& dict = prefs_->GetDict(pref_id);
return (dict.empty());
}
} // namespace translate
|