BrowsingContext.cpp 73 KB

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