components/sync/android/sync_service_android_bridge.cc

// Copyright 2013 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/sync/android/sync_service_android_bridge.h"

#include <cstdint>
#include <map>
#include <string>
#include <vector>

#include "base/android/jni_android.h"
#include "base/android/jni_array.h"
#include "base/android/jni_string.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/i18n/time_formatting.h"
#include "base/json/json_writer.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "components/signin/public/base/gaia_id_hash.h"
#include "components/signin/public/identity_manager/account_info.h"
#include "components/sync/base/data_type.h"
#include "components/sync/base/user_selectable_type.h"
#include "components/sync/service/local_data_description.h"
#include "components/sync/service/sync_service.h"
#include "components/sync/service/sync_service_utils.h"
#include "components/sync/service/sync_user_settings.h"
#include "google_apis/gaia/gaia_id.h"
#include "google_apis/gaia/google_service_auth_error.h"
#include "third_party/jni_zero/default_conversions.h"

// Must come after all headers that specialize FromJniType() / ToJniType().
#include "components/sync/android/jni_headers/SyncServiceImpl_jni.h"
#include "components/sync/android/jni_headers/SyncService_jni.h"

using base::android::AppendJavaStringArrayToStringVector;
using base::android::AttachCurrentThread;
using base::android::ConvertJavaStringToUTF8;
using base::android::ConvertUTF8ToJavaString;
using base::android::JavaRef;
using base::android::ScopedJavaLocalRef;

namespace syncer {

namespace {

DataType IntToDataTypeChecked(int type) {
  CHECK_GE(type, static_cast<int>(DataType::FIRST_REAL_DATA_TYPE));
  CHECK_LE(type, static_cast<int>(DataType::LAST_REAL_DATA_TYPE));
  return static_cast<DataType>(type);
}

std::vector<int32_t> DataTypeSetToVector(DataTypeSet types) {
  std::vector<int32_t> type_vector;
  for (DataType type : types) {
    type_vector.push_back(static_cast<int32_t>(type));
  }
  return type_vector;
}

DataTypeSet VectorToDataTypeSet(const std::vector<int32_t>& types_vector) {
  DataTypeSet data_type_set;
  for (int32_t type : types_vector) {
    data_type_set.Put(IntToDataTypeChecked(type));
  }
  return data_type_set;
}

std::vector<int32_t> UserSelectableTypeSetToVector(
    UserSelectableTypeSet types) {
  std::vector<int32_t> type_vector;
  type_vector.reserve(types.size());
  for (UserSelectableType type : types) {
    type_vector.push_back(static_cast<int32_t>(type));
  }
  return type_vector;
}

// Native callback for the JNI GetTypesWithUnsyncedData method. When
// SyncService::GetTypesWithUnsyncedData() completes, this method is called and
// the results are sent to the Java callback.
void NativeGetTypesWithUnsyncedDataCallback(
    JNIEnv* env,
    const base::android::ScopedJavaGlobalRef<jobject>& callback,
    absl::flat_hash_map<DataType, size_t> type_counts) {
  DataTypeSet types;
  for (const auto& [type, count] : type_counts) {
    types.Put(type);
  }
  Java_SyncServiceImpl_onGetTypesWithUnsyncedDataResult(
      env, callback, DataTypeSetToVector(types));
}

void NativeGetLocalDataDescriptionsCallback(
    JNIEnv* env,
    const base::android::ScopedJavaGlobalRef<jobject>& callback,
    std::map<DataType, LocalDataDescription> localDataDescription) {
  std::vector<int32_t> data_types;
  data_types.reserve(localDataDescription.size());
  std::vector<LocalDataDescription> local_data_descriptions;
  local_data_descriptions.reserve(localDataDescription.size());
  for (const auto& [data_type, description] : localDataDescription) {
    data_types.push_back(static_cast<int32_t>(data_type));
    local_data_descriptions.push_back(description);
  }

  Java_SyncServiceImpl_onGetLocalDataDescriptionsResult(
      env, callback, data_types, local_data_descriptions);
}

// Native callback for the JNI GetAllNodes method. When
// SyncService::GetAllNodesForDebugging() completes, this method is called and
// the results are sent to the Java callback.
void NativeGetAllNodesCallback(
    JNIEnv* env,
    const base::android::ScopedJavaGlobalRef<jobject>& callback,
    base::ListValue result) {
  std::string json_string;
  if (!base::JSONWriter::Write(result, &json_string)) {
    DVLOG(1) << "Writing as JSON failed. Passing empty string to Java code.";
    json_string = std::string();
  }

  Java_SyncServiceImpl_onGetAllNodesResult(env, callback, json_string);
}

UserSelectableType IntToUserSelectableTypeChecked(int type) {
  CHECK_GE(type, static_cast<int>(UserSelectableType::kFirstType));
  CHECK_LE(type, static_cast<int>(UserSelectableType::kLastType));
  return static_cast<UserSelectableType>(type);
}

}  // namespace

// static
SyncService* SyncServiceAndroidBridge::FromJavaObject(
    const base::android::JavaRef<jobject>& j_sync_service) {
  if (!j_sync_service) {
    return nullptr;
  }
  auto* bridge = reinterpret_cast<SyncServiceAndroidBridge*>(
      Java_SyncService_getNativeSyncServiceAndroidBridge(AttachCurrentThread(),
                                                         j_sync_service));
  return bridge ? bridge->native_sync_service_ : nullptr;
}

SyncServiceAndroidBridge::SyncServiceAndroidBridge(
    SyncService* native_sync_service)
    : native_sync_service_(native_sync_service) {
  DCHECK(native_sync_service_);

  java_ref_.Reset(Java_SyncServiceImpl_Constructor(
      base::android::AttachCurrentThread(), reinterpret_cast<intptr_t>(this)));

  native_sync_service_->AddObserver(this);
}

SyncServiceAndroidBridge::~SyncServiceAndroidBridge() = default;

ScopedJavaLocalRef<jobject> SyncServiceAndroidBridge::GetJavaObject() {
  return ScopedJavaLocalRef<jobject>(java_ref_);
}

void SyncServiceAndroidBridge::OnStateChanged(SyncService* sync) {
  // Notify the java world that our sync state has changed.
  JNIEnv* env = AttachCurrentThread();
  Java_SyncServiceImpl_syncStateChanged(env, java_ref_);
}

void SyncServiceAndroidBridge::OnSyncShutdown(SyncService* sync) {
  native_sync_service_->RemoveObserver(this);
  Java_SyncServiceImpl_destroy(AttachCurrentThread(), java_ref_);
  // Not worth resetting `native_sync_service_`, it owns this object and will
  // destroy it shortly.
}

void SyncServiceAndroidBridge::AcknowledgeBookmarksLimitExceededError(
    int32_t source) {
  native_sync_service_->AcknowledgeBookmarksLimitExceededError(
      static_cast<SyncService::BookmarksLimitExceededHelpClickedSource>(
          source));
}

bool SyncServiceAndroidBridge::IsSyncFeatureEnabled() {
  return native_sync_service_->IsSyncFeatureEnabled();
}

bool SyncServiceAndroidBridge::IsSyncDisabledByEnterprisePolicy() {
  return native_sync_service_->HasDisableReason(
      SyncService::DISABLE_REASON_ENTERPRISE_POLICY);
}

bool SyncServiceAndroidBridge::IsEngineInitialized() {
  return native_sync_service_->IsEngineInitialized();
}

std::vector<int32_t> SyncServiceAndroidBridge::GetActiveDataTypes() {
  return DataTypeSetToVector(native_sync_service_->GetActiveDataTypes());
}

std::vector<int32_t> SyncServiceAndroidBridge::GetSelectedTypes() {
  UserSelectableTypeSet user_selectable_types;
  user_selectable_types =
      native_sync_service_->GetUserSettings()->GetSelectedTypes();
  return UserSelectableTypeSetToVector(user_selectable_types);
}

void SyncServiceAndroidBridge::GetTypesWithUnsyncedData(
    JNIEnv* env,
    const base::android::JavaRef<jobject>& callback) {
  base::android::ScopedJavaGlobalRef<jobject> java_callback;
  java_callback.Reset(env, callback);
  native_sync_service_->GetTypesWithUnsyncedData(
      TypesRequiringUnsyncedDataCheckOnSignout(),
      base::BindOnce(&NativeGetTypesWithUnsyncedDataCallback, env,
                     java_callback));
}

void SyncServiceAndroidBridge::GetLocalDataDescriptions(
    JNIEnv* env,
    const std::vector<int32_t>& types,
    const base::android::JavaRef<jobject>& callback) {
  base::android::ScopedJavaGlobalRef<jobject> java_callback;
  java_callback.Reset(env, callback);

  native_sync_service_->GetLocalDataDescriptions(
      VectorToDataTypeSet(types),
      base::BindOnce(&NativeGetLocalDataDescriptionsCallback, env,
                     java_callback));
}

void SyncServiceAndroidBridge::TriggerLocalDataMigration(
    const std::vector<int32_t>& types) {
  native_sync_service_->TriggerLocalDataMigration(VectorToDataTypeSet(types));
}

bool SyncServiceAndroidBridge::IsTypeManagedByPolicy(int32_t type) {
  return native_sync_service_->GetUserSettings()->IsTypeManagedByPolicy(
      IntToUserSelectableTypeChecked(type));
}

bool SyncServiceAndroidBridge::IsTypeManagedByCustodian(int32_t type) {
  return native_sync_service_->GetUserSettings()->IsTypeManagedByCustodian(
      IntToUserSelectableTypeChecked(type));
}

void SyncServiceAndroidBridge::SetSelectedType(int32_t type, bool is_type_on) {
  if (native_sync_service_->GetAccountInfo().account_id.empty()) {
    // This function shouldn't be called while signed out, but evidence
    // suggests it sometimes does get called.
    // TODO(crbug.com/369301153): Remove workaround and adopt CHECK/NOTREACHED
    // once crashes are no longer reported. This could also be cleaned up once
    // crbug.com/40066949 is tackled.
    DUMP_WILL_BE_NOTREACHED();
    return;
  }

  native_sync_service_->GetUserSettings()->SetSelectedType(
      IntToUserSelectableTypeChecked(type), is_type_on);
}

bool SyncServiceAndroidBridge::IsCustomPassphraseAllowed() {
  return native_sync_service_->GetUserSettings()->IsCustomPassphraseAllowed();
}

bool SyncServiceAndroidBridge::IsEncryptEverythingEnabled() {
  return native_sync_service_->GetUserSettings()->IsEncryptEverythingEnabled();
}

bool SyncServiceAndroidBridge::IsPassphraseRequiredForPreferredDataTypes() {
  return native_sync_service_->GetUserSettings()
      ->IsPassphraseRequiredForPreferredDataTypes();
}

bool SyncServiceAndroidBridge::IsTrustedVaultKeyRequired() {
  return native_sync_service_->GetUserSettings()->IsTrustedVaultKeyRequired();
}

bool SyncServiceAndroidBridge::
    IsTrustedVaultKeyRequiredForPreferredDataTypes() {
  return native_sync_service_->GetUserSettings()
      ->IsTrustedVaultKeyRequiredForPreferredDataTypes();
}

bool SyncServiceAndroidBridge::IsTrustedVaultRecoverabilityDegraded() {
  return native_sync_service_->GetUserSettings()
      ->IsTrustedVaultRecoverabilityDegraded();
}

bool SyncServiceAndroidBridge::IsUsingExplicitPassphrase() {
  return native_sync_service_->GetUserSettings()->IsUsingExplicitPassphrase();
}

int32_t SyncServiceAndroidBridge::GetPassphraseType() {
  // TODO(crbug.com/40923935): Mapping nullopt -> kImplicitPassphrase
  // preserves the historic behavior, but ideally we should propagate the
  // nullopt state to Java.
  return static_cast<int32_t>(
      native_sync_service_->GetUserSettings()->GetPassphraseType().value_or(
          PassphraseType::kImplicitPassphrase));
}

int32_t SyncServiceAndroidBridge::GetTransportState() {
  return static_cast<int32_t>(native_sync_service_->GetTransportState());
}

int32_t SyncServiceAndroidBridge::GetUserActionableError() {
  return static_cast<int32_t>(native_sync_service_->GetUserActionableError());
}

void SyncServiceAndroidBridge::SetEncryptionPassphrase(
    const std::string& passphrase) {
  native_sync_service_->GetUserSettings()->SetEncryptionPassphrase(passphrase);
}

bool SyncServiceAndroidBridge::SetDecryptionPassphrase(
    const std::string& passphrase) {
  return native_sync_service_->GetUserSettings()->SetDecryptionPassphrase(
      passphrase);
}

int64_t SyncServiceAndroidBridge::GetExplicitPassphraseTime() {
  return native_sync_service_->GetUserSettings()
      ->GetExplicitPassphraseTime()
      .InMillisecondsSinceUnixEpoch();
}

void SyncServiceAndroidBridge::GetAllNodes(JNIEnv* env,
                                           const JavaRef<jobject>& callback) {
  base::android::ScopedJavaGlobalRef<jobject> java_callback;
  java_callback.Reset(env, callback);
  native_sync_service_->GetAllNodesForDebugging(
      base::BindOnce(&NativeGetAllNodesCallback, env, java_callback));
}

GoogleServiceAuthError SyncServiceAndroidBridge::GetAuthError() {
  return native_sync_service_->GetAuthError();
}

base::android::ScopedJavaLocalRef<jobject>
SyncServiceAndroidBridge::GetAccountInfo(JNIEnv* env) {
  CoreAccountInfo account_info = native_sync_service_->GetAccountInfo();
  return account_info.IsEmpty()
             ? nullptr
             : ConvertToJavaCoreAccountInfo(env, account_info);
}

bool SyncServiceAndroidBridge::
    IsPassphrasePromptMutedForCurrentProductVersion() {
  return native_sync_service_->GetUserSettings()
      ->IsPassphrasePromptMutedForCurrentProductVersion();
}

void SyncServiceAndroidBridge::
    MarkPassphrasePromptMutedForCurrentProductVersion() {
  native_sync_service_->GetUserSettings()
      ->MarkPassphrasePromptMutedForCurrentProductVersion();
}

bool SyncServiceAndroidBridge::ShouldOfferTrustedVaultOptIn() {
  return syncer::ShouldOfferTrustedVaultOptIn(native_sync_service_);
}

void SyncServiceAndroidBridge::TriggerRefresh() {
  native_sync_service_->TriggerRefresh(
      SyncService::TriggerRefreshSource::kAndroidSyncServiceBridge,
      DataTypeSet::All());
}

int64_t SyncServiceAndroidBridge::GetLastSyncedTimeForDebugging() {
  base::Time last_sync_time =
      native_sync_service_->GetLastSyncedTimeForDebugging();
  return static_cast<int64_t>(
      (last_sync_time - base::Time::UnixEpoch()).InMicroseconds());
}

void SyncServiceAndroidBridge::KeepAccountSettingsPrefsOnlyForUsers(
    const std::vector<std::string>& gaia_id_strings) {
  std::vector<GaiaId> gaia_ids;
  for (const std::string& gaia_id_string : gaia_id_strings) {
    gaia_ids.emplace_back(gaia_id_string);
  }
  native_sync_service_->GetUserSettings()->KeepAccountSettingsPrefsOnlyForUsers(
      gaia_ids);
}

}  // namespace syncer

DEFINE_JNI(SyncServiceImpl)
DEFINE_JNI(SyncService)