File: page_tool.cc

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (297 lines) | stat: -rw-r--r-- 11,772 bytes parent folder | download
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
// Copyright 2025 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/actor/tools/page_tool.h"

#include "chrome/browser/actor/actor_coordinator.h"
#include "chrome/common/actor/action_result.h"
#include "chrome/common/chrome_render_frame.mojom.h"
#include "content/public/browser/render_frame_host.h"
#include "mojo/public/cpp/bindings/associated_remote.h"
#include "third_party/abseil-cpp/absl/strings/str_format.h"
#include "third_party/blink/public/common/associated_interfaces/associated_interface_provider.h"
#include "ui/gfx/geometry/point.h"

namespace {

using ::content::RenderFrameHost;
using ::optimization_guide::proto::ActionInformation;
using ::optimization_guide::proto::ActionTarget;
using ::optimization_guide::proto::ClickAction_ClickCount;
using ::optimization_guide::proto::ClickAction_ClickType;
using ::optimization_guide::proto::ScrollAction_ScrollDirection;
using ::optimization_guide::proto::TypeAction_TypeMode;

void SetMojoTarget(const ActionTarget& target,
                   actor::mojom::ToolTargetPtr& out_mojo_target) {
  if (target.has_coordinate()) {
    out_mojo_target = actor::mojom::ToolTarget::NewCoordinate(
        gfx::Point(target.coordinate().x(), target.coordinate().y()));
  } else {
    // A ContentNodeId of 0 indicates the viewport. The mojo message indicates
    // viewport by omitting a target.
    if (target.content_node_id() > 0) {
      out_mojo_target =
          actor::mojom::ToolTarget::NewDomNodeId(target.content_node_id());
    }
  }
}

// Set mojom for click action based on proto. Returns false if the proto does
// not contain correct/sufficient information, true otherwise.
bool SetClickToolArgs(actor::mojom::ClickActionPtr& click,
                      const ActionInformation& action_info) {
  SetMojoTarget(action_info.click().target(), click->target);

  switch (action_info.click().click_type()) {
    case ClickAction_ClickType::ClickAction_ClickType_LEFT:
      click->type = actor::mojom::ClickAction::Type::kLeft;
      break;
    case ClickAction_ClickType::ClickAction_ClickType_RIGHT:
      click->type = actor::mojom::ClickAction::Type::kRight;
      break;
    case ClickAction_ClickType::ClickAction_ClickType_UNKNOWN_CLICK_TYPE:
    case ClickAction_ClickType::
        ClickAction_ClickType_ClickAction_ClickType_INT_MAX_SENTINEL_DO_NOT_USE_:
    case ClickAction_ClickType::
        ClickAction_ClickType_ClickAction_ClickType_INT_MIN_SENTINEL_DO_NOT_USE_:
      // TODO(issuetracker.google.com/412700289): Revert once this is set.
      click->type = actor::mojom::ClickAction::Type::kLeft;
      break;
      // return false;
  }

  switch (action_info.click().click_count()) {
    case ClickAction_ClickCount::ClickAction_ClickCount_SINGLE:
      click->count = actor::mojom::ClickAction::Count::kSingle;
      break;
    case ClickAction_ClickCount::ClickAction_ClickCount_DOUBLE:
      click->count = actor::mojom::ClickAction::Count::kDouble;
      break;
    case ClickAction_ClickCount::ClickAction_ClickCount_UNKNOWN_CLICK_COUNT:
    case ClickAction_ClickCount::
        ClickAction_ClickCount_ClickAction_ClickCount_INT_MIN_SENTINEL_DO_NOT_USE_:
    case ClickAction_ClickCount::
        ClickAction_ClickCount_ClickAction_ClickCount_INT_MAX_SENTINEL_DO_NOT_USE_:
      // TODO(issuetracker.google.com/412700289): Revert once this is set.
      click->count = actor::mojom::ClickAction::Count::kSingle;
      break;
      // return false;
  }
  return true;
}

// Set mojom for mouse move action based on proto.
void SetMouseMoveToolArgs(actor::mojom::MouseMoveActionPtr& move,
                          const ActionInformation& action_info) {
  SetMojoTarget(action_info.move_mouse().target(), move->target);
}

// Set mojom for type action based on proto.
// Returns false if the proto does not contain correct/sufficient information,
// true otherwise.
bool SetTypeToolArgs(actor::mojom::TypeActionPtr& type_action,
                     const ActionInformation& action_info) {
  SetMojoTarget(action_info.type().target(), type_action->target);

  type_action->text = action_info.type().text();
  type_action->follow_by_enter = action_info.type().follow_by_enter();

  // Map proto enum to mojom enum
  switch (action_info.type().mode()) {
    case TypeAction_TypeMode::TypeAction_TypeMode_DELETE_EXISTING:
      type_action->mode = actor::mojom::TypeAction::Mode::kDeleteExisting;
      break;
    case TypeAction_TypeMode::TypeAction_TypeMode_PREPEND:
      type_action->mode = actor::mojom::TypeAction::Mode::kPrepend;
      break;
    case TypeAction_TypeMode::TypeAction_TypeMode_APPEND:
      type_action->mode = actor::mojom::TypeAction::Mode::kAppend;
      break;
    case TypeAction_TypeMode::TypeAction_TypeMode_UNKNOWN_TYPE_MODE:
    case TypeAction_TypeMode::
        TypeAction_TypeMode_TypeAction_TypeMode_INT_MIN_SENTINEL_DO_NOT_USE_:
    case TypeAction_TypeMode::
        TypeAction_TypeMode_TypeAction_TypeMode_INT_MAX_SENTINEL_DO_NOT_USE_:
      // TODO(issuetracker.google.com/412700289): Revert once this is set.
      type_action->mode = actor::mojom::TypeAction::Mode::kDeleteExisting;
      break;
      //      DLOG(ERROR) << "TypeAction proto type mode not supported"
      //                  << action_info.type().mode();
      //      return false;
  }

  return true;
}

bool SetScrollToolArgs(actor::mojom::ScrollActionPtr& scroll,
                       const ActionInformation& action_info) {
  if (action_info.scroll().has_target()) {
    SetMojoTarget(action_info.scroll().target(), scroll->target);
  }
  switch (action_info.scroll().direction()) {
    case ScrollAction_ScrollDirection::ScrollAction_ScrollDirection_LEFT:
      scroll->direction = actor::mojom::ScrollAction::ScrollDirection::kLeft;
      break;
    case ScrollAction_ScrollDirection::ScrollAction_ScrollDirection_RIGHT:
      scroll->direction = actor::mojom::ScrollAction::ScrollDirection::kRight;
      break;
    case ScrollAction_ScrollDirection::ScrollAction_ScrollDirection_UP:
      scroll->direction = actor::mojom::ScrollAction::ScrollDirection::kUp;
      break;
    case ScrollAction_ScrollDirection::ScrollAction_ScrollDirection_DOWN:
      scroll->direction = actor::mojom::ScrollAction::ScrollDirection::kDown;
      break;
    case ScrollAction_ScrollDirection::
        ScrollAction_ScrollDirection_UNKNOWN_SCROLL_DIRECTION:
    case ScrollAction_ScrollDirection::
        ScrollAction_ScrollDirection_ScrollAction_ScrollDirection_INT_MIN_SENTINEL_DO_NOT_USE_:
    case ScrollAction_ScrollDirection::
        ScrollAction_ScrollDirection_ScrollAction_ScrollDirection_INT_MAX_SENTINEL_DO_NOT_USE_:
      // TODO(issuetracker.google.com/412700289): Revert once this is set.
      scroll->direction = actor::mojom::ScrollAction::ScrollDirection::kDown;
      break;
      // return false;
  }
  scroll->distance = action_info.scroll().distance();
  return true;
}

void SetSelectToolArgs(actor::mojom::SelectActionPtr& select,
                       const ActionInformation& action_info) {
  SetMojoTarget(action_info.select().target(), select->target);
  select->value = action_info.select().value();
}

void SetDragAndReleaseToolArgs(
    actor::mojom::DragAndReleaseActionPtr& drag_and_release,
    ActionInformation action_info) {
  SetMojoTarget(action_info.drag_and_release().from_target(),
                drag_and_release->from_target);
  SetMojoTarget(action_info.drag_and_release().to_target(),
                drag_and_release->to_target);
}

}  // namespace

namespace actor {

PageTool::PageTool(RenderFrameHost& frame, const ToolInvocation& invocation)
    : invocation_(invocation) {
  frame.GetRemoteAssociatedInterfaces()->GetInterface(&chrome_render_frame_);
}

PageTool::~PageTool() = default;

void PageTool::Validate(ValidateCallback callback) {
  // No browser-side validation yet.
  base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
      FROM_HERE, base::BindOnce(std::move(callback), MakeOkResult()));
}

void PageTool::Invoke(InvokeCallback callback) {
  auto request = actor::mojom::ToolInvocation::New();
  auto action_info = invocation_.GetActionInfo();

  switch (action_info.action_info_case()) {
    case ActionInformation::ActionInfoCase::kClick: {
      auto click = mojom::ClickAction::New();
      if (!SetClickToolArgs(click, action_info)) {
        std::move(callback).Run(
            MakeResult(mojom::ActionResultCode::kArgumentsInvalid));
        return;
      }
      request->action = mojom::ToolAction::NewClick(std::move(click));
      break;
    }
    case ActionInformation::ActionInfoCase::kType: {
      auto type = mojom::TypeAction::New();
      if (!SetTypeToolArgs(type, action_info)) {
        std::move(callback).Run(
            MakeResult(mojom::ActionResultCode::kArgumentsInvalid));
        return;
      }
      request->action = mojom::ToolAction::NewType(std::move(type));
      break;
    }
    case ActionInformation::ActionInfoCase::kScroll: {
      auto scroll = mojom::ScrollAction::New();
      if (!SetScrollToolArgs(scroll, action_info)) {
        std::move(callback).Run(
            MakeResult(mojom::ActionResultCode::kArgumentsInvalid));
        return;
      }
      request->action = mojom::ToolAction::NewScroll(std::move(scroll));
      break;
    }
    case ActionInformation::ActionInfoCase::kMoveMouse: {
      auto mouse_move = mojom::MouseMoveAction::New();
      SetMouseMoveToolArgs(mouse_move, action_info);
      request->action = mojom::ToolAction::NewMouseMove(std::move(mouse_move));
      break;
    }
    case ActionInformation::ActionInfoCase::kDragAndRelease: {
      auto drag_and_release = mojom::DragAndReleaseAction::New();
      SetDragAndReleaseToolArgs(drag_and_release, action_info);
      request->action =
          mojom::ToolAction::NewDragAndRelease(std::move(drag_and_release));
      break;
    }
    case ActionInformation::ActionInfoCase::kSelect: {
      auto select = mojom::SelectAction::New();
      SetSelectToolArgs(select, action_info);
      request->action = mojom::ToolAction::NewSelect(std::move(select));
      break;
    }
    case ActionInformation::ActionInfoCase::kNavigate:
    case ActionInformation::ActionInfoCase::kBack:
    case ActionInformation::ActionInfoCase::kForward:
    case ActionInformation::ActionInfoCase::kWait:
    case ActionInformation::ActionInfoCase::ACTION_INFO_NOT_SET:
      NOTREACHED();
  }

  chrome_render_frame_->InvokeTool(std::move(request), std::move(callback));
}

std::string PageTool::DebugString() const {
  std::string tool_type;
  // TODO(crbug.com/402210051): Add more details here about tool params.
  switch (invocation_.GetActionInfo().action_info_case()) {
    case ActionInformation::ActionInfoCase::kClick: {
      tool_type = "Click";
      break;
    }
    case ActionInformation::ActionInfoCase::kType: {
      tool_type = "Type";
      break;
    }
    case ActionInformation::ActionInfoCase::kScroll: {
      tool_type = "Scroll";
      break;
    }
    case ActionInformation::ActionInfoCase::kMoveMouse: {
      tool_type = "MoveMouse";
      break;
    }
    case ActionInformation::ActionInfoCase::kDragAndRelease: {
      tool_type = "DragAndRelease";
      break;
    }
    case ActionInformation::ActionInfoCase::kSelect: {
      tool_type = "Select";
      break;
    }
    case ActionInformation::ActionInfoCase::kNavigate:
    case ActionInformation::ActionInfoCase::kBack:
    case ActionInformation::ActionInfoCase::kForward:
    case ActionInformation::ActionInfoCase::kWait:
    case ActionInformation::ActionInfoCase::ACTION_INFO_NOT_SET:
      NOTREACHED();
  }

  return absl::StrFormat("PageTool:%s", tool_type.c_str());
}

}  // namespace actor