BrowsingContext.cpp 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411
  1. /*
  2. * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <LibWeb/Bindings/MainThreadVM.h>
  7. #include <LibWeb/DOM/Document.h>
  8. #include <LibWeb/DOM/ElementFactory.h>
  9. #include <LibWeb/DOM/Event.h>
  10. #include <LibWeb/DOM/HTMLCollection.h>
  11. #include <LibWeb/DOM/Range.h>
  12. #include <LibWeb/Fetch/Infrastructure/HTTP/Requests.h>
  13. #include <LibWeb/HTML/BrowsingContext.h>
  14. #include <LibWeb/HTML/BrowsingContextContainer.h>
  15. #include <LibWeb/HTML/BrowsingContextGroup.h>
  16. #include <LibWeb/HTML/CrossOrigin/CrossOriginOpenerPolicy.h>
  17. #include <LibWeb/HTML/EventLoop/EventLoop.h>
  18. #include <LibWeb/HTML/HTMLAnchorElement.h>
  19. #include <LibWeb/HTML/HTMLInputElement.h>
  20. #include <LibWeb/HTML/RemoteBrowsingContext.h>
  21. #include <LibWeb/HTML/SandboxingFlagSet.h>
  22. #include <LibWeb/HTML/Scripting/WindowEnvironmentSettingsObject.h>
  23. #include <LibWeb/HTML/Window.h>
  24. #include <LibWeb/HTML/WindowProxy.h>
  25. #include <LibWeb/HighResolutionTime/TimeOrigin.h>
  26. #include <LibWeb/Infra/Strings.h>
  27. #include <LibWeb/Layout/BreakNode.h>
  28. #include <LibWeb/Layout/TextNode.h>
  29. #include <LibWeb/Layout/Viewport.h>
  30. #include <LibWeb/Namespace.h>
  31. #include <LibWeb/Page/Page.h>
  32. #include <LibWeb/URL/URL.h>
  33. namespace Web::HTML {
  34. // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#matches-about:blank
  35. static bool url_matches_about_blank(AK::URL const& url)
  36. {
  37. // A URL matches about:blank if its scheme is "about", its path contains a single string "blank", its username and password are the empty string, and its host is null.
  38. return url.scheme() == "about"sv
  39. && url.path() == "blank"sv
  40. && url.username().is_empty()
  41. && url.password().is_empty()
  42. && url.host().is_null();
  43. }
  44. // https://html.spec.whatwg.org/multipage/browsers.html#determining-the-origin
  45. HTML::Origin determine_the_origin(BrowsingContext const& browsing_context, Optional<AK::URL> url, SandboxingFlagSet sandbox_flags, Optional<HTML::Origin> invocation_origin)
  46. {
  47. // 1. If sandboxFlags has its sandboxed origin browsing context flag set, then return a new opaque origin.
  48. if (sandbox_flags.flags & SandboxingFlagSet::SandboxedOrigin) {
  49. return HTML::Origin {};
  50. }
  51. // 2. If url is null, then return a new opaque origin.
  52. if (!url.has_value()) {
  53. return HTML::Origin {};
  54. }
  55. // 3. If invocationOrigin is non-null and url matches about:blank, then return invocationOrigin.
  56. if (invocation_origin.has_value() && url_matches_about_blank(*url)) {
  57. return invocation_origin.value();
  58. }
  59. // 4. If url is about:srcdoc, then return the origin of browsingContext's container document.
  60. if (url == AK::URL("about:srcdoc")) {
  61. VERIFY(browsing_context.container_document());
  62. return browsing_context.container_document()->origin();
  63. }
  64. // 5. Return url's origin.
  65. return URL::url_origin(*url);
  66. }
  67. // https://html.spec.whatwg.org/multipage/browsers.html#creating-a-new-top-level-browsing-context
  68. JS::NonnullGCPtr<BrowsingContext> BrowsingContext::create_a_new_top_level_browsing_context(Web::Page& page)
  69. {
  70. // 1. Let group be the result of creating a new browsing context group.
  71. auto group = BrowsingContextGroup::create_a_new_browsing_context_group(page);
  72. // 2. Return group's browsing context set[0].
  73. return *(*group->browsing_context_set().begin());
  74. }
  75. // https://html.spec.whatwg.org/multipage/browsers.html#creating-a-new-browsing-context
  76. JS::NonnullGCPtr<BrowsingContext> BrowsingContext::create_a_new_browsing_context(Page& page, JS::GCPtr<DOM::Document> creator, JS::GCPtr<DOM::Element> embedder, BrowsingContextGroup&)
  77. {
  78. // 1. Let browsingContext be a new browsing context.
  79. BrowsingContextContainer* container = (embedder && is<BrowsingContextContainer>(*embedder)) ? static_cast<BrowsingContextContainer*>(embedder.ptr()) : nullptr;
  80. auto browsing_context = Bindings::main_thread_vm().heap().allocate_without_realm<BrowsingContext>(page, container);
  81. // 2. Let unsafeContextCreationTime be the unsafe shared current time.
  82. [[maybe_unused]] auto unsafe_context_creation_time = HighResolutionTime::unsafe_shared_current_time();
  83. // 3. If creator is non-null, then set browsingContext's creator origin to return creator's origin,
  84. // browsingContext's creator URL to return creator's URL,
  85. // browsingContext's creator base URL to return creator's base URL,
  86. // FIXME: and browsingContext's virtual browsing context group ID to creator's top-level browsing context's virtual browsing context group ID.
  87. if (creator) {
  88. browsing_context->m_creator_origin = creator->origin();
  89. browsing_context->m_creator_url = creator->url();
  90. browsing_context->m_creator_base_url = creator->base_url();
  91. }
  92. // FIXME: 4. Let sandboxFlags be the result of determining the creation sandboxing flags given browsingContext and embedded.
  93. SandboxingFlagSet sandbox_flags;
  94. // 5. Let origin be the result of determining the origin given browsingContext, about:blank, sandboxFlags, and browsingContext's creator origin.
  95. auto origin = determine_the_origin(*browsing_context, AK::URL("about:blank"), sandbox_flags, browsing_context->m_creator_origin);
  96. // FIXME: 6. Let permissionsPolicy be the result of creating a permissions policy given browsingContext and origin. [PERMISSIONSPOLICY]
  97. // FIXME: 7. Let agent be the result of obtaining a similar-origin window agent given origin, group, and false.
  98. JS::GCPtr<Window> window;
  99. // 8. Let realm execution context be the result of creating a new JavaScript realm given agent and the following customizations:
  100. auto realm_execution_context = Bindings::create_a_new_javascript_realm(
  101. Bindings::main_thread_vm(),
  102. [&](JS::Realm& realm) -> JS::Object* {
  103. browsing_context->m_window_proxy = realm.heap().allocate<WindowProxy>(realm, realm).release_allocated_value_but_fixme_should_propagate_errors();
  104. // - For the global object, create a new Window object.
  105. window = HTML::Window::create(realm).release_value_but_fixme_should_propagate_errors();
  106. return window.ptr();
  107. },
  108. [&](JS::Realm&) -> JS::Object* {
  109. // - For the global this binding, use browsingContext's WindowProxy object.
  110. return browsing_context->m_window_proxy;
  111. });
  112. // 9. Let topLevelCreationURL be about:blank if embedder is null; otherwise embedder's relevant settings object's top-level creation URL.
  113. auto top_level_creation_url = !embedder ? AK::URL("about:blank") : relevant_settings_object(*embedder).top_level_creation_url;
  114. // 10. Let topLevelOrigin be origin if embedder is null; otherwise embedder's relevant settings object's top-level origin.
  115. auto top_level_origin = !embedder ? origin : relevant_settings_object(*embedder).origin();
  116. // 11. Set up a window environment settings object with about:blank, realm execution context, null, topLevelCreationURL, and topLevelOrigin.
  117. HTML::WindowEnvironmentSettingsObject::setup(
  118. AK::URL("about:blank"),
  119. move(realm_execution_context),
  120. {},
  121. top_level_creation_url,
  122. top_level_origin)
  123. .release_value_but_fixme_should_propagate_errors();
  124. // 12. Let loadTimingInfo be a new document load timing info with its navigation start time set to the result of calling
  125. // coarsen time with unsafeContextCreationTime and the new environment settings object's cross-origin isolated capability.
  126. auto load_timing_info = DOM::DocumentLoadTimingInfo();
  127. load_timing_info.navigation_start_time = HighResolutionTime::coarsen_time(
  128. unsafe_context_creation_time,
  129. verify_cast<WindowEnvironmentSettingsObject>(Bindings::host_defined_environment_settings_object(window->realm())).cross_origin_isolated_capability() == CanUseCrossOriginIsolatedAPIs::Yes);
  130. // 13. Let coop be a new cross-origin opener policy.
  131. auto coop = CrossOriginOpenerPolicy {};
  132. // 14. If creator is non-null and creator's origin is same origin with creator's relevant settings object's top-level origin,
  133. // then set coop to creator's browsing context's top-level browsing context's active document's cross-origin opener policy.
  134. if (creator && creator->origin().is_same_origin(relevant_settings_object(*creator).top_level_origin)) {
  135. VERIFY(creator->browsing_context());
  136. auto* top_level_document = creator->browsing_context()->top_level_browsing_context().active_document();
  137. VERIFY(top_level_document);
  138. coop = top_level_document->cross_origin_opener_policy();
  139. }
  140. // 15. Let document be a new Document, marked as an HTML document in quirks mode,
  141. // whose content type is "text/html",
  142. // origin is origin,
  143. // FIXME: active sandboxing flag set is sandboxFlags,
  144. // FIXME: permissions policy is permissionsPolicy,
  145. // cross-origin opener policy is coop,
  146. // load timing info is loadTimingInfo,
  147. // FIXME: navigation id is null,
  148. // and which is ready for post-load tasks.
  149. auto document = DOM::Document::create(window->realm()).release_value_but_fixme_should_propagate_errors();
  150. // Non-standard
  151. document->set_window({}, *window);
  152. window->set_associated_document(*document);
  153. document->set_quirks_mode(DOM::QuirksMode::Yes);
  154. document->set_content_type("text/html");
  155. document->set_origin(origin);
  156. document->set_url(AK::URL("about:blank"));
  157. document->set_cross_origin_opener_policy(coop);
  158. document->set_load_timing_info(load_timing_info);
  159. document->set_ready_for_post_load_tasks(true);
  160. // FIXME: 16. Assert: document's URL and document's relevant settings object's creation URL are about:blank.
  161. // 17. Set document's is initial about:blank to true.
  162. document->set_is_initial_about_blank(true);
  163. // 18. Ensure that document has a single child html node, which itself has two empty child nodes: a head element, and a body element.
  164. auto html_node = DOM::create_element(document, HTML::TagNames::html, Namespace::HTML).release_value_but_fixme_should_propagate_errors();
  165. MUST(html_node->append_child(DOM::create_element(document, HTML::TagNames::head, Namespace::HTML).release_value_but_fixme_should_propagate_errors()));
  166. MUST(html_node->append_child(DOM::create_element(document, HTML::TagNames::body, Namespace::HTML).release_value_but_fixme_should_propagate_errors()));
  167. MUST(document->append_child(html_node));
  168. // 19. Set the active document of browsingContext to document.
  169. browsing_context->set_active_document(*document);
  170. // 20. If browsingContext's creator URL is non-null, then set document's referrer to the serialization of it.
  171. if (browsing_context->m_creator_url.has_value()) {
  172. document->set_referrer(browsing_context->m_creator_url->serialize());
  173. }
  174. // FIXME: 21. If creator is non-null, then set document's policy container to a clone of creator's policy container.
  175. // 22. Append a new session history entry to browsingContext's session history whose URL is about:blank and document is document.
  176. browsing_context->m_session_history.append(HTML::SessionHistoryEntry {
  177. .url = AK::URL("about:blank"),
  178. .document = document.ptr(),
  179. .serialized_state = {},
  180. .policy_container = {},
  181. .scroll_restoration_mode = {},
  182. .browsing_context_name = {},
  183. .original_source_browsing_context = {},
  184. });
  185. // 23. Completely finish loading document.
  186. document->completely_finish_loading();
  187. // 24. Return browsingContext.
  188. return *browsing_context;
  189. }
  190. BrowsingContext::BrowsingContext(Page& page, HTML::BrowsingContextContainer* container)
  191. : m_page(page)
  192. , m_loader(*this)
  193. , m_event_handler({}, *this)
  194. , m_container(container)
  195. {
  196. m_cursor_blink_timer = Platform::Timer::create_repeating(500, [this] {
  197. if (!is_focused_context())
  198. return;
  199. if (m_cursor_position.node() && m_cursor_position.node()->layout_node()) {
  200. m_cursor_blink_state = !m_cursor_blink_state;
  201. m_cursor_position.node()->layout_node()->set_needs_display();
  202. }
  203. });
  204. }
  205. BrowsingContext::~BrowsingContext() = default;
  206. void BrowsingContext::visit_edges(Cell::Visitor& visitor)
  207. {
  208. Base::visit_edges(visitor);
  209. for (auto& entry : m_session_history)
  210. visitor.visit(entry.document);
  211. visitor.visit(m_container);
  212. visitor.visit(m_window_proxy);
  213. visitor.visit(m_opener_browsing_context);
  214. visitor.visit(m_group);
  215. visitor.visit(m_parent);
  216. visitor.visit(m_first_child);
  217. visitor.visit(m_last_child);
  218. visitor.visit(m_next_sibling);
  219. visitor.visit(m_previous_sibling);
  220. }
  221. void BrowsingContext::did_edit(Badge<EditEventHandler>)
  222. {
  223. reset_cursor_blink_cycle();
  224. if (m_cursor_position.node() && is<DOM::Text>(*m_cursor_position.node())) {
  225. auto& text_node = static_cast<DOM::Text&>(*m_cursor_position.node());
  226. if (auto* input_element = text_node.owner_input_element())
  227. input_element->did_edit_text_node({});
  228. }
  229. }
  230. void BrowsingContext::reset_cursor_blink_cycle()
  231. {
  232. m_cursor_blink_state = true;
  233. m_cursor_blink_timer->restart();
  234. if (m_cursor_position.is_valid() && m_cursor_position.node()->layout_node())
  235. m_cursor_position.node()->layout_node()->set_needs_display();
  236. }
  237. // https://html.spec.whatwg.org/multipage/browsers.html#top-level-browsing-context
  238. bool BrowsingContext::is_top_level() const
  239. {
  240. // A browsing context that has no parent browsing context is the top-level browsing context for itself and all of the browsing contexts for which it is an ancestor browsing context.
  241. return !parent();
  242. }
  243. bool BrowsingContext::is_focused_context() const
  244. {
  245. return m_page && &m_page->focused_context() == this;
  246. }
  247. // https://html.spec.whatwg.org/multipage/browsers.html#set-the-active-document
  248. void BrowsingContext::set_active_document(JS::NonnullGCPtr<DOM::Document> document)
  249. {
  250. auto previously_active_document = active_document();
  251. // 1. Let window be document's relevant global object.
  252. auto& window = verify_cast<HTML::Window>(relevant_global_object(document));
  253. // 2. Set document's visibility state to browsingContext's top-level browsing context's system visibility state.
  254. document->set_visibility_state({}, top_level_browsing_context().system_visibility_state());
  255. // 3. Set browsingContext's active window to window.
  256. m_window_proxy->set_window({}, window);
  257. // 4. Set window's associated Document to document.
  258. window.set_associated_document(document);
  259. // 5. Set window's relevant settings object's execution ready flag.
  260. relevant_settings_object(window).execution_ready = true;
  261. // AD-HOC:
  262. document->set_browsing_context(this);
  263. if (m_page && is_top_level())
  264. m_page->client().page_did_change_title(document->title());
  265. if (previously_active_document && previously_active_document != document.ptr())
  266. previously_active_document->did_stop_being_active_document_in_browsing_context({});
  267. }
  268. void BrowsingContext::set_viewport_rect(CSSPixelRect const& rect)
  269. {
  270. bool did_change = false;
  271. if (m_size != rect.size()) {
  272. m_size = rect.size();
  273. if (auto* document = active_document()) {
  274. // NOTE: Resizing the viewport changes the reference value for viewport-relative CSS lengths.
  275. document->invalidate_style();
  276. document->invalidate_layout();
  277. }
  278. did_change = true;
  279. }
  280. if (m_viewport_scroll_offset != rect.location()) {
  281. m_viewport_scroll_offset = rect.location();
  282. scroll_offset_did_change();
  283. did_change = true;
  284. }
  285. if (did_change) {
  286. for (auto* client : m_viewport_clients)
  287. client->browsing_context_did_set_viewport_rect(rect);
  288. }
  289. // Schedule the HTML event loop to ensure that a `resize` event gets fired.
  290. HTML::main_thread_event_loop().schedule();
  291. }
  292. void BrowsingContext::set_size(CSSPixelSize size)
  293. {
  294. if (m_size == size)
  295. return;
  296. m_size = size;
  297. if (auto* document = active_document()) {
  298. document->invalidate_style();
  299. document->invalidate_layout();
  300. }
  301. for (auto* client : m_viewport_clients)
  302. client->browsing_context_did_set_viewport_rect(viewport_rect());
  303. // Schedule the HTML event loop to ensure that a `resize` event gets fired.
  304. HTML::main_thread_event_loop().schedule();
  305. }
  306. void BrowsingContext::set_needs_display()
  307. {
  308. set_needs_display(viewport_rect());
  309. }
  310. void BrowsingContext::set_needs_display(CSSPixelRect const& rect)
  311. {
  312. if (!viewport_rect().intersects(rect))
  313. return;
  314. if (is_top_level()) {
  315. if (m_page)
  316. m_page->client().page_did_invalidate(to_top_level_rect(rect));
  317. return;
  318. }
  319. if (container() && container()->layout_node())
  320. container()->layout_node()->set_needs_display();
  321. }
  322. void BrowsingContext::scroll_to(CSSPixelPoint position)
  323. {
  324. // NOTE: Scrolling to a position requires up-to-date layout *unless* we're scrolling to (0, 0)
  325. // as (0, 0) is always guaranteed to be a valid scroll position.
  326. if (!position.is_zero()) {
  327. if (active_document())
  328. active_document()->update_layout();
  329. }
  330. if (m_page)
  331. m_page->client().page_did_request_scroll_to(position);
  332. }
  333. void BrowsingContext::scroll_to_anchor(DeprecatedString const& fragment)
  334. {
  335. JS::GCPtr<DOM::Document> document = active_document();
  336. if (!document)
  337. return;
  338. auto element = document->get_element_by_id(fragment);
  339. if (!element) {
  340. auto candidates = document->get_elements_by_name(fragment);
  341. for (auto& candidate : candidates->collect_matching_elements()) {
  342. if (is<HTML::HTMLAnchorElement>(*candidate)) {
  343. element = &verify_cast<HTML::HTMLAnchorElement>(*candidate);
  344. break;
  345. }
  346. }
  347. }
  348. if (!element)
  349. return;
  350. document->update_layout();
  351. if (!element->layout_node())
  352. return;
  353. auto& layout_node = *element->layout_node();
  354. CSSPixelRect target_rect { layout_node.box_type_agnostic_position(), { viewport_rect().width(), viewport_rect().height() } };
  355. if (is<Layout::Box>(layout_node)) {
  356. auto& layout_box = verify_cast<Layout::Box>(layout_node);
  357. auto padding_box = layout_box.box_model().padding_box();
  358. target_rect.translate_by(-padding_box.left, -padding_box.top);
  359. }
  360. if (m_page)
  361. m_page->client().page_did_request_scroll_into_view(target_rect);
  362. }
  363. CSSPixelRect BrowsingContext::to_top_level_rect(CSSPixelRect const& a_rect)
  364. {
  365. auto rect = a_rect;
  366. rect.set_location(to_top_level_position(a_rect.location()));
  367. return rect;
  368. }
  369. CSSPixelPoint BrowsingContext::to_top_level_position(CSSPixelPoint a_position)
  370. {
  371. auto position = a_position;
  372. for (auto ancestor = parent(); ancestor; ancestor = ancestor->parent()) {
  373. if (ancestor->is_top_level())
  374. break;
  375. if (!ancestor->container())
  376. return {};
  377. if (!ancestor->container()->layout_node())
  378. return {};
  379. position.translate_by(ancestor->container()->layout_node()->box_type_agnostic_position());
  380. }
  381. return position;
  382. }
  383. void BrowsingContext::set_cursor_position(DOM::Position position)
  384. {
  385. if (m_cursor_position == position)
  386. return;
  387. if (m_cursor_position.node() && m_cursor_position.node()->layout_node())
  388. m_cursor_position.node()->layout_node()->set_needs_display();
  389. m_cursor_position = move(position);
  390. if (m_cursor_position.node() && m_cursor_position.node()->layout_node())
  391. m_cursor_position.node()->layout_node()->set_needs_display();
  392. reset_cursor_blink_cycle();
  393. }
  394. static DeprecatedString visible_text_in_range(DOM::Range const& range)
  395. {
  396. // NOTE: This is an adaption of Range stringification, but we skip over DOM nodes that don't have a corresponding layout node.
  397. StringBuilder builder;
  398. if (range.start_container() == range.end_container() && is<DOM::Text>(*range.start_container())) {
  399. if (!range.start_container()->layout_node())
  400. return ""sv;
  401. return static_cast<DOM::Text const&>(*range.start_container()).data().substring(range.start_offset(), range.end_offset() - range.start_offset());
  402. }
  403. if (is<DOM::Text>(*range.start_container()) && range.start_container()->layout_node())
  404. builder.append(static_cast<DOM::Text const&>(*range.start_container()).data().substring_view(range.start_offset()));
  405. for (DOM::Node const* node = range.start_container(); node != range.end_container()->next_sibling(); node = node->next_in_pre_order()) {
  406. if (is<DOM::Text>(*node) && range.contains_node(*node) && node->layout_node())
  407. builder.append(static_cast<DOM::Text const&>(*node).data());
  408. }
  409. if (is<DOM::Text>(*range.end_container()) && range.end_container()->layout_node())
  410. builder.append(static_cast<DOM::Text const&>(*range.end_container()).data().substring_view(0, range.end_offset()));
  411. return builder.to_deprecated_string();
  412. }
  413. DeprecatedString BrowsingContext::selected_text() const
  414. {
  415. auto* document = active_document();
  416. if (!document)
  417. return ""sv;
  418. auto selection = const_cast<DOM::Document&>(*document).get_selection();
  419. auto range = selection->range();
  420. if (!range)
  421. return ""sv;
  422. return visible_text_in_range(*range);
  423. }
  424. void BrowsingContext::select_all()
  425. {
  426. auto* document = active_document();
  427. if (!document)
  428. return;
  429. auto* body = document->body();
  430. if (!body)
  431. return;
  432. auto selection = document->get_selection();
  433. if (!selection)
  434. return;
  435. (void)selection->select_all_children(*document->body());
  436. }
  437. void BrowsingContext::register_viewport_client(ViewportClient& client)
  438. {
  439. auto result = m_viewport_clients.set(&client);
  440. VERIFY(result == AK::HashSetResult::InsertedNewEntry);
  441. }
  442. void BrowsingContext::unregister_viewport_client(ViewportClient& client)
  443. {
  444. bool was_removed = m_viewport_clients.remove(&client);
  445. VERIFY(was_removed);
  446. }
  447. void BrowsingContext::register_frame_nesting(AK::URL const& url)
  448. {
  449. m_frame_nesting_levels.ensure(url)++;
  450. }
  451. bool BrowsingContext::is_frame_nesting_allowed(AK::URL const& url) const
  452. {
  453. return m_frame_nesting_levels.get(url).value_or(0) < 3;
  454. }
  455. bool BrowsingContext::increment_cursor_position_offset()
  456. {
  457. if (!m_cursor_position.increment_offset())
  458. return false;
  459. reset_cursor_blink_cycle();
  460. return true;
  461. }
  462. bool BrowsingContext::decrement_cursor_position_offset()
  463. {
  464. if (!m_cursor_position.decrement_offset())
  465. return false;
  466. reset_cursor_blink_cycle();
  467. return true;
  468. }
  469. DOM::Document* BrowsingContext::container_document()
  470. {
  471. if (auto* container = this->container())
  472. return &container->document();
  473. return nullptr;
  474. }
  475. DOM::Document const* BrowsingContext::container_document() const
  476. {
  477. if (auto* container = this->container())
  478. return &container->document();
  479. return nullptr;
  480. }
  481. // https://html.spec.whatwg.org/#rendering-opportunity
  482. bool BrowsingContext::has_a_rendering_opportunity() const
  483. {
  484. // A browsing context has a rendering opportunity if the user agent is currently able to present the contents of the browsing context to the user,
  485. // accounting for hardware refresh rate constraints and user agent throttling for performance reasons, but considering content presentable even if it's outside the viewport.
  486. // FIXME: We should at the very least say `false` here if we're an inactive browser tab.
  487. return true;
  488. }
  489. // https://html.spec.whatwg.org/multipage/interaction.html#currently-focused-area-of-a-top-level-browsing-context
  490. JS::GCPtr<DOM::Node> BrowsingContext::currently_focused_area()
  491. {
  492. // 1. If topLevelBC does not have system focus, then return null.
  493. if (!is_focused_context())
  494. return nullptr;
  495. // 2. Let candidate be topLevelBC's active document.
  496. auto* candidate = active_document();
  497. // 3. While candidate's focused area is a browsing context container with a non-null nested browsing context:
  498. // set candidate to the active document of that browsing context container's nested browsing context.
  499. while (candidate->focused_element()
  500. && is<HTML::BrowsingContextContainer>(candidate->focused_element())
  501. && static_cast<HTML::BrowsingContextContainer&>(*candidate->focused_element()).nested_browsing_context()) {
  502. candidate = static_cast<HTML::BrowsingContextContainer&>(*candidate->focused_element()).nested_browsing_context()->active_document();
  503. }
  504. // 4. If candidate's focused area is non-null, set candidate to candidate's focused area.
  505. if (candidate->focused_element()) {
  506. // NOTE: We return right away here instead of assigning to candidate,
  507. // since that would require compromising type safety.
  508. return candidate->focused_element();
  509. }
  510. // 5. Return candidate.
  511. return candidate;
  512. }
  513. // https://html.spec.whatwg.org/#the-rules-for-choosing-a-browsing-context-given-a-browsing-context-name
  514. BrowsingContext::ChosenBrowsingContext BrowsingContext::choose_a_browsing_context(StringView name, TokenizedFeature::NoOpener no_opener, ActivateTab activate_tab)
  515. {
  516. // The rules for choosing a browsing context, given a browsing context name name, a browsing context current, and
  517. // a boolean noopener are as follows:
  518. // 1. Let chosen be null.
  519. JS::GCPtr<AbstractBrowsingContext> chosen = nullptr;
  520. // 2. Let windowType be "existing or none".
  521. auto window_type = WindowType::ExistingOrNone;
  522. // 3. Let sandboxingFlagSet be current's active document's active sandboxing flag set.
  523. auto sandboxing_flag_set = active_document()->active_sandboxing_flag_set();
  524. // 4. If name is the empty string or an ASCII case-insensitive match for "_self", then set chosen to current.
  525. if (name.is_empty() || Infra::is_ascii_case_insensitive_match(name, "_self"sv)) {
  526. chosen = this;
  527. }
  528. // 5. Otherwise, if name is an ASCII case-insensitive match for "_parent", set chosen to current's parent browsing
  529. // context, if any, and current otherwise.
  530. else if (Infra::is_ascii_case_insensitive_match(name, "_parent"sv)) {
  531. if (auto parent = this->parent())
  532. chosen = parent;
  533. else
  534. chosen = this;
  535. }
  536. // 6. Otherwise, if name is an ASCII case-insensitive match for "_top", set chosen to current's top-level browsing
  537. // context, if any, and current otherwise.
  538. else if (Infra::is_ascii_case_insensitive_match(name, "_top"sv)) {
  539. chosen = &top_level_browsing_context();
  540. }
  541. // FIXME: 7. Otherwise, if name is not an ASCII case-insensitive match for "_blank", there exists a browsing context
  542. // whose name is the same as name, current is familiar with that browsing context, and the user agent
  543. // determines that the two browsing contexts are related enough that it is ok if they reach each other,
  544. // set chosen to that browsing context. If there are multiple matching browsing contexts, the user agent
  545. // should set chosen to one in some arbitrary consistent manner, such as the most recently opened, most
  546. // recently focused, or more closely related.
  547. else if (!Infra::is_ascii_case_insensitive_match(name, "_blank"sv)) {
  548. dbgln("FIXME: Find matching browser context for name {}", name);
  549. chosen = this;
  550. } else {
  551. // 8. Otherwise, a new browsing context is being requested, and what happens depends on the user agent's
  552. // configuration and abilities — it is determined by the rules given for the first applicable option from
  553. // the following list:
  554. // --> If current's active window does not have transient activation and the user agent has been configured to
  555. // not show popups (i.e., the user agent has a "popup blocker" enabled)
  556. VERIFY(m_page);
  557. if (!active_window()->has_transient_activation() && m_page->should_block_pop_ups()) {
  558. // FIXME: The user agent may inform the user that a popup has been blocked.
  559. dbgln("Pop-up blocked!");
  560. }
  561. // --> If sandboxingFlagSet has the sandboxed auxiliary navigation browsing context flag set
  562. else if (sandboxing_flag_set.flags & SandboxingFlagSet::SandboxedAuxiliaryNavigation) {
  563. // FIXME: The user agent may report to a developer console that a popup has been blocked.
  564. dbgln("Pop-up blocked!");
  565. }
  566. // --> If the user agent has been configured such that in this instance it will create a new browsing context
  567. else if (true) { // FIXME: When is this the case?
  568. // 1. Set windowType to "new and unrestricted".
  569. window_type = WindowType::NewAndUnrestricted;
  570. // 2. If current's top-level browsing context's active document's cross-origin opener policy's value is
  571. // "same-origin" or "same-origin-plus-COEP", then:
  572. if (top_level_browsing_context().active_document()->cross_origin_opener_policy().value == CrossOriginOpenerPolicyValue::SameOrigin || top_level_browsing_context().active_document()->cross_origin_opener_policy().value == CrossOriginOpenerPolicyValue::SameOriginPlusCOEP) {
  573. // 1. Let currentDocument be current's active document.
  574. auto* current_document = top_level_browsing_context().active_document();
  575. // 2. If currentDocument's origin is not same origin with currentDocument's relevant settings object's
  576. // top-level origin, then set noopener to true, name to "_blank", and windowType to "new with no opener".
  577. if (!current_document->origin().is_same_origin(current_document->relevant_settings_object().top_level_origin)) {
  578. no_opener = TokenizedFeature::NoOpener::Yes;
  579. name = "_blank"sv;
  580. window_type = WindowType::NewWithNoOpener;
  581. }
  582. }
  583. // 3. If noopener is true, then set chosen to the result of creating a new top-level browsing context.
  584. if (no_opener == TokenizedFeature::NoOpener::Yes) {
  585. auto handle = m_page->client().page_did_request_new_tab(activate_tab);
  586. chosen = RemoteBrowsingContext::create_a_new_remote_browsing_context(handle);
  587. }
  588. // 4. Otherwise:
  589. else {
  590. // 1. Set chosen to the result of creating a new auxiliary browsing context with current.
  591. // FIXME: We have no concept of auxiliary browsing context
  592. chosen = HTML::BrowsingContext::create_a_new_top_level_browsing_context(*m_page);
  593. // 2. If sandboxingFlagSet's sandboxed navigation browsing context flag is set, then current must be
  594. // set as chosen's one permitted sandboxed navigator.
  595. // FIXME: We have no concept of one permitted sandboxed navigator
  596. }
  597. // 5. If sandboxingFlagSet's sandbox propagates to auxiliary browsing contexts flag is set, then all the
  598. // flags that are set in sandboxingFlagSet must be set in chosen's popup sandboxing flag set.
  599. // FIXME: Our BrowsingContexts do not have SandboxingFlagSets yet, only documents do
  600. // 6. If name is not an ASCII case-insensitive match for "_blank", then set chosen's name to name.
  601. if (!Infra::is_ascii_case_insensitive_match(name, "_blank"sv))
  602. chosen->set_name(String::from_deprecated_string(name).release_value_but_fixme_should_propagate_errors());
  603. }
  604. // --> If the user agent has been configured such that in this instance t will reuse current
  605. else if (false) { // FIXME: When is this the case?
  606. // Set chosen to current.
  607. chosen = *this;
  608. }
  609. // --> If the user agent has been configured such that in this instance it will not find a browsing context
  610. else if (false) { // FIXME: When is this the case?
  611. // Do nothing.
  612. }
  613. }
  614. // 9. Return chosen and windowType.
  615. return { chosen.ptr(), window_type };
  616. }
  617. // https://html.spec.whatwg.org/multipage/browsers.html#document-tree-child-browsing-context
  618. size_t BrowsingContext::document_tree_child_browsing_context_count() const
  619. {
  620. size_t count = 0;
  621. // A browsing context child is a document-tree child browsing context of parent if child is a child browsing context and child's container is in a document tree.
  622. for_each_child([this, &count](BrowsingContext const& child) {
  623. if (child.is_child_of(*this) && child.container()->in_a_document_tree())
  624. ++count;
  625. });
  626. return count;
  627. }
  628. // https://html.spec.whatwg.org/multipage/browsers.html#child-browsing-context
  629. bool BrowsingContext::is_child_of(BrowsingContext const& parent) const
  630. {
  631. // A browsing context child is said to be a child browsing context of another browsing context parent,
  632. // if child's container document is non-null and child's container document's browsing context is parent.
  633. return container_document() && container_document()->browsing_context() == &parent;
  634. }
  635. // https://html.spec.whatwg.org/multipage/dom.html#still-on-its-initial-about:blank-document
  636. bool BrowsingContext::still_on_its_initial_about_blank_document() const
  637. {
  638. // A browsing context browsingContext is still on its initial about:blank Document
  639. // if browsingContext's session history's size is 1
  640. // and browsingContext's session history[0]'s document's is initial about:blank is true.
  641. return m_session_history.size() == 1
  642. && m_session_history[0].document
  643. && m_session_history[0].document->is_initial_about_blank();
  644. }
  645. DOM::Document const* BrowsingContext::active_document() const
  646. {
  647. auto* window = active_window();
  648. if (!window)
  649. return nullptr;
  650. return &window->associated_document();
  651. }
  652. DOM::Document* BrowsingContext::active_document()
  653. {
  654. auto* window = active_window();
  655. if (!window)
  656. return nullptr;
  657. return &window->associated_document();
  658. }
  659. // https://html.spec.whatwg.org/multipage/browsers.html#active-window
  660. HTML::Window* BrowsingContext::active_window()
  661. {
  662. return m_window_proxy->window();
  663. }
  664. // https://html.spec.whatwg.org/multipage/browsers.html#active-window
  665. HTML::Window const* BrowsingContext::active_window() const
  666. {
  667. return m_window_proxy->window();
  668. }
  669. HTML::WindowProxy* BrowsingContext::window_proxy()
  670. {
  671. return m_window_proxy.ptr();
  672. }
  673. HTML::WindowProxy const* BrowsingContext::window_proxy() const
  674. {
  675. return m_window_proxy.ptr();
  676. }
  677. void BrowsingContext::scroll_offset_did_change()
  678. {
  679. // https://w3c.github.io/csswg-drafts/cssom-view-1/#scrolling-events
  680. // Whenever a viewport gets scrolled (whether in response to user interaction or by an API), the user agent must run these steps:
  681. // 1. Let doc be the viewport’s associated Document.
  682. auto* doc = active_document();
  683. VERIFY(doc);
  684. // 2. If doc is already in doc’s pending scroll event targets, abort these steps.
  685. for (auto& target : doc->pending_scroll_event_targets()) {
  686. if (target.ptr() == doc)
  687. return;
  688. }
  689. // 3. Append doc to doc’s pending scroll event targets.
  690. doc->pending_scroll_event_targets().append(*doc);
  691. }
  692. BrowsingContextGroup* BrowsingContext::group()
  693. {
  694. return m_group;
  695. }
  696. void BrowsingContext::set_group(BrowsingContextGroup* group)
  697. {
  698. m_group = group;
  699. }
  700. // https://html.spec.whatwg.org/multipage/browsers.html#bcg-remove
  701. void BrowsingContext::remove()
  702. {
  703. // 1. Assert: browsingContext's group is non-null, because a browsing context only gets discarded once.
  704. VERIFY(group());
  705. // 2. Let group be browsingContext's group.
  706. JS::NonnullGCPtr<BrowsingContextGroup> group = *this->group();
  707. // 3. Set browsingContext's group to null.
  708. set_group(nullptr);
  709. // 4. Remove browsingContext from group's browsing context set.
  710. group->browsing_context_set().remove(this);
  711. // 5. If group's browsing context set is empty, then remove group from the user agent's browsing context group set.
  712. // NOTE: This is done by ~BrowsingContextGroup() when the refcount reaches 0.
  713. }
  714. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate
  715. WebIDL::ExceptionOr<void> BrowsingContext::navigate(
  716. JS::NonnullGCPtr<Fetch::Infrastructure::Request> resource,
  717. BrowsingContext& source_browsing_context,
  718. bool exceptions_enabled,
  719. HistoryHandlingBehavior history_handling,
  720. Optional<PolicyContainer> history_policy_container,
  721. DeprecatedString navigation_type,
  722. Optional<DeprecatedString> navigation_id,
  723. Function<void(JS::NonnullGCPtr<Fetch::Infrastructure::Response>)> process_response_end_of_body)
  724. {
  725. // 1. If resource is a URL, then set resource to a new request whose URL is resource.
  726. // NOTE: This function only accepts resources that are already a request, so this is irrelevant.
  727. // 2. If resource is a request and historyHandling is "reload", then set resource's reload-navigation flag.
  728. if (history_handling == HistoryHandlingBehavior::Reload)
  729. resource->set_reload_navigation(true);
  730. // 3. If the source browsing context is not allowed to navigate browsingContext, then:
  731. if (!source_browsing_context.is_allowed_to_navigate(*this)) {
  732. // 1. If exceptionsEnabled is given and is true, then throw a "SecurityError" DOMException.
  733. if (exceptions_enabled) {
  734. VERIFY(source_browsing_context.active_document());
  735. return WebIDL::SecurityError::create(source_browsing_context.active_document()->realm(), "Source browsing context not allowed to navigate"sv);
  736. }
  737. // FIXME: 2. Otherwise, the user agent may instead offer to open resource in a new top-level browsing context
  738. // or in the top-level browsing context of the source browsing context, at the user's option,
  739. // in which case the user agent must navigate that designated top-level browsing context
  740. // to resource as if the user had requested it independently.
  741. }
  742. // 4. If navigationId is null:
  743. if (!navigation_id.has_value()) {
  744. // 1. If historyHandling is "reload", and browsingContext's active document's navigation id is not null,
  745. if (history_handling == HistoryHandlingBehavior::Reload && active_document()->navigation_id().has_value()) {
  746. // let navigationId be browsingContext's active document's navigation id.
  747. navigation_id = active_document()->navigation_id();
  748. } else {
  749. // Otherwise let navigation id be the result of generating a random UUID. [UUID]
  750. // FIXME: Generate a UUID.
  751. navigation_id = "FIXME";
  752. }
  753. }
  754. // FIXME: 5. If browsingContext's active document's unload counter is greater than 0,
  755. // then invoke WebDriver BiDi navigation failed
  756. // with a WebDriver BiDi navigation status whose id is navigationId, status is "canceled", and url is resource's url
  757. // and return.
  758. // 6. If historyHandling is "default", and any of the following are true:
  759. // - browsingContext is still on its initial about:blank Document
  760. // - resource is a request whose URL equals browsingContext's active document's URL
  761. // - resource is a request whose URL's scheme is "javascript"
  762. if (history_handling == HistoryHandlingBehavior::Default
  763. && (still_on_its_initial_about_blank_document()
  764. || resource->url().equals(active_document()->url())
  765. || resource->url().scheme() == "javascript"sv)) {
  766. // then set historyHandling to "replace".
  767. history_handling = HistoryHandlingBehavior::Replace;
  768. }
  769. // 7. If historyHandling is not "reload", resource is a request,
  770. // resource's URL equals browsingContext's active document's URL with exclude fragments set to true,
  771. // and resource's URL's fragment is non-null, then:
  772. if (history_handling != HistoryHandlingBehavior::Reload
  773. && resource->url().equals(active_document()->url(), AK::URL::ExcludeFragment::Yes)
  774. && !resource->url().fragment().is_null()) {
  775. // 1. Navigate to a fragment given browsingContext, resource's URL, historyHandling, and navigationId.
  776. TRY(navigate_to_a_fragment(resource->url(), history_handling, *navigation_id));
  777. // 2. Return.
  778. return {};
  779. }
  780. // FIXME: 8. Let incumbentNavigationOrigin be the origin of the incumbent settings object,
  781. // or if no script was involved, the origin of the node document of the element that initiated the navigation.
  782. // FIXME: 9. Let initiatorPolicyContainer be a clone of the source browsing context's active document's policy container.
  783. // FIXME: 10. If resource is a request, then set resource's policy container to initiatorPolicyContainer.
  784. // FIXME: 11. Cancel any preexisting but not yet mature attempt to navigate browsingContext,
  785. // including canceling any instances of the fetch algorithm started by those attempts.
  786. // If one of those attempts has already created and initialized a new Document object,
  787. // abort that Document also.
  788. // (Navigation attempts that have matured already have session history entries,
  789. // and are therefore handled during the update the session history with the new page algorithm, later.)
  790. // FIXME: 12. Let unloadPromptResult be the result of calling prompt to unload with the active document of browsingContext.
  791. // If this instance of the navigation algorithm gets canceled while this step is running,
  792. // the prompt to unload algorithm must nonetheless be run to completion.
  793. // FIXME: 13. If unloadPromptResult is "refuse", then return a new WebDriver BiDi navigation status whose id is navigationId and status is "canceled".
  794. // 14. Abort the active document of browsingContext.
  795. active_document()->abort();
  796. // FIXME: 15. If browsingContext is a child browsing context, then put it in the delaying load events mode.
  797. // The user agent must take this child browsing context out of the delaying load events mode when this navigation algorithm later matures,
  798. // or when it terminates (whether due to having run all the steps, or being canceled, or being aborted),
  799. // whichever happens first.
  800. // FIXME: 16. Let sandboxFlags be the result of determining the creation sandboxing flags given browsingContext and browsingContext's container.
  801. // FIXME: 17. Let allowedToDownload be the result of running the allowed to download algorithm given the source browsing context and browsingContext.
  802. // 18. Let hasTransientActivation be true if the source browsing context's active window has transient activation; otherwise false.
  803. [[maybe_unused]] bool has_transient_activation = source_browsing_context.active_window()->has_transient_activation();
  804. // FIXME: 19. Invoke WebDriver BiDi navigation started with browsingContext, and a new WebDriver BiDi navigation status whose id is navigationId, url is resource's url, and status is "pending".
  805. // 20. Return, and continue running these steps in parallel.
  806. // FIXME: Implement the rest of this algorithm
  807. (void)history_policy_container;
  808. (void)navigation_type;
  809. (void)process_response_end_of_body;
  810. // AD-HOC:
  811. loader().load(resource->url(), FrameLoader::Type::IFrame);
  812. return {};
  813. }
  814. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate-fragid
  815. WebIDL::ExceptionOr<void> BrowsingContext::navigate_to_a_fragment(AK::URL const& url, HistoryHandlingBehavior history_handling, DeprecatedString navigation_id)
  816. {
  817. // 1. If historyHandling is not "replace",
  818. if (history_handling != HistoryHandlingBehavior::Replace) {
  819. // FIXME: then remove all the entries in browsingContext's session history after the current entry.
  820. // (If the current entry is the last entry in the session history, then no entries are removed.)
  821. }
  822. // 2. Remove any tasks queued by the history traversal task source that are associated with any Document objects
  823. // in browsingContext's top-level browsing context's document family.
  824. HTML::main_thread_event_loop().task_queue().remove_tasks_matching([&](HTML::Task const& task) {
  825. return task.source() == Task::Source::HistoryTraversal
  826. && task.document()
  827. && top_level_browsing_context().document_family_contains(*task.document());
  828. });
  829. // 3. Append a new session history entry to the session history whose URL is url,
  830. // document is the current entry's document,
  831. // policy container is the current entry's policy-container
  832. // and scroll restoration mode is the current entry's scroll restoration mode.
  833. m_session_history.append(SessionHistoryEntry {
  834. .url = url,
  835. .document = current_entry().document,
  836. .serialized_state = {},
  837. .policy_container = current_entry().policy_container,
  838. .scroll_restoration_mode = current_entry().scroll_restoration_mode,
  839. .browsing_context_name = {},
  840. .original_source_browsing_context = {},
  841. });
  842. // 4. Traverse the history to the new entry, with historyHandling set to historyHandling.
  843. // This will scroll to the fragment given in what is now the document's URL.
  844. TRY(traverse_the_history(m_session_history.size() - 1, history_handling));
  845. // FIXME: 5. Invoke WebDriver BiDi fragment navigated with browsingContext,
  846. // and a new WebDriver BiDi navigation status whose id is navigationId, url is resource's url, and status is "complete".
  847. (void)navigation_id;
  848. return {};
  849. }
  850. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#traverse-the-history
  851. WebIDL::ExceptionOr<void> BrowsingContext::traverse_the_history(size_t entry_index, HistoryHandlingBehavior history_handling, bool explicit_history_navigation)
  852. {
  853. auto* entry = &m_session_history[entry_index];
  854. // 1. If entry's document is null, then:
  855. if (!entry->document) {
  856. // 1. Assert: historyHandling is "default".
  857. VERIFY(history_handling == HistoryHandlingBehavior::Default);
  858. // 2. Let request be a new request whose URL is entry's URL.
  859. auto& vm = Bindings::main_thread_vm();
  860. auto request = Fetch::Infrastructure::Request::create(vm);
  861. request->set_url(entry->url);
  862. // 3. If explicitHistoryNavigation is true, then set request's history-navigation flag.
  863. if (explicit_history_navigation)
  864. request->set_history_navigation(true);
  865. // 4. Navigate the browsing context to request with historyHandling set to "entry update"
  866. // and with historyPolicyContainer set to entry's policy container.
  867. // The navigation must be done using the same source browsing context as was used the first time entry was created.
  868. VERIFY(entry->original_source_browsing_context);
  869. TRY(navigate(request, *entry->original_source_browsing_context, false, HistoryHandlingBehavior::EntryUpdate, entry->policy_container));
  870. // 5. Return.
  871. return {};
  872. }
  873. // FIXME: 2. Save persisted state to the current entry.
  874. // 3. Let newDocument be entry's document.
  875. JS::GCPtr<DOM::Document> new_document = entry->document.ptr();
  876. // 4. Assert: newDocument's is initial about:blank is false,
  877. // i.e., we never traverse back to the initial about:blank Document because it always gets replaced when we navigate away from it.
  878. VERIFY(!new_document->is_initial_about_blank());
  879. // 5. If newDocument is different than the current entry's document, or historyHandling is "entry update" or "reload", then:
  880. if (new_document.ptr() != current_entry().document.ptr()
  881. || history_handling == HistoryHandlingBehavior::EntryUpdate) {
  882. // FIXME: 1. If newDocument's suspended timer handles is not empty:
  883. // FIXME: 1. Assert: newDocument's suspension time is not zero.
  884. // FIXME: 2. Let suspendDuration be the current high resolution time minus newDocument's suspension time.
  885. // FIXME: 3. Let activeTimers be newDocument's relevant global object's map of active timers.
  886. // FIXME: 4. For each handle in newDocument's suspended timer handles, if activeTimers[handle] exists, then increase activeTimers[handle] by suspendDuration.
  887. }
  888. // 2. Remove any tasks queued by the history traversal task source
  889. // that are associated with any Document objects in the top-level browsing context's document family.
  890. HTML::main_thread_event_loop().task_queue().remove_tasks_matching([&](HTML::Task const& task) {
  891. return task.source() == Task::Source::HistoryTraversal
  892. && task.document()
  893. && top_level_browsing_context().document_family_contains(*task.document());
  894. });
  895. // 3. If newDocument's origin is not same origin with the current entry's document's origin, then:
  896. if (!new_document->origin().is_same_origin(current_entry().document->origin())) {
  897. // FIXME: 1. Let entriesToUpdate be all entries in the session history whose document's origin is same origin as the active document
  898. // and that are contiguous with the current entry.
  899. // FIXME: 2. For each entryToUpdate of entriesToUpdate, set entryToUpdate's browsing context name to the current browsing context name.
  900. // FIXME: 3. If the browsing context is a top-level browsing context, but not an auxiliary browsing context whose disowned is false, then set the browsing context's name to the empty string.
  901. }
  902. // 4. Set the active document of the browsing context to newDocument.
  903. set_active_document(*new_document);
  904. // 5. If entry's browsing context name is not null, then:
  905. if (entry->browsing_context_name.has_value()) {
  906. // 1. Set the browsing context's name to entry's browsing context name.
  907. m_name = *entry->browsing_context_name;
  908. // FIXME: 2. Let entriesToUpdate be all entries in the session history whose document's origin is same origin as the new active document's origin and that are contiguous with entry.
  909. // FIXME: 3. For each entryToUpdate of entriesToUpdate, set entryToUpdate's browsing context name to null.
  910. }
  911. // FIXME: 6. If newDocument has any form controls whose autofill field name is "off", invoke the reset algorithm of each of those elements.
  912. // 7. If newDocument's current document readiness "complete",
  913. if (new_document->ready_state() == "complete"sv) {
  914. // then queue a global task on the DOM manipulation task source given newDocument's relevant global object to run the following steps:
  915. queue_global_task(Task::Source::DOMManipulation, relevant_global_object(*new_document), [new_document] {
  916. // 1. If newDocument's page showing flag is true, then abort these steps.
  917. if (new_document->page_showing())
  918. return;
  919. // 2. Set newDocument's page showing flag to true.
  920. new_document->set_page_showing(true);
  921. // 3. Update the visibility state of newDocument to "hidden".
  922. new_document->update_the_visibility_state(VisibilityState::Hidden);
  923. // 4. Fire a page transition event named pageshow at newDocument's relevant global object with true.
  924. auto& window = verify_cast<HTML::Window>(relevant_global_object(*new_document));
  925. window.fire_a_page_transition_event(HTML::EventNames::pageshow, true);
  926. });
  927. }
  928. // 6. Set newDocument's URL to entry's URL.
  929. new_document->set_url(entry->url);
  930. // 7. Let hashChanged be false, and let oldURL and newURL be null.
  931. bool hash_changed = false;
  932. Optional<AK::URL> old_url;
  933. Optional<AK::URL> new_url;
  934. // 8. If entry's URL's fragment is not identical to the current entry's URL's fragment,
  935. // and entry's document equals the current entry's document,
  936. if (entry->url.fragment() != current_entry().url.fragment()
  937. && entry->document.ptr() == current_entry().document.ptr()) {
  938. // then set hashChanged to true, set oldURL to the current entry's URL, and set newURL to entry's URL.
  939. hash_changed = true;
  940. old_url = current_entry().url;
  941. new_url = entry->url;
  942. }
  943. // 9. If historyHandling is "replace", then remove the entry immediately before entry in the session history.
  944. if (history_handling == HistoryHandlingBehavior::Replace) {
  945. // FIXME: This is gnarly.
  946. m_session_history.remove(entry_index - 1);
  947. entry_index--;
  948. entry = &m_session_history[entry_index];
  949. }
  950. // 10. If entry's persisted user state is null, and its URL's fragment is non-null, then scroll to the fragment.
  951. if (!entry->url.fragment().is_null()) {
  952. // FIXME: Implement the full "scroll to the fragment" algorithm:
  953. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#scroll-to-the-fragment-identifier
  954. scroll_to_anchor(entry->url.fragment());
  955. }
  956. // 11. Set the current entry to entry.
  957. m_session_history_index = entry_index;
  958. // 12. Let targetRealm be the current Realm Record.
  959. auto* target_realm = Bindings::main_thread_vm().current_realm();
  960. VERIFY(target_realm);
  961. // FIXME: 13. Let state be null.
  962. // FIXME: 14. If entry's serialized state is not null, then set state to StructuredDeserialize(entry's serialized state, targetRealm).
  963. // If this throws an exception, catch it and ignore the exception.
  964. // FIXME: 15. Set newDocument's History object's state to state.
  965. // FIXME: 16. Let stateChanged be true if newDocument has a latest entry, and that entry is not entry; otherwise let it be false.
  966. // FIXME: 17. Set newDocument's latest entry to entry.
  967. // FIXME: 18. If stateChanged is true, then fire an event named popstate at newDocument's relevant global object, using PopStateEvent, with the state attribute initialized to state.
  968. // FIXME: 19. Restore persisted state from entry.
  969. // 20. If hashChanged is true,
  970. if (hash_changed) {
  971. // then queue a global task on the DOM manipulation task source given newDocument's relevant global object
  972. queue_global_task(Task::Source::DOMManipulation, relevant_global_object(*new_document), [new_document] {
  973. // to fire an event named hashchange at newDocument's relevant global object,
  974. // using HashChangeEvent, with the oldURL attribute initialized to oldURL
  975. // and the newURL attribute initialized to newURL.
  976. // FIXME: Implement a proper HashChangeEvent class.
  977. auto event = DOM::Event::create(verify_cast<HTML::Window>(relevant_global_object(*new_document)).realm(), HTML::EventNames::hashchange).release_value_but_fixme_should_propagate_errors();
  978. new_document->dispatch_event(event);
  979. });
  980. }
  981. return {};
  982. }
  983. // https://html.spec.whatwg.org/multipage/browsers.html#allowed-to-navigate
  984. bool BrowsingContext::is_allowed_to_navigate(BrowsingContext const& other) const
  985. {
  986. VERIFY(active_window());
  987. VERIFY(active_document());
  988. // 1. If A is not the same browsing context as B,
  989. // and A is not one of the ancestor browsing contexts of B,
  990. // and B is not a top-level browsing context,
  991. // FIXME: and A's active document's active sandboxing flag set has its sandboxed navigation browsing context flag set,
  992. // then return false.
  993. if (this != &other
  994. && !this->is_ancestor_of(other)
  995. && !other.is_top_level()) {
  996. return false;
  997. }
  998. // 2. Otherwise, if B is a top-level browsing context, and is one of the ancestor browsing contexts of A, then:
  999. if (other.is_top_level() && other.is_ancestor_of(*this)) {
  1000. // 1. If A's active window has transient activation
  1001. // and A's active document's active sandboxing flag set has its sandboxed top-level navigation with user activation browsing context flag set,
  1002. // then return false.
  1003. if (active_window()->has_transient_activation()
  1004. && active_document()->active_sandboxing_flag_set().flags & SandboxingFlagSet::SandboxedTopLevelNavigationWithUserActivation) {
  1005. return false;
  1006. }
  1007. // 2. Otherwise, if A's active window does not have transient activation
  1008. // and A's active document's active sandboxing flag set has its sandboxed top-level navigation without user activation browsing context flag set,
  1009. // then return false.
  1010. if (!active_window()->has_transient_activation()
  1011. && active_document()->active_sandboxing_flag_set().flags & SandboxingFlagSet::SandboxedTopLevelNavigationWithoutUserActivation) {
  1012. return false;
  1013. }
  1014. }
  1015. // 3. Otherwise, if B is a top-level browsing context,
  1016. // and is neither A nor one of the ancestor browsing contexts of A,
  1017. // and A's Document's active sandboxing flag set has its sandboxed navigation browsing context flag set,
  1018. // and A is not the one permitted sandboxed navigator of B,
  1019. // then return false.
  1020. if (other.is_top_level()
  1021. && &other != this
  1022. && !other.is_ancestor_of(*this)
  1023. && active_document()->active_sandboxing_flag_set().flags & SandboxingFlagSet::SandboxedNavigation
  1024. && this != other.the_one_permitted_sandboxed_navigator()) {
  1025. return false;
  1026. }
  1027. // 4. Return true.
  1028. return true;
  1029. }
  1030. // https://html.spec.whatwg.org/multipage/origin.html#one-permitted-sandboxed-navigator
  1031. BrowsingContext const* BrowsingContext::the_one_permitted_sandboxed_navigator() const
  1032. {
  1033. // FIXME: Implement this.
  1034. return nullptr;
  1035. }
  1036. // https://html.spec.whatwg.org/multipage/browsers.html#document-family
  1037. Vector<JS::Handle<DOM::Document>> BrowsingContext::document_family() const
  1038. {
  1039. HashTable<DOM::Document*> documents;
  1040. for (auto& entry : m_session_history) {
  1041. if (!entry.document)
  1042. continue;
  1043. if (documents.set(const_cast<DOM::Document*>(entry.document.ptr())) == AK::HashSetResult::ReplacedExistingEntry)
  1044. continue;
  1045. for (auto& context : entry.document->list_of_descendant_browsing_contexts()) {
  1046. for (auto& document : context->document_family()) {
  1047. documents.set(document.ptr());
  1048. }
  1049. }
  1050. }
  1051. Vector<JS::Handle<DOM::Document>> family;
  1052. for (auto* document : documents) {
  1053. family.append(*document);
  1054. }
  1055. return family;
  1056. }
  1057. // https://html.spec.whatwg.org/multipage/browsers.html#document-family
  1058. bool BrowsingContext::document_family_contains(DOM::Document const& document) const
  1059. {
  1060. return document_family().first_matching([&](auto& entry) { return entry.ptr() == &document; }).has_value();
  1061. }
  1062. VisibilityState BrowsingContext::system_visibility_state() const
  1063. {
  1064. return m_system_visibility_state;
  1065. }
  1066. // https://html.spec.whatwg.org/multipage/interaction.html#system-visibility-state
  1067. void BrowsingContext::set_system_visibility_state(VisibilityState visibility_state)
  1068. {
  1069. if (m_system_visibility_state == visibility_state)
  1070. return;
  1071. m_system_visibility_state = visibility_state;
  1072. // When a user-agent determines that the system visibility state for top-level browsing context context
  1073. // has changed to newState, it must queue a task on the user interaction task source to update
  1074. // the visibility state of all the Document objects in the top-level browsing context's document family with newState.
  1075. auto document_family = top_level_browsing_context().document_family();
  1076. // From the new navigable version, where it tells us what global object to use here:
  1077. // 1. Let document be navigable's active document.
  1078. // 2. Queue a global task on the user interaction task source given document's relevant global object to update the visibility state of document with newState.
  1079. // FIXME: Update this function to fully match the navigable version.
  1080. VERIFY(active_document());
  1081. queue_global_task(Task::Source::UserInteraction, relevant_global_object(*active_document()), [visibility_state, document_family = move(document_family)] {
  1082. for (auto& document : document_family) {
  1083. document->update_the_visibility_state(visibility_state);
  1084. }
  1085. });
  1086. }
  1087. // https://html.spec.whatwg.org/multipage/window-object.html#a-browsing-context-is-discarded
  1088. void BrowsingContext::discard()
  1089. {
  1090. m_has_been_discarded = true;
  1091. // 1. Discard all Document objects for all the entries in browsingContext's session history.
  1092. for (auto& entry : m_session_history) {
  1093. if (entry.document)
  1094. entry.document->discard();
  1095. }
  1096. // AD-HOC:
  1097. // FIXME: This should be in the session history!
  1098. if (auto* document = active_document())
  1099. document->discard();
  1100. // 2. If browsingContext is a top-level browsing context, then remove browsingContext.
  1101. if (is_top_level())
  1102. remove();
  1103. // AD-HOC:
  1104. if (parent())
  1105. parent()->remove_child(*this);
  1106. }
  1107. // https://html.spec.whatwg.org/multipage/window-object.html#close-a-browsing-context
  1108. void BrowsingContext::close()
  1109. {
  1110. VERIFY(active_document());
  1111. // FIXME: 1. If the result of calling prompt to unload with browsingContext's active document is "refuse", then return.
  1112. // 2. Unload browsingContext's active document.
  1113. active_document()->unload();
  1114. // 3. Remove browsingContext from the user interface (e.g., close or hide its tab in a tabbed browser).
  1115. if (m_page)
  1116. m_page->client().page_did_close_browsing_context(*this);
  1117. // 4. Discard browsingContext.
  1118. discard();
  1119. }
  1120. void BrowsingContext::append_child(JS::NonnullGCPtr<BrowsingContext> child)
  1121. {
  1122. VERIFY(!child->m_parent);
  1123. if (m_last_child)
  1124. m_last_child->m_next_sibling = child;
  1125. child->m_previous_sibling = m_last_child;
  1126. child->m_parent = this;
  1127. m_last_child = child;
  1128. if (!m_first_child)
  1129. m_first_child = m_last_child;
  1130. }
  1131. void BrowsingContext::remove_child(JS::NonnullGCPtr<BrowsingContext> child)
  1132. {
  1133. VERIFY(child->m_parent.ptr() == this);
  1134. if (m_first_child == child)
  1135. m_first_child = child->m_next_sibling;
  1136. if (m_last_child == child)
  1137. m_last_child = child->m_previous_sibling;
  1138. if (child->m_next_sibling)
  1139. child->m_next_sibling->m_previous_sibling = child->m_previous_sibling;
  1140. if (child->m_previous_sibling)
  1141. child->m_previous_sibling->m_next_sibling = child->m_next_sibling;
  1142. child->m_next_sibling = nullptr;
  1143. child->m_previous_sibling = nullptr;
  1144. child->m_parent = nullptr;
  1145. }
  1146. JS::GCPtr<BrowsingContext> BrowsingContext::first_child() const
  1147. {
  1148. return m_first_child;
  1149. }
  1150. JS::GCPtr<BrowsingContext> BrowsingContext::next_sibling() const
  1151. {
  1152. return m_next_sibling;
  1153. }
  1154. bool BrowsingContext::is_ancestor_of(BrowsingContext const& other) const
  1155. {
  1156. for (auto ancestor = other.parent(); ancestor; ancestor = ancestor->parent()) {
  1157. if (ancestor == this)
  1158. return true;
  1159. }
  1160. return false;
  1161. }
  1162. }