/* * Copyright (c) 2022, Dex♪ * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include class HeadlessBrowserPageClient final : public Web::PageClient { public: static NonnullOwnPtr create() { return adopt_own(*new HeadlessBrowserPageClient()); } virtual Web::Page& page() override { return *m_page; } virtual Web::Page const& page() const override { return *m_page; } Web::Layout::Viewport* layout_root() { auto* document = page().top_level_browsing_context().active_document(); if (!document) return nullptr; return document->layout_node(); } void load(AK::URL const& url) { page().load(url); } virtual void paint(Web::DevicePixelRect const& content_rect, Gfx::Bitmap& target) override { Gfx::Painter painter(target); if (auto* document = page().top_level_browsing_context().active_document()) document->update_layout(); painter.fill_rect({ {}, content_rect.size().to_type() }, palette().base()); auto* layout_root = this->layout_root(); if (!layout_root) { return; } Web::PaintContext context(painter, palette(), device_pixels_per_css_pixel()); context.set_should_show_line_box_borders(false); context.set_device_viewport_rect(content_rect); context.set_has_focus(true); layout_root->paint_all_phases(context); } void setup_palette(Core::AnonymousBuffer theme_buffer) { m_palette_impl = Gfx::PaletteImpl::create_with_anonymous_buffer(theme_buffer); } void set_viewport_rect(Gfx::IntRect viewport_rect) { page().top_level_browsing_context().set_viewport_rect(page().device_to_css_rect(viewport_rect.to_type())); } void set_screen_rect(Web::DevicePixelRect screen_rect) { m_screen_rect = screen_rect; } ErrorOr connect_to_webdriver(StringView webdriver_ipc_path) { VERIFY(!m_webdriver); m_webdriver = TRY(WebContent::WebDriverConnection::connect(*this, webdriver_ipc_path)); return {}; } // ^Web::PageClient virtual bool is_connection_open() const override { if (m_webdriver) return m_webdriver->is_open(); return true; } virtual Gfx::Palette palette() const override { return Gfx::Palette(*m_palette_impl); } virtual Web::DevicePixelRect screen_rect() const override { return m_screen_rect; } virtual float device_pixels_per_css_pixel() const override { return 1.0f; } virtual Web::CSS::PreferredColorScheme preferred_color_scheme() const override { return m_preferred_color_scheme; } virtual void page_did_change_title(DeprecatedString const&) override { } virtual void page_did_start_loading(AK::URL const&, bool) override { } virtual void page_did_finish_loading(AK::URL const&) override { } virtual void page_did_change_selection() override { } virtual void page_did_request_cursor_change(Gfx::StandardCursor) override { } virtual void page_did_request_context_menu(Web::CSSPixelPoint) override { } virtual void page_did_request_link_context_menu(Web::CSSPixelPoint, AK::URL const&, DeprecatedString const&, unsigned) override { } virtual void page_did_request_image_context_menu(Web::CSSPixelPoint, AK::URL const&, DeprecatedString const&, unsigned, Gfx::Bitmap const*) override { } virtual void page_did_click_link(AK::URL const&, DeprecatedString const&, unsigned) override { } virtual void page_did_middle_click_link(AK::URL const&, DeprecatedString const&, unsigned) override { } virtual void page_did_enter_tooltip_area(Web::CSSPixelPoint, DeprecatedString const&) override { } virtual void page_did_leave_tooltip_area() override { } virtual void page_did_hover_link(AK::URL const&) override { } virtual void page_did_unhover_link() override { } virtual void page_did_invalidate(Web::CSSPixelRect const&) override { } virtual void page_did_change_favicon(Gfx::Bitmap const&) override { } virtual void page_did_layout() override { } virtual void page_did_request_scroll_into_view(Web::CSSPixelRect const&) override { } virtual void page_did_request_alert(DeprecatedString const&) override { } virtual void page_did_request_confirm(DeprecatedString const&) override { } virtual void page_did_request_prompt(DeprecatedString const&, DeprecatedString const&) override { } virtual DeprecatedString page_did_request_cookie(AK::URL const&, Web::Cookie::Source) override { return DeprecatedString::empty(); } virtual void page_did_set_cookie(AK::URL const&, Web::Cookie::ParsedCookie const&, Web::Cookie::Source) override { } void request_file(Web::FileRequest request) override { auto file = Core::System::open(request.path(), O_RDONLY); request.on_file_request_finish(move(file)); } private: HeadlessBrowserPageClient() : m_page(make(*this)) { } NonnullOwnPtr m_page; RefPtr m_palette_impl; Web::DevicePixelRect m_screen_rect { 0, 0, 800, 600 }; Web::CSS::PreferredColorScheme m_preferred_color_scheme { Web::CSS::PreferredColorScheme::Auto }; RefPtr m_webdriver; }; class ImageCodecPluginHeadless : public Web::Platform::ImageCodecPlugin { public: ImageCodecPluginHeadless() = default; virtual ~ImageCodecPluginHeadless() override = default; virtual Optional decode_image(ReadonlyBytes data) override { auto decoder = Gfx::ImageDecoder::try_create_for_raw_bytes(data); if (!decoder) return Web::Platform::DecodedImage { false, 0, Vector {} }; if (!decoder->frame_count()) return Web::Platform::DecodedImage { false, 0, Vector {} }; Vector frames; for (size_t i = 0; i < decoder->frame_count(); ++i) { auto frame_or_error = decoder->frame(i); if (frame_or_error.is_error()) { frames.append({ {}, 0 }); } else { auto frame = frame_or_error.release_value(); frames.append({ move(frame.image), static_cast(frame.duration) }); } } return Web::Platform::DecodedImage { decoder->is_animated(), static_cast(decoder->loop_count()), frames, }; } }; static HashTable> s_all_requests; class HeadlessRequestServer : public Web::ResourceLoaderConnector { public: class HTTPHeadlessRequest : public Web::ResourceLoaderConnectorRequest , public Weakable { public: static ErrorOr> create(DeprecatedString const& method, AK::URL const& url, HashMap const& request_headers, ReadonlyBytes request_body, Core::ProxyData const&) { auto stream_backing_buffer = TRY(ByteBuffer::create_uninitialized(1 * MiB)); auto underlying_socket = TRY(Core::TCPSocket::connect(url.host(), url.port().value_or(80))); TRY(underlying_socket->set_blocking(false)); auto socket = TRY(Core::BufferedSocket::create(move(underlying_socket))); HTTP::HttpRequest request; if (method.equals_ignoring_ascii_case("head"sv)) request.set_method(HTTP::HttpRequest::HEAD); else if (method.equals_ignoring_ascii_case("get"sv)) request.set_method(HTTP::HttpRequest::GET); else if (method.equals_ignoring_ascii_case("post"sv)) request.set_method(HTTP::HttpRequest::POST); else request.set_method(HTTP::HttpRequest::Invalid); request.set_url(move(url)); request.set_headers(request_headers); request.set_body(TRY(ByteBuffer::copy(request_body))); return adopt_ref(*new HTTPHeadlessRequest(move(request), move(socket), move(stream_backing_buffer))); } virtual ~HTTPHeadlessRequest() override { } virtual void set_should_buffer_all_input(bool) override { } virtual bool stop() override { return false; } virtual void stream_into(Stream&) override { } private: HTTPHeadlessRequest(HTTP::HttpRequest&& request, NonnullOwnPtr socket, ByteBuffer&& stream_backing_buffer) : m_stream_backing_buffer(move(stream_backing_buffer)) , m_output_stream(try_make(m_stream_backing_buffer.bytes()).release_value_but_fixme_should_propagate_errors()) , m_socket(move(socket)) , m_job(HTTP::Job::construct(move(request), *m_output_stream)) { m_job->on_headers_received = [weak_this = make_weak_ptr()](auto& response_headers, auto response_code) { if (auto strong_this = weak_this.strong_ref()) { strong_this->m_response_code = response_code; for (auto& header : response_headers) { strong_this->m_response_headers.set(header.key, header.value); } } }; m_job->on_finish = [weak_this = make_weak_ptr()](bool success) { Core::deferred_invoke([weak_this, success] { if (auto strong_this = weak_this.strong_ref()) { ReadonlyBytes response_bytes { strong_this->m_output_stream->bytes().data(), strong_this->m_output_stream->offset() }; auto response_buffer = ByteBuffer::copy(response_bytes).release_value_but_fixme_should_propagate_errors(); strong_this->on_buffered_request_finish(success, strong_this->m_output_stream->offset(), strong_this->m_response_headers, strong_this->m_response_code, response_buffer); } }); }; m_job->start(*m_socket); } Optional m_response_code; ByteBuffer m_stream_backing_buffer; NonnullOwnPtr m_output_stream; NonnullOwnPtr m_socket; NonnullRefPtr m_job; HashMap m_response_headers; }; class HTTPSHeadlessRequest : public Web::ResourceLoaderConnectorRequest , public Weakable { public: static ErrorOr> create(DeprecatedString const& method, AK::URL const& url, HashMap const& request_headers, ReadonlyBytes request_body, Core::ProxyData const&) { auto stream_backing_buffer = TRY(ByteBuffer::create_uninitialized(1 * MiB)); auto underlying_socket = TRY(TLS::TLSv12::connect(url.host(), url.port().value_or(443))); TRY(underlying_socket->set_blocking(false)); auto socket = TRY(Core::BufferedSocket::create(move(underlying_socket))); HTTP::HttpRequest request; if (method.equals_ignoring_ascii_case("head"sv)) request.set_method(HTTP::HttpRequest::HEAD); else if (method.equals_ignoring_ascii_case("get"sv)) request.set_method(HTTP::HttpRequest::GET); else if (method.equals_ignoring_ascii_case("post"sv)) request.set_method(HTTP::HttpRequest::POST); else request.set_method(HTTP::HttpRequest::Invalid); request.set_url(move(url)); request.set_headers(request_headers); request.set_body(TRY(ByteBuffer::copy(request_body))); return adopt_ref(*new HTTPSHeadlessRequest(move(request), move(socket), move(stream_backing_buffer))); } virtual ~HTTPSHeadlessRequest() override { } virtual void set_should_buffer_all_input(bool) override { } virtual bool stop() override { return false; } virtual void stream_into(Stream&) override { } private: HTTPSHeadlessRequest(HTTP::HttpRequest&& request, NonnullOwnPtr socket, ByteBuffer&& stream_backing_buffer) : m_stream_backing_buffer(move(stream_backing_buffer)) , m_output_stream(try_make(m_stream_backing_buffer.bytes()).release_value_but_fixme_should_propagate_errors()) , m_socket(move(socket)) , m_job(HTTP::HttpsJob::construct(move(request), *m_output_stream)) { m_job->on_headers_received = [weak_this = make_weak_ptr()](auto& response_headers, auto response_code) { if (auto strong_this = weak_this.strong_ref()) { strong_this->m_response_code = response_code; for (auto& header : response_headers) { strong_this->m_response_headers.set(header.key, header.value); } } }; m_job->on_finish = [weak_this = make_weak_ptr()](bool success) { Core::deferred_invoke([weak_this, success] { if (auto strong_this = weak_this.strong_ref()) { ReadonlyBytes response_bytes { strong_this->m_output_stream->bytes().data(), strong_this->m_output_stream->offset() }; auto response_buffer = ByteBuffer::copy(response_bytes).release_value_but_fixme_should_propagate_errors(); strong_this->on_buffered_request_finish(success, strong_this->m_output_stream->offset(), strong_this->m_response_headers, strong_this->m_response_code, response_buffer); } }); }; m_job->start(*m_socket); } Optional m_response_code; ByteBuffer m_stream_backing_buffer; NonnullOwnPtr m_output_stream; NonnullOwnPtr m_socket; NonnullRefPtr m_job; HashMap m_response_headers; }; class GeminiHeadlessRequest : public Web::ResourceLoaderConnectorRequest , public Weakable { public: static ErrorOr> create(DeprecatedString const&, AK::URL const& url, HashMap const&, ReadonlyBytes, Core::ProxyData const&) { auto stream_backing_buffer = TRY(ByteBuffer::create_uninitialized(1 * MiB)); auto underlying_socket = TRY(Core::TCPSocket::connect(url.host(), url.port().value_or(80))); TRY(underlying_socket->set_blocking(false)); auto socket = TRY(Core::BufferedSocket::create(move(underlying_socket))); Gemini::GeminiRequest request; request.set_url(url); return adopt_ref(*new GeminiHeadlessRequest(move(request), move(socket), move(stream_backing_buffer))); } virtual ~GeminiHeadlessRequest() override { } virtual void set_should_buffer_all_input(bool) override { } virtual bool stop() override { return false; } virtual void stream_into(Stream&) override { } private: GeminiHeadlessRequest(Gemini::GeminiRequest&& request, NonnullOwnPtr socket, ByteBuffer&& stream_backing_buffer) : m_stream_backing_buffer(move(stream_backing_buffer)) , m_output_stream(try_make(m_stream_backing_buffer.bytes()).release_value_but_fixme_should_propagate_errors()) , m_socket(move(socket)) , m_job(Gemini::Job::construct(move(request), *m_output_stream)) { m_job->on_headers_received = [weak_this = make_weak_ptr()](auto& response_headers, auto response_code) { if (auto strong_this = weak_this.strong_ref()) { strong_this->m_response_code = response_code; for (auto& header : response_headers) { strong_this->m_response_headers.set(header.key, header.value); } } }; m_job->on_finish = [weak_this = make_weak_ptr()](bool success) { Core::deferred_invoke([weak_this, success] { if (auto strong_this = weak_this.strong_ref()) { ReadonlyBytes response_bytes { strong_this->m_output_stream->bytes().data(), strong_this->m_output_stream->offset() }; auto response_buffer = ByteBuffer::copy(response_bytes).release_value_but_fixme_should_propagate_errors(); strong_this->on_buffered_request_finish(success, strong_this->m_output_stream->offset(), strong_this->m_response_headers, strong_this->m_response_code, response_buffer); } }); }; m_job->start(*m_socket); } Optional m_response_code; ByteBuffer m_stream_backing_buffer; NonnullOwnPtr m_output_stream; NonnullOwnPtr m_socket; NonnullRefPtr m_job; HashMap m_response_headers; }; static NonnullRefPtr create() { return adopt_ref(*new HeadlessRequestServer()); } virtual ~HeadlessRequestServer() override { } virtual void prefetch_dns(AK::URL const&) override { } virtual void preconnect(AK::URL const&) override { } virtual RefPtr start_request(DeprecatedString const& method, AK::URL const& url, HashMap const& request_headers, ReadonlyBytes request_body, Core::ProxyData const& proxy) override { RefPtr request; if (url.scheme().equals_ignoring_ascii_case("http"sv)) { auto request_or_error = HTTPHeadlessRequest::create(method, url, request_headers, request_body, proxy); if (request_or_error.is_error()) return {}; request = request_or_error.release_value(); } if (url.scheme().equals_ignoring_ascii_case("https"sv)) { auto request_or_error = HTTPSHeadlessRequest::create(method, url, request_headers, request_body, proxy); if (request_or_error.is_error()) return {}; request = request_or_error.release_value(); } if (url.scheme().equals_ignoring_ascii_case("gemini"sv)) { auto request_or_error = GeminiHeadlessRequest::create(method, url, request_headers, request_body, proxy); if (request_or_error.is_error()) return {}; request = request_or_error.release_value(); } if (request) s_all_requests.set(request); return request; } private: HeadlessRequestServer() { } }; class HeadlessWebSocketClientManager : public Web::WebSockets::WebSocketClientManager { public: class HeadlessWebSocket : public Web::WebSockets::WebSocketClientSocket , public Weakable { public: static NonnullRefPtr create(NonnullRefPtr underlying_socket) { return adopt_ref(*new HeadlessWebSocket(move(underlying_socket))); } virtual ~HeadlessWebSocket() override { } virtual Web::WebSockets::WebSocket::ReadyState ready_state() override { switch (m_websocket->ready_state()) { case WebSocket::ReadyState::Connecting: return Web::WebSockets::WebSocket::ReadyState::Connecting; case WebSocket::ReadyState::Open: return Web::WebSockets::WebSocket::ReadyState::Open; case WebSocket::ReadyState::Closing: return Web::WebSockets::WebSocket::ReadyState::Closing; case WebSocket::ReadyState::Closed: return Web::WebSockets::WebSocket::ReadyState::Closed; } VERIFY_NOT_REACHED(); } virtual DeprecatedString subprotocol_in_use() override { return m_websocket->subprotocol_in_use(); } virtual void send(ByteBuffer binary_or_text_message, bool is_text) override { m_websocket->send(WebSocket::Message(binary_or_text_message, is_text)); } virtual void send(StringView message) override { m_websocket->send(WebSocket::Message(message)); } virtual void close(u16 code, DeprecatedString reason) override { m_websocket->close(code, reason); } private: HeadlessWebSocket(NonnullRefPtr underlying_socket) : m_websocket(move(underlying_socket)) { m_websocket->on_open = [weak_this = make_weak_ptr()] { if (auto strong_this = weak_this.strong_ref()) if (strong_this->on_open) strong_this->on_open(); }; m_websocket->on_message = [weak_this = make_weak_ptr()](auto message) { if (auto strong_this = weak_this.strong_ref()) { if (strong_this->on_message) { strong_this->on_message(Web::WebSockets::WebSocketClientSocket::Message { .data = move(message.data()), .is_text = message.is_text(), }); } } }; m_websocket->on_error = [weak_this = make_weak_ptr()](auto error) { if (auto strong_this = weak_this.strong_ref()) { if (strong_this->on_error) { switch (error) { case WebSocket::WebSocket::Error::CouldNotEstablishConnection: strong_this->on_error(Web::WebSockets::WebSocketClientSocket::Error::CouldNotEstablishConnection); return; case WebSocket::WebSocket::Error::ConnectionUpgradeFailed: strong_this->on_error(Web::WebSockets::WebSocketClientSocket::Error::ConnectionUpgradeFailed); return; case WebSocket::WebSocket::Error::ServerClosedSocket: strong_this->on_error(Web::WebSockets::WebSocketClientSocket::Error::ServerClosedSocket); return; } VERIFY_NOT_REACHED(); } } }; m_websocket->on_close = [weak_this = make_weak_ptr()](u16 code, DeprecatedString reason, bool was_clean) { if (auto strong_this = weak_this.strong_ref()) if (strong_this->on_close) strong_this->on_close(code, move(reason), was_clean); }; } NonnullRefPtr m_websocket; }; static NonnullRefPtr create() { return adopt_ref(*new HeadlessWebSocketClientManager()); } virtual ~HeadlessWebSocketClientManager() override { } virtual RefPtr connect(AK::URL const& url, DeprecatedString const& origin, Vector const& protocols) override { WebSocket::ConnectionInfo connection_info(url); connection_info.set_origin(origin); connection_info.set_protocols(protocols); auto connection = HeadlessWebSocket::create(WebSocket::WebSocket::create(move(connection_info))); return connection; } private: HeadlessWebSocketClientManager() { } }; static void load_page_for_screenshot_and_exit(HeadlessBrowserPageClient& page_client, int take_screenshot_after) { dbgln("Taking screenshot after {} seconds", take_screenshot_after); auto timer = Core::Timer::create_single_shot( take_screenshot_after * 1000, [&]() { // FIXME: Allow passing the output path as argument DeprecatedString output_file_path = "output.png"; dbgln("Saving to {}", output_file_path); if (Core::DeprecatedFile::exists(output_file_path)) MUST(Core::DeprecatedFile::remove(output_file_path, Core::DeprecatedFile::RecursionMode::Disallowed)); auto output_file = MUST(Core::File::open(output_file_path, Core::File::OpenMode::Write)); auto output_rect = page_client.screen_rect(); auto output_bitmap = MUST(Gfx::Bitmap::create(Gfx::BitmapFormat::BGRx8888, output_rect.size().to_type())); page_client.paint(output_rect, output_bitmap); auto image_buffer = MUST(Gfx::PNGWriter::encode(output_bitmap)); MUST(output_file->write(image_buffer.bytes())); exit(0); }).release_value_but_fixme_should_propagate_errors(); timer->start(); } ErrorOr serenity_main(Main::Arguments arguments) { int take_screenshot_after = 1; StringView url; StringView resources_folder; StringView error_page_url; StringView ca_certs_path; StringView webdriver_ipc_path; Core::EventLoop event_loop; Core::ArgsParser args_parser; args_parser.set_general_help("This utility runs the Browser in headless mode."); args_parser.add_option(take_screenshot_after, "Take a screenshot after [n] seconds (default: 1)", "screenshot", 's', "n"); args_parser.add_option(resources_folder, "Path of the base resources folder (defaults to /res)", "resources", 'r', "resources-root-path"); args_parser.add_option(error_page_url, "URL for the error page (defaults to file:///res/html/error.html)", "error-page", 'e', "error-page-url"); args_parser.add_option(ca_certs_path, "The bundled ca certificates file", "certs", 'c', "ca-certs-path"); args_parser.add_option(webdriver_ipc_path, "Path to the WebDriver IPC socket", "webdriver-ipc-path", 0, "path"); args_parser.add_positional_argument(url, "URL to open", "url", Core::ArgsParser::Required::Yes); args_parser.parse(arguments); Web::Platform::EventLoopPlugin::install(*new Web::Platform::EventLoopPluginSerenity); Web::Platform::FontPlugin::install(*new Web::Platform::FontPluginSerenity); Web::Platform::ImageCodecPlugin::install(*new ImageCodecPluginHeadless); Web::ResourceLoader::initialize(HeadlessRequestServer::create()); Web::WebSockets::WebSocketClientManager::initialize(HeadlessWebSocketClientManager::create()); if (!resources_folder.is_empty()) { Web::FrameLoader::set_default_favicon_path(LexicalPath::join(resources_folder, "icons/16x16/app-browser.png"sv).string()); Gfx::FontDatabase::set_default_fonts_lookup_path(LexicalPath::join(resources_folder, "fonts"sv).string()); } if (!ca_certs_path.is_empty()) { auto config_result = Core::ConfigFile::open(ca_certs_path); if (config_result.is_error()) { dbgln("Failed to load CA Certificates: {}", config_result.error()); } else { auto config = config_result.release_value(); DefaultRootCACertificates::the().reload_certificates(config); } } Gfx::FontDatabase::set_default_font_query("Katica 10 400 0"); Gfx::FontDatabase::set_window_title_font_query("Katica 10 700 0"); Gfx::FontDatabase::set_fixed_width_font_query("Csilla 10 400 0"); if (!error_page_url.is_empty()) Web::FrameLoader::set_error_page_url(error_page_url); auto page_client = HeadlessBrowserPageClient::create(); if (!resources_folder.is_empty()) { auto system_theme = TRY(Gfx::load_system_theme(LexicalPath::join(resources_folder, "themes/Default.ini"sv).string())); page_client->setup_palette(system_theme); } else { auto system_theme = TRY(Gfx::load_system_theme("/res/themes/Default.ini")); page_client->setup_palette(system_theme); } dbgln("Loading {}", url); page_client->load(AK::URL(url)); // FIXME: Allow passing these values as arguments page_client->set_viewport_rect({ 0, 0, 800, 600 }); page_client->set_screen_rect({ 0, 0, 800, 600 }); if (!webdriver_ipc_path.is_empty()) TRY(page_client->connect_to_webdriver(webdriver_ipc_path)); else load_page_for_screenshot_and_exit(*page_client, take_screenshot_after); return event_loop.exec(); }