BrowsingContext.cpp 62 KB

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