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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_TRANSLATE_CONTENT_BROWSER_CONTENT_TRANSLATE_DRIVER_H_
#define COMPONENTS_TRANSLATE_CONTENT_BROWSER_CONTENT_TRANSLATE_DRIVER_H_
#include <map>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/scoped_observation_traits.h"
#include "base/time/time.h"
#include "components/translate/content/common/translate.mojom.h"
#include "components/translate/core/browser/translate_driver.h"
#include "components/translate/core/common/translate_errors.h"
#include "content/public/browser/web_contents_observer.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver_set.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
namespace content {
class WebContents;
} // namespace content
namespace language {
class UrlLanguageHistogram;
} // namespace language
namespace translate {
struct LanguageDetectionDetails;
class TranslateManager;
// Content implementation of TranslateDriver.
class ContentTranslateDriver : public TranslateDriver,
public translate::mojom::ContentTranslateDriver,
public content::WebContentsObserver {
public:
class TranslationObserver : public base::CheckedObserver {
public:
// Handles when the value of IsPageTranslated is changed.
virtual void OnIsPageTranslatedChanged(content::WebContents* source) {}
// Handles when the value of translate_enabled is changed.
virtual void OnTranslateEnabledChanged(content::WebContents* source) {}
// Called when the page has been translated.
virtual void OnPageTranslated(const std::string& source_lang,
const std::string& translated_lang,
translate::TranslateErrors error_type) {}
};
ContentTranslateDriver(
content::WebContents& web_contents,
language::UrlLanguageHistogram* url_language_histogram);
ContentTranslateDriver(const ContentTranslateDriver&) = delete;
ContentTranslateDriver& operator=(const ContentTranslateDriver&) = delete;
~ContentTranslateDriver() override;
// Adds or removes observers.
void AddTranslationObserver(TranslationObserver* observer);
void RemoveTranslationObserver(TranslationObserver* observer);
// Number of attempts before waiting for a page to be fully reloaded.
void set_translate_max_reload_attempts(int attempts) {
max_reload_check_attempts_ = attempts;
}
// Sets the TranslateManager associated with this driver.
void set_translate_manager(TranslateManager* manager) {
translate_manager_ = manager;
}
// Initiates translation once the page is finished loading.
void InitiateTranslation(const std::string& page_lang, int attempt);
// TranslateDriver methods.
void OnIsPageTranslatedChanged() override;
void OnTranslateEnabledChanged() override;
bool IsLinkNavigation() override;
void TranslatePage(int page_seq_no,
const std::string& translate_script,
const std::string& source_lang,
const std::string& target_lang) override;
void RevertTranslation(int page_seq_no) override;
bool IsIncognito() const override;
const std::string& GetContentsMimeType() override;
const GURL& GetLastCommittedURL() const override;
const GURL& GetVisibleURL() override;
ukm::SourceId GetUkmSourceId() override;
bool HasCurrentPage() const override;
// content::WebContentsObserver implementation.
void DidFinishNavigation(
content::NavigationHandle* navigation_handle) override;
void OnPageTranslated(bool cancelled,
const std::string& source_lang,
const std::string& translated_lang,
TranslateErrors error_type);
// Adds a receiver in |receivers_| for the passed |receiver|.
void AddReceiver(
mojo::PendingReceiver<translate::mojom::ContentTranslateDriver> receiver);
// Called when a page has been loaded and can be potentially translated.
void RegisterPage(
mojo::PendingRemote<translate::mojom::TranslateAgent> translate_agent,
const translate::LanguageDetectionDetails& details,
bool page_level_translation_criteria_met) override;
private:
void OnPageAway(int page_seq_no);
void InitiateTranslationIfReload(
content::NavigationHandle* navigation_handle);
raw_ptr<TranslateManager, DanglingUntriaged> translate_manager_;
base::ObserverList<TranslationObserver, true> translation_observers_;
// Whether the associated browser context is off the record.
bool is_otr_context_;
// The last committed URL of the primary main frame of the contents.
GURL last_committed_url_;
// Max number of attempts before checking if a page has been reloaded.
int max_reload_check_attempts_;
// Records mojo connections with all current alive pages.
int next_page_seq_no_;
// mojo::Remote<TranslateAgent> is the connection between this driver and a
// TranslateAgent (which are per RenderFrame). Each TranslateAgent has a
// |binding_| member, representing the other end of this pipe.
std::map<int, mojo::Remote<mojom::TranslateAgent>> translate_agents_;
// Histogram to be notified about detected language of every page visited. Not
// owned here.
const raw_ptr<language::UrlLanguageHistogram> language_histogram_;
// ContentTranslateDriver is a singleton per web contents but multiple render
// frames may be contained in a single web contents. TranslateAgents get the
// other end of this receiver in the form of a ContentTranslateDriver.
mojo::ReceiverSet<translate::mojom::ContentTranslateDriver> receivers_;
// Time when the navigation was finished (i.e., DidFinishNavigation
// in the main frame). This is used to know a duration time to when the
// page language is determined.
base::TimeTicks finish_navigation_time_;
base::WeakPtrFactory<ContentTranslateDriver> weak_pointer_factory_{this};
};
} // namespace translate
namespace base {
template <>
struct ScopedObservationTraits<
translate::ContentTranslateDriver,
translate::ContentTranslateDriver::TranslationObserver> {
static void AddObserver(
translate::ContentTranslateDriver* source,
translate::ContentTranslateDriver::TranslationObserver* observer) {
source->AddTranslationObserver(observer);
}
static void RemoveObserver(
translate::ContentTranslateDriver* source,
translate::ContentTranslateDriver::TranslationObserver* observer) {
source->RemoveTranslationObserver(observer);
}
};
} // namespace base
#endif // COMPONENTS_TRANSLATE_CONTENT_BROWSER_CONTENT_TRANSLATE_DRIVER_H_
|
