Client.cpp 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816
  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, Tim Flynn <trflynn89@serenityos.org>
  7. *
  8. * SPDX-License-Identifier: BSD-2-Clause
  9. */
  10. #include <AK/Debug.h>
  11. #include <AK/JsonParser.h>
  12. #include <LibCore/DateTime.h>
  13. #include <LibCore/MemoryStream.h>
  14. #include <LibHTTP/HttpRequest.h>
  15. #include <LibHTTP/HttpResponse.h>
  16. #include <WebDriver/Client.h>
  17. #include <WebDriver/Session.h>
  18. #include <WebDriver/TimeoutsConfiguration.h>
  19. namespace WebDriver {
  20. Atomic<unsigned> Client::s_next_session_id;
  21. NonnullOwnPtrVector<Session> Client::s_sessions;
  22. Vector<Client::Route> Client::s_routes = {
  23. { HTTP::HttpRequest::Method::POST, { "session" }, &Client::handle_new_session },
  24. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id" }, &Client::handle_delete_session },
  25. { HTTP::HttpRequest::Method::GET, { "status" }, &Client::handle_get_status },
  26. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "timeouts" }, &Client::handle_get_timeouts },
  27. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "timeouts" }, &Client::handle_set_timeouts },
  28. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "url" }, &Client::handle_navigate_to },
  29. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "url" }, &Client::handle_get_current_url },
  30. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "back" }, &Client::handle_back },
  31. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "forward" }, &Client::handle_forward },
  32. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "refresh" }, &Client::handle_refresh },
  33. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "title" }, &Client::handle_get_title },
  34. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window" }, &Client::handle_get_window_handle },
  35. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "window" }, &Client::handle_close_window },
  36. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window", "handles" }, &Client::handle_get_window_handles },
  37. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "window", "rect" }, &Client::handle_get_window_rect },
  38. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "rect" }, &Client::handle_set_window_rect },
  39. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "maximize" }, &Client::handle_maximize_window },
  40. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "window", "minimize" }, &Client::handle_minimize_window },
  41. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element" }, &Client::handle_find_element },
  42. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "elements" }, &Client::handle_find_elements },
  43. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element", ":element_id", "element" }, &Client::handle_find_element_from_element },
  44. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "element", ":element_id", "elements" }, &Client::handle_find_elements_from_element },
  45. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "selected" }, &Client::handle_is_element_selected },
  46. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "attribute", ":name" }, &Client::handle_get_element_attribute },
  47. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "property", ":name" }, &Client::handle_get_element_property },
  48. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "css", ":property_name" }, &Client::handle_get_element_css_value },
  49. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "text" }, &Client::handle_get_element_text },
  50. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "name" }, &Client::handle_get_element_tag_name },
  51. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "rect" }, &Client::handle_get_element_rect },
  52. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "enabled" }, &Client::handle_is_element_enabled },
  53. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "source" }, &Client::handle_get_source },
  54. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "execute", "sync" }, &Client::handle_execute_script },
  55. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "execute", "async" }, &Client::handle_execute_async_script },
  56. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie" }, &Client::handle_get_all_cookies },
  57. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "cookie", ":name" }, &Client::handle_get_named_cookie },
  58. { HTTP::HttpRequest::Method::POST, { "session", ":session_id", "cookie" }, &Client::handle_add_cookie },
  59. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "cookie", ":name" }, &Client::handle_delete_cookie },
  60. { HTTP::HttpRequest::Method::DELETE, { "session", ":session_id", "cookie" }, &Client::handle_delete_all_cookies },
  61. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "screenshot" }, &Client::handle_take_screenshot },
  62. { HTTP::HttpRequest::Method::GET, { "session", ":session_id", "element", ":element_id", "screenshot" }, &Client::handle_take_element_screenshot },
  63. };
  64. Client::Client(NonnullOwnPtr<Core::Stream::BufferedTCPSocket> socket, Core::Object* parent)
  65. : Core::Object(parent)
  66. , m_socket(move(socket))
  67. {
  68. }
  69. void Client::die()
  70. {
  71. m_socket->close();
  72. deferred_invoke([this] { remove_from_parent(); });
  73. }
  74. void Client::start()
  75. {
  76. m_socket->on_ready_to_read = [this] {
  77. StringBuilder builder;
  78. // FIXME: All this should be moved to LibHTTP and be made spec compliant
  79. auto maybe_buffer = ByteBuffer::create_uninitialized(m_socket->buffer_size());
  80. if (maybe_buffer.is_error()) {
  81. warnln("Could not create buffer for client: {}", maybe_buffer.error());
  82. die();
  83. return;
  84. }
  85. auto buffer = maybe_buffer.release_value();
  86. for (;;) {
  87. auto maybe_can_read = m_socket->can_read_without_blocking();
  88. if (maybe_can_read.is_error()) {
  89. warnln("Failed to get the blocking status for the socket: {}", maybe_can_read.error());
  90. die();
  91. return;
  92. }
  93. if (!maybe_can_read.value())
  94. break;
  95. auto maybe_data = m_socket->read(buffer);
  96. if (maybe_data.is_error()) {
  97. warnln("Failed to read data from the request: {}", maybe_data.error());
  98. die();
  99. return;
  100. }
  101. if (m_socket->is_eof()) {
  102. die();
  103. break;
  104. }
  105. builder.append(StringView(maybe_data.value()));
  106. }
  107. auto request = builder.to_byte_buffer();
  108. auto http_request_or_error = HTTP::HttpRequest::from_raw_request(request);
  109. if (!http_request_or_error.has_value())
  110. return;
  111. auto http_request = http_request_or_error.release_value();
  112. auto body_or_error = read_body_as_json(http_request);
  113. if (body_or_error.is_error()) {
  114. warnln("Failed to read the request body: {}", body_or_error.error());
  115. die();
  116. return;
  117. }
  118. auto maybe_did_handle = handle_request(http_request, body_or_error.value());
  119. if (maybe_did_handle.is_error()) {
  120. warnln("Failed to handle the request: {}", maybe_did_handle.error());
  121. }
  122. die();
  123. };
  124. }
  125. ErrorOr<JsonValue> Client::read_body_as_json(HTTP::HttpRequest const& request)
  126. {
  127. // If we received a multipart body here, this would fail badly.
  128. unsigned content_length = 0;
  129. for (auto const& header : request.headers()) {
  130. if (header.name.equals_ignoring_case("Content-Length"sv)) {
  131. content_length = header.value.to_int(TrimWhitespace::Yes).value_or(0);
  132. break;
  133. }
  134. }
  135. if (!content_length)
  136. return JsonValue();
  137. // FIXME: Check the Content-Type is actually application/json
  138. JsonParser json_parser(request.body());
  139. return json_parser.parse();
  140. }
  141. ErrorOr<bool> Client::handle_request(HTTP::HttpRequest const& request, JsonValue const& body)
  142. {
  143. if constexpr (WEBDRIVER_DEBUG) {
  144. dbgln("Got HTTP request: {} {}", request.method_name(), request.resource());
  145. if (!body.is_null())
  146. dbgln("Body: {}", body.to_string());
  147. }
  148. auto routing_result_match = match_route(request.method(), request.resource());
  149. if (routing_result_match.is_error()) {
  150. auto error = routing_result_match.release_error();
  151. dbgln_if(WEBDRIVER_DEBUG, "Failed to match route: {}", error);
  152. TRY(send_error_response(error, request));
  153. return false;
  154. }
  155. auto routing_result = routing_result_match.release_value();
  156. auto result = (this->*routing_result.handler)(routing_result.parameters, body);
  157. if (result.is_error()) {
  158. dbgln_if(WEBDRIVER_DEBUG, "Error in calling route handler: {}", result.error());
  159. TRY(send_error_response(result.release_error(), request));
  160. return false;
  161. }
  162. auto object = result.release_value();
  163. TRY(send_response(object.to_string(), request));
  164. return true;
  165. }
  166. // https://w3c.github.io/webdriver/#dfn-send-a-response
  167. ErrorOr<void> Client::send_response(StringView content, HTTP::HttpRequest const& request)
  168. {
  169. // FIXME: Implement to spec.
  170. StringBuilder builder;
  171. builder.append("HTTP/1.0 200 OK\r\n"sv);
  172. builder.append("Server: WebDriver (SerenityOS)\r\n"sv);
  173. builder.append("X-Frame-Options: SAMEORIGIN\r\n"sv);
  174. builder.append("X-Content-Type-Options: nosniff\r\n"sv);
  175. builder.append("Pragma: no-cache\r\n"sv);
  176. builder.append("Content-Type: application/json; charset=utf-8\r\n"sv);
  177. builder.appendff("Content-Length: {}\r\n", content.length());
  178. builder.append("\r\n"sv);
  179. auto builder_contents = builder.to_byte_buffer();
  180. TRY(m_socket->write(builder_contents));
  181. while (!content.is_empty()) {
  182. auto bytes_sent = TRY(m_socket->write(content.bytes()));
  183. content = content.substring_view(bytes_sent);
  184. }
  185. log_response(200, request);
  186. auto keep_alive = false;
  187. if (auto it = request.headers().find_if([](auto& header) { return header.name.equals_ignoring_case("Connection"sv); }); !it.is_end()) {
  188. if (it->value.trim_whitespace().equals_ignoring_case("keep-alive"sv))
  189. keep_alive = true;
  190. }
  191. if (!keep_alive)
  192. m_socket->close();
  193. return {};
  194. }
  195. // https://w3c.github.io/webdriver/#dfn-send-an-error
  196. ErrorOr<void> Client::send_error_response(Web::WebDriver::Error const& error, HTTP::HttpRequest const& request)
  197. {
  198. // FIXME: Implement to spec.
  199. dbgln("send_error_response: {} {}: {}", error.http_status, error.error, error.message);
  200. auto reason_phrase = HTTP::HttpResponse::reason_phrase_for_code(error.http_status);
  201. auto result = JsonObject();
  202. result.set("error", error.error);
  203. result.set("message", error.message);
  204. result.set("stacktrace", "");
  205. if (error.data.has_value())
  206. result.set("data", *error.data);
  207. StringBuilder content_builder;
  208. result.serialize(content_builder);
  209. StringBuilder header_builder;
  210. header_builder.appendff("HTTP/1.0 {} ", error.http_status);
  211. header_builder.append(reason_phrase);
  212. header_builder.append("\r\n"sv);
  213. header_builder.append("Content-Type: application/json; charset=UTF-8\r\n"sv);
  214. header_builder.appendff("Content-Length: {}\r\n", content_builder.length());
  215. header_builder.append("\r\n"sv);
  216. TRY(m_socket->write(header_builder.to_byte_buffer()));
  217. TRY(m_socket->write(content_builder.to_byte_buffer()));
  218. log_response(error.http_status, request);
  219. return {};
  220. }
  221. void Client::log_response(unsigned code, HTTP::HttpRequest const& request)
  222. {
  223. outln("{} :: {:03d} :: {} {}", Core::DateTime::now().to_string(), code, request.method_name(), request.resource());
  224. }
  225. // https://w3c.github.io/webdriver/#dfn-match-a-request
  226. ErrorOr<Client::RoutingResult, Web::WebDriver::Error> Client::match_route(HTTP::HttpRequest::Method method, String const& resource)
  227. {
  228. // FIXME: Implement to spec.
  229. dbgln_if(WEBDRIVER_DEBUG, "match_route({}, {})", HTTP::to_string(method), resource);
  230. // https://w3c.github.io/webdriver/webdriver-spec.html#routing-requests
  231. if (!resource.starts_with(m_prefix))
  232. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::UnknownCommand, "The resource doesn't start with the prefix.");
  233. Vector<StringView> resource_split = resource.substring_view(m_prefix.length()).split_view('/', SplitBehavior::KeepEmpty);
  234. Vector<StringView> parameters;
  235. bool matched_path = false;
  236. for (auto const& route : Client::s_routes) {
  237. dbgln_if(WEBDRIVER_DEBUG, "- Checking {} {}", HTTP::to_string(route.method), String::join("/"sv, route.path));
  238. if (resource_split.size() != route.path.size()) {
  239. dbgln_if(WEBDRIVER_DEBUG, "-> Discarding: Wrong length");
  240. continue;
  241. }
  242. bool match = true;
  243. for (size_t i = 0; i < route.path.size(); ++i) {
  244. if (route.path[i].starts_with(':')) {
  245. parameters.append(resource_split[i]);
  246. continue;
  247. }
  248. if (route.path[i] != resource_split[i]) {
  249. match = false;
  250. parameters.clear();
  251. dbgln_if(WEBDRIVER_DEBUG, "-> Discarding: Part `{}` does not match `{}`", route.path[i], resource_split[i]);
  252. break;
  253. }
  254. }
  255. if (match && route.method == method) {
  256. dbgln_if(WEBDRIVER_DEBUG, "-> Matched! :^)");
  257. return RoutingResult { route.handler, parameters };
  258. }
  259. matched_path = true;
  260. }
  261. // Matched a path, but didn't match a known method
  262. if (matched_path) {
  263. dbgln_if(WEBDRIVER_DEBUG, "- A path matched, but method didn't. :^(");
  264. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::UnknownMethod, "The command matched a known URL but did not match a method for that URL.");
  265. }
  266. // Didn't have any match
  267. dbgln_if(WEBDRIVER_DEBUG, "- No matches. :^(");
  268. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::UnknownCommand, "The command was not recognized.");
  269. }
  270. ErrorOr<Session*, Web::WebDriver::Error> Client::find_session_with_id(StringView session_id)
  271. {
  272. auto session_id_or_error = session_id.to_uint<>();
  273. if (!session_id_or_error.has_value())
  274. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidSessionId, "Invalid session id");
  275. for (auto& session : Client::s_sessions) {
  276. if (session.session_id() == session_id_or_error.value())
  277. return &session;
  278. }
  279. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidSessionId, "Invalid session id");
  280. }
  281. ErrorOr<NonnullOwnPtr<Session>, Web::WebDriver::Error> Client::take_session_with_id(StringView session_id)
  282. {
  283. auto session_id_or_error = session_id.to_uint<>();
  284. if (!session_id_or_error.has_value())
  285. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidSessionId, "Invalid session id");
  286. for (size_t i = 0; i < Client::s_sessions.size(); ++i) {
  287. if (Client::s_sessions[i].session_id() == session_id_or_error.value()) {
  288. return Client::s_sessions.take(i);
  289. }
  290. }
  291. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::InvalidSessionId, "Invalid session id");
  292. }
  293. void Client::close_session(unsigned session_id)
  294. {
  295. bool found = Client::s_sessions.remove_first_matching([&](auto const& it) {
  296. return it->session_id() == session_id;
  297. });
  298. if (found)
  299. dbgln_if(WEBDRIVER_DEBUG, "Shut down session {}", session_id);
  300. else
  301. dbgln_if(WEBDRIVER_DEBUG, "Unable to shut down session {}: Not found", session_id);
  302. }
  303. JsonValue Client::make_json_value(JsonValue const& value)
  304. {
  305. JsonObject result;
  306. result.set("value", value);
  307. return result;
  308. }
  309. // 8.1 New Session, https://w3c.github.io/webdriver/#dfn-new-sessions
  310. // POST /session
  311. Web::WebDriver::Response Client::handle_new_session(Vector<StringView> const&, JsonValue const&)
  312. {
  313. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session");
  314. // FIXME: 1. If the maximum active sessions is equal to the length of the list of active sessions,
  315. // return error with error code session not created.
  316. // FIXME: 2. If the remote end is an intermediary node, take implementation-defined steps that either
  317. // result in returning an error with error code session not created, or in returning a
  318. // success with data that is isomorphic to that returned by remote ends according to the
  319. // rest of this algorithm. If an error is not returned, the intermediary node must retain a
  320. // reference to the session created on the upstream node as the associated session such
  321. // that commands may be forwarded to this associated session on subsequent commands.
  322. // FIXME: 3. If the maximum active sessions is equal to the length of the list of active sessions,
  323. // return error with error code session not created.
  324. // FIXME: 4. Let capabilities be the result of trying to process capabilities with parameters as an argument.
  325. auto capabilities = JsonObject {};
  326. // FIXME: 5. If capabilities’s is null, return error with error code session not created.
  327. // 6. Let session id be the result of generating a UUID.
  328. // FIXME: Actually create a UUID.
  329. auto session_id = Client::s_next_session_id++;
  330. // 7. Let session be a new session with the session ID of session id.
  331. NonnullOwnPtr<Session> session = make<Session>(session_id, *this);
  332. auto start_result = session->start();
  333. if (start_result.is_error()) {
  334. return Web::WebDriver::Error::from_code(Web::WebDriver::ErrorCode::SessionNotCreated, String::formatted("Failed to start session: {}", start_result.error().string_literal()));
  335. }
  336. auto& web_content_connection = session->web_content_connection();
  337. // FIXME: 8. Set the current session to session.
  338. // FIXME: 9. Run any WebDriver new session algorithm defined in external specifications,
  339. // with arguments session and capabilities.
  340. // 10. Append session to active sessions.
  341. Client::s_sessions.append(move(session));
  342. // 11. Let body be a JSON Object initialized with:
  343. JsonObject body;
  344. // "sessionId"
  345. // session id
  346. body.set("sessionId", String::number(session_id));
  347. // "capabilities"
  348. // capabilities
  349. body.set("capabilities", move(capabilities));
  350. // FIXME: 12. Initialize the following from capabilities:
  351. // NOTE: See spec for steps
  352. // 13. Set the webdriver-active flag to true.
  353. web_content_connection.async_set_is_webdriver_active(true);
  354. // FIXME: 14. Set the current top-level browsing context for session with the top-level browsing context
  355. // of the UA’s current browsing context.
  356. // FIXME: 15. Set the request queue to a new queue.
  357. // 16. Return success with data body.
  358. return make_json_value(body);
  359. }
  360. // 8.2 Delete Session, https://w3c.github.io/webdriver/#dfn-delete-session
  361. // DELETE /session/{session id}
  362. Web::WebDriver::Response Client::handle_delete_session(Vector<StringView> const& parameters, JsonValue const&)
  363. {
  364. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>");
  365. // 1. If the current session is an active session, try to close the session.
  366. auto session = TRY(take_session_with_id(parameters[0]));
  367. TRY(session->stop());
  368. // 2. Return success with data null.
  369. return make_json_value(JsonValue());
  370. }
  371. // 8.3 Status, https://w3c.github.io/webdriver/#dfn-status
  372. // GET /status
  373. Web::WebDriver::Response Client::handle_get_status(Vector<StringView> const&, JsonValue const&)
  374. {
  375. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /status");
  376. // 1. Let body be a new JSON Object with the following properties:
  377. // "ready"
  378. // The remote end’s readiness state.
  379. // "message"
  380. // An implementation-defined string explaining the remote end’s readiness state.
  381. // FIXME: Report if we are somehow not ready.
  382. JsonObject body;
  383. body.set("ready", true);
  384. body.set("message", "Ready to start some sessions!");
  385. // 2. Return success with data body.
  386. return JsonValue { body };
  387. }
  388. // 9.1 Get Timeouts, https://w3c.github.io/webdriver/#dfn-get-timeouts
  389. // GET /session/{session id}/timeouts
  390. Web::WebDriver::Response Client::handle_get_timeouts(Vector<StringView> const& parameters, JsonValue const&)
  391. {
  392. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session id>/timeouts");
  393. auto* session = TRY(find_session_with_id(parameters[0]));
  394. auto result = session->get_timeouts();
  395. return make_json_value(result);
  396. }
  397. // 9.2 Set Timeouts, https://w3c.github.io/webdriver/#dfn-set-timeouts
  398. // POST /session/{session id}/timeouts
  399. Web::WebDriver::Response Client::handle_set_timeouts(Vector<StringView> const& parameters, JsonValue const& payload)
  400. {
  401. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session id>/timeouts");
  402. auto* session = TRY(find_session_with_id(parameters[0]));
  403. auto result = TRY(session->set_timeouts(payload));
  404. return make_json_value(result);
  405. }
  406. // 10.1 Navigate To, https://w3c.github.io/webdriver/#dfn-navigate-to
  407. // POST /session/{session id}/url
  408. Web::WebDriver::Response Client::handle_navigate_to(Vector<StringView> const& parameters, JsonValue const& payload)
  409. {
  410. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/url");
  411. auto* session = TRY(find_session_with_id(parameters[0]));
  412. return session->web_content_connection().navigate_to(payload);
  413. }
  414. // 10.2 Get Current URL, https://w3c.github.io/webdriver/#dfn-get-current-url
  415. // GET /session/{session id}/url
  416. Web::WebDriver::Response Client::handle_get_current_url(Vector<StringView> const& parameters, JsonValue const&)
  417. {
  418. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/url");
  419. auto* session = TRY(find_session_with_id(parameters[0]));
  420. return session->web_content_connection().get_current_url();
  421. }
  422. // 10.3 Back, https://w3c.github.io/webdriver/#dfn-back
  423. // POST /session/{session id}/back
  424. Web::WebDriver::Response Client::handle_back(Vector<StringView> const& parameters, JsonValue const&)
  425. {
  426. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/back");
  427. auto* session = TRY(find_session_with_id(parameters[0]));
  428. auto result = TRY(session->back());
  429. return make_json_value(result);
  430. }
  431. // 10.4 Forward, https://w3c.github.io/webdriver/#dfn-forward
  432. // POST /session/{session id}/forward
  433. Web::WebDriver::Response Client::handle_forward(Vector<StringView> const& parameters, JsonValue const&)
  434. {
  435. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/forward");
  436. auto* session = TRY(find_session_with_id(parameters[0]));
  437. auto result = TRY(session->forward());
  438. return make_json_value(result);
  439. }
  440. // 10.5 Refresh, https://w3c.github.io/webdriver/#dfn-refresh
  441. // POST /session/{session id}/refresh
  442. Web::WebDriver::Response Client::handle_refresh(Vector<StringView> const& parameters, JsonValue const&)
  443. {
  444. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/refresh");
  445. auto* session = TRY(find_session_with_id(parameters[0]));
  446. auto result = TRY(session->refresh());
  447. return make_json_value(result);
  448. }
  449. // 10.6 Get Title, https://w3c.github.io/webdriver/#dfn-get-title
  450. // GET /session/{session id}/title
  451. Web::WebDriver::Response Client::handle_get_title(Vector<StringView> const& parameters, JsonValue const&)
  452. {
  453. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/title");
  454. auto* session = TRY(find_session_with_id(parameters[0]));
  455. auto result = TRY(session->get_title());
  456. return make_json_value(result);
  457. }
  458. // 11.1 Get Window Handle, https://w3c.github.io/webdriver/#get-window-handle
  459. // GET /session/{session id}/window
  460. Web::WebDriver::Response Client::handle_get_window_handle(Vector<StringView> const& parameters, JsonValue const&)
  461. {
  462. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window");
  463. auto* session = TRY(find_session_with_id(parameters[0]));
  464. auto result = TRY(session->get_window_handle());
  465. return make_json_value(result);
  466. }
  467. // 11.2 Close Window, https://w3c.github.io/webdriver/#dfn-close-window
  468. // DELETE /session/{session id}/window
  469. Web::WebDriver::Response Client::handle_close_window(Vector<StringView> const& parameters, JsonValue const&)
  470. {
  471. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/window");
  472. auto* session = TRY(find_session_with_id(parameters[0]));
  473. TRY(unwrap_result(session->close_window()));
  474. return make_json_value(JsonValue());
  475. }
  476. // 11.4 Get Window Handles, https://w3c.github.io/webdriver/#dfn-get-window-handles
  477. // GET /session/{session id}/window/handles
  478. Web::WebDriver::Response Client::handle_get_window_handles(Vector<StringView> const& parameters, JsonValue const&)
  479. {
  480. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window/handles");
  481. auto* session = TRY(find_session_with_id(parameters[0]));
  482. auto result = TRY(session->get_window_handles());
  483. return make_json_value(result);
  484. }
  485. // 11.8.1 Get Window Rect, https://w3c.github.io/webdriver/#dfn-get-window-rect
  486. // GET /session/{session id}/window/rect
  487. Web::WebDriver::Response Client::handle_get_window_rect(Vector<StringView> const& parameters, JsonValue const&)
  488. {
  489. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/window/rect");
  490. auto* session = TRY(find_session_with_id(parameters[0]));
  491. return session->web_content_connection().get_window_rect();
  492. }
  493. // 11.8.2 Set Window Rect, https://w3c.github.io/webdriver/#dfn-set-window-rect
  494. // POST /session/{session id}/window/rect
  495. Web::WebDriver::Response Client::handle_set_window_rect(Vector<StringView> const& parameters, JsonValue const& payload)
  496. {
  497. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/rect");
  498. auto* session = TRY(find_session_with_id(parameters[0]));
  499. return session->web_content_connection().set_window_rect(payload);
  500. }
  501. // 11.8.3 Maximize Window, https://w3c.github.io/webdriver/#dfn-maximize-window
  502. // POST /session/{session id}/window/maximize
  503. Web::WebDriver::Response Client::handle_maximize_window(Vector<StringView> const& parameters, JsonValue const&)
  504. {
  505. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/maximize");
  506. auto* session = TRY(find_session_with_id(parameters[0]));
  507. return session->web_content_connection().maximize_window();
  508. }
  509. // 11.8.4 Minimize Window, https://w3c.github.io/webdriver/#minimize-window
  510. // POST /session/{session id}/window/minimize
  511. Web::WebDriver::Response Client::handle_minimize_window(Vector<StringView> const& parameters, JsonValue const&)
  512. {
  513. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/window/minimize");
  514. auto* session = TRY(find_session_with_id(parameters[0]));
  515. return session->web_content_connection().minimize_window();
  516. }
  517. // 12.3.2 Find Element, https://w3c.github.io/webdriver/#dfn-find-element
  518. // POST /session/{session id}/element
  519. Web::WebDriver::Response Client::handle_find_element(Vector<StringView> const& parameters, JsonValue const& payload)
  520. {
  521. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element");
  522. auto* session = TRY(find_session_with_id(parameters[0]));
  523. return session->web_content_connection().find_element(payload);
  524. }
  525. // 12.3.3 Find Elements, https://w3c.github.io/webdriver/#dfn-find-elements
  526. // POST /session/{session id}/elements
  527. Web::WebDriver::Response Client::handle_find_elements(Vector<StringView> const& parameters, JsonValue const& payload)
  528. {
  529. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/elements");
  530. auto* session = TRY(find_session_with_id(parameters[0]));
  531. return session->web_content_connection().find_elements(payload);
  532. }
  533. // 12.3.4 Find Element From Element, https://w3c.github.io/webdriver/#dfn-find-element-from-element
  534. // POST /session/{session id}/element/{element id}/element
  535. Web::WebDriver::Response Client::handle_find_element_from_element(Vector<StringView> const& parameters, JsonValue const& payload)
  536. {
  537. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/element");
  538. auto* session = TRY(find_session_with_id(parameters[0]));
  539. return session->web_content_connection().find_element_from_element(payload, parameters[1]);
  540. }
  541. // 12.3.5 Find Elements From Element, https://w3c.github.io/webdriver/#dfn-find-elements-from-element
  542. // POST /session/{session id}/element/{element id}/elements
  543. Web::WebDriver::Response Client::handle_find_elements_from_element(Vector<StringView> const& parameters, JsonValue const& payload)
  544. {
  545. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/element/<element_id>/elements");
  546. auto* session = TRY(find_session_with_id(parameters[0]));
  547. return session->web_content_connection().find_elements_from_element(payload, parameters[1]);
  548. }
  549. // 12.4.1 Is Element Selected, https://w3c.github.io/webdriver/#dfn-is-element-selected
  550. // GET /session/{session id}/element/{element id}/selected
  551. Web::WebDriver::Response Client::handle_is_element_selected(Vector<StringView> const& parameters, JsonValue const&)
  552. {
  553. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/selected");
  554. auto* session = TRY(find_session_with_id(parameters[0]));
  555. return session->web_content_connection().is_element_selected(parameters[1]);
  556. }
  557. // 12.4.2 Get Element Attribute, https://w3c.github.io/webdriver/#dfn-get-element-attribute
  558. // GET /session/{session id}/element/{element id}/attribute/{name}
  559. Web::WebDriver::Response Client::handle_get_element_attribute(Vector<StringView> const& parameters, JsonValue const&)
  560. {
  561. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/attribute/<name>");
  562. auto* session = TRY(find_session_with_id(parameters[0]));
  563. return session->web_content_connection().get_element_attribute(parameters[1], parameters[2]);
  564. }
  565. // 12.4.3 Get Element Property, https://w3c.github.io/webdriver/#dfn-get-element-property
  566. // GET /session/{session id}/element/{element id}/property/{name}
  567. Web::WebDriver::Response Client::handle_get_element_property(Vector<StringView> const& parameters, JsonValue const&)
  568. {
  569. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/property/<name>");
  570. auto* session = TRY(find_session_with_id(parameters[0]));
  571. return session->web_content_connection().get_element_property(parameters[1], parameters[2]);
  572. }
  573. // 12.4.4 Get Element CSS Value, https://w3c.github.io/webdriver/#dfn-get-element-css-value
  574. // GET /session/{session id}/element/{element id}/css/{property name}
  575. Web::WebDriver::Response Client::handle_get_element_css_value(Vector<StringView> const& parameters, JsonValue const&)
  576. {
  577. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/css/<property_name>");
  578. auto* session = TRY(find_session_with_id(parameters[0]));
  579. return session->web_content_connection().get_element_css_value(parameters[1], parameters[2]);
  580. }
  581. // 12.4.5 Get Element Text, https://w3c.github.io/webdriver/#dfn-get-element-text
  582. // GET /session/{session id}/element/{element id}/text
  583. Web::WebDriver::Response Client::handle_get_element_text(Vector<StringView> const& parameters, JsonValue const&)
  584. {
  585. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/text");
  586. auto* session = TRY(find_session_with_id(parameters[0]));
  587. return session->web_content_connection().get_element_text(parameters[1]);
  588. }
  589. // 12.4.6 Get Element Tag Name, https://w3c.github.io/webdriver/#dfn-get-element-tag-name
  590. // GET /session/{session id}/element/{element id}/name
  591. Web::WebDriver::Response Client::handle_get_element_tag_name(Vector<StringView> const& parameters, JsonValue const&)
  592. {
  593. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/name");
  594. auto* session = TRY(find_session_with_id(parameters[0]));
  595. return session->web_content_connection().get_element_tag_name(parameters[1]);
  596. }
  597. // 12.4.7 Get Element Rect, https://w3c.github.io/webdriver/#dfn-get-element-rect
  598. // GET /session/{session id}/element/{element id}/rect
  599. Web::WebDriver::Response Client::handle_get_element_rect(Vector<StringView> const& parameters, JsonValue const&)
  600. {
  601. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/rect");
  602. auto* session = TRY(find_session_with_id(parameters[0]));
  603. return session->web_content_connection().get_element_rect(parameters[1]);
  604. }
  605. // 12.4.8 Is Element Enabled, https://w3c.github.io/webdriver/#dfn-is-element-enabled
  606. // GET /session/{session id}/element/{element id}/enabled
  607. Web::WebDriver::Response Client::handle_is_element_enabled(Vector<StringView> const& parameters, JsonValue const&)
  608. {
  609. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/enabled");
  610. auto* session = TRY(find_session_with_id(parameters[0]));
  611. return session->web_content_connection().is_element_enabled(parameters[1]);
  612. }
  613. // 13.1 Get Page Source, https://w3c.github.io/webdriver/#dfn-get-page-source
  614. // GET /session/{session id}/source
  615. Web::WebDriver::Response Client::handle_get_source(Vector<StringView> const& parameters, JsonValue const&)
  616. {
  617. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/source");
  618. auto* session = TRY(find_session_with_id(parameters[0]));
  619. return session->web_content_connection().get_source();
  620. }
  621. // 13.2.1 Execute Script, https://w3c.github.io/webdriver/#dfn-execute-script
  622. // POST /session/{session id}/execute/sync
  623. Web::WebDriver::Response Client::handle_execute_script(Vector<StringView> const& parameters, JsonValue const& payload)
  624. {
  625. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/execute/sync");
  626. auto* session = TRY(find_session_with_id(parameters[0]));
  627. return session->web_content_connection().execute_script(payload);
  628. }
  629. // 13.2.2 Execute Async Script, https://w3c.github.io/webdriver/#dfn-execute-async-script
  630. // POST /session/{session id}/execute/async
  631. Web::WebDriver::Response Client::handle_execute_async_script(Vector<StringView> const& parameters, JsonValue const& payload)
  632. {
  633. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/execute/async");
  634. auto* session = TRY(find_session_with_id(parameters[0]));
  635. return session->web_content_connection().execute_async_script(payload);
  636. }
  637. // 14.1 Get All Cookies, https://w3c.github.io/webdriver/#dfn-get-all-cookies
  638. // GET /session/{session id}/cookie
  639. Web::WebDriver::Response Client::handle_get_all_cookies(Vector<StringView> const& parameters, JsonValue const&)
  640. {
  641. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/cookie");
  642. auto* session = TRY(find_session_with_id(parameters[0]));
  643. return session->web_content_connection().get_all_cookies();
  644. }
  645. // 14.2 Get Named Cookie, https://w3c.github.io/webdriver/#dfn-get-named-cookie
  646. // GET /session/{session id}/cookie/{name}
  647. Web::WebDriver::Response Client::handle_get_named_cookie(Vector<StringView> const& parameters, JsonValue const&)
  648. {
  649. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/cookie/<name>");
  650. auto* session = TRY(find_session_with_id(parameters[0]));
  651. return session->web_content_connection().get_named_cookie(parameters[1]);
  652. }
  653. // 14.3 Add Cookie, https://w3c.github.io/webdriver/#dfn-adding-a-cookie
  654. // POST /session/{session id}/cookie
  655. Web::WebDriver::Response Client::handle_add_cookie(Vector<StringView> const& parameters, JsonValue const& payload)
  656. {
  657. dbgln_if(WEBDRIVER_DEBUG, "Handling POST /session/<session_id>/cookie");
  658. auto* session = TRY(find_session_with_id(parameters[0]));
  659. auto result = TRY(session->add_cookie(payload));
  660. return make_json_value(result);
  661. }
  662. // 14.4 Delete Cookie, https://w3c.github.io/webdriver/#dfn-delete-cookie
  663. // DELETE /session/{session id}/cookie/{name}
  664. Web::WebDriver::Response Client::handle_delete_cookie(Vector<StringView> const& parameters, JsonValue const&)
  665. {
  666. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/cookie/<name>");
  667. auto* session = TRY(find_session_with_id(parameters[0]));
  668. auto result = TRY(session->delete_cookie(parameters[1]));
  669. return make_json_value(result);
  670. }
  671. // 14.5 Delete All Cookies, https://w3c.github.io/webdriver/#dfn-delete-all-cookies
  672. // DELETE /session/{session id}/cookie
  673. Web::WebDriver::Response Client::handle_delete_all_cookies(Vector<StringView> const& parameters, JsonValue const&)
  674. {
  675. dbgln_if(WEBDRIVER_DEBUG, "Handling DELETE /session/<session_id>/cookie");
  676. auto* session = TRY(find_session_with_id(parameters[0]));
  677. auto result = TRY(session->delete_all_cookies());
  678. return make_json_value(result);
  679. }
  680. // 17.1 Take Screenshot, https://w3c.github.io/webdriver/#take-screenshot
  681. // GET /session/{session id}/screenshot
  682. Web::WebDriver::Response Client::handle_take_screenshot(Vector<StringView> const& parameters, JsonValue const&)
  683. {
  684. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/screenshot");
  685. auto* session = TRY(find_session_with_id(parameters[0]));
  686. return session->web_content_connection().take_screenshot();
  687. }
  688. // 17.2 Take Element Screenshot, https://w3c.github.io/webdriver/#dfn-take-element-screenshot
  689. // GET /session/{session id}/element/{element id}/screenshot
  690. Web::WebDriver::Response Client::handle_take_element_screenshot(Vector<StringView> const& parameters, JsonValue const&)
  691. {
  692. dbgln_if(WEBDRIVER_DEBUG, "Handling GET /session/<session_id>/element/<element_id>/screenshot");
  693. auto* session = TRY(find_session_with_id(parameters[0]));
  694. return session->web_content_connection().take_element_screenshot(parameters[1]);
  695. }
  696. }