// Copyright (c) 2012 The Chromium Authors. All rights reserved. // 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 "base/i18n/number_formatting.h" #include "base/i18n/time_formatting.h" #include "base/prefs/pref_service.h" #include "base/string_util.h" #include "base/utf_string_conversions.h" #include "chrome/browser/profiles/profile.h" #include "chrome/browser/profiles/profile_manager.h" #include "chrome/browser/signin/signin_global_error.h" #include "chrome/browser/signin/signin_manager.h" #include "chrome/browser/signin/signin_ui_util.h" #include "chrome/browser/sync/profile_sync_service.h" #include "chrome/browser/sync/profile_sync_service_factory.h" #include "chrome/browser/ui/browser.h" #include "chrome/browser/ui/browser_window.h" #include "chrome/browser/ui/webui/signin/login_ui_service.h" #include "chrome/browser/ui/webui/signin/login_ui_service_factory.h" #include "chrome/common/chrome_switches.h" #include "chrome/common/pref_names.h" #include "chrome/common/url_constants.h" #include "google_apis/gaia/google_service_auth_error.h" #include "grit/browser_resources.h" #include "grit/chromium_strings.h" #include "grit/generated_resources.h" #include "grit/locale_settings.h" #include "sync/internal_api/public/base/model_type.h" #include "sync/internal_api/public/sessions/sync_session_snapshot.h" #include "sync/protocol/proto_enum_conversions.h" #include "sync/protocol/sync_protocol_error.h" #include "ui/base/l10n/l10n_util.h" #include "ui/base/resource/resource_bundle.h" typedef GoogleServiceAuthError AuthError; namespace sync_ui_util { namespace { // Returns the message that should be displayed when the user is authenticated // and can connect to the sync server. If the user hasn't yet authenticated, an // empty string is returned. string16 GetSyncedStateStatusLabel(ProfileSyncService* service, const SigninManager& signin, StatusLabelStyle style) { string16 user_name = UTF8ToUTF16(signin.GetAuthenticatedUsername()); if (!user_name.empty()) { if (!service || service->IsManaged()) { // User is signed in, but sync is disabled. return l10n_util::GetStringFUTF16(IDS_SIGNED_IN_WITH_SYNC_DISABLED, user_name); } else if (service->IsStartSuppressed()) { return l10n_util::GetStringFUTF16(IDS_SIGNED_IN_WITH_SYNC_SUPPRESSED, user_name); } } if (!service || !service->sync_initialized()) { // User is not signed in, or sync is still initializing. return string16(); } DCHECK(!user_name.empty()); // Message may also carry additional advice with an HTML link, if acceptable. switch (style) { case PLAIN_TEXT: return l10n_util::GetStringFUTF16( IDS_SYNC_ACCOUNT_SYNCING_TO_USER, user_name); case WITH_HTML: return l10n_util::GetStringFUTF16( IDS_SYNC_ACCOUNT_SYNCING_TO_USER_WITH_MANAGE_LINK, user_name, ASCIIToUTF16(chrome::kSyncGoogleDashboardURL)); default: NOTREACHED(); return NULL; } } void GetStatusForActionableError( const syncer::SyncProtocolError& error, string16* status_label) { DCHECK(status_label); switch (error.action) { case syncer::STOP_AND_RESTART_SYNC: status_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_STOP_AND_RESTART_SYNC)); break; case syncer::UPGRADE_CLIENT: status_label->assign( l10n_util::GetStringFUTF16(IDS_SYNC_UPGRADE_CLIENT, l10n_util::GetStringUTF16(IDS_PRODUCT_NAME))); break; case syncer::ENABLE_SYNC_ON_ACCOUNT: status_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_ENABLE_SYNC_ON_ACCOUNT)); break; case syncer::CLEAR_USER_DATA_AND_RESYNC: status_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_CLEAR_USER_DATA)); break; default: NOTREACHED(); } } // TODO(akalin): Write unit tests for these three functions below. // status_label and link_label must either be both NULL or both non-NULL. MessageType GetStatusInfo(ProfileSyncService* service, const SigninManager& signin, StatusLabelStyle style, string16* status_label, string16* link_label) { DCHECK_EQ(status_label == NULL, link_label == NULL); MessageType result_type(SYNCED); if (signin.GetAuthenticatedUsername().empty()) return PRE_SYNCED; if (!service || service->IsManaged() || service->HasSyncSetupCompleted() || service->IsStartSuppressed()) { // The order or priority is going to be: 1. Unrecoverable errors. // 2. Auth errors. 3. Protocol errors. 4. Passphrase errors. if (service && service->HasUnrecoverableError()) { if (status_label) { status_label->assign(l10n_util::GetStringFUTF16( IDS_SYNC_STATUS_UNRECOVERABLE_ERROR, l10n_util::GetStringUTF16(IDS_SYNC_UNRECOVERABLE_ERROR_HELP_URL))); } return SYNC_ERROR; } // For auth errors first check if an auth is in progress. if (signin.AuthInProgress()) { if (status_label) { status_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_AUTHENTICATING_LABEL)); } return PRE_SYNCED; } // No auth in progress check for an auth error. AuthError auth_error = signin.signin_global_error()->GetLastAuthError(); if (auth_error.state() != AuthError::NONE) { if (status_label && link_label) signin_ui_util::GetStatusLabelsForAuthError( signin, status_label, link_label); return SYNC_ERROR; } // We dont have an auth error. Check for sync errors if the sync service // is enabled. if (service) { ProfileSyncService::Status status; service->QueryDetailedSyncStatus(&status); if (ShouldShowActionOnUI(status.sync_protocol_error)) { if (status_label) { GetStatusForActionableError(status.sync_protocol_error, status_label); } return SYNC_ERROR; } // Check for a passphrase error. if (service->IsPassphraseRequired()) { if (service->IsPassphraseRequiredForDecryption()) { // TODO(lipalani) : Ask tim if this is still needed. // NOT first machine. // Show a link ("needs attention"), but still indicate the // current synced status. Return SYNC_PROMO so that // the configure link will still be shown. if (status_label && link_label) { status_label->assign(GetSyncedStateStatusLabel( service, signin, style)); link_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_PASSWORD_SYNC_ATTENTION)); } return SYNC_PROMO; } } // Check to see if sync has been disabled via the dasboard and needs to be // set up once again. if (service->IsStartSuppressed() && status.sync_protocol_error.error_type == syncer::NOT_MY_BIRTHDAY) { if (status_label) { status_label->assign(GetSyncedStateStatusLabel(service, signin, style)); } return PRE_SYNCED; } } // There is no error. Display "Last synced..." message. if (status_label) status_label->assign(GetSyncedStateStatusLabel(service, signin, style)); return SYNCED; } else { // Either show auth error information with a link to re-login, auth in prog, // or provide a link to continue with setup. if (service->FirstSetupInProgress()) { result_type = PRE_SYNCED; ProfileSyncService::Status status; service->QueryDetailedSyncStatus(&status); AuthError auth_error = signin.signin_global_error()->GetLastAuthError(); if (status_label) { status_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_NTP_SETUP_IN_PROGRESS)); } if (signin.AuthInProgress()) { if (status_label) { status_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_AUTHENTICATING_LABEL)); } } else if (auth_error.state() != AuthError::NONE && auth_error.state() != AuthError::TWO_FACTOR) { if (status_label) { status_label->clear(); signin_ui_util::GetStatusLabelsForAuthError( signin, status_label, NULL); } result_type = SYNC_ERROR; } } else if (service->HasUnrecoverableError()) { result_type = SYNC_ERROR; ProfileSyncService::Status status; service->QueryDetailedSyncStatus(&status); if (ShouldShowActionOnUI(status.sync_protocol_error)) { if (status_label) { GetStatusForActionableError(status.sync_protocol_error, status_label); } } else if (status_label) { status_label->assign(l10n_util::GetStringUTF16(IDS_SYNC_SETUP_ERROR)); } } } return result_type; } // Returns the status info for use on the new tab page, where we want slightly // different information than in the settings panel. MessageType GetStatusInfoForNewTabPage(ProfileSyncService* service, const SigninManager& signin, string16* status_label, string16* link_label) { DCHECK(status_label); DCHECK(link_label); if (service->HasSyncSetupCompleted() && service->IsPassphraseRequired()) { if (service->passphrase_required_reason() == syncer::REASON_ENCRYPTION) { // First machine migrating to passwords. Show as a promotion. if (status_label && link_label) { status_label->assign( l10n_util::GetStringFUTF16( IDS_SYNC_NTP_PASSWORD_PROMO, l10n_util::GetStringUTF16(IDS_PRODUCT_NAME))); link_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_NTP_PASSWORD_ENABLE)); } return SYNC_PROMO; } else { // NOT first machine. // Show a link and present as an error ("needs attention"). if (status_label && link_label) { status_label->assign(string16()); link_label->assign( l10n_util::GetStringUTF16(IDS_SYNC_CONFIGURE_ENCRYPTION)); } return SYNC_ERROR; } } // Fallback to default. return GetStatusInfo(service, signin, WITH_HTML, status_label, link_label); } } // namespace MessageType GetStatusLabels(ProfileSyncService* service, const SigninManager& signin, StatusLabelStyle style, string16* status_label, string16* link_label) { DCHECK(status_label); DCHECK(link_label); return sync_ui_util::GetStatusInfo( service, signin, style, status_label, link_label); } MessageType GetStatusLabelsForNewTabPage(ProfileSyncService* service, const SigninManager& signin, string16* status_label, string16* link_label) { DCHECK(status_label); DCHECK(link_label); return sync_ui_util::GetStatusInfoForNewTabPage( service, signin, status_label, link_label); } void GetStatusLabelsForSyncGlobalError(ProfileSyncService* service, const SigninManager& signin, string16* menu_label, string16* bubble_message, string16* bubble_accept_label) { DCHECK(menu_label); DCHECK(bubble_message); DCHECK(bubble_accept_label); *menu_label = string16(); *bubble_message = string16(); *bubble_accept_label = string16(); // Only display an error if we've completed sync setup. if (!service->HasSyncSetupCompleted()) return; // Display a passphrase error if we have one. if (service->IsPassphraseRequired() && service->IsPassphraseRequiredForDecryption()) { // This is not the first machine so ask user to enter passphrase. *menu_label = l10n_util::GetStringUTF16( IDS_SYNC_PASSPHRASE_ERROR_WRENCH_MENU_ITEM); string16 product_name = l10n_util::GetStringUTF16(IDS_PRODUCT_NAME); *bubble_message = l10n_util::GetStringFUTF16( IDS_SYNC_PASSPHRASE_ERROR_BUBBLE_VIEW_MESSAGE, product_name); *bubble_accept_label = l10n_util::GetStringUTF16( IDS_SYNC_PASSPHRASE_ERROR_BUBBLE_VIEW_ACCEPT); return; } } MessageType GetStatus( ProfileSyncService* service, const SigninManager& signin) { return sync_ui_util::GetStatusInfo(service, signin, WITH_HTML, NULL, NULL); } string16 ConstructTime(int64 time_in_int) { base::Time time = base::Time::FromInternalValue(time_in_int); // If time is null the format function returns a time in 1969. if (time.is_null()) return string16(); return base::TimeFormatFriendlyDateAndTime(time); } } // namespace sync_ui_util