/* * Copyright (c) 2020-2021, Andreas Kling * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #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 namespace WebView { class ViewImplementation; class WEBVIEW_API WebContentClient final : public IPC::ConnectionToServer , public WebContentClientEndpoint { C_OBJECT_ABSTRACT(WebContentClient); public: using InitTransport = Messages::WebContentServer::InitTransport; template Callback> static void for_each_client(Callback callback); static size_t client_count() { return clients().size(); } static Optional client_for_compositor_context_id(Web::Compositor::CompositorContextId); WebContentClient(NonnullOwnPtr, u64 initial_page_id); ~WebContentClient(); void assign_view(Badge, ViewImplementation&); void set_compositor_connection_id(Badge, i32); Optional compositor_connection_id(Badge) const { return m_compositor_connection_id; } void register_view(u64 page_id, ViewImplementation&); void unregister_view(u64 page_id); void prepare_for_detached_close(u64 page_id); void request_close(u64 page_id); void web_ui_disconnected(Badge); bool has_views() const { return !m_views.is_empty(); } void notify_all_views_of_crash(); ErrorOr reconnect_to_compositor_process(Badge); ErrorOr recreate_compositor_contexts(Badge); void replay_compositor_view_state_after_reconnect(Badge); void notify_compositor_process_reconnected(Badge); Web::Compositor::CompositorContextId compositor_context_id_for_page(u64 page_id); Optional page_id_for_compositor_context_id(Web::Compositor::CompositorContextId) const; bool send_async_scroll_to_compositor(u64 page_id, Gfx::FloatPoint position, Gfx::FloatPoint delta_in_device_pixels); bool handle_mouse_event_in_compositor(u64 page_id, Web::MouseEvent const&); bool handle_pinch_event_in_compositor(u64 page_id, Web::PinchEvent const&); void dispatch_mouse_event_to_web_content(u64 page_id, Web::MouseEvent const&); void notify_presented_bitmap_ready_to_paint(u64 page_id, i32 bitmap_id); void did_present_backing_stores(u64 page_id, i32 front_bitmap_id, Gfx::SharedImage front_backing_store, i32 back_bitmap_id, Gfx::SharedImage back_backing_store); void did_present_bitmap(u64 page_id, Gfx::IntRect, i32 bitmap_id); pid_t pid() const { return m_process_handle.pid; } void set_pid(pid_t pid) { m_process_handle.pid = pid; } private: void maybe_record_history_visit_for_current_load(u64 page_id, URL::URL const&, Optional title, StringView reason); void close_server_if_unused(); bool forget_compositor_context(Web::Compositor::CompositorContextId); void destroy_all_compositor_contexts(); virtual void die() override; virtual Messages::WebContentClient::AllocateCompositorContextIdResponse allocate_compositor_context_id(u64 page_id, Web::Compositor::PagePresentationRegistration) override; virtual void did_destroy_compositor_context(Web::Compositor::CompositorContextId) override; virtual void did_request_new_process_for_navigation(u64 page_id, URL::URL url, Variant document_resource, Web::Bindings::NavigationHistoryBehavior history_handling) override; virtual void did_start_webdriver_navigation(u64 page_id, URL::URL url) override; virtual void did_finish_loading(u64 page_id, URL::URL) override; virtual void did_request_refresh(u64 page_id) override; virtual void did_request_cursor_change(u64 page_id, Gfx::Cursor) override; virtual void did_change_title(u64 page_id, Utf16String) override; virtual void did_change_url(u64 page_id, URL::URL) override; virtual void did_request_tooltip_override(u64 page_id, Gfx::IntPoint, ByteString) override; virtual void did_stop_tooltip_override(u64 page_id) override; virtual void did_enter_tooltip_area(u64 page_id, ByteString) override; virtual void did_leave_tooltip_area(u64 page_id) override; virtual void did_hover_link(u64 page_id, URL::URL) override; virtual void did_unhover_link(u64 page_id) override; virtual void did_click_link(u64 page_id, URL::URL, ByteString, unsigned) override; virtual void did_middle_click_link(u64 page_id, URL::URL, ByteString, unsigned) override; virtual void did_start_loading(u64 page_id, URL::URL, Variant, bool, Web::Bindings::NavigationHistoryBehavior) override; virtual void did_cancel_loading(u64 page_id, URL::URL) override; virtual void did_request_context_menu(u64 page_id, Gfx::IntPoint, Web::ContextMenuForInputEventsTarget) override; virtual void did_request_link_context_menu(u64 page_id, Gfx::IntPoint, URL::URL, ByteString, unsigned) override; virtual void did_request_image_context_menu(u64 page_id, Gfx::IntPoint, URL::URL, ByteString, unsigned, Optional) override; virtual void did_request_media_context_menu(u64 page_id, Gfx::IntPoint, ByteString, unsigned, Web::Page::MediaContextMenu) override; virtual void did_get_source(u64 page_id, URL::URL, URL::URL, String) override; virtual void did_inspect_dom_tree(u64 page_id, String) override; virtual void did_inspect_storage(u64 page_id, u64 request_id, String) override; virtual void did_inspect_dom_node(u64 page_id, DOMNodeProperties) override; virtual void did_inspect_grid_layouts(u64 page_id, String) override; virtual void did_inspect_current_grid(u64 page_id, String) override; virtual void did_inspect_current_flexbox(u64 page_id, String) override; virtual void did_inspect_indexed_database(u64 page_id, u64 request_id, String) override; virtual void did_inspect_accessibility_tree(u64 page_id, String) override; virtual void did_get_hovered_node_id(u64 page_id, Web::UniqueNodeID node_id) override; virtual void did_get_node_id_at_position(u64 page_id, u64 request_id, Web::UniqueNodeID node_id) override; virtual void did_finish_editing_dom_node(u64 page_id, Optional node_id) override; virtual void did_mutate_dom(u64 page_id, Mutation) override; virtual void did_get_dom_node_html(u64 page_id, String html) override; virtual void did_list_style_sheets(u64 page_id, Vector stylesheets) override; virtual void did_get_style_sheet_source(u64 page_id, Web::CSS::StyleSheetIdentifier identifier, URL::URL, String source) override; virtual void did_take_screenshot(u64 page_id, Gfx::ShareableBitmap screenshot) override; virtual void did_get_internal_page_info(u64 page_id, PageInfoType, Optional) override; virtual void did_execute_js_console_input(u64 page_id, JsonValue) override; virtual void did_output_js_console_message(u64 page_id, ConsoleOutput) override; virtual void did_start_network_request(u64 page_id, u64 request_id, URL::URL, ByteString method, Vector, ByteBuffer request_body, Optional initiator_type) override; virtual void did_receive_network_response_headers(u64 page_id, u64 request_id, u32 status_code, Optional reason_phrase, Vector) override; virtual void did_receive_network_response_body(u64 page_id, u64 request_id, ByteBuffer data) override; virtual void did_finish_network_request(u64 page_id, u64 request_id, u64 body_size, Requests::RequestTimingInfo, Optional) override; virtual void did_change_favicon(u64 page_id, Gfx::ShareableBitmap) override; virtual void did_request_alert(u64 page_id, String) override; virtual void did_request_confirm(u64 page_id, String) override; virtual void did_request_prompt(u64 page_id, String, String) override; virtual void did_request_set_prompt_text(u64 page_id, String message) override; virtual void did_request_accept_dialog(u64 page_id) override; virtual void did_request_dismiss_dialog(u64 page_id) override; virtual void did_request_document_cookie_version_index(u64 page_id, i64 document_id, String domain) override; virtual Messages::WebContentClient::DidRequestAllCookiesWebdriverResponse did_request_all_cookies_webdriver(URL::URL) override; virtual Messages::WebContentClient::DidRequestAllCookiesCookiestoreResponse did_request_all_cookies_cookiestore(URL::URL) override; virtual Messages::WebContentClient::DidRequestNamedCookieResponse did_request_named_cookie(URL::URL, String) override; virtual Messages::WebContentClient::DidRequestCookieResponse did_request_cookie(u64 page_id, URL::URL, HTTP::Cookie::Source) override; virtual void did_set_cookie(URL::URL, HTTP::Cookie::ParsedCookie, HTTP::Cookie::Source) override; virtual void did_update_cookie(HTTP::Cookie::Cookie) override; virtual void did_expire_cookies_with_time_offset(AK::Duration) override; virtual void did_request_delete_all_cookies(u64 page_id, u64 request_id, URL::URL) override; virtual void did_store_hsts_policy(String, HTTP::HSTS::ParsedHSTSPolicy) override; virtual Messages::WebContentClient::DidIsKnownHstsHostResponse did_is_known_hsts_host(String) override; virtual Messages::WebContentClient::DidRequestStorageItemResponse did_request_storage_item(Web::StorageAPI::StorageEndpointType storage_endpoint, String storage_key, String bottle_key) override; virtual Messages::WebContentClient::DidSetStorageItemResponse did_set_storage_item(Web::StorageAPI::StorageEndpointType storage_endpoint, String storage_key, String bottle_key, String value) override; virtual void did_remove_storage_item(Web::StorageAPI::StorageEndpointType storage_endpoint, String storage_key, String bottle_key) override; virtual Messages::WebContentClient::DidRequestStorageKeysResponse did_request_storage_keys(Web::StorageAPI::StorageEndpointType storage_endpoint, String storage_key) override; virtual void did_clear_storage(Web::StorageAPI::StorageEndpointType storage_endpoint, String storage_key) override; virtual void did_change_storage_item(u64 page_id, Web::StorageAPI::StorageEndpointType storage_endpoint, String url, Optional key, Optional old_value, Optional new_value) override; virtual void did_update_indexed_database(u64 page_id, String update) override; virtual void did_post_broadcast_channel_message(u64 page_id, Web::HTML::BroadcastChannelMessage message) override; virtual Messages::WebContentClient::DidRequestNewWebViewResponse did_request_new_web_view(u64 page_id, Web::HTML::ActivateTab, Web::HTML::WebViewHints) override; virtual void did_request_activate_tab(u64 page_id) override; virtual void did_close_browsing_context(u64 page_id) override; virtual void did_change_needs_beforeunload_check(u64 page_id, bool needs_beforeunload_check) override; virtual Messages::WebContentClient::DidRequestTraverseTheHistoryByDeltaResponse did_request_traverse_the_history_by_delta(u64 page_id, i32 delta, Web::HistoryTraversalPrecheck) override; virtual void did_request_webdriver_history_traversal(u64 page_id, u64 request_id, i32 delta) override; virtual Messages::WebContentClient::DidRequestWebdriverLoadUrlFromUiResponse did_request_webdriver_load_url_from_ui(u64 page_id, URL::URL url) override; virtual Messages::WebContentClient::DidRequestWebdriverTraverseHistoryFromUiResponse did_request_webdriver_traverse_history_from_ui(u64 page_id, i32 delta) override; virtual Messages::WebContentClient::DidRequestWebdriverMarkWebContentSessionHistoryStaleResponse did_request_webdriver_mark_web_content_session_history_stale(u64 page_id) override; virtual Messages::WebContentClient::DidRequestWebdriverSessionHistoryResponse did_request_webdriver_session_history(u64 page_id) override; virtual void did_request_webdriver_navigation_completion(u64 page_id, u64 request_id, Optional page_load_timeout) override; virtual void did_update_resource_count(u64 page_id, i32 count_waiting) override; virtual void did_request_restore_window(u64 page_id) override; virtual void did_request_reposition_window(u64 page_id, Gfx::IntPoint) override; virtual void did_request_resize_window(u64 page_id, Gfx::IntSize) override; virtual void did_request_maximize_window(u64 page_id) override; virtual void did_request_minimize_window(u64 page_id) override; virtual void did_request_fullscreen_window(u64 page_id) override; virtual void did_request_exit_fullscreen(u64 page_id) override; virtual void did_request_file(u64 page_id, ByteString path, i32) override; virtual void did_request_color_picker(u64 page_id, Color current_color) override; virtual void did_request_file_picker(u64 page_id, Web::HTML::FileFilter accepted_file_types, Web::HTML::AllowMultipleFiles) override; virtual void did_request_select_dropdown(u64 page_id, Gfx::IntPoint content_position, i32 minimum_width, Vector items) override; virtual void did_finish_handling_input_event(u64 page_id, Web::EventResult event_result) override; virtual void did_update_input_caret_rect(u64 page_id, Optional rect) override; virtual void did_finish_test(u64 page_id, String text) override; virtual void did_set_test_timeout(u64 page_id, double milliseconds) override; virtual void did_receive_reference_test_metadata(u64 page_id, JsonValue) override; virtual void did_set_browser_zoom(u64 page_id, double factor) override; virtual void did_find_in_page(u64 page_id, size_t current_match_index, Optional total_match_count) override; virtual void did_change_theme_color(u64 page_id, Gfx::Color color) override; virtual void did_change_background_color(u64 page_id, Gfx::Color color) override; virtual void did_insert_clipboard_entry(u64 page_id, Web::Clipboard::SystemClipboardRepresentation, String presentation_style) override; virtual void did_request_clipboard_entries(u64 page_id, u64 request_id) override; virtual void did_request_primary_paste(u64 page_id) override; virtual void did_update_primary_selection(u64 page_id, String) override; virtual void did_change_audio_play_state(u64 page_id, Web::HTML::AudioPlayState) override; virtual void did_update_navigation_buttons_state(u64 page_id, bool back_enabled, bool forward_enabled) override; virtual void did_update_session_history(u64 page_id, Vector, Vector, size_t current_used_step_index) override; virtual Messages::WebContentClient::DidRequestUiProcessSessionHistoryForTestingResponse did_request_ui_process_session_history_for_testing(u64 page_id) override; virtual Messages::WebContentClient::DidUpdateSessionHistoryAndRequestUiProcessSessionHistoryForTestingResponse did_update_session_history_and_request_ui_process_session_history_for_testing(u64 page_id, Vector, Vector, size_t current_used_step_index) override; virtual void did_set_top_level_session_history(u64 page_id, bool accepted, Vector, Vector used_steps, size_t current_used_step_index) override; virtual void did_traverse_the_history_to_step(u64 page_id, i32 step, bool step_was_available, Web::HTML::HistoryStepResult) override; virtual void did_check_if_traverse_history_step_is_canceled( u64 page_id, u64 request_id, i32 step, bool canceled) override; virtual void did_reset_session_history_for_testing(u64 page_id) override; virtual Messages::WebContentClient::StartWorkerAgentResponse start_worker_agent(u64 page_id, Web::HTML::WorkerAgentStartRequest request) override; virtual void close_worker_agent(u64 page_id, Web::HTML::WorkerAgentId agent_id, Web::HTML::WorkerAgentOwnerToken owner_token) override; Optional view_for_page_id(u64, SourceLocation = SourceLocation::current()); void remember_compositor_context(Web::Compositor::CompositorContextId, Optional page_id); HashMap> m_views; HashTable m_detached_pages_pending_close; HashMap> m_compositor_contexts; HashMap m_history_recorded_urls_for_current_load; Optional m_compositor_connection_id; u64 m_initial_page_id { 0 }; ProcessHandle m_process_handle; RefPtr m_detached_page_close_timer; RefPtr m_web_ui; static HashTable& clients(); }; template Callback> void WebContentClient::for_each_client(Callback callback) { for (auto& it : clients()) { if (callback(*it) == IterationDecision::Break) return; } } }