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
|
// Copyright 2024 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/on_device_translation/translation_manager_impl.h"
#include <string_view>
#include "base/feature_list.h"
#include "base/rand_util.h"
#include "base/task/sequenced_task_runner.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/component_updater/translate_kit_component_installer.h"
#include "chrome/browser/content_settings/host_content_settings_map_factory.h"
#include "chrome/browser/on_device_translation/component_manager.h"
#include "chrome/browser/on_device_translation/pref_names.h"
#include "chrome/browser/on_device_translation/service_controller.h"
#include "chrome/browser/on_device_translation/service_controller_manager.h"
#include "chrome/browser/on_device_translation/translation_manager_util.h"
#include "chrome/browser/on_device_translation/translation_metrics.h"
#include "chrome/browser/on_device_translation/translator.h"
#include "components/content_settings/core/browser/host_content_settings_map.h"
#include "components/content_settings/core/common/content_settings.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "components/crx_file/id_util.h"
#include "components/services/on_device_translation/public/cpp/features.h"
#include "content/public/browser/render_frame_host.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/features_generated.h"
#include "third_party/blink/public/mojom/ai/model_download_progress_observer.mojom.h"
#include "ui/base/l10n/l10n_util.h"
namespace on_device_translation {
namespace {
const void* kTranslationManagerUserDataKey = &kTranslationManagerUserDataKey;
using blink::mojom::CanCreateTranslatorResult;
using blink::mojom::CreateTranslatorError;
using blink::mojom::CreateTranslatorResult;
using blink::mojom::TranslationManagerCreateTranslatorClient;
using blink::mojom::TranslatorLanguageCode;
using blink::mojom::TranslatorLanguageCodePtr;
using content::BrowserContext;
// TODO(crbug.com/419848973): This is a workaround until the "he" language code
// is fully supported.
std::string SwitchLanguageCodeToIwIfHe(std::string language_code) {
std::string language_subtag = language_code;
int pos = language_code.find("-");
if (pos != -1) {
language_subtag.resize(pos);
}
if (language_subtag == "he") {
language_code.replace(0, 2, "iw");
}
return language_code;
}
void RunTranslationAvailableCallbackWithMasking(
bool mask_readily_result,
std::string source_language,
std::string target_language,
TranslationManagerImpl::TranslationAvailableCallback callback,
CanCreateTranslatorResult result) {
if (result == CanCreateTranslatorResult::kReadily && mask_readily_result) {
result =
CanCreateTranslatorResult::kAfterDownloadTranslatorCreationRequired;
}
std::move(callback).Run(result);
}
} // namespace
TranslationManagerImpl* TranslationManagerImpl::translation_manager_for_test_ =
nullptr;
TranslationManagerImpl::TranslationManagerImpl(
base::PassKey<TranslationManagerImpl>,
BrowserContext* browser_context,
const url::Origin& origin)
: TranslationManagerImpl(browser_context, origin) {}
TranslationManagerImpl::TranslationManagerImpl(BrowserContext* browser_context,
const url::Origin& origin)
: browser_context_(browser_context->GetWeakPtr()), origin_(origin) {}
TranslationManagerImpl::~TranslationManagerImpl() = default;
// static
base::AutoReset<TranslationManagerImpl*> TranslationManagerImpl::SetForTesting(
TranslationManagerImpl* manager) {
return base::AutoReset<TranslationManagerImpl*>(
&translation_manager_for_test_, manager);
}
// static
void TranslationManagerImpl::Bind(
BrowserContext* browser_context,
base::SupportsUserData* context_user_data,
const url::Origin& origin,
mojo::PendingReceiver<blink::mojom::TranslationManager> receiver) {
auto* manager = GetOrCreate(browser_context, context_user_data, origin);
CHECK(manager);
CHECK_EQ(manager->origin_, origin);
manager->receiver_set_.Add(manager, std::move(receiver));
}
// static
TranslationManagerImpl* TranslationManagerImpl::GetOrCreate(
BrowserContext* browser_context,
base::SupportsUserData* context_user_data,
const url::Origin& origin) {
// Use the testing instance of `TranslationManagerImpl*`, if it exists.
if (translation_manager_for_test_) {
return translation_manager_for_test_;
}
// TODO(crbug.com/322229993): Now that only one TranslationManager can be
// bound, we can remove this.
if (auto* manager = static_cast<TranslationManagerImpl*>(
context_user_data->GetUserData(kTranslationManagerUserDataKey))) {
return manager;
}
auto manager = std::make_unique<TranslationManagerImpl>(
base::PassKey<TranslationManagerImpl>(), browser_context, origin);
auto* manager_ptr = manager.get();
context_user_data->SetUserData(kTranslationManagerUserDataKey,
std::move(manager));
return manager_ptr;
}
base::Value TranslationManagerImpl::GetInitializedTranslationsValue() {
return HostContentSettingsMapFactory::GetForProfile(browser_context())
->GetWebsiteSetting(origin_.GetURL(), origin_.GetURL(),
ContentSettingsType::INITIALIZED_TRANSLATIONS,
/*info=*/nullptr);
}
bool TranslationManagerImpl::HasInitializedTranslator(
const std::string& source_language,
const std::string& target_language) {
base::Value initialized_translations_value =
GetInitializedTranslationsValue();
if (initialized_translations_value.is_dict()) {
return initialized_translations_value.GetDict()
.EnsureList(source_language)
->contains(target_language);
}
return false;
}
void TranslationManagerImpl::SetTranslatorInitializedContentSetting(
base::Value initialized_translations) {
HostContentSettingsMapFactory::GetForProfile(browser_context())
->SetWebsiteSettingDefaultScope(
origin_.GetURL(), origin_.GetURL(),
ContentSettingsType::INITIALIZED_TRANSLATIONS,
std::move(initialized_translations));
}
void TranslationManagerImpl::SetInitializedTranslation(
const std::string& source_language,
const std::string& target_language) {
base::Value initialized_translations_value =
GetInitializedTranslationsValue();
// Initialize a dictionary to store data, if none exists.
if (!initialized_translations_value.is_dict()) {
initialized_translations_value = base::Value(base::Value::Dict());
}
// Update or initialize the list of targets for the source language.
base::Value::List* target_languages_list =
initialized_translations_value.GetDict().EnsureList(source_language);
if (!target_languages_list->contains(target_language)) {
target_languages_list->Append(target_language);
}
SetTranslatorInitializedContentSetting(
std::move(initialized_translations_value));
}
std::optional<std::string> TranslationManagerImpl::GetBestFitLanguageCode(
std::string requested_language) {
// The "crash" code is only allowed in testing. This code triggers the mock
// TranslateKit lib to crash, so that we can test graceful handling of
// TranslateKit crashes.
if (CrashesAllowed() && requested_language == "crash") {
return requested_language;
}
std::string best_fit =
SwitchLanguageCodeToIwIfHe(std::move(requested_language));
return LookupMatchingLocaleByBestFit(kSupportedLanguageCodes,
std::move(best_fit));
}
base::TimeDelta TranslationManagerImpl::GetTranslatorDownloadDelay() {
return base::RandTimeDelta(base::Seconds(2), base::Seconds(3));
}
component_updater::ComponentUpdateService*
TranslationManagerImpl::GetComponentUpdateService() {
return g_browser_process->component_updater();
}
bool TranslationManagerImpl::CrashesAllowed() {
return false;
}
void TranslationManagerImpl::CreateTranslatorImpl(
mojo::PendingRemote<TranslationManagerCreateTranslatorClient> client,
const std::string& source_language,
const std::string& target_language) {
GetServiceController().CreateTranslator(
source_language, target_language,
base::BindOnce(
[](base::WeakPtr<TranslationManagerImpl> self,
mojo::PendingRemote<TranslationManagerCreateTranslatorClient>
client,
const std::string& source_language,
const std::string& target_language,
base::expected<mojo::PendingRemote<mojom::Translator>,
CreateTranslatorError> result) {
if (!client || !self) {
// Request was aborted or the frame was destroyed. Note: Currently
// aborting createTranslator() is not supported yet.
// TODO(crbug.com/331735396): Support abort signal.
return;
}
if (!result.has_value()) {
mojo::Remote<TranslationManagerCreateTranslatorClient>(
std::move(client))
->OnResult(CreateTranslatorResult::NewError(result.error()),
nullptr, nullptr);
return;
}
mojo::PendingRemote<::blink::mojom::Translator> blink_remote;
self->translators_.Add(
std::make_unique<Translator>(self->browser_context_,
source_language, target_language,
std::move(result.value())),
blink_remote.InitWithNewPipeAndPassReceiver());
mojo::Remote<TranslationManagerCreateTranslatorClient>(
std::move(client))
->OnResult(CreateTranslatorResult::NewTranslator(
std::move(blink_remote)),
TranslatorLanguageCode::New(source_language),
TranslatorLanguageCode::New(target_language));
// TODO(crbug.com/414393698): Ensure stored WebsiteSetting is not
// updated when create is aborted prior to download completion.
//
// Update the corresponding website setting if a translator has
// been initialized as a result of translator creation.
if (!self->HasInitializedTranslator(source_language,
target_language)) {
self->SetInitializedTranslation(source_language, target_language);
}
},
weak_ptr_factory_.GetWeakPtr(), std::move(client), source_language,
target_language));
}
void TranslationManagerImpl::CreateTranslator(
mojo::PendingRemote<TranslationManagerCreateTranslatorClient> client,
blink::mojom::TranslatorCreateOptionsPtr options,
bool add_fake_download_delay) {
std::optional<std::string> maybe_source_language =
GetBestFitLanguageCode(options->source_lang->code);
std::optional<std::string> maybe_target_language =
GetBestFitLanguageCode(options->target_lang->code);
// TranslationAvailable should have been called on these language codes which
// has already verified that a best fit language code exists.
CHECK(maybe_source_language.has_value());
CHECK(maybe_target_language.has_value());
std::string source_language = *std::move(maybe_source_language);
std::string target_language = *std::move(maybe_target_language);
RecordTranslationAPICallForLanguagePair("Create", source_language,
target_language);
if (!IsTranslatorAllowed(browser_context())) {
mojo::Remote(std::move(client))
->OnResult(CreateTranslatorResult::NewError(
CreateTranslatorError::kDisallowedByPolicy),
nullptr, nullptr);
return;
}
if (options->observer_remote) {
base::flat_set<std::string> component_ids = {
component_updater::TranslateKitComponentInstallerPolicy::
GetExtensionId()};
std::set<LanguagePackKey> language_pack_keys =
CalculateRequiredLanguagePacks(source_language, target_language);
for (const LanguagePackKey& language_pack_key : language_pack_keys) {
const LanguagePackComponentConfig& config =
GetLanguagePackComponentConfig(language_pack_key);
component_ids.insert(
crx_file::id_util::GenerateIdFromHash(config.public_key_sha));
}
model_download_progress_manager_.AddObserver(
GetComponentUpdateService(), std::move(options->observer_remote),
std::move(component_ids));
}
base::OnceClosure create_translator =
base::BindOnce(&TranslationManagerImpl::CreateTranslatorImpl,
weak_ptr_factory_.GetWeakPtr(), std::move(client),
source_language, target_language);
if (add_fake_download_delay) {
base::SequencedTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE, std::move(create_translator), GetTranslatorDownloadDelay());
} else {
std::move(create_translator).Run();
}
}
OnDeviceTranslationServiceController&
TranslationManagerImpl::GetServiceController() {
if (!service_controller_) {
ServiceControllerManager* manager =
ServiceControllerManager::GetForBrowserContext(browser_context());
CHECK(manager);
service_controller_ = manager->GetServiceControllerForOrigin(origin_);
}
return *service_controller_;
}
void TranslationManagerImpl::TranslationAvailable(
TranslatorLanguageCodePtr source_lang,
TranslatorLanguageCodePtr target_lang,
TranslationAvailableCallback callback) {
std::optional<std::string> maybe_source_language =
GetBestFitLanguageCode(std::move(source_lang->code));
std::optional<std::string> maybe_target_language =
GetBestFitLanguageCode(std::move(target_lang->code));
if (!maybe_source_language.has_value() ||
!maybe_target_language.has_value()) {
std::move(callback).Run(CanCreateTranslatorResult::kNoNotSupportedLanguage);
return;
}
std::string source_language = *std::move(maybe_source_language);
std::string target_language = *std::move(maybe_target_language);
RecordTranslationAPICallForLanguagePair("Availability", source_language,
target_language);
if (!IsTranslatorAllowed(browser_context())) {
std::move(callback).Run(CanCreateTranslatorResult::kNoDisallowedByPolicy);
return;
}
const std::vector<std::string_view> accept_languages =
GetAcceptLanguages(browser_context());
bool are_source_and_target_accept_or_english =
(IsInAcceptLanguage(accept_languages, source_language) ||
l10n_util::GetLanguage(source_language) == "en") &&
(IsInAcceptLanguage(accept_languages, target_language) ||
l10n_util::GetLanguage(target_language) == "en");
bool mask_readily_result =
!HasInitializedTranslator(source_language, target_language) &&
!are_source_and_target_accept_or_english;
GetServiceController().CanTranslate(
std::move(source_language), std::move(target_language),
base::BindOnce(&RunTranslationAvailableCallbackWithMasking,
mask_readily_result, source_language, target_language,
std::move(callback)));
}
} // namespace on_device_translation
|