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
|
// Copyright 2017 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/language/ios/browser/ios_language_detection_tab_helper.h"
#include "base/functional/bind.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/strings/utf_string_conversions.h"
#include "base/timer/elapsed_timer.h"
#include "components/language/core/browser/url_language_histogram.h"
#include "components/language/ios/browser/language_detection_java_script_feature.h"
#include "components/language/ios/browser/string_clipping_util.h"
#include "components/prefs/pref_member.h"
#include "components/translate/core/browser/translate_pref_names.h"
#include "components/translate/core/common/language_detection_details.h"
#include "components/translate/core/common/translate_constants.h"
#include "components/translate/core/common/translate_util.h"
#include "components/translate/core/language_detection/language_detection_model.h"
#include "components/translate/core/language_detection/language_detection_util.h"
#import "ios/web/common/url_scheme_util.h"
#include "ios/web/public/js_messaging/web_frame.h"
#import "ios/web/public/navigation/navigation_context.h"
#include "net/http/http_response_headers.h"
namespace language {
// Note: This should stay in sync with the constant in language_detection.js.
const size_t kMaxIndexChars = 65535;
namespace {
// Name for the UMA metric used to track language detection evaluation duration.
const char kTranslateLanguageDetectionTFLiteModelEvaluationDuration[] =
"Translate.LanguageDetection.TFLiteModelEvaluationDuration";
// The old CLD model version.
const char kCLDModelVersion[] = "CLD3";
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class LanguageDetectionMethod {
kTFLiteModelUsed = 0,
kTFLiteModelUnavailable = 1,
kTFLiteModelDisabled = 2,
kTFLiteModelIgnored_DEPRECATED = 3,
kMaxValue = kTFLiteModelIgnored_DEPRECATED
};
} // namespace
IOSLanguageDetectionTabHelper::IOSLanguageDetectionTabHelper(
web::WebState* web_state,
UrlLanguageHistogram* url_language_histogram,
translate::LanguageDetectionModel* language_detection_model,
PrefService* prefs)
: web_state_(web_state),
url_language_histogram_(url_language_histogram),
language_detection_model_(language_detection_model),
weak_method_factory_(this) {
DCHECK(web_state_);
translate_enabled_.Init(translate::prefs::kOfferTranslateEnabled, prefs);
// Attempt to detect language since preloaded tabs will not execute
// WebStateObserver::PageLoaded.
StartLanguageDetection();
web_state_->AddObserver(this);
web::WebFramesManager* web_frames_manager =
LanguageDetectionJavaScriptFeature::GetInstance()->GetWebFramesManager(
web_state);
web_frames_manager->AddObserver(this);
}
IOSLanguageDetectionTabHelper::~IOSLanguageDetectionTabHelper() {
for (auto& observer : observer_list_) {
observer.IOSLanguageDetectionTabHelperWasDestroyed(this);
}
if (web_state_) {
web_state_->RemoveObserver(this);
web_state_ = nullptr;
}
}
void IOSLanguageDetectionTabHelper::AddObserver(Observer* observer) {
observer_list_.AddObserver(observer);
}
void IOSLanguageDetectionTabHelper::RemoveObserver(Observer* observer) {
observer_list_.RemoveObserver(observer);
}
void IOSLanguageDetectionTabHelper::OnLanguageDetermined(
const translate::LanguageDetectionDetails& details) {
// Update language histogram.
if (url_language_histogram_ && details.is_model_reliable) {
url_language_histogram_->OnPageVisited(details.model_detected_language);
}
for (auto& observer : observer_list_) {
observer.OnLanguageDetermined(details);
}
}
// web::WebFramesManager::Observer
void IOSLanguageDetectionTabHelper::WebFrameBecameAvailable(
web::WebFramesManager* web_frames_manager,
web::WebFrame* web_frame) {
if (web_frame->IsMainFrame() && waiting_for_main_frame_) {
waiting_for_main_frame_ = false;
StartLanguageDetection();
}
}
// web::WebStateObserver implementation:
void IOSLanguageDetectionTabHelper::PageLoaded(
web::WebState* web_state,
web::PageLoadCompletionStatus load_completion_status) {
DCHECK_EQ(web_state_, web_state);
if (load_completion_status == web::PageLoadCompletionStatus::SUCCESS)
StartLanguageDetection();
}
void IOSLanguageDetectionTabHelper::DidStartNavigation(
web::WebState* web_state,
web::NavigationContext* navigation_context) {
waiting_for_main_frame_ = false;
}
void IOSLanguageDetectionTabHelper::DidFinishNavigation(
web::WebState* web_state,
web::NavigationContext* navigation_context) {
DCHECK_EQ(web_state_, web_state);
if (navigation_context->IsSameDocument()) {
StartLanguageDetection();
} else {
ExtractContentLanguageHeader(navigation_context->GetResponseHeaders());
}
}
void IOSLanguageDetectionTabHelper::WebStateDestroyed(
web::WebState* web_state) {
DCHECK_EQ(web_state_, web_state);
web_state_->RemoveObserver(this);
web_state_ = nullptr;
}
void IOSLanguageDetectionTabHelper::StartLanguageDetection() {
// Translate setting should not cancel language detection, except if it is
// disabled by policy.
if (!translate_enabled_.GetValue() && translate_enabled_.IsManaged()) {
return;
}
DCHECK(web_state_);
const GURL& url = web_state_->GetVisibleURL();
if (!web::UrlHasWebScheme(url) || !web_state_->ContentIsHTML())
return;
web::WebFramesManager* web_frames_manager =
LanguageDetectionJavaScriptFeature::GetInstance()->GetWebFramesManager(
web_state_);
web::WebFrame* web_frame = web_frames_manager->GetMainWebFrame();
if (!web_frame) {
waiting_for_main_frame_ = true;
return;
}
LanguageDetectionJavaScriptFeature::GetInstance()->StartLanguageDetection(
web_frame);
}
// Select the correct DeterminePageLanguage to call based on the feature flags.
std::string IOSLanguageDetectionTabHelper::DeterminePageLanguage(
const std::string& code,
const std::string& html_lang,
const std::u16string& contents,
std::string* model_detected_language,
bool* is_model_reliable,
float& model_reliability_score,
std::string* detection_model_version) {
if (translate::IsTFLiteLanguageDetectionEnabled() &&
language_detection_model_ && language_detection_model_->IsAvailable()) {
base::ElapsedTimer timer;
std::string tflite_language =
language_detection_model_->DeterminePageLanguage(
code, html_lang, contents, model_detected_language,
is_model_reliable, model_reliability_score);
base::UmaHistogramTimes(
kTranslateLanguageDetectionTFLiteModelEvaluationDuration,
timer.Elapsed());
*detection_model_version = language_detection_model_->GetModelVersion();
base::UmaHistogramEnumeration(
"IOS.Translate.PageLoad.LanguageDetectionMethod",
LanguageDetectionMethod::kTFLiteModelUsed);
return tflite_language;
}
if (translate::IsTFLiteLanguageDetectionEnabled()) {
base::UmaHistogramEnumeration(
"IOS.Translate.PageLoad.LanguageDetectionMethod",
LanguageDetectionMethod::kTFLiteModelUnavailable);
} else {
base::UmaHistogramEnumeration(
"IOS.Translate.PageLoad.LanguageDetectionMethod",
LanguageDetectionMethod::kTFLiteModelDisabled);
}
return ::translate::DeterminePageLanguage(
code, html_lang, contents, model_detected_language, is_model_reliable,
model_reliability_score);
}
void IOSLanguageDetectionTabHelper::OnTextRetrieved(
const bool has_notranslate,
const std::string& js_http_content_language,
const std::string& html_lang,
const GURL& url,
const base::Value* text_content) {
if (!web_state_ || web_state_->IsBeingDestroyed()) {
// If the webState is destroyed, this callback will still be called as the
// request is cancelled.
return;
}
// If there is no language defined in httpEquiv, use the HTTP header.
const std::string http_content_language = js_http_content_language.empty()
? content_language_header_
: js_http_content_language;
std::string model_detected_language;
bool is_model_reliable;
float model_reliability_score = 0.0;
std::u16string text = text_content && text_content->is_string()
? base::UTF8ToUTF16(text_content->GetString())
: std::u16string();
std::string detection_model_version = kCLDModelVersion;
std::string language =
DeterminePageLanguage(http_content_language, html_lang,
GetStringByClippingLastWord(text, kMaxIndexChars),
&model_detected_language, &is_model_reliable,
model_reliability_score, &detection_model_version);
if (language.empty())
return; // No language detected.
// Avoid an unnecessary copy of the full text content (which can be
// ~64kB) until we need it on iOS (e.g. for the translate internals
// page).
translate::LanguageDetectionDetails details;
details.time = base::Time::Now();
details.url = url;
details.has_notranslate = has_notranslate;
details.content_language = http_content_language;
details.model_detected_language = model_detected_language;
details.is_model_reliable = is_model_reliable;
details.html_root_language = html_lang;
details.adopted_language = language;
details.detection_model_version = detection_model_version;
OnLanguageDetermined(details);
}
base::WeakPtr<IOSLanguageDetectionTabHelper>
IOSLanguageDetectionTabHelper::GetWeakPtr() {
return weak_method_factory_.GetWeakPtr();
}
void IOSLanguageDetectionTabHelper::ExtractContentLanguageHeader(
net::HttpResponseHeaders* headers) {
if (!headers) {
content_language_header_.clear();
return;
}
content_language_header_ =
headers->GetNormalizedHeader("content-language").value_or(std::string());
// Remove everything after the comma ',' if any.
size_t comma_index = content_language_header_.find_first_of(',');
if (comma_index != std::string::npos)
content_language_header_.resize(comma_index);
}
} // namespace language
|