ViewImplementation.cpp 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372
  1. /*
  2. * Copyright (c) 2023, Linus Groh <linusg@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Error.h>
  7. #include <AK/LexicalPath.h>
  8. #include <AK/String.h>
  9. #include <LibCore/DateTime.h>
  10. #include <LibCore/StandardPaths.h>
  11. #include <LibGfx/ImageFormats/PNGWriter.h>
  12. #include <LibWebView/ViewImplementation.h>
  13. namespace WebView {
  14. ViewImplementation::ViewImplementation()
  15. {
  16. m_backing_store_shrink_timer = Core::Timer::create_single_shot(3000, [this] {
  17. resize_backing_stores_if_needed(WindowResizeInProgress::No);
  18. }).release_value_but_fixme_should_propagate_errors();
  19. m_repeated_crash_timer = Core::Timer::create_single_shot(1000, [this] {
  20. // Reset the "crashing a lot" counter after 1 second in case we just
  21. // happen to be visiting crashy websites a lot.
  22. this->m_crash_count = 0;
  23. }).release_value_but_fixme_should_propagate_errors();
  24. }
  25. WebContentClient& ViewImplementation::client()
  26. {
  27. VERIFY(m_client_state.client);
  28. return *m_client_state.client;
  29. }
  30. WebContentClient const& ViewImplementation::client() const
  31. {
  32. VERIFY(m_client_state.client);
  33. return *m_client_state.client;
  34. }
  35. void ViewImplementation::load(AK::URL const& url)
  36. {
  37. m_url = url;
  38. client().async_load_url(url);
  39. }
  40. void ViewImplementation::load_html(StringView html, AK::URL const& url)
  41. {
  42. m_url = url;
  43. client().async_load_html(html, url);
  44. }
  45. void ViewImplementation::load_empty_document()
  46. {
  47. load_html(""sv, {});
  48. }
  49. void ViewImplementation::zoom_in()
  50. {
  51. if (m_zoom_level >= ZOOM_MAX_LEVEL)
  52. return;
  53. m_zoom_level += ZOOM_STEP;
  54. update_zoom();
  55. }
  56. void ViewImplementation::zoom_out()
  57. {
  58. if (m_zoom_level <= ZOOM_MIN_LEVEL)
  59. return;
  60. m_zoom_level -= ZOOM_STEP;
  61. update_zoom();
  62. }
  63. void ViewImplementation::reset_zoom()
  64. {
  65. m_zoom_level = 1.0f;
  66. update_zoom();
  67. }
  68. void ViewImplementation::set_preferred_color_scheme(Web::CSS::PreferredColorScheme color_scheme)
  69. {
  70. client().async_set_preferred_color_scheme(color_scheme);
  71. }
  72. DeprecatedString ViewImplementation::selected_text()
  73. {
  74. return client().get_selected_text();
  75. }
  76. void ViewImplementation::select_all()
  77. {
  78. client().async_select_all();
  79. }
  80. void ViewImplementation::get_source()
  81. {
  82. client().async_get_source();
  83. }
  84. void ViewImplementation::inspect_dom_tree()
  85. {
  86. client().async_inspect_dom_tree();
  87. }
  88. void ViewImplementation::inspect_accessibility_tree()
  89. {
  90. client().async_inspect_accessibility_tree();
  91. }
  92. ErrorOr<ViewImplementation::DOMNodeProperties> ViewImplementation::inspect_dom_node(i32 node_id, Optional<Web::CSS::Selector::PseudoElement> pseudo_element)
  93. {
  94. auto response = client().inspect_dom_node(node_id, pseudo_element);
  95. if (!response.has_style())
  96. return Error::from_string_view("Inspected node returned no style"sv);
  97. return DOMNodeProperties {
  98. .computed_style_json = TRY(String::from_deprecated_string(response.take_computed_style())),
  99. .resolved_style_json = TRY(String::from_deprecated_string(response.take_resolved_style())),
  100. .custom_properties_json = TRY(String::from_deprecated_string(response.take_custom_properties())),
  101. .node_box_sizing_json = TRY(String::from_deprecated_string(response.take_node_box_sizing())),
  102. };
  103. }
  104. void ViewImplementation::clear_inspected_dom_node()
  105. {
  106. client().inspect_dom_node(0, {});
  107. }
  108. i32 ViewImplementation::get_hovered_node_id()
  109. {
  110. return client().get_hovered_node_id();
  111. }
  112. void ViewImplementation::debug_request(DeprecatedString const& request, DeprecatedString const& argument)
  113. {
  114. client().async_debug_request(request, argument);
  115. }
  116. void ViewImplementation::run_javascript(StringView js_source)
  117. {
  118. client().async_run_javascript(js_source);
  119. }
  120. void ViewImplementation::js_console_input(DeprecatedString const& js_source)
  121. {
  122. client().async_js_console_input(js_source);
  123. }
  124. void ViewImplementation::js_console_request_messages(i32 start_index)
  125. {
  126. client().async_js_console_request_messages(start_index);
  127. }
  128. void ViewImplementation::toggle_video_play_state()
  129. {
  130. client().async_toggle_video_play_state();
  131. }
  132. void ViewImplementation::toggle_video_loop_state()
  133. {
  134. client().async_toggle_video_loop_state();
  135. }
  136. void ViewImplementation::toggle_video_controls_state()
  137. {
  138. client().async_toggle_video_controls_state();
  139. }
  140. void ViewImplementation::handle_resize()
  141. {
  142. resize_backing_stores_if_needed(WindowResizeInProgress::Yes);
  143. m_backing_store_shrink_timer->restart();
  144. }
  145. #if !defined(AK_OS_SERENITY)
  146. ErrorOr<NonnullRefPtr<WebView::WebContentClient>> ViewImplementation::launch_web_content_process(ReadonlySpan<String> candidate_web_content_paths, EnableCallgrindProfiling enable_callgrind_profiling, IsLayoutTestMode is_layout_test_mode)
  147. {
  148. int socket_fds[2] {};
  149. TRY(Core::System::socketpair(AF_LOCAL, SOCK_STREAM, 0, socket_fds));
  150. int ui_fd = socket_fds[0];
  151. int wc_fd = socket_fds[1];
  152. int fd_passing_socket_fds[2] {};
  153. TRY(Core::System::socketpair(AF_LOCAL, SOCK_STREAM, 0, fd_passing_socket_fds));
  154. int ui_fd_passing_fd = fd_passing_socket_fds[0];
  155. int wc_fd_passing_fd = fd_passing_socket_fds[1];
  156. if (auto child_pid = TRY(Core::System::fork()); child_pid == 0) {
  157. TRY(Core::System::close(ui_fd_passing_fd));
  158. TRY(Core::System::close(ui_fd));
  159. auto takeover_string = TRY(String::formatted("WebContent:{}", wc_fd));
  160. TRY(Core::System::setenv("SOCKET_TAKEOVER"sv, takeover_string, true));
  161. auto webcontent_fd_passing_socket_string = TRY(String::number(wc_fd_passing_fd));
  162. ErrorOr<void> result;
  163. for (auto const& path : candidate_web_content_paths) {
  164. constexpr auto callgrind_prefix_length = 3;
  165. auto arguments = Vector {
  166. "valgrind"sv,
  167. "--tool=callgrind"sv,
  168. "--instr-atstart=no"sv,
  169. path.bytes_as_string_view(),
  170. "--webcontent-fd-passing-socket"sv,
  171. webcontent_fd_passing_socket_string
  172. };
  173. if (enable_callgrind_profiling == EnableCallgrindProfiling::No)
  174. arguments.remove(0, callgrind_prefix_length);
  175. if (is_layout_test_mode == IsLayoutTestMode::Yes)
  176. arguments.append("--layout-test-mode"sv);
  177. result = Core::System::exec(arguments[0], arguments.span(), Core::System::SearchInPath::Yes);
  178. if (!result.is_error())
  179. break;
  180. }
  181. if (result.is_error())
  182. warnln("Could not launch any of {}: {}", candidate_web_content_paths, result.error());
  183. VERIFY_NOT_REACHED();
  184. }
  185. TRY(Core::System::close(wc_fd_passing_fd));
  186. TRY(Core::System::close(wc_fd));
  187. auto socket = TRY(Core::LocalSocket::adopt_fd(ui_fd));
  188. TRY(socket->set_blocking(true));
  189. auto new_client = TRY(adopt_nonnull_ref_or_enomem(new (nothrow) WebView::WebContentClient(move(socket), *this)));
  190. new_client->set_fd_passing_socket(TRY(Core::LocalSocket::adopt_fd(ui_fd_passing_fd)));
  191. if (enable_callgrind_profiling == EnableCallgrindProfiling::Yes) {
  192. dbgln();
  193. dbgln("\033[1;45mLaunched WebContent process under callgrind!\033[0m");
  194. dbgln("\033[100mRun `\033[4mcallgrind_control -i on\033[24m` to start instrumentation and `\033[4mcallgrind_control -i off\033[24m` stop it again.\033[0m");
  195. dbgln();
  196. }
  197. return new_client;
  198. }
  199. #endif
  200. void ViewImplementation::resize_backing_stores_if_needed(WindowResizeInProgress window_resize_in_progress)
  201. {
  202. if (m_client_state.has_usable_bitmap) {
  203. // NOTE: We keep the outgoing front bitmap as a backup so we have something to paint until we get a new one.
  204. m_backup_bitmap = m_client_state.front_bitmap.bitmap;
  205. m_backup_bitmap_size = m_client_state.front_bitmap.last_painted_size;
  206. }
  207. m_client_state.has_usable_bitmap = false;
  208. auto viewport_rect = this->viewport_rect();
  209. if (viewport_rect.is_empty())
  210. return;
  211. Gfx::IntSize minimum_needed_size;
  212. if (window_resize_in_progress == WindowResizeInProgress::Yes) {
  213. // Pad the minimum needed size so that we don't have to keep reallocating backing stores while the window is being resized.
  214. minimum_needed_size = { viewport_rect.width() + 256, viewport_rect.height() + 256 };
  215. } else {
  216. // If we're not in the middle of a resize, we can shrink the backing store size to match the viewport size.
  217. minimum_needed_size = viewport_rect.size();
  218. m_client_state.front_bitmap = {};
  219. m_client_state.back_bitmap = {};
  220. }
  221. auto reallocate_backing_store_if_needed = [&](SharedBitmap& backing_store) {
  222. if (!backing_store.bitmap || !backing_store.bitmap->size().contains(minimum_needed_size)) {
  223. if (auto new_bitmap_or_error = Gfx::Bitmap::create_shareable(Gfx::BitmapFormat::BGRx8888, minimum_needed_size); !new_bitmap_or_error.is_error()) {
  224. if (backing_store.bitmap)
  225. client().async_remove_backing_store(backing_store.id);
  226. backing_store.pending_paints = 0;
  227. backing_store.bitmap = new_bitmap_or_error.release_value();
  228. backing_store.id = m_client_state.next_bitmap_id++;
  229. client().async_add_backing_store(backing_store.id, backing_store.bitmap->to_shareable_bitmap());
  230. }
  231. backing_store.last_painted_size = viewport_rect.size();
  232. }
  233. };
  234. reallocate_backing_store_if_needed(m_client_state.front_bitmap);
  235. reallocate_backing_store_if_needed(m_client_state.back_bitmap);
  236. request_repaint();
  237. }
  238. void ViewImplementation::request_repaint()
  239. {
  240. // If this widget was instantiated but not yet added to a window,
  241. // it won't have a back bitmap yet, so we can just skip repaint requests.
  242. if (!m_client_state.back_bitmap.bitmap)
  243. return;
  244. // Don't request a repaint until pending paint requests have finished.
  245. if (m_client_state.back_bitmap.pending_paints) {
  246. m_client_state.got_repaint_requests_while_painting = true;
  247. return;
  248. }
  249. m_client_state.back_bitmap.pending_paints++;
  250. client().async_paint(viewport_rect(), m_client_state.back_bitmap.id);
  251. }
  252. void ViewImplementation::handle_web_content_process_crash()
  253. {
  254. dbgln("WebContent process crashed!");
  255. ++m_crash_count;
  256. constexpr size_t max_reasonable_crash_count = 5U;
  257. if (m_crash_count >= max_reasonable_crash_count) {
  258. dbgln("WebContent has crashed {} times in quick succession! Not restarting...", m_crash_count);
  259. m_repeated_crash_timer->stop();
  260. return;
  261. }
  262. m_repeated_crash_timer->restart();
  263. create_client();
  264. VERIFY(m_client_state.client);
  265. // Don't keep a stale backup bitmap around.
  266. m_backup_bitmap = nullptr;
  267. handle_resize();
  268. StringBuilder builder;
  269. builder.append("<html><head><title>Crashed: "sv);
  270. builder.append(escape_html_entities(m_url.to_deprecated_string()));
  271. builder.append("</title></head><body>"sv);
  272. builder.append("<h1>Web page crashed"sv);
  273. if (!m_url.host().is_empty()) {
  274. builder.appendff(" on {}", escape_html_entities(m_url.host()));
  275. }
  276. builder.append("</h1>"sv);
  277. auto escaped_url = escape_html_entities(m_url.to_deprecated_string());
  278. builder.appendff("The web page <a href=\"{}\">{}</a> has crashed.<br><br>You can reload the page to try again.", escaped_url, escaped_url);
  279. builder.append("</body></html>"sv);
  280. load_html(builder.to_deprecated_string(), m_url);
  281. }
  282. ErrorOr<void> ViewImplementation::take_screenshot(ScreenshotType type)
  283. {
  284. Gfx::ShareableBitmap bitmap;
  285. switch (type) {
  286. case ScreenshotType::Visible:
  287. if (auto* visible_bitmap = m_client_state.has_usable_bitmap ? m_client_state.front_bitmap.bitmap.ptr() : m_backup_bitmap.ptr())
  288. bitmap = visible_bitmap->to_shareable_bitmap();
  289. break;
  290. case ScreenshotType::Full:
  291. bitmap = client().take_document_screenshot();
  292. break;
  293. }
  294. if (!bitmap.is_valid())
  295. return Error::from_string_view("Failed to take a screenshot of the current tab"sv);
  296. LexicalPath path { Core::StandardPaths::downloads_directory() };
  297. path = path.append(TRY(Core::DateTime::now().to_string("screenshot-%Y-%m-%d-%H-%M-%S.png"sv)));
  298. auto encoded = TRY(Gfx::PNGWriter::encode(*bitmap.bitmap()));
  299. auto screenshot_file = TRY(Core::File::open(path.string(), Core::File::OpenMode::Write));
  300. TRY(screenshot_file->write_until_depleted(encoded));
  301. return {};
  302. }
  303. }