Client.cpp 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. /*
  2. * Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com>
  3. * Copyright (c) 2022, Sam Atkins <atkinssj@serenityos.org>
  4. * Copyright (c) 2022, Tobias Christiansen <tobyase@serenityos.org>
  5. * Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
  6. * Copyright (c) 2022-2024, Tim Flynn <trflynn89@ladybird.org>
  7. *
  8. * SPDX-License-Identifier: BSD-2-Clause
  9. */
  10. #include <AK/Debug.h>
  11. #include <AK/JsonObject.h>
  12. #include <AK/JsonValue.h>
  13. #include <LibCore/EventLoop.h>
  14. #include <LibCore/Timer.h>
  15. #include <LibWeb/WebDriver/Capabilities.h>
  16. #include <LibWeb/WebDriver/TimeoutsConfiguration.h>
  17. #include <WebDriver/Client.h>
  18. namespace WebDriver {
  19. Atomic<unsigned> Client::s_next_session_id;
  20. HashMap<unsigned, NonnullRefPtr<Session>> Client::s_sessions;
  21. ErrorOr<NonnullRefPtr<Client>> Client::try_create(NonnullOwnPtr<Core::BufferedTCPSocket> socket, LaunchBrowserCallbacks callbacks, Core::EventReceiver* parent)
  22. {
  23. if (!callbacks.launch_browser || !callbacks.launch_headless_browser)
  24. return Error::from_string_literal("All callbacks to launch a browser must be provided");
  25. TRY(socket->set_blocking(true));
  26. return adopt_nonnull_ref_or_enomem(new (nothrow) Client(move(socket), move(callbacks), parent));
  27. }
  28. Client::Client(NonnullOwnPtr<Core::BufferedTCPSocket> socket, LaunchBrowserCallbacks callbacks, Core::EventReceiver* parent)
  29. : Web::WebDriver::Client(move(socket), parent)
  30. , m_callbacks(move(callbacks))
  31. {
  32. }
  33. Client::~Client() = default;
  34. ErrorOr<NonnullRefPtr<Session>, Web::WebDriver::Error> Client::find_session_with_id(StringView session_id, AllowInvalidWindowHandle allow_invalid_window_handle)
  35. {
  36. auto session_id_or_error = session_id.to_number<unsigned>();
  37. if (!session_id_or_error.has_value())
  38. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidSessionId, "Invalid session id");
  39. if (auto session = s_sessions.get(*session_id_or_error); session.has_value()) {
  40. if (allow_invalid_window_handle == AllowInvalidWindowHandle::No)
  41. TRY(session.value()->ensure_current_window_handle_is_valid());
  42. return *session.release_value();
  43. }
  44. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidSessionId, "Invalid session id");
  45. }
  46. void Client::close_session(unsigned session_id)
  47. {
  48. if (s_sessions.remove(session_id))
  49. dbgln_if(WEBDRIVER_DEBUG, "Shut down session {}", session_id);
  50. else
  51. dbgln_if(WEBDRIVER_DEBUG, "Unable to shut down session {}: Not found", session_id);
  52. }
  53. // Step 12 of https://w3c.github.io/webdriver/#dfn-new-sessions
  54. static void initialize_session_from_capabilities(WebContentConnection& web_content_connection, JsonObject& capabilities)
  55. {
  56. // 1. Let strategy be the result of getting property "pageLoadStrategy" from capabilities.
  57. auto strategy = capabilities.get_byte_string("pageLoadStrategy"sv);
  58. // 2. If strategy is a string, set the current session’s page loading strategy to strategy. Otherwise, set the page loading strategy to normal and set a property of capabilities with name "pageLoadStrategy" and value "normal".
  59. if (strategy.has_value())
  60. web_content_connection.async_set_page_load_strategy(Web::WebDriver::page_load_strategy_from_string(*strategy));
  61. else
  62. capabilities.set("pageLoadStrategy"sv, "normal"sv);
  63. // 3. Let strictFileInteractability be the result of getting property "strictFileInteractability" from capabilities.
  64. auto strict_file_interactiblity = capabilities.get_bool("strictFileInteractability"sv);
  65. // 4. If strictFileInteractability is a boolean, set the current session’s strict file interactability to strictFileInteractability. Otherwise set the current session’s strict file interactability to false.
  66. if (strict_file_interactiblity.has_value())
  67. web_content_connection.async_set_strict_file_interactability(*strict_file_interactiblity);
  68. else
  69. capabilities.set("strictFileInteractability"sv, false);
  70. // FIXME: 5. Let proxy be the result of getting property "proxy" from capabilities and run the substeps of the first matching statement:
  71. // FIXME: proxy is a proxy configuration object
  72. // FIXME: Take implementation-defined steps to set the user agent proxy using the extracted proxy configuration. If the defined proxy cannot be configured return error with error code session not created.
  73. // FIXME: Otherwise
  74. // FIXME: Set a property of capabilities with name "proxy" and a value that is a new JSON Object.
  75. // 6. If capabilities has a property with the key "timeouts":
  76. if (auto timeouts = capabilities.get_object("timeouts"sv); timeouts.has_value()) {
  77. // a. Let timeouts be the result of trying to JSON deserialize as a timeouts configuration the value of the "timeouts" property.
  78. // NOTE: This happens on the remote end.
  79. // b. Make the session timeouts the new timeouts.
  80. MUST(web_content_connection.set_timeouts(*timeouts));
  81. } else {
  82. // 7. Set a property on capabilities with name "timeouts" and value that of the JSON deserialization of the session timeouts.
  83. capabilities.set("timeouts"sv, Web::WebDriver::timeouts_object({}));
  84. }
  85. // 8. Apply changes to the user agent for any implementation-defined capabilities selected during the capabilities processing step.
  86. auto behavior = capabilities.get_byte_string("unhandledPromptBehavior"sv);
  87. if (behavior.has_value())
  88. web_content_connection.async_set_unhandled_prompt_behavior(Web::WebDriver::unhandled_prompt_behavior_from_string(*behavior));
  89. else
  90. capabilities.set("unhandledPromptBehavior"sv, "dismiss and notify"sv);
  91. }
  92. // 8.1 New Session, https://w3c.github.io/webdriver/#dfn-new-sessions
  93. // POST /session
  94. Web::WebDriver::Response Client::new_session(Web::WebDriver::Parameters, JsonValue payload)
  95. {
  96. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session");
  97. // FIXME: 1. If the maximum active sessions is equal to the length of the list of active sessions,
  98. // return error with error code session not created.
  99. // FIXME: 2. If the remote end is an intermediary node, take implementation-defined steps that either
  100. // result in returning an error with error code session not created, or in returning a
  101. // success with data that is isomorphic to that returned by remote ends according to the
  102. // rest of this algorithm. If an error is not returned, the intermediary node must retain a
  103. // reference to the session created on the upstream node as the associated session such
  104. // that commands may be forwarded to this associated session on subsequent commands.
  105. // FIXME: 3. If the maximum active sessions is equal to the length of the list of active sessions,
  106. // return error with error code session not created.
  107. // 4. Let capabilities be the result of trying to process capabilities with parameters as an argument.
  108. auto capabilities = TRY(Web::WebDriver::process_capabilities(payload));
  109. // 5. If capabilities’s is null, return error with error code session not created.
  110. if (capabilities.is_null())
  111. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::SessionNotCreated, "Could not match capabilities"sv);
  112. // 6. Let session id be the result of generating a UUID.
  113. // FIXME: Actually create a UUID.
  114. auto session_id = Client::s_next_session_id++;
  115. // 7. Let session be a new session with the session ID of session id.
  116. Web::WebDriver::LadybirdOptions options { capabilities.as_object() };
  117. auto session = make_ref_counted<Session>(session_id, *this, move(options));
  118. if (auto start_result = session->start(m_callbacks); start_result.is_error())
  119. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::SessionNotCreated, ByteString::formatted("Failed to start session: {}", start_result.error()));
  120. auto& web_content_connection = session->web_content_connection();
  121. // FIXME: 8. Set the current session to session.
  122. // FIXME: 9. Run any WebDriver new session algorithm defined in external specifications,
  123. // with arguments session and capabilities.
  124. // 10. Append session to active sessions.
  125. s_sessions.set(session_id, move(session));
  126. // NOTE: We do step 12 before 11 because step 12 mutates the capabilities we set in step 11.
  127. // 12. Initialize the following from capabilities:
  128. initialize_session_from_capabilities(web_content_connection, capabilities.as_object());
  129. // 11. Let body be a JSON Object initialized with:
  130. JsonObject body;
  131. // "sessionId"
  132. // session id
  133. body.set("sessionId", ByteString::number(session_id));
  134. // "capabilities"
  135. // capabilities
  136. body.set("capabilities", move(capabilities));
  137. // 13. Set the webdriver-active flag to true.
  138. web_content_connection.async_set_is_webdriver_active(true);
  139. // FIXME: 14. Set the current top-level browsing context for session with the top-level browsing context
  140. // of the UA’s current browsing context.
  141. // FIXME: 15. Set the request queue to a new queue.
  142. // 16. Return success with data body.
  143. return JsonValue { move(body) };
  144. }
  145. // 8.2 Delete Session, https://w3c.github.io/webdriver/#dfn-delete-session
  146. // DELETE /session/{session id}
  147. Web::WebDriver::Response Client::delete_session(Web::WebDriver::Parameters parameters, JsonValue)
  148. {
  149. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>");
  150. // 1. If the current session is an active session, try to close the session.
  151. if (auto session = find_session_with_id(parameters[0], AllowInvalidWindowHandle::Yes); !session.is_error())
  152. close_session(session.value()->session_id());
  153. // 2. Return success with data null.
  154. return JsonValue {};
  155. }
  156. // 8.3 Status, https://w3c.github.io/webdriver/#dfn-status
  157. // GET /status
  158. Web::WebDriver::Response Client::get_status(Web::WebDriver::Parameters, JsonValue)
  159. {
  160. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /status");
  161. // 1. Let body be a new JSON Object with the following properties:
  162. // "ready"
  163. // The remote end’s readiness state.
  164. // "message"
  165. // An implementation-defined string explaining the remote end’s readiness state.
  166. // FIXME: Report if we are somehow not ready.
  167. JsonObject body;
  168. body.set("ready", true);
  169. body.set("message", "Ready to start some sessions!");
  170. // 2. Return success with data body.
  171. return JsonValue { body };
  172. }
  173. // 9.1 Get Timeouts, https://w3c.github.io/webdriver/#dfn-get-timeouts
  174. // GET /session/{session id}/timeouts
  175. Web::WebDriver::Response Client::get_timeouts(Web::WebDriver::Parameters parameters, JsonValue)
  176. {
  177. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session id>/timeouts");
  178. auto session = TRY(find_session_with_id(parameters[0]));
  179. return session->web_content_connection().get_timeouts();
  180. }
  181. // 9.2 Set Timeouts, https://w3c.github.io/webdriver/#dfn-set-timeouts
  182. // POST /session/{session id}/timeouts
  183. Web::WebDriver::Response Client::set_timeouts(Web::WebDriver::Parameters parameters, JsonValue payload)
  184. {
  185. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session id>/timeouts");
  186. auto session = TRY(find_session_with_id(parameters[0]));
  187. return session->web_content_connection().set_timeouts(payload);
  188. }
  189. // 10.1 Navigate To, https://w3c.github.io/webdriver/#dfn-navigate-to
  190. // POST /session/{session id}/url
  191. Web::WebDriver::Response Client::navigate_to(Web::WebDriver::Parameters parameters, JsonValue payload)
  192. {
  193. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/url");
  194. auto session = TRY(find_session_with_id(parameters[0]));
  195. return session->navigate_to(payload);
  196. }
  197. // 10.2 Get Current URL, https://w3c.github.io/webdriver/#dfn-get-current-url
  198. // GET /session/{session id}/url
  199. Web::WebDriver::Response Client::get_current_url(Web::WebDriver::Parameters parameters, JsonValue)
  200. {
  201. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/url");
  202. auto session = TRY(find_session_with_id(parameters[0]));
  203. return session->web_content_connection().get_current_url();
  204. }
  205. // 10.3 Back, https://w3c.github.io/webdriver/#dfn-back
  206. // POST /session/{session id}/back
  207. Web::WebDriver::Response Client::back(Web::WebDriver::Parameters parameters, JsonValue)
  208. {
  209. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/back");
  210. auto session = TRY(find_session_with_id(parameters[0]));
  211. return session->web_content_connection().back();
  212. }
  213. // 10.4 Forward, https://w3c.github.io/webdriver/#dfn-forward
  214. // POST /session/{session id}/forward
  215. Web::WebDriver::Response Client::forward(Web::WebDriver::Parameters parameters, JsonValue)
  216. {
  217. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/forward");
  218. auto session = TRY(find_session_with_id(parameters[0]));
  219. return session->web_content_connection().forward();
  220. }
  221. // 10.5 Refresh, https://w3c.github.io/webdriver/#dfn-refresh
  222. // POST /session/{session id}/refresh
  223. Web::WebDriver::Response Client::refresh(Web::WebDriver::Parameters parameters, JsonValue)
  224. {
  225. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/refresh");
  226. auto session = TRY(find_session_with_id(parameters[0]));
  227. return session->web_content_connection().refresh();
  228. }
  229. // 10.6 Get Title, https://w3c.github.io/webdriver/#dfn-get-title
  230. // GET /session/{session id}/title
  231. Web::WebDriver::Response Client::get_title(Web::WebDriver::Parameters parameters, JsonValue)
  232. {
  233. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/title");
  234. auto session = TRY(find_session_with_id(parameters[0]));
  235. return session->web_content_connection().get_title();
  236. }
  237. // 11.1 Get Window Handle, https://w3c.github.io/webdriver/#get-window-handle
  238. // GET /session/{session id}/window
  239. Web::WebDriver::Response Client::get_window_handle(Web::WebDriver::Parameters parameters, JsonValue)
  240. {
  241. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window");
  242. auto session = TRY(find_session_with_id(parameters[0]));
  243. // 1. If the current top-level browsing context is no longer open, return error with error code no such window.
  244. TRY(session->web_content_connection().ensure_top_level_browsing_context_is_open());
  245. // 2. Return success with data being the window handle associated with the current top-level browsing context.
  246. return JsonValue { session->current_window_handle() };
  247. }
  248. // 11.2 Close Window, https://w3c.github.io/webdriver/#dfn-close-window
  249. // DELETE /session/{session id}/window
  250. Web::WebDriver::Response Client::close_window(Web::WebDriver::Parameters parameters, JsonValue)
  251. {
  252. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/window");
  253. auto session = TRY(find_session_with_id(parameters[0]));
  254. return session->close_window();
  255. }
  256. // 11.3 Switch to Window, https://w3c.github.io/webdriver/#dfn-switch-to-window
  257. // POST /session/{session id}/window
  258. Web::WebDriver::Response Client::switch_to_window(Web::WebDriver::Parameters parameters, AK::JsonValue payload)
  259. {
  260. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window");
  261. auto session = TRY(find_session_with_id(parameters[0], AllowInvalidWindowHandle::Yes));
  262. if (!payload.is_object())
  263. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidArgument, "Payload is not a JSON object");
  264. // 1. Let handle be the result of getting the property "handle" from the parameters argument.
  265. auto handle = payload.as_object().get("handle"sv);
  266. // 2. If handle is undefined, return error with error code invalid argument.
  267. if (!handle.has_value())
  268. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidArgument, "No property called 'handle' present");
  269. return session->switch_to_window(handle->as_string());
  270. }
  271. // 11.4 Get Window Handles, https://w3c.github.io/webdriver/#dfn-get-window-handles
  272. // GET /session/{session id}/window/handles
  273. Web::WebDriver::Response Client::get_window_handles(Web::WebDriver::Parameters parameters, JsonValue)
  274. {
  275. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window/handles");
  276. auto session = TRY(find_session_with_id(parameters[0], AllowInvalidWindowHandle::Yes));
  277. return session->get_window_handles();
  278. }
  279. // 11.5 New Window, https://w3c.github.io/webdriver/#dfn-new-window
  280. // POST /session/{session id}/window/new
  281. Web::WebDriver::Response Client::new_window(Web::WebDriver::Parameters parameters, JsonValue payload)
  282. {
  283. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/new");
  284. auto session = TRY(find_session_with_id(parameters[0]));
  285. auto handle = TRY(session->web_content_connection().new_window(payload));
  286. constexpr u32 CONNECTION_TIMEOUT_MS = 5000;
  287. auto timeout_fired = false;
  288. auto timer = Core::Timer::create_single_shot(CONNECTION_TIMEOUT_MS, [&timeout_fired] { timeout_fired = true; });
  289. timer->start();
  290. Core::EventLoop::current().spin_until([&session, &timeout_fired, handle = handle.as_object().get("handle"sv)->as_string()]() {
  291. return session->has_window_handle(handle) || timeout_fired;
  292. });
  293. if (timeout_fired)
  294. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::Timeout, "Timed out waiting for window handle");
  295. return handle;
  296. }
  297. // 11.6 Switch To Frame, https://w3c.github.io/webdriver/#dfn-switch-to-frame
  298. // POST /session/{session id}/frame
  299. Web::WebDriver::Response Client::switch_to_frame(Web::WebDriver::Parameters parameters, JsonValue payload)
  300. {
  301. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/frame");
  302. auto session = TRY(find_session_with_id(parameters[0]));
  303. return session->web_content_connection().switch_to_frame(move(payload));
  304. }
  305. // 11.7 Switch To Parent Frame, https://w3c.github.io/webdriver/#dfn-switch-to-parent-frame
  306. // POST /session/{session id}/frame/parent
  307. Web::WebDriver::Response Client::switch_to_parent_frame(Web::WebDriver::Parameters parameters, JsonValue payload)
  308. {
  309. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/frame/parent");
  310. auto session = TRY(find_session_with_id(parameters[0]));
  311. return session->web_content_connection().switch_to_parent_frame(move(payload));
  312. }
  313. // 11.8.1 Get Window Rect, https://w3c.github.io/webdriver/#dfn-get-window-rect
  314. // GET /session/{session id}/window/rect
  315. Web::WebDriver::Response Client::get_window_rect(Web::WebDriver::Parameters parameters, JsonValue)
  316. {
  317. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window/rect");
  318. auto session = TRY(find_session_with_id(parameters[0]));
  319. return session->web_content_connection().get_window_rect();
  320. }
  321. // 11.8.2 Set Window Rect, https://w3c.github.io/webdriver/#dfn-set-window-rect
  322. // POST /session/{session id}/window/rect
  323. Web::WebDriver::Response Client::set_window_rect(Web::WebDriver::Parameters parameters, JsonValue payload)
  324. {
  325. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/rect");
  326. auto session = TRY(find_session_with_id(parameters[0]));
  327. return session->set_window_rect(payload);
  328. }
  329. // 11.8.3 Maximize Window, https://w3c.github.io/webdriver/#dfn-maximize-window
  330. // POST /session/{session id}/window/maximize
  331. Web::WebDriver::Response Client::maximize_window(Web::WebDriver::Parameters parameters, JsonValue)
  332. {
  333. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/maximize");
  334. auto session = TRY(find_session_with_id(parameters[0]));
  335. return session->maximize_window();
  336. }
  337. // 11.8.4 Minimize Window, https://w3c.github.io/webdriver/#minimize-window
  338. // POST /session/{session id}/window/minimize
  339. Web::WebDriver::Response Client::minimize_window(Web::WebDriver::Parameters parameters, JsonValue)
  340. {
  341. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/minimize");
  342. auto session = TRY(find_session_with_id(parameters[0]));
  343. return session->minimize_window();
  344. }
  345. // 11.8.5 Fullscreen Window, https://w3c.github.io/webdriver/#dfn-fullscreen-window
  346. // POST /session/{session id}/window/fullscreen
  347. Web::WebDriver::Response Client::fullscreen_window(Web::WebDriver::Parameters parameters, JsonValue)
  348. {
  349. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/fullscreen");
  350. auto session = TRY(find_session_with_id(parameters[0]));
  351. return session->fullscreen_window();
  352. }
  353. // Extension: Consume User Activation, https://html.spec.whatwg.org/multipage/interaction.html#user-activation-user-agent-automation
  354. // POST /session/{session id}/window/consume-user-activation
  355. Web::WebDriver::Response Client::consume_user_activation(Web::WebDriver::Parameters parameters, JsonValue)
  356. {
  357. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/consume-user-activation");
  358. auto session = TRY(find_session_with_id(parameters[0]));
  359. return session->web_content_connection().consume_user_activation();
  360. }
  361. // 12.3.2 Find Element, https://w3c.github.io/webdriver/#dfn-find-element
  362. // POST /session/{session id}/element
  363. Web::WebDriver::Response Client::find_element(Web::WebDriver::Parameters parameters, JsonValue payload)
  364. {
  365. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element");
  366. auto session = TRY(find_session_with_id(parameters[0]));
  367. return session->web_content_connection().find_element(payload);
  368. }
  369. // 12.3.3 Find Elements, https://w3c.github.io/webdriver/#dfn-find-elements
  370. // POST /session/{session id}/elements
  371. Web::WebDriver::Response Client::find_elements(Web::WebDriver::Parameters parameters, JsonValue payload)
  372. {
  373. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/elements");
  374. auto session = TRY(find_session_with_id(parameters[0]));
  375. return session->web_content_connection().find_elements(payload);
  376. }
  377. // 12.3.4 Find Element From Element, https://w3c.github.io/webdriver/#dfn-find-element-from-element
  378. // POST /session/{session id}/element/{element id}/element
  379. Web::WebDriver::Response Client::find_element_from_element(Web::WebDriver::Parameters parameters, JsonValue payload)
  380. {
  381. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/element");
  382. auto session = TRY(find_session_with_id(parameters[0]));
  383. return session->web_content_connection().find_element_from_element(payload, move(parameters[1]));
  384. }
  385. // 12.3.5 Find Elements From Element, https://w3c.github.io/webdriver/#dfn-find-elements-from-element
  386. // POST /session/{session id}/element/{element id}/elements
  387. Web::WebDriver::Response Client::find_elements_from_element(Web::WebDriver::Parameters parameters, JsonValue payload)
  388. {
  389. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/elements");
  390. auto session = TRY(find_session_with_id(parameters[0]));
  391. return session->web_content_connection().find_elements_from_element(payload, move(parameters[1]));
  392. }
  393. // 12.3.6 Find Element From Shadow Root, https://w3c.github.io/webdriver/#find-element-from-shadow-root
  394. // POST /session/{session id}/shadow/{shadow id}/element
  395. Web::WebDriver::Response Client::find_element_from_shadow_root(Web::WebDriver::Parameters parameters, JsonValue payload)
  396. {
  397. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/shadow/<shadow_id>/element");
  398. auto session = TRY(find_session_with_id(parameters[0]));
  399. return session->web_content_connection().find_element_from_shadow_root(payload, move(parameters[1]));
  400. }
  401. // 12.3.7 Find Elements From Shadow Root, https://w3c.github.io/webdriver/#find-elements-from-shadow-root
  402. // POST /session/{session id}/shadow/{shadow id}/elements
  403. Web::WebDriver::Response Client::find_elements_from_shadow_root(Web::WebDriver::Parameters parameters, JsonValue payload)
  404. {
  405. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/shadow/<shadow_id>/elements");
  406. auto session = TRY(find_session_with_id(parameters[0]));
  407. return session->web_content_connection().find_elements_from_shadow_root(payload, move(parameters[1]));
  408. }
  409. // 12.3.8 Get Active Element, https://w3c.github.io/webdriver/#get-active-element
  410. // GET /session/{session id}/element/active
  411. Web::WebDriver::Response Client::get_active_element(Web::WebDriver::Parameters parameters, JsonValue)
  412. {
  413. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/active");
  414. auto session = TRY(find_session_with_id(parameters[0]));
  415. return session->web_content_connection().get_active_element();
  416. }
  417. // 12.3.9 Get Element Shadow Root, https://w3c.github.io/webdriver/#get-element-shadow-root
  418. // GET /session/{session id}/element/{element id}/shadow
  419. Web::WebDriver::Response Client::get_element_shadow_root(Web::WebDriver::Parameters parameters, JsonValue)
  420. {
  421. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/shadow");
  422. auto session = TRY(find_session_with_id(parameters[0]));
  423. return session->web_content_connection().get_element_shadow_root(move(parameters[1]));
  424. }
  425. // 12.4.1 Is Element Selected, https://w3c.github.io/webdriver/#dfn-is-element-selected
  426. // GET /session/{session id}/element/{element id}/selected
  427. Web::WebDriver::Response Client::is_element_selected(Web::WebDriver::Parameters parameters, JsonValue)
  428. {
  429. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/selected");
  430. auto session = TRY(find_session_with_id(parameters[0]));
  431. return session->web_content_connection().is_element_selected(move(parameters[1]));
  432. }
  433. // 12.4.2 Get Element Attribute, https://w3c.github.io/webdriver/#dfn-get-element-attribute
  434. // GET /session/{session id}/element/{element id}/attribute/{name}
  435. Web::WebDriver::Response Client::get_element_attribute(Web::WebDriver::Parameters parameters, JsonValue)
  436. {
  437. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/attribute/<name>");
  438. auto session = TRY(find_session_with_id(parameters[0]));
  439. return session->web_content_connection().get_element_attribute(move(parameters[1]), move(parameters[2]));
  440. }
  441. // 12.4.3 Get Element Property, https://w3c.github.io/webdriver/#dfn-get-element-property
  442. // GET /session/{session id}/element/{element id}/property/{name}
  443. Web::WebDriver::Response Client::get_element_property(Web::WebDriver::Parameters parameters, JsonValue)
  444. {
  445. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/property/<name>");
  446. auto session = TRY(find_session_with_id(parameters[0]));
  447. return session->web_content_connection().get_element_property(move(parameters[1]), move(parameters[2]));
  448. }
  449. // 12.4.4 Get Element CSS Value, https://w3c.github.io/webdriver/#dfn-get-element-css-value
  450. // GET /session/{session id}/element/{element id}/css/{property name}
  451. Web::WebDriver::Response Client::get_element_css_value(Web::WebDriver::Parameters parameters, JsonValue)
  452. {
  453. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/css/<property_name>");
  454. auto session = TRY(find_session_with_id(parameters[0]));
  455. return session->web_content_connection().get_element_css_value(move(parameters[1]), move(parameters[2]));
  456. }
  457. // 12.4.5 Get Element Text, https://w3c.github.io/webdriver/#dfn-get-element-text
  458. // GET /session/{session id}/element/{element id}/text
  459. Web::WebDriver::Response Client::get_element_text(Web::WebDriver::Parameters parameters, JsonValue)
  460. {
  461. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/text");
  462. auto session = TRY(find_session_with_id(parameters[0]));
  463. return session->web_content_connection().get_element_text(move(parameters[1]));
  464. }
  465. // 12.4.6 Get Element Tag Name, https://w3c.github.io/webdriver/#dfn-get-element-tag-name
  466. // GET /session/{session id}/element/{element id}/name
  467. Web::WebDriver::Response Client::get_element_tag_name(Web::WebDriver::Parameters parameters, JsonValue)
  468. {
  469. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/name");
  470. auto session = TRY(find_session_with_id(parameters[0]));
  471. return session->web_content_connection().get_element_tag_name(move(parameters[1]));
  472. }
  473. // 12.4.7 Get Element Rect, https://w3c.github.io/webdriver/#dfn-get-element-rect
  474. // GET /session/{session id}/element/{element id}/rect
  475. Web::WebDriver::Response Client::get_element_rect(Web::WebDriver::Parameters parameters, JsonValue)
  476. {
  477. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/rect");
  478. auto session = TRY(find_session_with_id(parameters[0]));
  479. return session->web_content_connection().get_element_rect(move(parameters[1]));
  480. }
  481. // 12.4.8 Is Element Enabled, https://w3c.github.io/webdriver/#dfn-is-element-enabled
  482. // GET /session/{session id}/element/{element id}/enabled
  483. Web::WebDriver::Response Client::is_element_enabled(Web::WebDriver::Parameters parameters, JsonValue)
  484. {
  485. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/enabled");
  486. auto session = TRY(find_session_with_id(parameters[0]));
  487. return session->web_content_connection().is_element_enabled(move(parameters[1]));
  488. }
  489. // 12.4.9 https://w3c.github.io/webdriver/#dfn-get-computed-role
  490. // GET /session/{session id}/element/{element id}/computedrole
  491. Web::WebDriver::Response Client::get_computed_role(Web::WebDriver::Parameters parameters, AK::JsonValue)
  492. {
  493. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session id>/element/<element id>/computedrole");
  494. auto session = TRY(find_session_with_id(parameters[0]));
  495. return session->web_content_connection().get_computed_role(move(parameters[1]));
  496. }
  497. // 12.4.10 Get Computed Label, https://w3c.github.io/webdriver/#get-computed-label
  498. // GET /session/{session id}/element/{element id}/computedlabel
  499. Web::WebDriver::Response Client::get_computed_label(Web::WebDriver::Parameters parameters, JsonValue)
  500. {
  501. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session id>/element/<element id>/computedlabel");
  502. auto session = TRY(find_session_with_id(parameters[0]));
  503. return session->web_content_connection().get_computed_label(move(parameters[1]));
  504. }
  505. // 12.5.1 Element Click, https://w3c.github.io/webdriver/#element-click
  506. // POST /session/{session id}/element/{element id}/click
  507. Web::WebDriver::Response Client::element_click(Web::WebDriver::Parameters parameters, JsonValue)
  508. {
  509. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/click");
  510. auto session = TRY(find_session_with_id(parameters[0]));
  511. return session->element_click(move(parameters[1]));
  512. }
  513. // 12.5.2 Element Clear, https://w3c.github.io/webdriver/#dfn-element-clear
  514. // POST /session/{session id}/element/{element id}/clear
  515. Web::WebDriver::Response Client::element_clear(Web::WebDriver::Parameters parameters, JsonValue)
  516. {
  517. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/clear");
  518. auto session = TRY(find_session_with_id(parameters[0]));
  519. return session->web_content_connection().element_clear(move(parameters[1]));
  520. }
  521. // 12.5.3 Element Send Keys, https://w3c.github.io/webdriver/#dfn-element-send-keys
  522. // POST /session/{session id}/element/{element id}/value
  523. Web::WebDriver::Response Client::element_send_keys(Web::WebDriver::Parameters parameters, JsonValue payload)
  524. {
  525. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/value");
  526. auto session = TRY(find_session_with_id(parameters[0]));
  527. return session->element_send_keys(move(parameters[1]), move(payload));
  528. }
  529. // 13.1 Get Page Source, https://w3c.github.io/webdriver/#dfn-get-page-source
  530. // GET /session/{session id}/source
  531. Web::WebDriver::Response Client::get_source(Web::WebDriver::Parameters parameters, JsonValue)
  532. {
  533. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/source");
  534. auto session = TRY(find_session_with_id(parameters[0]));
  535. return session->web_content_connection().get_source();
  536. }
  537. // 13.2.1 Execute Script, https://w3c.github.io/webdriver/#dfn-execute-script
  538. // POST /session/{session id}/execute/sync
  539. Web::WebDriver::Response Client::execute_script(Web::WebDriver::Parameters parameters, JsonValue payload)
  540. {
  541. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/execute/sync");
  542. auto session = TRY(find_session_with_id(parameters[0]));
  543. return session->execute_script(move(payload), Session::ScriptMode::Sync);
  544. }
  545. // 13.2.2 Execute Async Script, https://w3c.github.io/webdriver/#dfn-execute-async-script
  546. // POST /session/{session id}/execute/async
  547. Web::WebDriver::Response Client::execute_async_script(Web::WebDriver::Parameters parameters, JsonValue payload)
  548. {
  549. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/execute/async");
  550. auto session = TRY(find_session_with_id(parameters[0]));
  551. return session->execute_script(move(payload), Session::ScriptMode::Async);
  552. }
  553. // 14.1 Get All Cookies, https://w3c.github.io/webdriver/#dfn-get-all-cookies
  554. // GET /session/{session id}/cookie
  555. Web::WebDriver::Response Client::get_all_cookies(Web::WebDriver::Parameters parameters, JsonValue)
  556. {
  557. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/cookie");
  558. auto session = TRY(find_session_with_id(parameters[0]));
  559. return session->web_content_connection().get_all_cookies();
  560. }
  561. // 14.2 Get Named Cookie, https://w3c.github.io/webdriver/#dfn-get-named-cookie
  562. // GET /session/{session id}/cookie/{name}
  563. Web::WebDriver::Response Client::get_named_cookie(Web::WebDriver::Parameters parameters, JsonValue)
  564. {
  565. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/cookie/<name>");
  566. auto session = TRY(find_session_with_id(parameters[0]));
  567. return session->web_content_connection().get_named_cookie(move(parameters[1]));
  568. }
  569. // 14.3 Add Cookie, https://w3c.github.io/webdriver/#dfn-adding-a-cookie
  570. // POST /session/{session id}/cookie
  571. Web::WebDriver::Response Client::add_cookie(Web::WebDriver::Parameters parameters, JsonValue payload)
  572. {
  573. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/cookie");
  574. auto session = TRY(find_session_with_id(parameters[0]));
  575. return session->web_content_connection().add_cookie(payload);
  576. }
  577. // 14.4 Delete Cookie, https://w3c.github.io/webdriver/#dfn-delete-cookie
  578. // DELETE /session/{session id}/cookie/{name}
  579. Web::WebDriver::Response Client::delete_cookie(Web::WebDriver::Parameters parameters, JsonValue)
  580. {
  581. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/cookie/<name>");
  582. auto session = TRY(find_session_with_id(parameters[0]));
  583. return session->web_content_connection().delete_cookie(move(parameters[1]));
  584. }
  585. // 14.5 Delete All Cookies, https://w3c.github.io/webdriver/#dfn-delete-all-cookies
  586. // DELETE /session/{session id}/cookie
  587. Web::WebDriver::Response Client::delete_all_cookies(Web::WebDriver::Parameters parameters, JsonValue)
  588. {
  589. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/cookie");
  590. auto session = TRY(find_session_with_id(parameters[0]));
  591. return session->web_content_connection().delete_all_cookies();
  592. }
  593. // 15.7 Perform Actions, https://w3c.github.io/webdriver/#perform-actions
  594. // POST /session/{session id}/actions
  595. Web::WebDriver::Response Client::perform_actions(Web::WebDriver::Parameters parameters, JsonValue payload)
  596. {
  597. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/actions");
  598. auto session = TRY(find_session_with_id(parameters[0]));
  599. return session->perform_actions(move(payload));
  600. }
  601. // 15.8 Release Actions, https://w3c.github.io/webdriver/#release-actions
  602. // DELETE /session/{session id}/actions
  603. Web::WebDriver::Response Client::release_actions(Web::WebDriver::Parameters parameters, JsonValue)
  604. {
  605. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/actions");
  606. auto session = TRY(find_session_with_id(parameters[0]));
  607. return session->web_content_connection().release_actions();
  608. }
  609. // 16.1 Dismiss Alert, https://w3c.github.io/webdriver/#dismiss-alert
  610. // POST /session/{session id}/alert/dismiss
  611. Web::WebDriver::Response Client::dismiss_alert(Web::WebDriver::Parameters parameters, JsonValue)
  612. {
  613. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/alert/dismiss");
  614. auto session = TRY(find_session_with_id(parameters[0]));
  615. return session->dismiss_alert();
  616. }
  617. // 16.2 Accept Alert, https://w3c.github.io/webdriver/#accept-alert
  618. // POST /session/{session id}/alert/accept
  619. Web::WebDriver::Response Client::accept_alert(Web::WebDriver::Parameters parameters, JsonValue)
  620. {
  621. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/alert/accept");
  622. auto session = TRY(find_session_with_id(parameters[0]));
  623. return session->accept_alert();
  624. }
  625. // 16.3 Get Alert Text, https://w3c.github.io/webdriver/#get-alert-text
  626. // GET /session/{session id}/alert/text
  627. Web::WebDriver::Response Client::get_alert_text(Web::WebDriver::Parameters parameters, JsonValue)
  628. {
  629. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/alert/text");
  630. auto session = TRY(find_session_with_id(parameters[0]));
  631. return session->web_content_connection().get_alert_text();
  632. }
  633. // 16.4 Send Alert Text, https://w3c.github.io/webdriver/#send-alert-text
  634. // POST /session/{session id}/alert/text
  635. Web::WebDriver::Response Client::send_alert_text(Web::WebDriver::Parameters parameters, JsonValue payload)
  636. {
  637. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/alert/text");
  638. auto session = TRY(find_session_with_id(parameters[0]));
  639. return session->web_content_connection().send_alert_text(payload);
  640. }
  641. // 17.1 Take Screenshot, https://w3c.github.io/webdriver/#take-screenshot
  642. // GET /session/{session id}/screenshot
  643. Web::WebDriver::Response Client::take_screenshot(Web::WebDriver::Parameters parameters, JsonValue)
  644. {
  645. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/screenshot");
  646. auto session = TRY(find_session_with_id(parameters[0]));
  647. return session->web_content_connection().take_screenshot();
  648. }
  649. // 17.2 Take Element Screenshot, https://w3c.github.io/webdriver/#dfn-take-element-screenshot
  650. // GET /session/{session id}/element/{element id}/screenshot
  651. Web::WebDriver::Response Client::take_element_screenshot(Web::WebDriver::Parameters parameters, JsonValue)
  652. {
  653. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/screenshot");
  654. auto session = TRY(find_session_with_id(parameters[0]));
  655. return session->web_content_connection().take_element_screenshot(move(parameters[1]));
  656. }
  657. // 18.1 Print Page, https://w3c.github.io/webdriver/#dfn-print-page
  658. // POST /session/{session id}/print
  659. Web::WebDriver::Response Client::print_page(Web::WebDriver::Parameters parameters, JsonValue payload)
  660. {
  661. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session id>/print");
  662. auto session = TRY(find_session_with_id(parameters[0]));
  663. return session->web_content_connection().print_page(move(payload));
  664. }
  665. }