Client.cpp 37 KB

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