File: editor_mediator.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (425 lines) | stat: -rw-r--r-- 15,105 bytes parent folder | download | duplicates (6)
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
// Copyright 2023 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/ash/input_method/editor_mediator.h"

#include <optional>
#include <string_view>

#include "ash/constants/ash_pref_names.h"
#include "ash/shell.h"
#include "base/check_op.h"
#include "base/containers/contains.h"
#include "base/containers/fixed_flat_set.h"
#include "chrome/browser/ash/input_method/editor_consent_enums.h"
#include "chrome/browser/ash/input_method/editor_geolocation_provider.h"
#include "chrome/browser/ash/input_method/editor_metrics_enums.h"
#include "chrome/browser/ash/input_method/editor_metrics_recorder.h"
#include "chrome/browser/ash/input_method/editor_query_context.h"
#include "chrome/browser/ash/input_method/editor_text_query_from_manta.h"
#include "chrome/browser/ash/input_method/editor_text_query_from_memory.h"
#include "chrome/browser/ash/input_method/editor_text_query_provider.h"
#include "chrome/browser/ash/input_method/editor_transition_enums.h"
#include "chrome/browser/ash/magic_boost/magic_boost_controller_ash.h"
#include "chrome/browser/ash/profiles/profile_helper.h"
#include "chrome/browser/ui/webui/ash/mako/mako_bubble_coordinator.h"
#include "chromeos/ash/components/editor_menu/public/cpp/editor_consent_status.h"
#include "chromeos/ash/components/editor_menu/public/cpp/editor_helpers.h"
#include "chromeos/ash/components/editor_menu/public/cpp/editor_mode.h"
#include "chromeos/ash/components/editor_menu/public/cpp/editor_text_selection_mode.h"
#include "chromeos/components/magic_boost/public/cpp/magic_boost_state.h"
#include "ui/base/ime/ash/ime_bridge.h"
#include "ui/display/screen.h"
#include "ui/display/tablet_state.h"

namespace ash::input_method {
namespace {

constexpr std::u16string_view kAnnouncementViewName = u"Orca";

crosapi::mojom::MagicBoostController::TransitionAction
ConvertToMagicBoostTransitionAction(EditorNoticeTransitionAction action) {
  switch (action) {
    case EditorNoticeTransitionAction::kDoNothing:
      return crosapi::mojom::MagicBoostController::TransitionAction::kDoNothing;
    case EditorNoticeTransitionAction::kShowEditorPanel:
      return crosapi::mojom::MagicBoostController::TransitionAction::
          kShowEditorPanel;
  }
}

}  // namespace

EditorMediator::EditorMediator(
    Profile* profile,
    std::unique_ptr<EditorGeolocationProvider> editor_geolocation_provider)
    : profile_(profile),
      panel_manager_(this),
      editor_geolocation_provider_(std::move(editor_geolocation_provider)),
      editor_context_(this, this, editor_geolocation_provider_.get()),
      editor_switch_(
          std::make_unique<EditorSwitch>(this, profile, &editor_context_)),
      metrics_recorder_(
          std::make_unique<EditorMetricsRecorder>(&editor_context_,
                                                  GetEditorOpportunityMode())),
      consent_store_(
          std::make_unique<EditorConsentStore>(profile->GetPrefs(),
                                               metrics_recorder_.get())),
      announcer_(kAnnouncementViewName) {
  editor_context_.OnTabletModeUpdated(
      display::Screen::GetScreen()->InTabletMode());
}

EditorMediator::~EditorMediator() = default;

void EditorMediator::BindEditorClient(
    mojo::PendingReceiver<orca::mojom::EditorClient> pending_receiver) {
  if (IsServiceConnected()) {
    service_connection_->editor_client_connector()->BindEditorClient(
        std::move(pending_receiver));
  }
}

void EditorMediator::OnEditorServiceConnected(bool is_connection_successful) {}

bool EditorMediator::IsServiceConnected() {
  return editor_service_connector_ && editor_service_connector_->IsBound() &&
         service_connection_;
}

void EditorMediator::ResetEditorConnections() {
  if (editor_service_connector_) {
    service_connection_ = std::make_unique<ServiceConnection>(
        profile_, this, metrics_recorder_.get(),
        editor_service_connector_.get());
    panel_manager_.BindEditorClient();
  }
}

void EditorMediator::OnContextUpdated() {
  editor_switch_->OnContextUpdated();
}

void EditorMediator::OnImeChange(std::string_view engine_id) {
  if (base::FeatureList::IsEnabled(ash::features::kOrcaServiceConnection) &&
      service_connection_) {
    ResetEditorConnections();
  }
}

std::optional<ukm::SourceId> EditorMediator::GetUkmSourceId() {
  TextInputTarget* text_input = IMEBridge::Get()->GetInputContextHandler();
  if (!text_input) {
    return std::nullopt;
  }

  ukm::SourceId source_id = text_input->GetClientSourceForMetrics();
  if (source_id == ukm::kInvalidSourceId) {
    return std::nullopt;
  }
  return source_id;
}

void EditorMediator::OnFocus(int context_id) {
  if (mako_bubble_coordinator_.IsShowingUI() ||
      panel_manager_.IsEditorMenuVisible()) {
    return;
  }

  if (IsAllowedForUse() && !editor_service_connector_) {
    editor_service_connector_ =
        std::make_unique<EditorServiceConnector>(&editor_context_);
    ResetEditorConnections();
  }

  if (IsServiceConnected()) {
    service_connection_->system_actuator()->OnFocus(context_id);
  }
}

void EditorMediator::OnBlur() {
  if (mako_bubble_coordinator_.IsShowingUI() ||
      panel_manager_.IsEditorMenuVisible()) {
    return;
  }
}

void EditorMediator::OnActivateIme(std::string_view engine_id) {
  editor_context_.OnActivateIme(engine_id);

  if (base::FeatureList::IsEnabled(ash::features::kOrcaServiceConnection) &&
      IsServiceConnected()) {
    ResetEditorConnections();
  }
}

void EditorMediator::OnDisplayTabletStateChanged(display::TabletState state) {
  switch (state) {
    case display::TabletState::kInClamshellMode:
      editor_context_.OnTabletModeUpdated(/*tablet_mode_enabled=*/false);
      break;
    case display::TabletState::kEnteringTabletMode:
      editor_context_.OnTabletModeUpdated(/*tablet_mode_enabled=*/true);
      if (mako_bubble_coordinator_.IsShowingUI()) {
        mako_bubble_coordinator_.CloseUI();
      }
      break;
    case display::TabletState::kInTabletMode:
    case display::TabletState::kExitingTabletMode:
      break;
  }
}

void EditorMediator::OnSurroundingTextChanged(const std::u16string& text,
                                              gfx::Range selection_range) {
  if (mako_bubble_coordinator_.IsShowingUI() ||
      panel_manager_.IsEditorMenuVisible()) {
    return;
  }

  surrounding_text_ = {.text = text, .selection_range = selection_range};
}

void EditorMediator::Announce(const std::u16string& message) {
  announcer_.Announce(message);
}

void EditorMediator::ProcessConsentAction(ConsentAction consent_action) {
  consent_store_->ProcessConsentAction(consent_action);
}

void EditorMediator::ShowUI() {
  mako_bubble_coordinator_.ShowUI();
}

void EditorMediator::CloseUI() {
  mako_bubble_coordinator_.CloseUI();
}

size_t EditorMediator::GetSelectedTextLength() {
  return surrounding_text_.selection_range.length();
}

void EditorMediator::OnEditorModeChanged(
    chromeos::editor_menu::EditorMode mode) {
  panel_manager_.NotifyEditorModeChanged(mode);
}

void EditorMediator::OnPromoCardDeclined() {
  consent_store_->ProcessPromoCardAction(PromoCardAction::kDecline);
}

void EditorMediator::HandleTrigger(
    std::optional<std::string_view> preset_query_id,
    std::optional<std::string_view> freeform_text) {
  metrics_recorder_->SetTone(preset_query_id, freeform_text);

  EditorQueryContext active_query_context =
      query_context_.has_value()
          ? EditorQueryContext{query_context_->preset_query_id,
                               query_context_->freeform_text}
          : EditorQueryContext{preset_query_id, freeform_text};

  switch (GetEditorMode()) {
    case chromeos::editor_menu::EditorMode::kRewrite:
      mako_bubble_coordinator_.LoadEditorUI(
          profile_, MakoEditorMode::kRewrite,
          /*can_fallback_to_center_position=*/true,
          /*feedback_enabled=*/CanAccessFeedback(),
          active_query_context.preset_query_id,
          active_query_context.freeform_text);
      query_context_ = std::nullopt;
      metrics_recorder_->LogEditorState(EditorStates::kNativeRequest);
      break;
    case chromeos::editor_menu::EditorMode::kWrite:
      mako_bubble_coordinator_.LoadEditorUI(
          profile_, MakoEditorMode::kWrite,
          /*can_fallback_to_center_position=*/true,
          /*feedback_enabled=*/CanAccessFeedback(),
          active_query_context.preset_query_id,
          active_query_context.freeform_text);
      query_context_ = std::nullopt;
      metrics_recorder_->LogEditorState(EditorStates::kNativeRequest);
      break;
    case chromeos::editor_menu::EditorMode::kConsentNeeded:
      query_context_ = EditorQueryContext(/*preset_query_id=*/preset_query_id,
                                          /*freeform_text=*/freeform_text);
      ShowNotice(EditorNoticeTransitionAction::kShowEditorPanel);
      metrics_recorder_->LogEditorState(EditorStates::kConsentScreenImpression);
      break;
    case chromeos::editor_menu::EditorMode::kHardBlocked:
    case chromeos::editor_menu::EditorMode::kSoftBlocked:
      mako_bubble_coordinator_.CloseUI();
  }
}

void EditorMediator::ShowNotice(
    EditorNoticeTransitionAction transition_action) {
  if (chromeos::MagicBoostState::Get()->IsMagicBoostAvailable()) {
    ash::MagicBoostControllerAsh::Get()->ShowDisclaimerUi(
        /*display_id=*/display::Screen::GetScreen()->GetPrimaryDisplay().id(),
        /*action=*/
        ConvertToMagicBoostTransitionAction(transition_action),
        /*opt_in_features=*/OptInFeatures::kOrcaAndHmr);
    return;
  }

  if (IsServiceConnected()) {
    service_connection_->system_actuator()->SetNoticeTransitionAction(
        transition_action);
  }

  mako_bubble_coordinator_.LoadConsentUI(profile_);
}

void EditorMediator::CacheContext() {
  OnTextFieldContextualInfoChanged(GetTextFieldContextualInfo());

  mako_bubble_coordinator_.CacheContextCaretBounds();

  size_t selected_length =
      chromeos::editor_helpers::NonWhitespaceAndSymbolsLength(
          surrounding_text_.text, surrounding_text_.selection_range);
  editor_context_.OnTextSelectionLengthChanged(selected_length);

  if (IsServiceConnected()) {
    service_connection_->editor_event_proxy()->OnSurroundingTextChanged(
        surrounding_text_.text, surrounding_text_.selection_range);
  }
}

void EditorMediator::FetchAndUpdateInputContextForTesting() {
  OnTextFieldContextualInfoChanged(GetTextFieldContextualInfo());
}

EditorMediator::ServiceConnection::ServiceConnection(
    Profile* profile,
    EditorMediator* mediator,
    EditorMetricsRecorder* metrics_recorder,
    EditorServiceConnector* service_connector) {
  mojo::PendingAssociatedRemote<orca::mojom::SystemActuator>
      system_actuator_remote;
  mojo::PendingAssociatedRemote<orca::mojom::TextQueryProvider>
      text_query_provider_remote;
  mojo::PendingAssociatedReceiver<orca::mojom::EditorClientConnector>
      editor_client_connector_receiver;
  mojo::PendingAssociatedReceiver<orca::mojom::EditorEventSink>
      editor_event_sink_receiver;

  system_actuator_ = std::make_unique<EditorSystemActuator>(
      profile, system_actuator_remote.InitWithNewEndpointAndPassReceiver(),
      mediator);
  text_query_provider_ = std::make_unique<EditorTextQueryProvider>(
      text_query_provider_remote.InitWithNewEndpointAndPassReceiver(),
      metrics_recorder, std::make_unique<EditorTextQueryFromManta>(profile));
  editor_client_connector_ = std::make_unique<EditorClientConnector>(
      editor_client_connector_receiver.InitWithNewEndpointAndPassRemote());
  editor_event_proxy_ = std::make_unique<EditorEventProxy>(
      editor_event_sink_receiver.InitWithNewEndpointAndPassRemote());

  service_connector->BindEditor(std::move(editor_client_connector_receiver),
                                std::move(editor_event_sink_receiver),
                                std::move(system_actuator_remote),
                                std::move(text_query_provider_remote));
}

EditorMediator::ServiceConnection::~ServiceConnection() = default;

EditorEventProxy* EditorMediator::ServiceConnection::editor_event_proxy() {
  return editor_event_proxy_.get();
}

EditorClientConnector*
EditorMediator::ServiceConnection::editor_client_connector() {
  return editor_client_connector_.get();
}

EditorTextQueryProvider*
EditorMediator::ServiceConnection::text_query_provider() {
  return text_query_provider_.get();
}

EditorSystemActuator* EditorMediator::ServiceConnection::system_actuator() {
  return system_actuator_.get();
}

void EditorMediator::OnTextFieldContextualInfoChanged(
    const TextFieldContextualInfo& info) {
  editor_context_.OnInputContextUpdated(
      IMEBridge::Get()->GetCurrentInputContext(), info);

  if (IsServiceConnected()) {
    service_connection_->system_actuator()->OnInputContextUpdated(info.tab_url);
  }
}

bool EditorMediator::IsAllowedForUse() {
  return editor_switch_->IsAllowedForUse();
}

bool EditorMediator::CanAccessFeedback() {
  return editor_switch_->IsFeedbackEnabled();
}

bool EditorMediator::CanShowNoticeBanner() const {
  return editor_switch_->CanShowNoticeBanner();
}

chromeos::editor_menu::EditorMode EditorMediator::GetEditorMode() const {
  if (editor_mode_override_for_testing_.has_value()) {
    return *editor_mode_override_for_testing_;
  }
  return editor_switch_->GetEditorMode();
}

chromeos::editor_menu::EditorTextSelectionMode
EditorMediator::GetEditorTextSelectionMode() const {
  return editor_switch_->GetEditorTextSelectionMode();
}

chromeos::editor_menu::EditorConsentStatus EditorMediator::GetConsentStatus()
    const {
  return consent_store_->GetConsentStatus();
}

EditorMetricsRecorder* EditorMediator::GetMetricsRecorder() {
  return metrics_recorder_.get();
}

EditorOpportunityMode EditorMediator::GetEditorOpportunityMode() const {
  return editor_switch_->GetEditorOpportunityMode();
}

std::vector<EditorBlockedReason> EditorMediator::GetBlockedReasons() const {
  return editor_switch_->GetBlockedReasons();
}

void EditorMediator::Shutdown() {
  // Note that this method is part of the two-phase shutdown completed by a
  // KeyedService. This method is invoked as the first phase, and is called
  // prior to the destruction of the keyed profile (this allows us to cleanup
  // any resources that depend on a valid profile instance - ie WebUI). The
  // second phase is the destruction of the eKeyedService itself.
  mako_bubble_coordinator_.CloseUI();
  profile_ = nullptr;
  consent_store_ = nullptr;
  editor_switch_ = nullptr;
}

bool EditorMediator::SetTextQueryProviderResponseForTesting(
    const std::vector<std::string>& mock_results) {
  if (!IsServiceConnected()) {
    return false;
  }
  service_connection_->text_query_provider()->SetProvider(
      std::make_unique<EditorTextQueryFromMemory>(mock_results));  // IN-TEST
  return true;
}

void EditorMediator::OverrideEditorModeForTesting(
    chromeos::editor_menu::EditorMode editor_mode) {
  editor_mode_override_for_testing_ = editor_mode;
}

}  // namespace ash::input_method