/* * Copyright (c) 2020-2021, Andreas Kling * * SPDX-License-Identifier: BSD-2-Clause */ #include "OutOfProcessWebView.h" #include "WebContentClient.h" #include #include #include #include #include #include #include #include #include #include #include #include #include REGISTER_WIDGET(WebView, OutOfProcessWebView) namespace WebView { OutOfProcessWebView::OutOfProcessWebView() { set_should_hide_unnecessary_scrollbars(true); set_focus_policy(GUI::FocusPolicy::StrongFocus); create_client(); } OutOfProcessWebView::~OutOfProcessWebView() = default; void OutOfProcessWebView::handle_web_content_process_crash() { create_client(); VERIFY(m_client_state.client); // Don't keep a stale backup bitmap around. m_backup_bitmap = nullptr; handle_resize(); StringBuilder builder; builder.append("Crashed: "sv); builder.append(escape_html_entities(m_url.to_deprecated_string())); builder.append(""sv); builder.append("

Web page crashed"sv); if (!m_url.host().is_empty()) { builder.appendff(" on {}", escape_html_entities(m_url.host())); } builder.append("

"sv); auto escaped_url = escape_html_entities(m_url.to_deprecated_string()); builder.appendff("The web page {} has crashed.

You can reload the page to try again.", escaped_url, escaped_url); builder.append(""sv); load_html(builder.to_deprecated_string(), m_url); } void OutOfProcessWebView::create_client() { m_client_state = {}; m_client_state.client = WebContentClient::try_create(*this).release_value_but_fixme_should_propagate_errors(); m_client_state.client->on_web_content_process_crash = [this] { deferred_invoke([this] { handle_web_content_process_crash(); }); }; client().async_update_system_theme(Gfx::current_system_theme_buffer()); client().async_update_system_fonts(Gfx::FontDatabase::default_font_query(), Gfx::FontDatabase::fixed_width_font_query(), Gfx::FontDatabase::window_title_font_query()); client().async_update_screen_rects(GUI::Desktop::the().rects(), GUI::Desktop::the().main_screen_index()); } void OutOfProcessWebView::load(const AK::URL& url) { m_url = url; client().async_load_url(url); } void OutOfProcessWebView::load_html(StringView html, const AK::URL& url) { m_url = url; client().async_load_html(html, url); } void OutOfProcessWebView::load_empty_document() { m_url = {}; client().async_load_html("", {}); } void OutOfProcessWebView::paint_event(GUI::PaintEvent& event) { Super::paint_event(event); // If the available size is empty, we don't have a front or back bitmap to draw. if (available_size().is_empty()) return; GUI::Painter painter(*this); painter.add_clip_rect(event.rect()); if (auto* bitmap = m_client_state.has_usable_bitmap ? m_client_state.front_bitmap.bitmap.ptr() : m_backup_bitmap.ptr()) { painter.add_clip_rect(frame_inner_rect()); painter.translate(frame_thickness(), frame_thickness()); painter.blit({ 0, 0 }, *bitmap, bitmap->rect()); return; } painter.fill_rect(frame_inner_rect(), palette().base()); } void OutOfProcessWebView::resize_event(GUI::ResizeEvent& event) { Super::resize_event(event); handle_resize(); } void OutOfProcessWebView::handle_resize() { client().async_set_viewport_rect(Gfx::IntRect({ horizontal_scrollbar().value(), vertical_scrollbar().value() }, available_size())); if (m_client_state.has_usable_bitmap) { // NOTE: We keep the outgoing front bitmap as a backup so we have something to paint until we get a new one. m_backup_bitmap = m_client_state.front_bitmap.bitmap; } if (m_client_state.front_bitmap.bitmap) client().async_remove_backing_store(m_client_state.front_bitmap.id); if (m_client_state.back_bitmap.bitmap) client().async_remove_backing_store(m_client_state.back_bitmap.id); m_client_state.front_bitmap = {}; m_client_state.back_bitmap = {}; m_client_state.has_usable_bitmap = false; if (available_size().is_empty()) return; if (auto new_bitmap_or_error = Gfx::Bitmap::try_create_shareable(Gfx::BitmapFormat::BGRx8888, available_size()); !new_bitmap_or_error.is_error()) { m_client_state.front_bitmap.bitmap = new_bitmap_or_error.release_value(); m_client_state.front_bitmap.id = m_client_state.next_bitmap_id++; client().async_add_backing_store(m_client_state.front_bitmap.id, m_client_state.front_bitmap.bitmap->to_shareable_bitmap()); } if (auto new_bitmap_or_error = Gfx::Bitmap::try_create_shareable(Gfx::BitmapFormat::BGRx8888, available_size()); !new_bitmap_or_error.is_error()) { m_client_state.back_bitmap.bitmap = new_bitmap_or_error.release_value(); m_client_state.back_bitmap.id = m_client_state.next_bitmap_id++; client().async_add_backing_store(m_client_state.back_bitmap.id, m_client_state.back_bitmap.bitmap->to_shareable_bitmap()); } request_repaint(); } void OutOfProcessWebView::keydown_event(GUI::KeyEvent& event) { enqueue_input_event(event); } void OutOfProcessWebView::keyup_event(GUI::KeyEvent& event) { enqueue_input_event(event); } void OutOfProcessWebView::mousedown_event(GUI::MouseEvent& event) { enqueue_input_event(event); } void OutOfProcessWebView::mouseup_event(GUI::MouseEvent& event) { enqueue_input_event(event); if (event.button() == GUI::MouseButton::Backward && on_back_button) { on_back_button(); } else if (event.button() == GUI::MouseButton::Forward && on_forward_button) { on_forward_button(); } } void OutOfProcessWebView::mousemove_event(GUI::MouseEvent& event) { enqueue_input_event(event); } void OutOfProcessWebView::mousewheel_event(GUI::MouseEvent& event) { enqueue_input_event(event); } void OutOfProcessWebView::doubleclick_event(GUI::MouseEvent& event) { enqueue_input_event(event); } void OutOfProcessWebView::theme_change_event(GUI::ThemeChangeEvent& event) { Super::theme_change_event(event); client().async_update_system_theme(Gfx::current_system_theme_buffer()); request_repaint(); } void OutOfProcessWebView::screen_rects_change_event(GUI::ScreenRectsChangeEvent& event) { client().async_update_screen_rects(event.rects(), event.main_screen_index()); } void OutOfProcessWebView::notify_server_did_paint(Badge, i32 bitmap_id) { if (m_client_state.back_bitmap.id == bitmap_id) { m_client_state.has_usable_bitmap = true; m_client_state.back_bitmap.pending_paints--; swap(m_client_state.back_bitmap, m_client_state.front_bitmap); // We don't need the backup bitmap anymore, so drop it. m_backup_bitmap = nullptr; update(); if (m_client_state.got_repaint_requests_while_painting) { m_client_state.got_repaint_requests_while_painting = false; request_repaint(); } } } void OutOfProcessWebView::notify_server_did_invalidate_content_rect(Badge, [[maybe_unused]] Gfx::IntRect const& content_rect) { request_repaint(); } void OutOfProcessWebView::notify_server_did_change_selection(Badge) { request_repaint(); } void OutOfProcessWebView::notify_server_did_request_cursor_change(Badge, Gfx::StandardCursor cursor) { set_override_cursor(cursor); } void OutOfProcessWebView::notify_server_did_layout(Badge, Gfx::IntSize content_size) { set_content_size(content_size); } void OutOfProcessWebView::notify_server_did_change_title(Badge, DeprecatedString const& title) { if (on_title_change) on_title_change(title); } void OutOfProcessWebView::notify_server_did_request_scroll(Badge, i32 x_delta, i32 y_delta) { horizontal_scrollbar().increase_slider_by(x_delta); vertical_scrollbar().increase_slider_by(y_delta); } void OutOfProcessWebView::notify_server_did_request_scroll_to(Badge, Gfx::IntPoint scroll_position) { horizontal_scrollbar().set_value(scroll_position.x()); vertical_scrollbar().set_value(scroll_position.y()); } void OutOfProcessWebView::notify_server_did_request_scroll_into_view(Badge, Gfx::IntRect const& rect) { scroll_into_view(rect, true, true); } void OutOfProcessWebView::notify_server_did_enter_tooltip_area(Badge, Gfx::IntPoint, DeprecatedString const& title) { GUI::Application::the()->show_tooltip(title, nullptr); } void OutOfProcessWebView::notify_server_did_leave_tooltip_area(Badge) { GUI::Application::the()->hide_tooltip(); } void OutOfProcessWebView::notify_server_did_hover_link(Badge, const AK::URL& url) { if (on_link_hover) on_link_hover(url); } void OutOfProcessWebView::notify_server_did_unhover_link(Badge) { set_override_cursor(Gfx::StandardCursor::None); if (on_link_hover) on_link_hover({}); } void OutOfProcessWebView::notify_server_did_click_link(Badge, const AK::URL& url, DeprecatedString const& target, unsigned int modifiers) { if (on_link_click) on_link_click(url, target, modifiers); } void OutOfProcessWebView::notify_server_did_middle_click_link(Badge, const AK::URL& url, DeprecatedString const& target, unsigned int modifiers) { if (on_link_middle_click) on_link_middle_click(url, target, modifiers); } void OutOfProcessWebView::notify_server_did_start_loading(Badge, const AK::URL& url, bool is_redirect) { m_url = url; if (on_load_start) on_load_start(url, is_redirect); } void OutOfProcessWebView::notify_server_did_finish_loading(Badge, const AK::URL& url) { m_url = url; if (on_load_finish) on_load_finish(url); } void OutOfProcessWebView::notify_server_did_request_navigate_back(Badge) { if (on_navigate_back) on_navigate_back(); } void OutOfProcessWebView::notify_server_did_request_navigate_forward(Badge) { if (on_navigate_forward) on_navigate_forward(); } void OutOfProcessWebView::notify_server_did_request_refresh(Badge) { if (on_refresh) on_refresh(); } void OutOfProcessWebView::notify_server_did_request_context_menu(Badge, Gfx::IntPoint content_position) { if (on_context_menu_request) on_context_menu_request(screen_relative_rect().location().translated(to_widget_position(content_position))); } void OutOfProcessWebView::notify_server_did_request_link_context_menu(Badge, Gfx::IntPoint content_position, const AK::URL& url, DeprecatedString const&, unsigned) { if (on_link_context_menu_request) on_link_context_menu_request(url, screen_relative_rect().location().translated(to_widget_position(content_position))); } void OutOfProcessWebView::notify_server_did_request_image_context_menu(Badge, Gfx::IntPoint content_position, const AK::URL& url, DeprecatedString const&, unsigned, Gfx::ShareableBitmap const& bitmap) { if (on_image_context_menu_request) on_image_context_menu_request(url, screen_relative_rect().location().translated(to_widget_position(content_position)), bitmap); } void OutOfProcessWebView::notify_server_did_request_alert(Badge, DeprecatedString const& message) { m_dialog = GUI::MessageBox::construct(window(), message, "Alert"sv, GUI::MessageBox::Type::Information, GUI::MessageBox::InputType::OK); m_dialog->set_icon(window()->icon()); m_dialog->exec(); client().async_alert_closed(); m_dialog = nullptr; } void OutOfProcessWebView::notify_server_did_request_confirm(Badge, DeprecatedString const& message) { m_dialog = GUI::MessageBox::construct(window(), message, "Confirm"sv, GUI::MessageBox::Type::Warning, GUI::MessageBox::InputType::OKCancel); m_dialog->set_icon(window()->icon()); client().async_confirm_closed(m_dialog->exec() == GUI::Dialog::ExecResult::OK); m_dialog = nullptr; } void OutOfProcessWebView::notify_server_did_request_prompt(Badge, DeprecatedString const& message, DeprecatedString const& default_) { m_dialog = GUI::InputBox::construct(window(), default_, message, "Prompt"sv, StringView {}, GUI::InputType::Text); m_dialog->set_icon(window()->icon()); if (m_dialog->exec() == GUI::InputBox::ExecResult::OK) client().async_prompt_closed(static_cast(*m_dialog).text_value()); else client().async_prompt_closed({}); m_dialog = nullptr; } void OutOfProcessWebView::notify_server_did_request_set_prompt_text(Badge, DeprecatedString const& message) { if (m_dialog && is(*m_dialog)) static_cast(*m_dialog).set_text_value(message); } void OutOfProcessWebView::notify_server_did_request_accept_dialog(Badge) { if (m_dialog) m_dialog->done(GUI::Dialog::ExecResult::OK); } void OutOfProcessWebView::notify_server_did_request_dismiss_dialog(Badge) { if (m_dialog) m_dialog->done(GUI::Dialog::ExecResult::Cancel); } void OutOfProcessWebView::notify_server_did_get_source(const AK::URL& url, DeprecatedString const& source) { if (on_get_source) on_get_source(url, source); } void OutOfProcessWebView::notify_server_did_get_dom_tree(DeprecatedString const& dom_tree) { if (on_get_dom_tree) on_get_dom_tree(dom_tree); } void OutOfProcessWebView::notify_server_did_get_dom_node_properties(i32 node_id, DeprecatedString const& specified_style, DeprecatedString const& computed_style, DeprecatedString const& custom_properties, DeprecatedString const& node_box_sizing) { if (on_get_dom_node_properties) on_get_dom_node_properties(node_id, specified_style, computed_style, custom_properties, node_box_sizing); } void OutOfProcessWebView::notify_server_did_output_js_console_message(i32 message_index) { if (on_js_console_new_message) on_js_console_new_message(message_index); } void OutOfProcessWebView::notify_server_did_get_js_console_messages(i32 start_index, Vector const& message_types, Vector const& messages) { if (on_get_js_console_messages) on_get_js_console_messages(start_index, message_types, messages); } void OutOfProcessWebView::notify_server_did_change_favicon(Gfx::Bitmap const& favicon) { if (on_favicon_change) on_favicon_change(favicon); } Vector OutOfProcessWebView::notify_server_did_request_all_cookies(Badge, AK::URL const& url) { if (on_get_all_cookies) return on_get_all_cookies(url); return {}; } Optional OutOfProcessWebView::notify_server_did_request_named_cookie(Badge, AK::URL const& url, DeprecatedString const& name) { if (on_get_named_cookie) return on_get_named_cookie(url, name); return {}; } DeprecatedString OutOfProcessWebView::notify_server_did_request_cookie(Badge, const AK::URL& url, Web::Cookie::Source source) { if (on_get_cookie) return on_get_cookie(url, source); return {}; } void OutOfProcessWebView::notify_server_did_set_cookie(Badge, const AK::URL& url, Web::Cookie::ParsedCookie const& cookie, Web::Cookie::Source source) { if (on_set_cookie) on_set_cookie(url, cookie, source); } void OutOfProcessWebView::notify_server_did_update_cookie(Badge, Web::Cookie::Cookie const& cookie) { if (on_update_cookie) on_update_cookie(cookie); } void OutOfProcessWebView::notify_server_did_update_resource_count(i32 count_waiting) { if (on_resource_status_change) on_resource_status_change(count_waiting); } void OutOfProcessWebView::notify_server_did_request_restore_window() { if (on_restore_window) on_restore_window(); } Gfx::IntPoint OutOfProcessWebView::notify_server_did_request_reposition_window(Gfx::IntPoint position) { if (on_reposition_window) return on_reposition_window(position); return {}; } Gfx::IntSize OutOfProcessWebView::notify_server_did_request_resize_window(Gfx::IntSize size) { if (on_resize_window) return on_resize_window(size); return {}; } Gfx::IntRect OutOfProcessWebView::notify_server_did_request_maximize_window() { if (on_maximize_window) return on_maximize_window(); return {}; } Gfx::IntRect OutOfProcessWebView::notify_server_did_request_minimize_window() { if (on_minimize_window) return on_minimize_window(); return {}; } Gfx::IntRect OutOfProcessWebView::notify_server_did_request_fullscreen_window() { if (on_fullscreen_window) return on_fullscreen_window(); return {}; } void OutOfProcessWebView::notify_server_did_request_file(Badge, DeprecatedString const& path, i32 request_id) { auto file = FileSystemAccessClient::Client::the().try_request_file_read_only_approved(window(), path); if (file.is_error()) client().async_handle_file_return(file.error().code(), {}, request_id); else client().async_handle_file_return(0, IPC::File(file.value()->leak_fd()), request_id); } void OutOfProcessWebView::did_scroll() { client().async_set_viewport_rect(visible_content_rect()); request_repaint(); } void OutOfProcessWebView::request_repaint() { // If this widget was instantiated but not yet added to a window, // it won't have a back bitmap yet, so we can just skip repaint requests. if (!m_client_state.back_bitmap.bitmap) return; // Don't request a repaint until pending paint requests have finished. if (m_client_state.back_bitmap.pending_paints) { m_client_state.got_repaint_requests_while_painting = true; return; } m_client_state.back_bitmap.pending_paints++; client().async_paint(m_client_state.back_bitmap.bitmap->rect().translated(horizontal_scrollbar().value(), vertical_scrollbar().value()), m_client_state.back_bitmap.id); } WebContentClient& OutOfProcessWebView::client() { VERIFY(m_client_state.client); return *m_client_state.client; } void OutOfProcessWebView::debug_request(DeprecatedString const& request, DeprecatedString const& argument) { client().async_debug_request(request, argument); } void OutOfProcessWebView::get_source() { client().async_get_source(); } void OutOfProcessWebView::inspect_dom_tree() { client().async_inspect_dom_tree(); } Optional OutOfProcessWebView::inspect_dom_node(i32 node_id, Optional pseudo_element) { auto response = client().inspect_dom_node(node_id, pseudo_element); if (!response.has_style()) return {}; return DOMNodeProperties { .specified_values_json = response.specified_style(), .computed_values_json = response.computed_style(), .custom_properties_json = response.custom_properties(), .node_box_sizing_json = response.node_box_sizing() }; } void OutOfProcessWebView::clear_inspected_dom_node() { client().inspect_dom_node(0, {}); } i32 OutOfProcessWebView::get_hovered_node_id() { return client().get_hovered_node_id(); } void OutOfProcessWebView::js_console_input(DeprecatedString const& js_source) { client().async_js_console_input(js_source); } void OutOfProcessWebView::js_console_request_messages(i32 start_index) { client().async_js_console_request_messages(start_index); } void OutOfProcessWebView::run_javascript(StringView js_source) { client().async_run_javascript(js_source); } DeprecatedString OutOfProcessWebView::selected_text() { return client().get_selected_text(); } void OutOfProcessWebView::select_all() { client().async_select_all(); } DeprecatedString OutOfProcessWebView::dump_layout_tree() { return client().dump_layout_tree(); } OrderedHashMap OutOfProcessWebView::get_local_storage_entries() { return client().get_local_storage_entries(); } OrderedHashMap OutOfProcessWebView::get_session_storage_entries() { return client().get_session_storage_entries(); } void OutOfProcessWebView::set_content_filters(Vector filters) { client().async_set_content_filters(filters); } void OutOfProcessWebView::set_proxy_mappings(Vector proxies, HashMap mappings) { client().async_set_proxy_mappings(move(proxies), move(mappings)); } void OutOfProcessWebView::set_preferred_color_scheme(Web::CSS::PreferredColorScheme color_scheme) { client().async_set_preferred_color_scheme(color_scheme); } void OutOfProcessWebView::connect_to_webdriver(DeprecatedString const& webdriver_ipc_path) { client().async_connect_to_webdriver(webdriver_ipc_path); } void OutOfProcessWebView::set_window_position(Gfx::IntPoint position) { client().async_set_window_position(position); } void OutOfProcessWebView::set_window_size(Gfx::IntSize size) { client().async_set_window_size(size); } Gfx::ShareableBitmap OutOfProcessWebView::take_screenshot() const { if (auto* bitmap = m_client_state.has_usable_bitmap ? m_client_state.front_bitmap.bitmap.ptr() : m_backup_bitmap.ptr()) return bitmap->to_shareable_bitmap(); return {}; } Gfx::ShareableBitmap OutOfProcessWebView::take_document_screenshot() { return client().take_document_screenshot(); } void OutOfProcessWebView::focusin_event(GUI::FocusEvent&) { client().async_set_has_focus(true); } void OutOfProcessWebView::focusout_event(GUI::FocusEvent&) { client().async_set_has_focus(false); } void OutOfProcessWebView::set_system_visibility_state(bool visible) { client().async_set_system_visibility_state(visible); } void OutOfProcessWebView::show_event(GUI::ShowEvent&) { set_system_visibility_state(true); } void OutOfProcessWebView::hide_event(GUI::HideEvent&) { set_system_visibility_state(false); } void OutOfProcessWebView::enqueue_input_event(InputEvent const& event) { m_pending_input_events.enqueue(event); process_next_input_event(); } void OutOfProcessWebView::process_next_input_event() { if (m_pending_input_events.is_empty()) return; if (m_is_awaiting_response_for_input_event) return; m_is_awaiting_response_for_input_event = true; // Send the next event over to the web content to be handled by JS. // We'll later get a message to say whether JS prevented the default event behavior, // at which point we either discard or handle that event, then try and process the next one. auto event = m_pending_input_events.head(); event.visit( [this](GUI::KeyEvent const& event) { switch (event.type()) { case GUI::Event::Type::KeyDown: client().async_key_down(event.key(), event.modifiers(), event.code_point()); break; case GUI::Event::Type::KeyUp: client().async_key_up(event.key(), event.modifiers(), event.code_point()); break; default: dbgln("Unrecognized key event type in OOPWV input event queue: {}", event.type()); VERIFY_NOT_REACHED(); } }, [this](GUI::MouseEvent const& event) { switch (event.type()) { case GUI::Event::Type::MouseDown: client().async_mouse_down(to_content_position(event.position()), event.button(), event.buttons(), event.modifiers()); break; case GUI::Event::Type::MouseUp: client().async_mouse_up(to_content_position(event.position()), event.button(), event.buttons(), event.modifiers()); break; case GUI::Event::Type::MouseMove: client().async_mouse_move(to_content_position(event.position()), event.button(), event.buttons(), event.modifiers()); break; case GUI::Event::Type::MouseWheel: client().async_mouse_wheel(to_content_position(event.position()), event.button(), event.buttons(), event.modifiers(), event.wheel_delta_x(), event.wheel_delta_y()); break; case GUI::Event::Type::MouseDoubleClick: client().async_doubleclick(to_content_position(event.position()), event.button(), event.buttons(), event.modifiers()); break; default: dbgln("Unrecognized mouse event type in OOPWV input event queue: {}", event.type()); VERIFY_NOT_REACHED(); } }); } void OutOfProcessWebView::notify_server_did_finish_handling_input_event(bool event_was_accepted) { VERIFY(m_is_awaiting_response_for_input_event); auto event = m_pending_input_events.dequeue(); m_is_awaiting_response_for_input_event = false; if (!event_was_accepted) { // Here we handle events that were not consumed or cancelled by web content. // That is, we manually implement the steps that would have happened if the original // OutOfProcessWebView::foo_event() had called event.ignore(). // // The first step is to give our superclass a chance to handle the event. // // Then, if it does not, we dispatch the event to our parent widget, but limited so // that it will never bubble up to the Window. (Otherwise, it would then dispatch the // event to us since we are the focused widget, and it would go round indefinitely.) // // Finally, any unhandled KeyDown events are propagated to trigger any Actions. event.visit( [this](GUI::KeyEvent& event) { switch (event.type()) { case GUI::Event::Type::KeyDown: Super::keydown_event(event); break; case GUI::Event::Type::KeyUp: Super::keyup_event(event); break; default: dbgln("Unhandled key event type in OOPWV input event queue: {}", event.type()); VERIFY_NOT_REACHED(); } if (!event.is_accepted()) { parent_widget()->dispatch_event(event, window()); // NOTE: If other events can ever trigger shortcuts, propagate those here. if (!event.is_accepted() && event.type() == GUI::Event::Type::KeyDown) window()->propagate_shortcuts_up_to_application(event, this); } }, [this](GUI::MouseEvent& event) { switch (event.type()) { case GUI::Event::Type::MouseDown: Super::mousedown_event(event); break; case GUI::Event::Type::MouseUp: Super::mouseup_event(event); break; case GUI::Event::Type::MouseMove: Super::mousemove_event(event); break; case GUI::Event::Type::MouseWheel: Super::mousewheel_event(event); break; case GUI::Event::Type::MouseDoubleClick: Super::doubleclick_event(event); break; default: dbgln("Unhandled mouse event type in OOPWV input event queue: {}", event.type()); VERIFY_NOT_REACHED(); } if (!event.is_accepted()) parent_widget()->dispatch_event(event, window()); // FIXME: Propagate event for mouse-button shortcuts once that is implemented. }); } process_next_input_event(); } }