| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Copyright (c) 2022, Florent Castelli <florent.castelli@gmail.com> | 
					
						
							|  |  |  |  * Copyright (c) 2022, Sam Atkins <atkinssj@serenityos.org> | 
					
						
							|  |  |  |  * Copyright (c) 2022, Tobias Christiansen <tobyase@serenityos.org> | 
					
						
							|  |  |  |  * Copyright (c) 2022, Linus Groh <linusg@serenityos.org> | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |  * Copyright (c) 2022-2024, Tim Flynn <trflynn89@ladybird.org> | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |  * | 
					
						
							|  |  |  |  * SPDX-License-Identifier: BSD-2-Clause | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #include <AK/ByteBuffer.h>
 | 
					
						
							|  |  |  | #include <AK/Debug.h>
 | 
					
						
							|  |  |  | #include <AK/Format.h>
 | 
					
						
							|  |  |  | #include <AK/JsonObject.h>
 | 
					
						
							|  |  |  | #include <AK/JsonParser.h>
 | 
					
						
							|  |  |  | #include <AK/JsonValue.h>
 | 
					
						
							|  |  |  | #include <AK/Span.h>
 | 
					
						
							|  |  |  | #include <AK/StringBuilder.h>
 | 
					
						
							|  |  |  | #include <AK/StringView.h>
 | 
					
						
							|  |  |  | #include <LibCore/DateTime.h>
 | 
					
						
							|  |  |  | #include <LibHTTP/HttpResponse.h>
 | 
					
						
							|  |  |  | #include <LibWeb/WebDriver/Client.h>
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | namespace Web::WebDriver { | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | using RouteHandler = Response (*)(Client&, Parameters, JsonValue); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | struct Route { | 
					
						
							|  |  |  |     HTTP::HttpRequest::Method method {}; | 
					
						
							|  |  |  |     StringView path; | 
					
						
							|  |  |  |     RouteHandler handler { nullptr }; | 
					
						
							|  |  |  | }; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | struct MatchedRoute { | 
					
						
							|  |  |  |     RouteHandler handler; | 
					
						
							| 
									
										
										
										
											2023-03-05 15:31:49 -05:00
										 |  |  |     Vector<String> parameters; | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | }; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-07-07 22:59:01 -04:00
										 |  |  | #define ROUTE(method, path, handler)                              \
 | 
					
						
							|  |  |  |     Route                                                         \ | 
					
						
							|  |  |  |     {                                                             \ | 
					
						
							|  |  |  |         HTTP::HttpRequest::method,                                \ | 
					
						
							|  |  |  |             path,                                                 \ | 
					
						
							|  |  |  |             [](auto& client, auto parameters, auto payload) {     \ | 
					
						
							|  |  |  |                 return client.handler(parameters, move(payload)); \ | 
					
						
							|  |  |  |             }                                                     \ | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | // https://w3c.github.io/webdriver/#dfn-endpoints
 | 
					
						
							|  |  |  | static constexpr auto s_webdriver_endpoints = Array { | 
					
						
							|  |  |  |     ROUTE(POST, "/session"sv, new_session), | 
					
						
							|  |  |  |     ROUTE(DELETE, "/session/:session_id"sv, delete_session), | 
					
						
							|  |  |  |     ROUTE(GET, "/status"sv, get_status), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/timeouts"sv, get_timeouts), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/timeouts"sv, set_timeouts), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/url"sv, navigate_to), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/url"sv, get_current_url), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/back"sv, back), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/forward"sv, forward), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/refresh"sv, refresh), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/title"sv, get_title), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/window"sv, get_window_handle), | 
					
						
							|  |  |  |     ROUTE(DELETE, "/session/:session_id/window"sv, close_window), | 
					
						
							| 
									
										
										
										
											2022-11-24 20:32:53 -06:00
										 |  |  |     ROUTE(POST, "/session/:session_id/window"sv, switch_to_window), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/window/handles"sv, get_window_handles), | 
					
						
							| 
									
										
										
										
											2023-03-14 14:09:50 +03:00
										 |  |  |     ROUTE(POST, "/session/:session_id/window/new"sv, new_window), | 
					
						
							| 
									
										
										
										
											2024-09-07 12:41:54 -07:00
										 |  |  |     ROUTE(POST, "/session/:session_id/frame"sv, switch_to_frame), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/frame/parent"sv, switch_to_parent_frame), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/window/rect"sv, get_window_rect), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/window/rect"sv, set_window_rect), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/window/maximize"sv, maximize_window), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/window/minimize"sv, minimize_window), | 
					
						
							| 
									
										
										
										
											2022-11-13 19:00:38 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/window/fullscreen"sv, fullscreen_window), | 
					
						
							| 
									
										
										
										
											2024-05-29 11:14:42 -06:00
										 |  |  |     ROUTE(POST, "/session/:session_id/window/consume-user-activation"sv, consume_user_activation), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/element"sv, find_element), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/elements"sv, find_elements), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/element/:element_id/element"sv, find_element_from_element), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/element/:element_id/elements"sv, find_elements_from_element), | 
					
						
							| 
									
										
										
										
											2022-11-14 19:48:48 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/shadow/:shadow_id/element"sv, find_element_from_shadow_root), | 
					
						
							| 
									
										
										
										
											2022-11-14 19:54:17 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/shadow/:shadow_id/elements"sv, find_elements_from_shadow_root), | 
					
						
							| 
									
										
										
										
											2022-11-14 19:02:23 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/element/active"sv, get_active_element), | 
					
						
							| 
									
										
										
										
											2022-11-14 19:27:11 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/shadow"sv, get_element_shadow_root), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/selected"sv, is_element_selected), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/attribute/:name"sv, get_element_attribute), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/property/:name"sv, get_element_property), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/css/:name"sv, get_element_css_value), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/text"sv, get_element_text), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/name"sv, get_element_tag_name), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/rect"sv, get_element_rect), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/enabled"sv, is_element_enabled), | 
					
						
							| 
									
										
										
										
											2023-01-15 10:26:08 -06:00
										 |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/computedrole"sv, get_computed_role), | 
					
						
							| 
									
										
										
										
											2023-02-19 11:36:08 -06:00
										 |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/computedlabel"sv, get_computed_label), | 
					
						
							| 
									
										
										
										
											2023-01-26 14:11:54 +00:00
										 |  |  |     ROUTE(POST, "/session/:session_id/element/:element_id/click"sv, element_click), | 
					
						
							| 
									
										
										
										
											2024-09-07 12:41:54 -07:00
										 |  |  |     ROUTE(POST, "/session/:session_id/element/:element_id/clear"sv, element_clear), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/element/:element_id/value"sv, element_send_keys), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/source"sv, get_source), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/execute/sync"sv, execute_script), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/execute/async"sv, execute_async_script), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/cookie"sv, get_all_cookies), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/cookie/:name"sv, get_named_cookie), | 
					
						
							|  |  |  |     ROUTE(POST, "/session/:session_id/cookie"sv, add_cookie), | 
					
						
							|  |  |  |     ROUTE(DELETE, "/session/:session_id/cookie/:name"sv, delete_cookie), | 
					
						
							|  |  |  |     ROUTE(DELETE, "/session/:session_id/cookie"sv, delete_all_cookies), | 
					
						
							| 
									
										
										
										
											2024-09-02 14:41:24 -04:00
										 |  |  |     ROUTE(POST, "/session/:session_id/actions"sv, perform_actions), | 
					
						
							| 
									
										
										
										
											2023-06-17 17:36:00 +02:00
										 |  |  |     ROUTE(DELETE, "/session/:session_id/actions"sv, release_actions), | 
					
						
							| 
									
										
										
										
											2022-11-16 07:15:57 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/alert/dismiss"sv, dismiss_alert), | 
					
						
							| 
									
										
										
										
											2022-11-16 07:24:22 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/alert/accept"sv, accept_alert), | 
					
						
							| 
									
										
										
										
											2022-11-16 08:26:48 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/alert/text"sv, get_alert_text), | 
					
						
							| 
									
										
										
										
											2022-11-16 08:57:05 -05:00
										 |  |  |     ROUTE(POST, "/session/:session_id/alert/text"sv, send_alert_text), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     ROUTE(GET, "/session/:session_id/screenshot"sv, take_screenshot), | 
					
						
							|  |  |  |     ROUTE(GET, "/session/:session_id/element/:element_id/screenshot"sv, take_element_screenshot), | 
					
						
							| 
									
										
										
										
											2022-11-27 00:30:03 +01:00
										 |  |  |     ROUTE(POST, "/session/:session_id/print"sv, print_page), | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | }; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | // https://w3c.github.io/webdriver/#dfn-match-a-request
 | 
					
						
							|  |  |  | static ErrorOr<MatchedRoute, Error> match_route(HTTP::HttpRequest const& request) | 
					
						
							|  |  |  | { | 
					
						
							| 
									
										
										
										
											2024-02-07 08:06:55 -07:00
										 |  |  |     dbgln_if(WEBDRIVER_ROUTE_DEBUG, "match_route({}, {})", HTTP::to_string_view(request.method()), request.resource()); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							|  |  |  |     auto request_path = request.resource().view(); | 
					
						
							| 
									
										
										
										
											2023-03-05 15:31:49 -05:00
										 |  |  |     Vector<String> parameters; | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							|  |  |  |     auto next_segment = [](auto& path) -> Optional<StringView> { | 
					
						
							|  |  |  |         if (auto index = path.find('/'); index.has_value() && (*index + 1) < path.length()) { | 
					
						
							|  |  |  |             path = path.substring_view(*index + 1); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |             if (index = path.find('/'); index.has_value()) | 
					
						
							|  |  |  |                 return path.substring_view(0, *index); | 
					
						
							|  |  |  |             return path; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         path = {}; | 
					
						
							|  |  |  |         return {}; | 
					
						
							|  |  |  |     }; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     for (auto const& route : s_webdriver_endpoints) { | 
					
						
							| 
									
										
										
										
											2024-02-07 08:06:55 -07:00
										 |  |  |         dbgln_if(WEBDRIVER_ROUTE_DEBUG, "- Checking {} {}", HTTP::to_string_view(route.method), route.path); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |         if (route.method != request.method()) | 
					
						
							|  |  |  |             continue; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         auto route_path = route.path; | 
					
						
							|  |  |  |         Optional<bool> match; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         auto on_failed_match = [&]() { | 
					
						
							|  |  |  |             request_path = request.resource(); | 
					
						
							|  |  |  |             parameters.clear(); | 
					
						
							|  |  |  |             match = false; | 
					
						
							|  |  |  |         }; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         while (!match.has_value()) { | 
					
						
							|  |  |  |             auto request_segment = next_segment(request_path); | 
					
						
							|  |  |  |             auto route_segment = next_segment(route_path); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |             if (!request_segment.has_value() && !route_segment.has_value()) | 
					
						
							|  |  |  |                 match = true; | 
					
						
							|  |  |  |             else if (request_segment.has_value() != route_segment.has_value()) | 
					
						
							|  |  |  |                 on_failed_match(); | 
					
						
							|  |  |  |             else if (route_segment->starts_with(':')) | 
					
						
							| 
									
										
										
										
											2023-03-05 15:31:49 -05:00
										 |  |  |                 TRY(parameters.try_append(TRY(String::from_utf8(*request_segment)))); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |             else if (request_segment != route_segment) | 
					
						
							|  |  |  |                 on_failed_match(); | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         if (*match) { | 
					
						
							| 
									
										
										
										
											2024-02-07 08:06:55 -07:00
										 |  |  |             dbgln_if(WEBDRIVER_ROUTE_DEBUG, "- Found match with parameters={}", parameters); | 
					
						
							| 
									
										
										
										
											2023-03-05 15:31:49 -05:00
										 |  |  |             return MatchedRoute { route.handler, move(parameters) }; | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |         } | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     return Error::from_code(ErrorCode::UnknownCommand, "The command was not recognized."); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-11-13 00:52:44 -05:00
										 |  |  | static JsonValue make_success_response(JsonValue value) | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  |     JsonObject result; | 
					
						
							|  |  |  |     result.set("value", move(value)); | 
					
						
							|  |  |  |     return result; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-08-06 18:09:39 +02:00
										 |  |  | Client::Client(NonnullOwnPtr<Core::BufferedTCPSocket> socket, Core::EventReceiver* parent) | 
					
						
							|  |  |  |     : Core::EventReceiver(parent) | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     , m_socket(move(socket)) | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  |     m_socket->on_ready_to_read = [this] { | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |         if (auto result = on_ready_to_read(); result.is_error()) | 
					
						
							|  |  |  |             handle_error({}, result.release_error()); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     }; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Client::~Client() | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  |     m_socket->close(); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | void Client::die() | 
					
						
							|  |  |  | { | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     // We defer removing this connection to avoid closing its socket while we are inside the on_ready_to_read callback.
 | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     deferred_invoke([this] { remove_from_parent(); }); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ErrorOr<void, Client::WrappedError> Client::on_ready_to_read() | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  |     // FIXME: All this should be moved to LibHTTP and be made spec compliant.
 | 
					
						
							|  |  |  |     auto buffer = TRY(ByteBuffer::create_uninitialized(m_socket->buffer_size())); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     for (;;) { | 
					
						
							|  |  |  |         if (!TRY(m_socket->can_read_without_blocking())) | 
					
						
							|  |  |  |             break; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-02-24 22:38:01 +01:00
										 |  |  |         auto data = TRY(m_socket->read_some(buffer)); | 
					
						
							| 
									
										
										
										
											2023-03-23 03:14:17 +03:00
										 |  |  |         TRY(m_remaining_request.try_append(StringView { data })); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-06-19 16:16:10 +03:00
										 |  |  |         if (m_socket->is_eof()) { | 
					
						
							|  |  |  |             die(); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |             break; | 
					
						
							| 
									
										
										
										
											2023-06-19 16:16:10 +03:00
										 |  |  |         } | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-03-23 03:14:17 +03:00
										 |  |  |     if (m_remaining_request.is_empty()) | 
					
						
							|  |  |  |         return {}; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     auto parsed_request = HTTP::HttpRequest::from_raw_request(m_remaining_request.string_view().bytes()); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     // If the request is not complete, we need to wait for more data to arrive.
 | 
					
						
							|  |  |  |     if (parsed_request.is_error() && parsed_request.error() == HTTP::HttpRequest::ParseError::RequestIncomplete) | 
					
						
							|  |  |  |         return {}; | 
					
						
							| 
									
										
										
										
											2023-03-23 03:14:17 +03:00
										 |  |  | 
 | 
					
						
							|  |  |  |     m_remaining_request.clear(); | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     auto request = parsed_request.release_value(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     deferred_invoke([this, request = move(request)]() { | 
					
						
							|  |  |  |         auto body = read_body_as_json(request); | 
					
						
							|  |  |  |         if (body.is_error()) { | 
					
						
							|  |  |  |             handle_error(request, body.release_error()); | 
					
						
							|  |  |  |             return; | 
					
						
							|  |  |  |         } | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |         if (auto result = handle_request(request, body.release_value()); result.is_error()) | 
					
						
							|  |  |  |             handle_error(request, result.release_error()); | 
					
						
							|  |  |  |     }); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							|  |  |  |     return {}; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  | ErrorOr<JsonValue, Client::WrappedError> Client::read_body_as_json(HTTP::HttpRequest const& request) | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | { | 
					
						
							|  |  |  |     // FIXME: If we received a multipart body here, this would fail badly.
 | 
					
						
							|  |  |  |     // FIXME: Check the Content-Type is actually application/json.
 | 
					
						
							|  |  |  |     size_t content_length = 0; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     for (auto const& header : request.headers().headers()) { | 
					
						
							| 
									
										
										
										
											2023-03-10 08:48:54 +01:00
										 |  |  |         if (header.name.equals_ignoring_ascii_case("Content-Length"sv)) { | 
					
						
							| 
									
										
										
										
											2023-12-23 15:59:14 +13:00
										 |  |  |             content_length = header.value.to_number<size_t>(TrimWhitespace::Yes).value_or(0); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |             break; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     if (content_length == 0) | 
					
						
							|  |  |  |         return JsonValue {}; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     JsonParser json_parser(request.body()); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     return TRY(json_parser.parse()); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  | ErrorOr<void, Client::WrappedError> Client::handle_request(HTTP::HttpRequest const& request, JsonValue body) | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | { | 
					
						
							|  |  |  |     if constexpr (WEBDRIVER_DEBUG) { | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |         dbgln("Got HTTP request: {} {}", request.method_name(), request.resource()); | 
					
						
							| 
									
										
										
										
											2024-01-06 15:49:17 -05:00
										 |  |  |         dbgln("Body: {}", body); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     auto [handler, parameters] = TRY(match_route(request)); | 
					
						
							| 
									
										
										
										
											2023-03-05 15:31:49 -05:00
										 |  |  |     auto result = TRY((*handler)(*this, move(parameters), move(body))); | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     return send_success_response(request, move(result)); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | void Client::handle_error(HTTP::HttpRequest const& request, WrappedError const& error) | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  |     error.visit( | 
					
						
							|  |  |  |         [](AK::Error const& error) { | 
					
						
							|  |  |  |             warnln("Internal error: {}", error); | 
					
						
							|  |  |  |         }, | 
					
						
							|  |  |  |         [](HTTP::HttpRequest::ParseError const& error) { | 
					
						
							|  |  |  |             warnln("HTTP request parsing error: {}", HTTP::HttpRequest::parse_error_to_string(error)); | 
					
						
							|  |  |  |         }, | 
					
						
							|  |  |  |         [&](WebDriver::Error const& error) { | 
					
						
							|  |  |  |             if (send_error_response(request, error).is_error()) | 
					
						
							|  |  |  |                 warnln("Could not send error response"); | 
					
						
							|  |  |  |         }); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     die(); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  | ErrorOr<void, Client::WrappedError> Client::send_success_response(HTTP::HttpRequest const& request, JsonValue result) | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | { | 
					
						
							| 
									
										
										
										
											2023-03-20 02:26:07 +03:00
										 |  |  |     bool keep_alive = false; | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     if (auto it = request.headers().headers().find_if([](auto& header) { return header.name.equals_ignoring_ascii_case("Connection"sv); }); !it.is_end()) | 
					
						
							| 
									
										
										
										
											2023-03-20 02:26:07 +03:00
										 |  |  |         keep_alive = it->value.trim_whitespace().equals_ignoring_ascii_case("keep-alive"sv); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-11-13 00:52:44 -05:00
										 |  |  |     result = make_success_response(move(result)); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     auto content = result.serialized<StringBuilder>(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     StringBuilder builder; | 
					
						
							| 
									
										
										
										
											2024-09-26 16:16:36 -04:00
										 |  |  |     builder.append("HTTP/1.1 200 OK\r\n"sv); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     builder.append("Server: WebDriver (SerenityOS)\r\n"sv); | 
					
						
							|  |  |  |     builder.append("X-Frame-Options: SAMEORIGIN\r\n"sv); | 
					
						
							|  |  |  |     builder.append("X-Content-Type-Options: nosniff\r\n"sv); | 
					
						
							| 
									
										
										
										
											2023-03-20 02:26:07 +03:00
										 |  |  |     if (keep_alive) | 
					
						
							|  |  |  |         builder.append("Connection: keep-alive\r\n"sv); | 
					
						
							| 
									
										
										
										
											2024-09-26 16:16:36 -04:00
										 |  |  |     builder.append("Cache-Control: no-cache\r\n"sv); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     builder.append("Content-Type: application/json; charset=utf-8\r\n"sv); | 
					
						
							|  |  |  |     builder.appendff("Content-Length: {}\r\n", content.length()); | 
					
						
							|  |  |  |     builder.append("\r\n"sv); | 
					
						
							| 
									
										
										
										
											2024-09-24 18:05:29 -04:00
										 |  |  |     builder.append(content); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-09-24 18:05:29 -04:00
										 |  |  |     TRY(m_socket->write_until_depleted(builder.string_view())); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							|  |  |  |     if (!keep_alive) | 
					
						
							|  |  |  |         die(); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     log_response(request, 200); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     return {}; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  | ErrorOr<void, Client::WrappedError> Client::send_error_response(HTTP::HttpRequest const& request, Error const& error) | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | { | 
					
						
							|  |  |  |     // FIXME: Implement to spec.
 | 
					
						
							|  |  |  |     dbgln_if(WEBDRIVER_DEBUG, "Sending error response: {} {}: {}", error.http_status, error.error, error.message); | 
					
						
							|  |  |  |     auto reason = HTTP::HttpResponse::reason_phrase_for_code(error.http_status); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-05-30 16:05:35 +01:00
										 |  |  |     JsonObject error_response; | 
					
						
							|  |  |  |     error_response.set("error", error.error); | 
					
						
							|  |  |  |     error_response.set("message", error.message); | 
					
						
							|  |  |  |     error_response.set("stacktrace", ""); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     if (error.data.has_value()) | 
					
						
							| 
									
										
										
										
											2024-05-30 16:05:35 +01:00
										 |  |  |         error_response.set("data", *error.data); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     JsonObject result; | 
					
						
							|  |  |  |     result.set("value", move(error_response)); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-09-26 20:57:39 -04:00
										 |  |  |     auto content = result.serialized<StringBuilder>(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     StringBuilder builder; | 
					
						
							|  |  |  |     builder.appendff("HTTP/1.1 {} {}\r\n", error.http_status, reason); | 
					
						
							|  |  |  |     builder.append("Cache-Control: no-cache\r\n"sv); | 
					
						
							|  |  |  |     builder.append("Content-Type: application/json; charset=utf-8\r\n"sv); | 
					
						
							|  |  |  |     builder.appendff("Content-Length: {}\r\n", content.length()); | 
					
						
							|  |  |  |     builder.append("\r\n"sv); | 
					
						
							|  |  |  |     builder.append(content); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     TRY(m_socket->write_until_depleted(builder.string_view())); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     log_response(request, error.http_status); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  |     return {}; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  | void Client::log_response(HTTP::HttpRequest const& request, unsigned code) | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | { | 
					
						
							| 
									
										
										
										
											2024-10-27 14:57:00 -04:00
										 |  |  |     outln("{} :: {:03d} :: {} {}", Core::DateTime::now().to_byte_string(), code, request.method_name(), request.resource()); | 
					
						
							| 
									
										
										
										
											2022-11-12 23:23:37 -05:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | } |