blob: 5df319792a7a817a8d0a1a6499e261033a1a72a2 [file] [log] [blame]
// Copyright 2012 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/sync/sync_ui_util.h"
#include <utility>
#include "base/feature_list.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/signin/chrome_signin_client_factory.h"
#include "chrome/browser/signin/identity_manager_factory.h"
#include "chrome/browser/signin/signin_util.h"
#include "chrome/browser/sync/sync_service_factory.h"
#include "chrome/grit/branded_strings.h"
#include "chrome/grit/generated_resources.h"
#include "components/password_manager/core/browser/features/password_manager_features_util.h"
#include "components/prefs/pref_service.h"
#include "components/signin/public/base/signin_switches.h"
#include "components/signin/public/identity_manager/account_info.h"
#include "components/signin/public/identity_manager/identity_manager.h"
#include "components/strings/grit/components_strings.h"
#include "components/sync/base/features.h"
#include "components/sync/service/sync_service.h"
#include "components/sync/service/sync_user_settings.h"
#include "google_apis/gaia/gaia_urls.h"
#include "google_apis/gaia/google_service_auth_error.h"
#include "net/base/url_util.h"
#include "ui/base/l10n/l10n_util.h"
#if BUILDFLAG(IS_CHROMEOS)
#include "ash/constants/ash_features.h"
#endif
#if !BUILDFLAG(IS_ANDROID)
#include "chrome/browser/search_engines/ui_thread_search_terms_data.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/browser_navigator.h"
#include "chrome/browser/ui/singleton_tabs.h"
#endif
namespace {
SyncStatusLabels GetStatusForUnrecoverableError(
bool is_user_clear_primary_account_allowed) {
#if !BUILDFLAG(IS_CHROMEOS)
int status_label_string_id =
is_user_clear_primary_account_allowed
? IDS_SYNC_STATUS_UNRECOVERABLE_ERROR
:
// The message for managed accounts is the same as that on ChromeOS.
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR_NEEDS_SIGNOUT;
#else
int status_label_string_id =
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR_NEEDS_SIGNOUT;
#endif
return {SyncStatusMessageType::kSyncError, status_label_string_id,
IDS_SYNC_RELOGIN_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kReauthenticate};
}
SyncStatusLabels GetSyncStatusLabelsImpl(
const syncer::SyncService* service,
bool is_user_clear_primary_account_allowed,
const GoogleServiceAuthError& auth_error) {
DCHECK(service);
DCHECK(!auth_error.IsTransientError());
if (!service->HasSyncConsent()) {
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
// If local Sync were enabled, then the SyncService shouldn't report having a
// primary (or any) account.
DCHECK(!service->IsLocalSyncEnabled());
// First check if Chrome needs to be updated.
if (service->RequiresClientUpgrade()) {
return {SyncStatusMessageType::kSyncError, IDS_SYNC_UPGRADE_CLIENT,
IDS_SYNC_UPGRADE_CLIENT_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kUpgradeClient};
}
// Then check for an unrecoverable error.
if (service->HasUnrecoverableError()) {
return GetStatusForUnrecoverableError(
is_user_clear_primary_account_allowed);
}
// Then check for an auth error.
if (auth_error.state() != GoogleServiceAuthError::NONE) {
DCHECK(auth_error.IsPersistentError());
return {SyncStatusMessageType::kSyncError, IDS_SYNC_RELOGIN_ERROR,
IDS_SYNC_RELOGIN_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kReauthenticate};
}
// Check if Sync is disabled by policy.
if (service->HasDisableReason(
syncer::SyncService::DISABLE_REASON_ENTERPRISE_POLICY)) {
// TODO(crbug.com/41429548): Is SyncStatusMessageType::kSynced correct for
// this case?
return {SyncStatusMessageType::kSynced,
IDS_SIGNED_IN_WITH_SYNC_DISABLED_BY_POLICY, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, SyncStatusActionType::kNoAction};
}
// Check to see if sync has been disabled via the dashboard and needs to be
// set up once again.
#if BUILDFLAG(IS_CHROMEOS)
if (service->GetUserSettings()->IsSyncFeatureDisabledViaDashboard()) {
return {SyncStatusMessageType::kSyncError,
IDS_SIGNED_IN_WITH_SYNC_STOPPED_VIA_DASHBOARD,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
#endif // BUILDFLAG(IS_CHROMEOS)
if (service->GetUserSettings()->IsInitialSyncFeatureSetupComplete()) {
// Check for a passphrase error.
if (service->GetUserSettings()
->IsPassphraseRequiredForPreferredDataTypes()) {
// TODO(mastiz): This should return
// SyncStatusMessageType::kPasswordsOnlySyncError if only passwords are
// encrypted as per IsEncryptEverythingEnabled().
return {SyncStatusMessageType::kSyncError, IDS_SYNC_STATUS_NEEDS_PASSWORD,
IDS_SYNC_STATUS_NEEDS_PASSWORD_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kEnterPassphrase};
}
if (service->IsSyncFeatureActive() &&
service->GetUserSettings()
->IsTrustedVaultKeyRequiredForPreferredDataTypes()) {
return {service->GetUserSettings()->IsEncryptEverythingEnabled()
? SyncStatusMessageType::kSyncError
: SyncStatusMessageType::kPasswordsOnlySyncError,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_STATUS_NEEDS_KEYS_BUTTON,
IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kRetrieveTrustedVaultKeys};
}
// At this point, there is no Sync error.
if (service->IsSyncFeatureActive()) {
return {SyncStatusMessageType::kSynced,
service->GetUserSettings()->IsSyncEverythingEnabled()
? IDS_SYNC_ACCOUNT_SYNCING
: IDS_SYNC_ACCOUNT_SYNCING_CUSTOM_DATA_TYPES,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
} else {
// Sync is still initializing.
return {SyncStatusMessageType::kSynced, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
}
// If first setup is in progress, show an "in progress" message.
if (service->IsSetupInProgress()) {
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_SETUP_IN_PROGRESS,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
// At this point we've ruled out all other cases - all that's left is a
// missing Sync confirmation.
DCHECK(ShouldRequestSyncConfirmation(service));
return {SyncStatusMessageType::kSyncError, IDS_SYNC_SETTINGS_NOT_CONFIRMED,
IDS_SYNC_ERROR_USER_MENU_CONFIRM_SYNC_SETTINGS_BUTTON,
IDS_SYNC_EMPTY_STRING, SyncStatusActionType::kConfirmSyncSettings};
}
#if !BUILDFLAG(IS_ANDROID)
void FocusWebContents(Browser* browser) {
content::WebContents* const contents =
browser->tab_strip_model()->GetActiveWebContents();
if (contents) {
contents->Focus();
}
}
void OpenTabForSyncTrustedVaultUserAction(Browser* browser, const GURL& url) {
DCHECK(browser);
FocusWebContents(browser);
NavigateParams params(GetSingletonTabNavigateParams(browser, url));
// Allow the window to close itself.
params.opened_by_another_window = true;
Navigate(&params);
}
std::optional<AvatarSyncErrorType> GetTrustedVaultError(
const syncer::SyncService* sync_service) {
if (sync_service->GetUserSettings()
->IsTrustedVaultKeyRequiredForPreferredDataTypes()) {
return sync_service->GetUserSettings()->IsEncryptEverythingEnabled()
? AvatarSyncErrorType::kTrustedVaultKeyMissingForEverythingError
: AvatarSyncErrorType::kTrustedVaultKeyMissingForPasswordsError;
}
if (sync_service->GetUserSettings()->IsTrustedVaultRecoverabilityDegraded()) {
return sync_service->GetUserSettings()->IsEncryptEverythingEnabled()
? AvatarSyncErrorType::
kTrustedVaultRecoverabilityDegradedForEverythingError
: AvatarSyncErrorType::
kTrustedVaultRecoverabilityDegradedForPasswordsError;
}
return std::nullopt;
}
#endif // !BUILDFLAG(IS_ANDROID)
} // namespace
SyncStatusLabels GetSyncStatusLabels(
syncer::SyncService* sync_service,
signin::IdentityManager* identity_manager,
bool is_user_clear_primary_account_allowed) {
if (!sync_service) {
// This can happen if Sync is disabled via the command line.
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
DCHECK(identity_manager);
CoreAccountInfo account_info = sync_service->GetAccountInfo();
GoogleServiceAuthError auth_error =
identity_manager->GetErrorStateOfRefreshTokenForAccount(
account_info.account_id);
return GetSyncStatusLabelsImpl(
sync_service, is_user_clear_primary_account_allowed, auth_error);
}
SyncStatusLabels GetSyncStatusLabels(Profile* profile) {
CHECK(profile);
signin::IdentityManager* identity_manager =
IdentityManagerFactory::GetForProfile(profile);
CHECK(identity_manager);
return GetSyncStatusLabels(
SyncServiceFactory::GetForProfile(profile), identity_manager,
ChromeSigninClientFactory::GetForProfile(profile)
->IsClearPrimaryAccountAllowed(identity_manager->HasPrimaryAccount(
signin::ConsentLevel::kSync)));
}
SyncStatusMessageType GetSyncStatusMessageType(Profile* profile) {
return GetSyncStatusLabels(profile).message_type;
}
#if !BUILDFLAG(IS_ANDROID)
SyncStatusLabels GetSyncStatusLabelsForSettings(
const syncer::SyncService* service) {
// Check to see if sync has been disabled via the dashboard and needs to be
// set up once again.
if (!service) {
// This can happen if Sync is disabled via the command line.
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
#if BUILDFLAG(IS_CHROMEOS)
if (service->GetUserSettings()->IsSyncFeatureDisabledViaDashboard()) {
return {SyncStatusMessageType::kSyncError,
IDS_SIGNED_IN_WITH_SYNC_STOPPED_VIA_DASHBOARD,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
#endif // BUILDFLAG(IS_CHROMEOS)
// If first setup is in progress, show an "in progress" message.
if (service->IsSetupInProgress()) {
return {SyncStatusMessageType::kPreSynced, IDS_SYNC_SETUP_IN_PROGRESS,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
// At this point, there is no Sync error.
if (service->IsSyncFeatureActive()) {
return {SyncStatusMessageType::kSynced,
service->GetUserSettings()->IsSyncEverythingEnabled()
? IDS_SYNC_ACCOUNT_SYNCING
: IDS_SYNC_ACCOUNT_SYNCING_CUSTOM_DATA_TYPES,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
// Sync is still initializing.
return {SyncStatusMessageType::kSynced, IDS_SYNC_EMPTY_STRING,
IDS_SYNC_EMPTY_STRING, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kNoAction};
}
SyncStatusLabels GetAvatarSyncErrorLabelsForSettings(
AvatarSyncErrorType error) {
switch (error) {
case AvatarSyncErrorType::kSyncPaused:
return {SyncStatusMessageType::kSyncError, IDS_SYNC_RELOGIN_ERROR,
IDS_SYNC_RELOGIN_BUTTON, IDS_SYNC_EMPTY_STRING,
SyncStatusActionType::kReauthenticate};
case AvatarSyncErrorType::kTrustedVaultKeyMissingForPasswordsError:
return {SyncStatusMessageType::kPasswordsOnlySyncError,
IDS_SETTINGS_ERROR_PASSWORDS_USER_ERROR_DESCRIPTION,
IDS_SYNC_STATUS_NEEDS_KEYS_BUTTON,
IDS_PROFILES_ACCOUNT_REMOVAL_TITLE,
SyncStatusActionType::kRetrieveTrustedVaultKeys};
case AvatarSyncErrorType::
kTrustedVaultRecoverabilityDegradedForPasswordsError:
return {
SyncStatusMessageType::kPasswordsOnlySyncError,
IDS_SETTINGS_ERROR_RECOVERABILITY_DEGRADED_FOR_PASSWORDS_USER_ERROR_DESCRIPTION,
IDS_SYNC_STATUS_NEEDS_KEYS_BUTTON, IDS_PROFILES_ACCOUNT_REMOVAL_TITLE,
SyncStatusActionType::kRetrieveTrustedVaultKeys};
case AvatarSyncErrorType::kPassphraseError:
return {SyncStatusMessageType::kSyncError,
IDS_SETTINGS_ERROR_PASSPHRASE_USER_ERROR_DESCRIPTION_WITH_EMAIL,
IDS_SYNC_STATUS_NEEDS_PASSWORD_BUTTON, IDS_SETTINGS_SIGN_OUT,
SyncStatusActionType::kEnterPassphrase};
case AvatarSyncErrorType::
kTrustedVaultRecoverabilityDegradedForEverythingError:
case AvatarSyncErrorType::kTrustedVaultKeyMissingForEverythingError:
return {SyncStatusMessageType::kSyncError,
IDS_SETTINGS_ERROR_TRUSTED_VAULT_USER_ERROR_DESCRIPTION,
IDS_SYNC_STATUS_NEEDS_KEYS_BUTTON,
IDS_PROFILES_ACCOUNT_REMOVAL_TITLE,
SyncStatusActionType::kRetrieveTrustedVaultKeys};
case AvatarSyncErrorType::kUpgradeClientError:
return {SyncStatusMessageType::kSyncError,
IDS_SETTINGS_ERROR_UPGRADE_CLIENT_USER_ERROR_DESCRIPTION,
IDS_SYNC_UPGRADE_CLIENT_BUTTON, IDS_SETTINGS_SIGN_OUT,
SyncStatusActionType::kUpgradeClient};
case AvatarSyncErrorType::kSettingsUnconfirmedError:
return {SyncStatusMessageType::kSyncError,
IDS_SYNC_SETTINGS_NOT_CONFIRMED,
IDS_SYNC_ERROR_USER_MENU_CONFIRM_SYNC_SETTINGS_BUTTON,
IDS_PROFILES_ACCOUNT_REMOVAL_TITLE,
SyncStatusActionType::kConfirmSyncSettings};
case AvatarSyncErrorType::kManagedUserUnrecoverableError:
return {SyncStatusMessageType::kSyncError,
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR_NEEDS_SIGNOUT,
IDS_SYNC_RELOGIN_BUTTON, IDS_PROFILES_ACCOUNT_REMOVAL_TITLE,
SyncStatusActionType::kReauthenticate};
case AvatarSyncErrorType::kUnrecoverableError:
return {SyncStatusMessageType::kSyncError,
IDS_SYNC_STATUS_UNRECOVERABLE_ERROR, IDS_SYNC_RELOGIN_BUTTON,
IDS_PROFILES_ACCOUNT_REMOVAL_TITLE,
SyncStatusActionType::kReauthenticate};
}
}
std::optional<AvatarSyncErrorType> GetAvatarSyncErrorType(Profile* profile) {
const syncer::SyncService* service =
SyncServiceFactory::GetForProfile(profile);
if (!service) {
return std::nullopt;
}
if (!service->HasSyncConsent()) {
// Only some errors can be shown if the account isn't a consented primary
// account.
// Note the condition checked is not IsInitialSyncFeatureSetupComplete(),
// because the setup incomplete case is treated separately below. See the
// comment in ShouldRequestSyncConfirmation() about dashboard resets.
if (service->RequiresClientUpgrade()) {
return AvatarSyncErrorType::kUpgradeClientError;
}
if (service->GetUserSettings()
->IsPassphraseRequiredForPreferredDataTypes()) {
return AvatarSyncErrorType::kPassphraseError;
}
return GetTrustedVaultError(service);
}
// RequiresClientUpgrade() is unrecoverable, but is treated separately below.
if (service->HasUnrecoverableError() && !service->RequiresClientUpgrade()) {
// Display different messages and buttons for managed accounts.
if (!ChromeSigninClientFactory::GetForProfile(profile)
->IsClearPrimaryAccountAllowed(
IdentityManagerFactory::GetForProfile(profile)
->HasPrimaryAccount(signin::ConsentLevel::kSync))) {
return AvatarSyncErrorType::kManagedUserUnrecoverableError;
}
return AvatarSyncErrorType::kUnrecoverableError;
}
if (service->GetTransportState() ==
syncer::SyncService::TransportState::PAUSED) {
return AvatarSyncErrorType::kSyncPaused;
}
if (service->RequiresClientUpgrade()) {
return AvatarSyncErrorType::kUpgradeClientError;
}
if (ShouldShowSyncPassphraseError(service)) {
return AvatarSyncErrorType::kPassphraseError;
}
const std::optional<AvatarSyncErrorType> trusted_vault_error =
GetTrustedVaultError(service);
if (trusted_vault_error) {
return trusted_vault_error;
}
if (ShouldRequestSyncConfirmation(service)) {
return AvatarSyncErrorType::kSettingsUnconfirmedError;
}
return std::nullopt;
}
std::u16string GetAvatarSyncErrorDescription(AvatarSyncErrorType error,
bool is_sync_feature_enabled,
const std::string& user_email) {
switch (error) {
case AvatarSyncErrorType::kSyncPaused:
return l10n_util::GetStringUTF16(IDS_PROFILES_DICE_SYNC_PAUSED_TITLE);
case AvatarSyncErrorType::kTrustedVaultKeyMissingForPasswordsError:
return l10n_util::GetStringFUTF16(
IDS_SYNC_ERROR_PASSWORDS_USER_MENU_ERROR_DESCRIPTION,
base::UTF8ToUTF16(user_email));
case AvatarSyncErrorType::
kTrustedVaultRecoverabilityDegradedForPasswordsError:
return l10n_util::GetStringFUTF16(
IDS_SYNC_ERROR_RECOVERABILITY_DEGRADED_FOR_PASSWORDS_USER_MENU_ERROR_DESCRIPTION,
base::UTF8ToUTF16(user_email));
case AvatarSyncErrorType::
kTrustedVaultRecoverabilityDegradedForEverythingError:
return l10n_util::GetStringFUTF16(
IDS_SYNC_ERROR_TRUSTED_VAULT_USER_MENU_ERROR_DESCRIPTION,
base::UTF8ToUTF16(user_email));
case AvatarSyncErrorType::kPassphraseError:
return l10n_util::GetStringFUTF16(
IDS_SYNC_ERROR_PASSPHRASE_USER_MENU_ERROR_DESCRIPTION,
base::UTF8ToUTF16(user_email));
case AvatarSyncErrorType::kUpgradeClientError:
return l10n_util::GetStringFUTF16(
IDS_SYNC_ERROR_UPGRADE_CLIENT_USER_MENU_ERROR_DESCRIPTION,
base::UTF8ToUTF16(user_email));
case AvatarSyncErrorType::kTrustedVaultKeyMissingForEverythingError:
return l10n_util::GetStringFUTF16(
IDS_SYNC_ERROR_TRUSTED_VAULT_USER_MENU_ERROR_DESCRIPTION,
base::UTF8ToUTF16(user_email));
case AvatarSyncErrorType::kSettingsUnconfirmedError:
case AvatarSyncErrorType::kManagedUserUnrecoverableError:
case AvatarSyncErrorType::kUnrecoverableError:
return l10n_util::GetStringUTF16(IDS_SYNC_ERROR_USER_MENU_TITLE);
}
}
#endif // !BUILDFLAG(IS_ANDROID)
bool ShouldRequestSyncConfirmation(const syncer::SyncService* service) {
// This method mainly handles the situation where the initial Sync setup was
// aborted without actually disabling Sync again. That generally shouldn't
// happen, but it might if Chrome crashed while the setup was ongoing, or due
// to past bugs in the setup flow.
return !service->IsLocalSyncEnabled() && service->HasSyncConsent() &&
!service->IsSetupInProgress() &&
!service->GetUserSettings()->IsInitialSyncFeatureSetupComplete();
}
bool ShouldShowSyncPassphraseError(const syncer::SyncService* service) {
const syncer::SyncUserSettings* settings = service->GetUserSettings();
return settings->IsInitialSyncFeatureSetupComplete() &&
settings->IsPassphraseRequiredForPreferredDataTypes();
}
#if !BUILDFLAG(IS_ANDROID)
void OpenTabForSyncKeyRetrieval(
Browser* browser,
syncer::TrustedVaultUserActionTriggerForUMA trigger) {
RecordKeyRetrievalTrigger(trigger);
const GURL continue_url =
GURL(UIThreadSearchTermsData().GoogleBaseURLValue());
GURL retrieval_url =
GaiaUrls::GetInstance()->signin_chrome_sync_keys_retrieval_url();
if (continue_url.is_valid()) {
retrieval_url = net::AppendQueryParameter(retrieval_url, "continue",
continue_url.spec());
}
OpenTabForSyncTrustedVaultUserAction(browser, retrieval_url);
}
void OpenTabForSyncKeyRecoverabilityDegraded(
Browser* browser,
syncer::TrustedVaultUserActionTriggerForUMA trigger) {
RecordRecoverabilityDegradedFixTrigger(trigger);
const GURL continue_url =
GURL(UIThreadSearchTermsData().GoogleBaseURLValue());
GURL url = GaiaUrls::GetInstance()
->signin_chrome_sync_keys_recoverability_degraded_url();
if (continue_url.is_valid()) {
url = net::AppendQueryParameter(url, "continue", continue_url.spec());
}
OpenTabForSyncTrustedVaultUserAction(browser, url);
}
#endif // !BUILDFLAG(IS_ANDROID)