Client.cpp 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  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/ByteBuffer.h>
  11. #include <AK/Debug.h>
  12. #include <AK/Format.h>
  13. #include <AK/JsonObject.h>
  14. #include <AK/JsonParser.h>
  15. #include <AK/JsonValue.h>
  16. #include <AK/Span.h>
  17. #include <AK/StringBuilder.h>
  18. #include <AK/StringView.h>
  19. #include <LibCore/DateTime.h>
  20. #include <LibHTTP/HttpResponse.h>
  21. #include <LibWeb/WebDriver/Client.h>
  22. namespace Web::WebDriver {
  23. using RouteHandler = Response (*)(Client&, Parameters, JsonValue);
  24. struct Route {
  25. HTTP::HttpRequest::Method method {};
  26. StringView path;
  27. RouteHandler handler { nullptr };
  28. };
  29. struct MatchedRoute {
  30. RouteHandler handler;
  31. Vector<StringView> parameters;
  32. };
  33. // clang-format off
  34. // This would be formatted rather badly.
  35. #define ROUTE(method, path, handler) \
  36. Route { \
  37. HTTP::HttpRequest::method, \
  38. path, \
  39. [](auto& client, auto parameters, auto payload) { \
  40. return client.handler(parameters, move(payload)); \
  41. } \
  42. }
  43. // clang-format on
  44. // https://w3c.github.io/webdriver/#dfn-endpoints
  45. static constexpr auto s_webdriver_endpoints = Array {
  46. ROUTE(POST, "/session"sv, new_session),
  47. ROUTE(DELETE, "/session/:session_id"sv, delete_session),
  48. ROUTE(GET, "/status"sv, get_status),
  49. ROUTE(GET, "/session/:session_id/timeouts"sv, get_timeouts),
  50. ROUTE(POST, "/session/:session_id/timeouts"sv, set_timeouts),
  51. ROUTE(POST, "/session/:session_id/url"sv, navigate_to),
  52. ROUTE(GET, "/session/:session_id/url"sv, get_current_url),
  53. ROUTE(POST, "/session/:session_id/back"sv, back),
  54. ROUTE(POST, "/session/:session_id/forward"sv, forward),
  55. ROUTE(POST, "/session/:session_id/refresh"sv, refresh),
  56. ROUTE(GET, "/session/:session_id/title"sv, get_title),
  57. ROUTE(GET, "/session/:session_id/window"sv, get_window_handle),
  58. ROUTE(DELETE, "/session/:session_id/window"sv, close_window),
  59. ROUTE(POST, "/session/:session_id/window"sv, switch_to_window),
  60. ROUTE(GET, "/session/:session_id/window/handles"sv, get_window_handles),
  61. ROUTE(GET, "/session/:session_id/window/rect"sv, get_window_rect),
  62. ROUTE(POST, "/session/:session_id/window/rect"sv, set_window_rect),
  63. ROUTE(POST, "/session/:session_id/window/maximize"sv, maximize_window),
  64. ROUTE(POST, "/session/:session_id/window/minimize"sv, minimize_window),
  65. ROUTE(POST, "/session/:session_id/window/fullscreen"sv, fullscreen_window),
  66. ROUTE(POST, "/session/:session_id/element"sv, find_element),
  67. ROUTE(POST, "/session/:session_id/elements"sv, find_elements),
  68. ROUTE(POST, "/session/:session_id/element/:element_id/element"sv, find_element_from_element),
  69. ROUTE(POST, "/session/:session_id/element/:element_id/elements"sv, find_elements_from_element),
  70. ROUTE(POST, "/session/:session_id/shadow/:shadow_id/element"sv, find_element_from_shadow_root),
  71. ROUTE(POST, "/session/:session_id/shadow/:shadow_id/elements"sv, find_elements_from_shadow_root),
  72. ROUTE(GET, "/session/:session_id/element/active"sv, get_active_element),
  73. ROUTE(GET, "/session/:session_id/element/:element_id/shadow"sv, get_element_shadow_root),
  74. ROUTE(GET, "/session/:session_id/element/:element_id/selected"sv, is_element_selected),
  75. ROUTE(GET, "/session/:session_id/element/:element_id/attribute/:name"sv, get_element_attribute),
  76. ROUTE(GET, "/session/:session_id/element/:element_id/property/:name"sv, get_element_property),
  77. ROUTE(GET, "/session/:session_id/element/:element_id/css/:name"sv, get_element_css_value),
  78. ROUTE(GET, "/session/:session_id/element/:element_id/text"sv, get_element_text),
  79. ROUTE(GET, "/session/:session_id/element/:element_id/name"sv, get_element_tag_name),
  80. ROUTE(GET, "/session/:session_id/element/:element_id/rect"sv, get_element_rect),
  81. ROUTE(GET, "/session/:session_id/element/:element_id/enabled"sv, is_element_enabled),
  82. ROUTE(GET, "/session/:session_id/element/:element_id/computedrole"sv, get_computed_role),
  83. ROUTE(POST, "/session/:session_id/element/:element_id/click"sv, click),
  84. ROUTE(GET, "/session/:session_id/source"sv, get_source),
  85. ROUTE(POST, "/session/:session_id/execute/sync"sv, execute_script),
  86. ROUTE(POST, "/session/:session_id/execute/async"sv, execute_async_script),
  87. ROUTE(GET, "/session/:session_id/cookie"sv, get_all_cookies),
  88. ROUTE(GET, "/session/:session_id/cookie/:name"sv, get_named_cookie),
  89. ROUTE(POST, "/session/:session_id/cookie"sv, add_cookie),
  90. ROUTE(DELETE, "/session/:session_id/cookie/:name"sv, delete_cookie),
  91. ROUTE(DELETE, "/session/:session_id/cookie"sv, delete_all_cookies),
  92. ROUTE(POST, "/session/:session_id/alert/dismiss"sv, dismiss_alert),
  93. ROUTE(POST, "/session/:session_id/alert/accept"sv, accept_alert),
  94. ROUTE(GET, "/session/:session_id/alert/text"sv, get_alert_text),
  95. ROUTE(POST, "/session/:session_id/alert/text"sv, send_alert_text),
  96. ROUTE(GET, "/session/:session_id/screenshot"sv, take_screenshot),
  97. ROUTE(GET, "/session/:session_id/element/:element_id/screenshot"sv, take_element_screenshot),
  98. ROUTE(POST, "/session/:session_id/print"sv, print_page),
  99. };
  100. // https://w3c.github.io/webdriver/#dfn-match-a-request
  101. static ErrorOr<MatchedRoute, Error> match_route(HTTP::HttpRequest const& request)
  102. {
  103. dbgln_if(WEBDRIVER_DEBUG, "match_route({}, {})", HTTP::to_deprecated_string(request.method()), request.resource());
  104. auto request_path = request.resource().view();
  105. Vector<StringView> parameters;
  106. auto next_segment = [](auto& path) -> Optional<StringView> {
  107. if (auto index = path.find('/'); index.has_value() && (*index + 1) < path.length()) {
  108. path = path.substring_view(*index + 1);
  109. if (index = path.find('/'); index.has_value())
  110. return path.substring_view(0, *index);
  111. return path;
  112. }
  113. path = {};
  114. return {};
  115. };
  116. for (auto const& route : s_webdriver_endpoints) {
  117. dbgln_if(WEBDRIVER_DEBUG, "- Checking {} {}", HTTP::to_deprecated_string(route.method), route.path);
  118. if (route.method != request.method())
  119. continue;
  120. auto route_path = route.path;
  121. Optional<bool> match;
  122. auto on_failed_match = [&]() {
  123. request_path = request.resource();
  124. parameters.clear();
  125. match = false;
  126. };
  127. while (!match.has_value()) {
  128. auto request_segment = next_segment(request_path);
  129. auto route_segment = next_segment(route_path);
  130. if (!request_segment.has_value() && !route_segment.has_value())
  131. match = true;
  132. else if (request_segment.has_value() != route_segment.has_value())
  133. on_failed_match();
  134. else if (route_segment->starts_with(':'))
  135. parameters.append(*request_segment);
  136. else if (request_segment != route_segment)
  137. on_failed_match();
  138. }
  139. if (*match) {
  140. dbgln_if(WEBDRIVER_DEBUG, "- Found match with parameters={}", parameters);
  141. return MatchedRoute { route.handler, parameters };
  142. }
  143. }
  144. return Error::from_code(ErrorCode::UnknownCommand, "The command was not recognized.");
  145. }
  146. static JsonValue make_success_response(JsonValue value)
  147. {
  148. JsonObject result;
  149. result.set("value", move(value));
  150. return result;
  151. }
  152. Client::Client(NonnullOwnPtr<Core::Stream::BufferedTCPSocket> socket, Core::Object* parent)
  153. : Core::Object(parent)
  154. , m_socket(move(socket))
  155. {
  156. m_socket->on_ready_to_read = [this] {
  157. if (auto result = on_ready_to_read(); result.is_error()) {
  158. result.error().visit(
  159. [](AK::Error const& error) {
  160. warnln("Internal error: {}", error);
  161. },
  162. [this](WebDriver::Error const& error) {
  163. if (send_error_response(error).is_error())
  164. warnln("Could not send error response");
  165. });
  166. die();
  167. }
  168. m_request = {};
  169. };
  170. }
  171. Client::~Client()
  172. {
  173. m_socket->close();
  174. }
  175. void Client::die()
  176. {
  177. deferred_invoke([this] { remove_from_parent(); });
  178. }
  179. ErrorOr<void, Client::WrappedError> Client::on_ready_to_read()
  180. {
  181. // FIXME: All this should be moved to LibHTTP and be made spec compliant.
  182. auto buffer = TRY(ByteBuffer::create_uninitialized(m_socket->buffer_size()));
  183. StringBuilder builder;
  184. for (;;) {
  185. if (!TRY(m_socket->can_read_without_blocking()))
  186. break;
  187. auto data = TRY(m_socket->read(buffer));
  188. TRY(builder.try_append(StringView { data }));
  189. if (m_socket->is_eof())
  190. break;
  191. }
  192. m_request = HTTP::HttpRequest::from_raw_request(builder.to_byte_buffer());
  193. if (!m_request.has_value())
  194. return {};
  195. auto body = TRY(read_body_as_json());
  196. TRY(handle_request(move(body)));
  197. return {};
  198. }
  199. ErrorOr<JsonValue, Client::WrappedError> Client::read_body_as_json()
  200. {
  201. // FIXME: If we received a multipart body here, this would fail badly.
  202. // FIXME: Check the Content-Type is actually application/json.
  203. size_t content_length = 0;
  204. for (auto const& header : m_request->headers()) {
  205. if (header.name.equals_ignoring_case("Content-Length"sv)) {
  206. content_length = header.value.to_uint<size_t>(TrimWhitespace::Yes).value_or(0);
  207. break;
  208. }
  209. }
  210. if (content_length == 0)
  211. return JsonValue {};
  212. JsonParser json_parser(m_request->body());
  213. return TRY(json_parser.parse());
  214. }
  215. ErrorOr<void, Client::WrappedError> Client::handle_request(JsonValue body)
  216. {
  217. if constexpr (WEBDRIVER_DEBUG) {
  218. dbgln("Got HTTP request: {} {}", m_request->method_name(), m_request->resource());
  219. if (!body.is_null())
  220. dbgln("Body: {}", body.to_deprecated_string());
  221. }
  222. auto const& [handler, parameters] = TRY(match_route(*m_request));
  223. auto result = TRY((*handler)(*this, parameters, move(body)));
  224. return send_success_response(move(result));
  225. }
  226. ErrorOr<void, Client::WrappedError> Client::send_success_response(JsonValue result)
  227. {
  228. result = make_success_response(move(result));
  229. auto content = result.serialized<StringBuilder>();
  230. StringBuilder builder;
  231. builder.append("HTTP/1.0 200 OK\r\n"sv);
  232. builder.append("Server: WebDriver (SerenityOS)\r\n"sv);
  233. builder.append("X-Frame-Options: SAMEORIGIN\r\n"sv);
  234. builder.append("X-Content-Type-Options: nosniff\r\n"sv);
  235. builder.append("Pragma: no-cache\r\n"sv);
  236. builder.append("Content-Type: application/json; charset=utf-8\r\n"sv);
  237. builder.appendff("Content-Length: {}\r\n", content.length());
  238. builder.append("\r\n"sv);
  239. auto builder_contents = builder.to_byte_buffer();
  240. TRY(m_socket->write(builder_contents));
  241. while (!content.is_empty()) {
  242. auto bytes_sent = TRY(m_socket->write(content.bytes()));
  243. content = content.substring_view(bytes_sent);
  244. }
  245. bool keep_alive = false;
  246. if (auto it = m_request->headers().find_if([](auto& header) { return header.name.equals_ignoring_case("Connection"sv); }); !it.is_end())
  247. keep_alive = it->value.trim_whitespace().equals_ignoring_case("keep-alive"sv);
  248. if (!keep_alive)
  249. die();
  250. log_response(200);
  251. return {};
  252. }
  253. ErrorOr<void, Client::WrappedError> Client::send_error_response(Error const& error)
  254. {
  255. // FIXME: Implement to spec.
  256. dbgln_if(WEBDRIVER_DEBUG, "Sending error response: {} {}: {}", error.http_status, error.error, error.message);
  257. auto reason = HTTP::HttpResponse::reason_phrase_for_code(error.http_status);
  258. JsonObject result;
  259. result.set("error", error.error);
  260. result.set("message", error.message);
  261. result.set("stacktrace", "");
  262. if (error.data.has_value())
  263. result.set("data", *error.data);
  264. StringBuilder content_builder;
  265. result.serialize(content_builder);
  266. StringBuilder header_builder;
  267. header_builder.appendff("HTTP/1.0 {} {}\r\n", error.http_status, reason);
  268. header_builder.append("Content-Type: application/json; charset=UTF-8\r\n"sv);
  269. header_builder.appendff("Content-Length: {}\r\n", content_builder.length());
  270. header_builder.append("\r\n"sv);
  271. TRY(m_socket->write(header_builder.to_byte_buffer()));
  272. TRY(m_socket->write(content_builder.to_byte_buffer()));
  273. log_response(error.http_status);
  274. return {};
  275. }
  276. void Client::log_response(unsigned code)
  277. {
  278. outln("{} :: {:03d} :: {} {}", Core::DateTime::now().to_deprecated_string(), code, m_request->method_name(), m_request->resource());
  279. }
  280. }