Client.cpp 37 KB

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