/* * Copyright (c) 2024, Andrew Kaster * * 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 #if defined(AK_OS_MACOS) # include #endif namespace WebView { struct ApplicationSettingsObserver; struct ApplicationBookmarkStoreObserver; class WEBVIEW_API Application : public DevTools::DevToolsDelegate { AK_MAKE_NONCOPYABLE(Application); public: virtual ~Application(); ErrorOr execute(); static Application& the() { return *s_the; } static Settings& settings() { return the().m_settings; } static BrowserOptions const& browser_options() { return the().m_browser_options; } static RequestServerOptions const& request_server_options() { return the().m_request_server_options; } static WebContentOptions& web_content_options() { return the().m_web_content_options; } static Requests::RequestClient& request_server_client() { return *the().m_request_server_client; } static ImageDecoderClient::Client& image_decoder_client() { return *the().m_image_decoder_client; } static BookmarkStore& bookmark_store() { return the().m_bookmark_store; } static HistoryStore& history_store() { return *the().m_history_store; } void update_bookmark_action_for_current_web_view(); void bookmarks_changed(Badge); void show_bookmarks_bar_changed(Badge); void clear_history(); virtual void show_bookmark_context_menu(Gfx::IntPoint, Optional, [[maybe_unused]] Optional target_folder_id) { } static CookieJar& cookie_jar() { return *the().m_cookie_jar; } static StorageJar& storage_jar() { return *the().m_storage_jar; } static ProcessManager& process_manager() { return *the().m_process_manager; } #if defined(AK_OS_MACOS) static IPC::TransportBootstrapMachServer& transport_bootstrap_server() { return the().m_transport_bootstrap_server; } void set_browser_process_transport_handler(Function)> handler); #endif ErrorOr> launch_web_content_process(ViewImplementation&); virtual Optional active_web_view() const { return {}; } virtual Optional open_blank_new_tab(Web::HTML::ActivateTab) const { return {}; } void open_url_in_new_tab(URL::URL const&, Web::HTML::ActivateTab) const; void open_bookmark_in_new_tab(String const& bookmark_id, Web::HTML::ActivateTab) const; Main::Arguments const& command_line_arguments() const { return m_arguments; } void add_child_process(Process&&); // FIXME: Should these methods be part of Application, instead of deferring to ProcessManager? #if defined(AK_OS_MACH) void set_process_mach_port(pid_t, Core::MachPort&&); #endif Optional find_process(pid_t); virtual bool should_capture_web_content_output() const { return false; } ErrorOr path_for_downloaded_file(StringView file) const; virtual void display_download_confirmation_dialog(StringView download_name, LexicalPath const& path) const; virtual void display_error_dialog(StringView error_message) const; // FIXME: We should implement UI-agnostic platform APIs to interact with the system clipboard. virtual Utf16String clipboard_text() const; virtual Vector clipboard_entries() const; virtual void insert_clipboard_entry(Web::Clipboard::SystemClipboardRepresentation); struct BrowsingDataSizes { u64 cache_size_since_requested_time { 0 }; u64 total_cache_size { 0 }; u64 site_data_size_since_requested_time { 0 }; u64 total_site_data_size { 0 }; }; NonnullRefPtr> estimate_browsing_data_size_accessed_since(UnixDateTime since); struct ClearBrowsingDataOptions { enum class Delete { No, Yes, }; UnixDateTime since { UnixDateTime::earliest() }; Delete delete_cached_files { Delete::No }; Delete delete_history { Delete::No }; Delete delete_site_data { Delete::No }; }; void clear_browsing_data(ClearBrowsingDataOptions const&); Action& reload_action() { return *m_reload_action; } Action& copy_selection_action() { return *m_copy_selection_action; } Action& paste_action() { return *m_paste_action; } Action& select_all_action() { return *m_select_all_action; } Action& open_about_page_action() { return *m_open_about_page_action; } Action& open_settings_page_action() { return *m_open_settings_page_action; } Menu& zoom_menu() { return *m_zoom_menu; } Action& reset_zoom_action() { return *m_reset_zoom_action; } Menu& color_scheme_menu() { return *m_color_scheme_menu; } Menu& contrast_menu() { return *m_contrast_menu; } Menu& motion_menu() { return *m_motion_menu; } Menu& bookmarks_menu() { return *m_bookmarks_menu; } Menu& bookmarks_bar_context_menu() { return *m_bookmarks_bar_context_menu; } Menu& bookmark_context_menu() { return *m_bookmark_context_menu; } Menu& bookmark_folder_context_menu() { return *m_bookmark_folder_context_menu; } Menu& inspect_menu() { return *m_inspect_menu; } Action& view_source_action() { return *m_view_source_action; } Menu& debug_menu() { return *m_debug_menu; } FileDownloader& file_downloader() { return m_file_downloader; } void apply_view_options(Badge, ViewImplementation&); ErrorOr toggle_devtools_enabled(); void refresh_tab_list(); Optional time_zone_watcher(); protected: explicit Application(Optional ladybird_binary_path = {}); ErrorOr initialize(Main::Arguments const&); virtual void process_did_exit(Process&&); virtual void create_platform_arguments(Core::ArgsParser&) { } virtual void create_platform_options(BrowserOptions&, RequestServerOptions&, WebContentOptions&) { } virtual NonnullOwnPtr create_platform_event_loop(); virtual Optional ask_user_for_download_path([[maybe_unused]] StringView file) const { return {}; } virtual void rebuild_bookmarks_menu() const { } virtual void update_bookmarks_bar_display([[maybe_unused]] bool show_bookmarks_bar) const { } struct BookmarkID { String id; Optional target_folder_id; }; virtual Optional bookmark_item_id_for_context_menu() const { return {}; } using BookmarkPromise = Core::Promise; virtual NonnullRefPtr display_add_bookmark_dialog() const; virtual NonnullRefPtr display_edit_bookmark_dialog([[maybe_unused]] BookmarkItem::Bookmark const& current_bookmark) const; using BookmarkFolderPromise = Core::Promise; virtual NonnullRefPtr display_add_bookmark_folder_dialog() const; virtual NonnullRefPtr display_edit_bookmark_folder_dialog([[maybe_unused]] BookmarkItem::Folder const& current_folder) const; virtual void on_devtools_enabled() const; virtual void on_devtools_disabled() const; Main::Arguments& arguments() { return m_arguments; } private: ErrorOr launch_services(); void launch_spare_web_content_process(); ErrorOr launch_request_server(); ErrorOr launch_image_decoder_server(); ErrorOr launch_devtools_server(); void initialize_actions(); void update_bookmarks_bar_action(); struct MenuData { Menu& menu; ReadonlySpan items; Optional target_folder_id; }; void create_bookmark_menu_items(Optional = {}); virtual Vector tab_list() const override; virtual Vector css_property_list() const override; virtual void inspect_tab(DevTools::TabDescription const&, OnTabInspectionComplete) const override; virtual void inspect_accessibility_tree(DevTools::TabDescription const&, OnAccessibilityTreeInspectionComplete) const override; virtual void listen_for_dom_properties(DevTools::TabDescription const&, OnDOMNodePropertiesReceived) const override; virtual void stop_listening_for_dom_properties(DevTools::TabDescription const&) const override; virtual void inspect_dom_node(DevTools::TabDescription const&, DOMNodeProperties::Type, Web::UniqueNodeID, Optional) const override; virtual void clear_inspected_dom_node(DevTools::TabDescription const&) const override; virtual void highlight_dom_node(DevTools::TabDescription const&, Web::UniqueNodeID, Optional) const override; virtual void clear_highlighted_dom_node(DevTools::TabDescription const&) const override; virtual void listen_for_dom_mutations(DevTools::TabDescription const&, OnDOMMutationReceived) const override; virtual void stop_listening_for_dom_mutations(DevTools::TabDescription const&) const override; virtual void get_dom_node_inner_html(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeHTMLReceived) const override; virtual void get_dom_node_outer_html(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeHTMLReceived) const override; virtual void set_dom_node_outer_html(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, OnDOMNodeEditComplete) const override; virtual void set_dom_node_text(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, OnDOMNodeEditComplete) const override; virtual void set_dom_node_tag(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, OnDOMNodeEditComplete) const override; virtual void add_dom_node_attributes(DevTools::TabDescription const&, Web::UniqueNodeID, ReadonlySpan, OnDOMNodeEditComplete) const override; virtual void replace_dom_node_attribute(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, ReadonlySpan, OnDOMNodeEditComplete) const override; virtual void create_child_element(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const override; virtual void insert_dom_node_before(DevTools::TabDescription const&, Web::UniqueNodeID, Web::UniqueNodeID, Optional, OnDOMNodeEditComplete) const override; virtual void clone_dom_node(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const override; virtual void remove_dom_node(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const override; virtual void retrieve_style_sheets(DevTools::TabDescription const&, OnStyleSheetsReceived) const override; virtual void retrieve_style_sheet_source(DevTools::TabDescription const&, Web::CSS::StyleSheetIdentifier const&) const override; virtual void listen_for_style_sheet_sources(DevTools::TabDescription const&, OnStyleSheetSourceReceived) const override; virtual void stop_listening_for_style_sheet_sources(DevTools::TabDescription const&) const override; virtual void evaluate_javascript(DevTools::TabDescription const&, String const&, OnScriptEvaluationComplete) const override; virtual void listen_for_console_messages(DevTools::TabDescription const&, OnConsoleMessage) const override; virtual void stop_listening_for_console_messages(DevTools::TabDescription const&) const override; virtual void listen_for_network_events(DevTools::TabDescription const&, OnNetworkRequestStarted, OnNetworkResponseHeadersReceived, OnNetworkResponseBodyReceived, OnNetworkRequestFinished) const override; virtual void stop_listening_for_network_events(DevTools::TabDescription const&) const override; virtual void listen_for_navigation_events(DevTools::TabDescription const&, OnNavigationStarted, OnNavigationFinished) const override; virtual void stop_listening_for_navigation_events(DevTools::TabDescription const&) const override; virtual void did_connect_devtools_client(DevTools::TabDescription const&) const override; virtual void did_disconnect_devtools_client(DevTools::TabDescription const&) const override; static Application* s_the; Settings m_settings; OwnPtr m_settings_observer; BookmarkStore m_bookmark_store; OwnPtr m_bookmark_store_observer; OwnPtr m_history_store; Main::Arguments m_arguments; BrowserOptions m_browser_options; RequestServerOptions m_request_server_options; WebContentOptions m_web_content_options; RefPtr m_request_server_client; RefPtr m_image_decoder_client; RefPtr m_spare_web_content_process; bool m_has_queued_task_to_launch_spare_web_content_process { false }; RefPtr m_database; RefPtr m_history_database; OwnPtr m_cookie_jar; OwnPtr m_storage_jar; OwnPtr m_time_zone_watcher; OwnPtr m_event_loop; OwnPtr m_process_manager; RefPtr m_reload_action; RefPtr m_copy_selection_action; RefPtr m_paste_action; RefPtr m_select_all_action; RefPtr m_open_about_page_action; RefPtr m_open_settings_page_action; RefPtr m_zoom_menu; RefPtr m_reset_zoom_action; RefPtr m_color_scheme_menu; Web::CSS::PreferredColorScheme m_color_scheme { Web::CSS::PreferredColorScheme::Auto }; RefPtr m_contrast_menu; Web::CSS::PreferredContrast m_contrast { Web::CSS::PreferredContrast::Auto }; RefPtr m_motion_menu; Web::CSS::PreferredMotion m_motion { Web::CSS::PreferredMotion::Auto }; RefPtr m_bookmarks_menu; RefPtr m_toggle_bookmark_action; RefPtr m_toggle_bookmark_bar_action; size_t m_bookmarks_menu_static_size { 0 }; RefPtr m_bookmarks_bar_context_menu; RefPtr m_bookmark_context_menu; RefPtr m_bookmark_folder_context_menu; RefPtr m_inspect_menu; RefPtr m_view_source_action; RefPtr m_toggle_devtools_action; RefPtr m_debug_menu; RefPtr m_show_line_box_borders_action; RefPtr m_enable_scripting_action; RefPtr m_enable_content_filtering_action; RefPtr m_block_pop_ups_action; StringView m_user_agent_string; StringView m_navigator_compatibility_mode; Optional m_clipboard; FileDownloader m_file_downloader; #if defined(AK_OS_MACOS) OwnPtr m_mach_port_server; IPC::TransportBootstrapMachServer m_transport_bootstrap_server; Function)> m_on_browser_process_transport; #endif OwnPtr m_devtools; mutable HashMap m_navigation_listener_ids; }; } #define WEB_VIEW_APPLICATION(ApplicationType) \ public: \ template \ static ErrorOr> create(Main::Arguments const& arguments, ApplicationArguments&&... application_arguments) \ { \ auto app = adopt_own(*new ApplicationType { forward(application_arguments)... }); \ TRY(app->initialize(arguments)); \ return app; \ } \ \ static ApplicationType& the() \ { \ return static_cast(WebView::Application::the()); \ } \ \ private: