TraversableNavigable.cpp 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131
  1. /*
  2. * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/QuickSort.h>
  7. #include <LibWeb/Bindings/MainThreadVM.h>
  8. #include <LibWeb/DOM/Document.h>
  9. #include <LibWeb/HTML/BrowsingContextGroup.h>
  10. #include <LibWeb/HTML/DocumentState.h>
  11. #include <LibWeb/HTML/Navigation.h>
  12. #include <LibWeb/HTML/NavigationParams.h>
  13. #include <LibWeb/HTML/Parser/HTMLParser.h>
  14. #include <LibWeb/HTML/SessionHistoryEntry.h>
  15. #include <LibWeb/HTML/TraversableNavigable.h>
  16. #include <LibWeb/HTML/Window.h>
  17. #include <LibWeb/Page/Page.h>
  18. #include <LibWeb/Platform/EventLoopPlugin.h>
  19. namespace Web::HTML {
  20. JS_DEFINE_ALLOCATOR(TraversableNavigable);
  21. TraversableNavigable::TraversableNavigable(JS::NonnullGCPtr<Page> page)
  22. : m_session_history_traversal_queue(vm().heap().allocate_without_realm<SessionHistoryTraversalQueue>())
  23. , m_page(page)
  24. {
  25. }
  26. TraversableNavigable::~TraversableNavigable() = default;
  27. void TraversableNavigable::visit_edges(Cell::Visitor& visitor)
  28. {
  29. Base::visit_edges(visitor);
  30. visitor.visit(m_page);
  31. visitor.visit(m_session_history_entries);
  32. visitor.visit(m_session_history_traversal_queue);
  33. }
  34. static OrderedHashTable<TraversableNavigable*>& user_agent_top_level_traversable_set()
  35. {
  36. static OrderedHashTable<TraversableNavigable*> set;
  37. return set;
  38. }
  39. // https://html.spec.whatwg.org/multipage/document-sequences.html#creating-a-new-top-level-browsing-context
  40. WebIDL::ExceptionOr<BrowsingContextAndDocument> create_a_new_top_level_browsing_context_and_document(JS::NonnullGCPtr<Page> page)
  41. {
  42. // 1. Let group and document be the result of creating a new browsing context group and document.
  43. auto [group, document] = TRY(BrowsingContextGroup::create_a_new_browsing_context_group_and_document(page));
  44. // 2. Return group's browsing context set[0] and document.
  45. return BrowsingContextAndDocument { **group->browsing_context_set().begin(), document };
  46. }
  47. // https://html.spec.whatwg.org/multipage/document-sequences.html#creating-a-new-top-level-traversable
  48. WebIDL::ExceptionOr<JS::NonnullGCPtr<TraversableNavigable>> TraversableNavigable::create_a_new_top_level_traversable(JS::NonnullGCPtr<Page> page, JS::GCPtr<HTML::BrowsingContext> opener, String target_name)
  49. {
  50. auto& vm = Bindings::main_thread_vm();
  51. // 1. Let document be null.
  52. JS::GCPtr<DOM::Document> document = nullptr;
  53. // 2. If opener is null, then set document to the second return value of creating a new top-level browsing context and document.
  54. if (!opener) {
  55. document = TRY(create_a_new_top_level_browsing_context_and_document(page)).document;
  56. }
  57. // 3. Otherwise, set document to the second return value of creating a new auxiliary browsing context and document given opener.
  58. else {
  59. document = TRY(BrowsingContext::create_a_new_auxiliary_browsing_context_and_document(page, *opener)).document;
  60. }
  61. // 4. Let documentState be a new document state, with
  62. auto document_state = vm.heap().allocate_without_realm<DocumentState>();
  63. // document: document
  64. document_state->set_document(document);
  65. // initiator origin: null if opener is null; otherwise, document's origin
  66. document_state->set_initiator_origin(opener ? Optional<Origin> {} : document->origin());
  67. // origin: document's origin
  68. document_state->set_origin(document->origin());
  69. // navigable target name: targetName
  70. document_state->set_navigable_target_name(target_name);
  71. // about base URL: document's about base URL
  72. document_state->set_about_base_url(document->about_base_url());
  73. // 5. Let traversable be a new traversable navigable.
  74. auto traversable = vm.heap().allocate_without_realm<TraversableNavigable>(page);
  75. // 6. Initialize the navigable traversable given documentState.
  76. TRY_OR_THROW_OOM(vm, traversable->initialize_navigable(document_state, nullptr));
  77. // 7. Let initialHistoryEntry be traversable's active session history entry.
  78. auto initial_history_entry = traversable->active_session_history_entry();
  79. VERIFY(initial_history_entry);
  80. // 8. Set initialHistoryEntry's step to 0.
  81. initial_history_entry->set_step(0);
  82. // 9. Append initialHistoryEntry to traversable's session history entries.
  83. traversable->m_session_history_entries.append(*initial_history_entry);
  84. // FIXME: 10. If opener is non-null, then legacy-clone a traversable storage shed given opener's top-level traversable and traversable. [STORAGE]
  85. // 11. Append traversable to the user agent's top-level traversable set.
  86. user_agent_top_level_traversable_set().set(traversable);
  87. // 12. Return traversable.
  88. return traversable;
  89. }
  90. // https://html.spec.whatwg.org/multipage/document-sequences.html#create-a-fresh-top-level-traversable
  91. WebIDL::ExceptionOr<JS::NonnullGCPtr<TraversableNavigable>> TraversableNavigable::create_a_fresh_top_level_traversable(JS::NonnullGCPtr<Page> page, URL::URL const& initial_navigation_url, Variant<Empty, String, POSTResource> initial_navigation_post_resource)
  92. {
  93. // 1. Let traversable be the result of creating a new top-level traversable given null and the empty string.
  94. auto traversable = TRY(create_a_new_top_level_traversable(page, nullptr, {}));
  95. page->set_top_level_traversable(traversable);
  96. // AD-HOC: Mark the about:blank document as finished parsing if we're only going to about:blank
  97. // Skip the initial navigation as well. This matches the behavior of the window open steps.
  98. if (url_matches_about_blank(initial_navigation_url)) {
  99. Platform::EventLoopPlugin::the().deferred_invoke([traversable, initial_navigation_url] {
  100. // FIXME: We do this other places too when creating a new about:blank document. Perhaps it's worth a spec issue?
  101. HTML::HTMLParser::the_end(*traversable->active_document());
  102. // FIXME: If we perform the URL and history update steps here, we start hanging tests and the UI process will
  103. // try to load() the initial URLs passed on the command line before we finish processing the events here.
  104. // However, because we call this before the PageClient is fully initialized... that gets awkward.
  105. });
  106. }
  107. else {
  108. // 2. Navigate traversable to initialNavigationURL using traversable's active document, with documentResource set to initialNavigationPostResource.
  109. TRY(traversable->navigate({ .url = initial_navigation_url,
  110. .source_document = *traversable->active_document(),
  111. .document_resource = initial_navigation_post_resource }));
  112. }
  113. // 3. Return traversable.
  114. return traversable;
  115. }
  116. // https://html.spec.whatwg.org/multipage/document-sequences.html#top-level-traversable
  117. bool TraversableNavigable::is_top_level_traversable() const
  118. {
  119. // A top-level traversable is a traversable navigable with a null parent.
  120. return parent() == nullptr;
  121. }
  122. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-all-used-history-steps
  123. Vector<int> TraversableNavigable::get_all_used_history_steps() const
  124. {
  125. // FIXME: 1. Assert: this is running within traversable's session history traversal queue.
  126. // 2. Let steps be an empty ordered set of non-negative integers.
  127. OrderedHashTable<int> steps;
  128. // 3. Let entryLists be the ordered set « traversable's session history entries ».
  129. Vector<Vector<JS::NonnullGCPtr<SessionHistoryEntry>>> entry_lists { session_history_entries() };
  130. // 4. For each entryList of entryLists:
  131. while (!entry_lists.is_empty()) {
  132. auto entry_list = entry_lists.take_first();
  133. // 1. For each entry of entryList:
  134. for (auto& entry : entry_list) {
  135. // 1. Append entry's step to steps.
  136. steps.set(entry->step().get<int>());
  137. // 2. For each nestedHistory of entry's document state's nested histories, append nestedHistory's entries list to entryLists.
  138. for (auto& nested_history : entry->document_state()->nested_histories())
  139. entry_lists.append(nested_history.entries);
  140. }
  141. }
  142. // 5. Return steps, sorted.
  143. auto sorted_steps = steps.values();
  144. quick_sort(sorted_steps);
  145. return sorted_steps;
  146. }
  147. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-the-history-object-length-and-index
  148. TraversableNavigable::HistoryObjectLengthAndIndex TraversableNavigable::get_the_history_object_length_and_index(int step) const
  149. {
  150. // 1. Let steps be the result of getting all used history steps within traversable.
  151. auto steps = get_all_used_history_steps();
  152. // 2. Let scriptHistoryLength be the size of steps.
  153. auto script_history_length = steps.size();
  154. // 3. Assert: steps contains step.
  155. VERIFY(steps.contains_slow(step));
  156. // 4. Let scriptHistoryIndex be the index of step in steps.
  157. auto script_history_index = *steps.find_first_index(step);
  158. // 5. Return (scriptHistoryLength, scriptHistoryIndex).
  159. return HistoryObjectLengthAndIndex {
  160. .script_history_length = script_history_length,
  161. .script_history_index = script_history_index
  162. };
  163. }
  164. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-the-used-step
  165. int TraversableNavigable::get_the_used_step(int step) const
  166. {
  167. // 1. Let steps be the result of getting all used history steps within traversable.
  168. auto steps = get_all_used_history_steps();
  169. // 2. Return the greatest item in steps that is less than or equal to step.
  170. VERIFY(!steps.is_empty());
  171. Optional<int> result;
  172. for (size_t i = 0; i < steps.size(); i++) {
  173. if (steps[i] <= step) {
  174. if (!result.has_value() || (result.value() < steps[i])) {
  175. result = steps[i];
  176. }
  177. }
  178. }
  179. return result.value();
  180. }
  181. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#get-all-navigables-whose-current-session-history-entry-will-change-or-reload
  182. Vector<JS::Handle<Navigable>> TraversableNavigable::get_all_navigables_whose_current_session_history_entry_will_change_or_reload(int target_step) const
  183. {
  184. // 1. Let results be an empty list.
  185. Vector<JS::Handle<Navigable>> results;
  186. // 2. Let navigablesToCheck be « traversable ».
  187. Vector<JS::Handle<Navigable>> navigables_to_check;
  188. navigables_to_check.append(const_cast<TraversableNavigable&>(*this));
  189. // 3. For each navigable of navigablesToCheck:
  190. while (!navigables_to_check.is_empty()) {
  191. auto navigable = navigables_to_check.take_first();
  192. // 1. Let targetEntry be the result of getting the target history entry given navigable and targetStep.
  193. auto target_entry = navigable->get_the_target_history_entry(target_step);
  194. // 2. If targetEntry is not navigable's current session history entry or targetEntry's document state's reload pending is true, then append navigable to results.
  195. if (target_entry != navigable->current_session_history_entry() || target_entry->document_state()->reload_pending()) {
  196. results.append(*navigable);
  197. }
  198. // 3. If targetEntry's document is navigable's document, and targetEntry's document state's reload pending is false, then extend navigablesToCheck with the child navigables of navigable.
  199. if (target_entry->document() == navigable->active_document() && !target_entry->document_state()->reload_pending()) {
  200. navigables_to_check.extend(navigable->child_navigables());
  201. }
  202. }
  203. // 4. Return results.
  204. return results;
  205. }
  206. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-all-navigables-that-only-need-history-object-length/index-update
  207. Vector<JS::Handle<Navigable>> TraversableNavigable::get_all_navigables_that_only_need_history_object_length_index_update(int target_step) const
  208. {
  209. // NOTE: Other navigables might not be impacted by the traversal. For example, if the response is a 204, the currently active document will remain.
  210. // Additionally, going 'back' after a 204 will change the current session history entry, but the active session history entry will already be correct.
  211. // 1. Let results be an empty list.
  212. Vector<JS::Handle<Navigable>> results;
  213. // 2. Let navigablesToCheck be « traversable ».
  214. Vector<JS::Handle<Navigable>> navigables_to_check;
  215. navigables_to_check.append(const_cast<TraversableNavigable&>(*this));
  216. // 3. For each navigable of navigablesToCheck:
  217. while (!navigables_to_check.is_empty()) {
  218. auto navigable = navigables_to_check.take_first();
  219. // 1. Let targetEntry be the result of getting the target history entry given navigable and targetStep.
  220. auto target_entry = navigable->get_the_target_history_entry(target_step);
  221. // 2. If targetEntry is navigable's current session history entry and targetEntry's document state's reload pending is false, then:
  222. if (target_entry == navigable->current_session_history_entry() && !target_entry->document_state()->reload_pending()) {
  223. // 1. Append navigable to results.
  224. results.append(navigable);
  225. // 2. Extend navigablesToCheck with navigable's child navigables.
  226. navigables_to_check.extend(navigable->child_navigables());
  227. }
  228. }
  229. // 4. Return results.
  230. return results;
  231. }
  232. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-all-navigables-that-might-experience-a-cross-document-traversal
  233. Vector<JS::Handle<Navigable>> TraversableNavigable::get_all_navigables_that_might_experience_a_cross_document_traversal(int target_step) const
  234. {
  235. // NOTE: From traversable's session history traversal queue's perspective, these documents are candidates for going cross-document during the
  236. // traversal described by targetStep. They will not experience a cross-document traversal if the status code for their target document is
  237. // HTTP 204 No Content.
  238. // Note that if a given navigable might experience a cross-document traversal, this algorithm will return navigable but not its child navigables.
  239. // Those would end up unloaded, not traversed.
  240. // 1. Let results be an empty list.
  241. Vector<JS::Handle<Navigable>> results;
  242. // 2. Let navigablesToCheck be « traversable ».
  243. Vector<JS::Handle<Navigable>> navigables_to_check;
  244. navigables_to_check.append(const_cast<TraversableNavigable&>(*this));
  245. // 3. For each navigable of navigablesToCheck:
  246. while (!navigables_to_check.is_empty()) {
  247. auto navigable = navigables_to_check.take_first();
  248. // 1. Let targetEntry be the result of getting the target history entry given navigable and targetStep.
  249. auto target_entry = navigable->get_the_target_history_entry(target_step);
  250. // 2. If targetEntry's document is not navigable's document or targetEntry's document state's reload pending is true, then append navigable to results.
  251. // NOTE: Although navigable's active history entry can change synchronously, the new entry will always have the same Document,
  252. // so accessing navigable's document is reliable.
  253. if (target_entry->document() != navigable->active_document() || target_entry->document_state()->reload_pending()) {
  254. results.append(navigable);
  255. }
  256. // 3. Otherwise, extend navigablesToCheck with navigable's child navigables.
  257. // Adding child navigables to navigablesToCheck means those navigables will also be checked by this loop.
  258. // Child navigables are only checked if the navigable's active document will not change as part of this traversal.
  259. else {
  260. navigables_to_check.extend(navigable->child_navigables());
  261. }
  262. }
  263. // 4. Return results.
  264. return results;
  265. }
  266. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#deactivate-a-document-for-a-cross-document-navigation
  267. static void deactivate_a_document_for_cross_document_navigation(JS::NonnullGCPtr<DOM::Document> displayed_document, Optional<UserNavigationInvolvement>, JS::NonnullGCPtr<SessionHistoryEntry> target_entry, JS::NonnullGCPtr<JS::HeapFunction<void()>> after_potential_unloads)
  268. {
  269. // 1. Let navigable be displayedDocument's node navigable.
  270. auto navigable = displayed_document->navigable();
  271. // 2. Let potentiallyTriggerViewTransition be false.
  272. auto potentially_trigger_view_transition = false;
  273. // FIXME: 3. Let isBrowserUINavigation be true if userNavigationInvolvement is "browser UI"; otherwise false.
  274. // FIXME: 4. Set potentiallyTriggerViewTransition to the result of calling can navigation trigger a cross-document
  275. // view-transition? given displayedDocument, targetEntry's document, navigationType, and isBrowserUINavigation.
  276. // 5. If potentiallyTriggerViewTransition is false, then:
  277. if (!potentially_trigger_view_transition) {
  278. // FIXME 1. Let firePageSwapBeforeUnload be the following step
  279. // 1. Fire the pageswap event given displayedDocument, targetEntry, navigationType, and null.
  280. // 2. Set the ongoing navigation for navigable to null.
  281. navigable->set_ongoing_navigation({});
  282. // 3. Unload a document and its descendants given displayedDocument, targetEntry's document, afterPotentialUnloads, and firePageSwapBeforeUnload.
  283. displayed_document->unload_a_document_and_its_descendants(target_entry->document(), after_potential_unloads);
  284. }
  285. // FIXME: 6. Otherwise, queue a global task on the navigation and traversal task source given navigable's active window to run the steps:
  286. else {
  287. // FIXME: 1. Let proceedWithNavigationAfterViewTransitionCapture be the following step:
  288. // 1. Append the following session history traversal steps to navigable's traversable navigable:
  289. // 1. Set the ongoing navigation for navigable to null.
  290. // 2. Unload a document and its descendants given displayedDocument, targetEntry's document, and afterPotentialUnloads.
  291. // FIXME: 2. Let viewTransition be the result of setting up a cross-document view-transition given displayedDocument,
  292. // targetEntry's document, navigationType, and proceedWithNavigationAfterViewTransitionCapture.
  293. // FIXME: 3. Fire the pageswap event given displayedDocument, targetEntry, navigationType, and viewTransition.
  294. // FIXME: 4. If viewTransition is null, then run proceedWithNavigationAfterViewTransitionCapture.
  295. TODO();
  296. }
  297. }
  298. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#apply-the-history-step
  299. TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_history_step(
  300. int step,
  301. bool check_for_cancelation,
  302. IGNORE_USE_IN_ESCAPING_LAMBDA Optional<SourceSnapshotParams> source_snapshot_params,
  303. JS::GCPtr<Navigable> initiator_to_check,
  304. Optional<UserNavigationInvolvement> user_involvement_for_navigate_events,
  305. IGNORE_USE_IN_ESCAPING_LAMBDA Optional<Bindings::NavigationType> navigation_type,
  306. IGNORE_USE_IN_ESCAPING_LAMBDA SynchronousNavigation synchronous_navigation)
  307. {
  308. auto& vm = this->vm();
  309. // FIXME: 1. Assert: This is running within traversable's session history traversal queue.
  310. // 2. Let targetStep be the result of getting the used step given traversable and step.
  311. auto target_step = get_the_used_step(step);
  312. // Note: Calling this early so we can re-use the same list in 3.2 and 6.
  313. auto change_or_reload_navigables = get_all_navigables_whose_current_session_history_entry_will_change_or_reload(target_step);
  314. // 3. If initiatorToCheck is not null, then:
  315. if (initiator_to_check != nullptr) {
  316. // 1. Assert: sourceSnapshotParams is not null.
  317. VERIFY(source_snapshot_params.has_value());
  318. // 2. For each navigable of get all navigables whose current session history entry will change or reload:
  319. // if initiatorToCheck is not allowed by sandboxing to navigate navigable given sourceSnapshotParams, then return "initiator-disallowed".
  320. for (auto const& navigable : change_or_reload_navigables) {
  321. if (!initiator_to_check->allowed_by_sandboxing_to_navigate(*navigable, *source_snapshot_params))
  322. return HistoryStepResult::InitiatorDisallowed;
  323. }
  324. }
  325. // 4. Let navigablesCrossingDocuments be the result of getting all navigables that might experience a cross-document traversal given traversable and targetStep.
  326. [[maybe_unused]] auto navigables_crossing_documents = get_all_navigables_that_might_experience_a_cross_document_traversal(target_step);
  327. // 5. FIXME: If checkForCancelation is true, and the result of checking if unloading is canceled given navigablesCrossingDocuments, traversable, targetStep,
  328. // and userInvolvementForNavigateEvents is not "continue", then return that result.
  329. (void)check_for_cancelation;
  330. // 6. Let changingNavigables be the result of get all navigables whose current session history entry will change or reload given traversable and targetStep.
  331. auto changing_navigables = move(change_or_reload_navigables);
  332. // 7. Let nonchangingNavigablesThatStillNeedUpdates be the result of getting all navigables that only need history object length/index update given traversable and targetStep.
  333. auto non_changing_navigables_that_still_need_updates = get_all_navigables_that_only_need_history_object_length_index_update(target_step);
  334. // 8. For each navigable of changingNavigables:
  335. for (auto& navigable : changing_navigables) {
  336. // 1. Let targetEntry be the result of getting the target history entry given navigable and targetStep.
  337. auto target_entry = navigable->get_the_target_history_entry(target_step);
  338. // 2. Set navigable's current session history entry to targetEntry.
  339. navigable->set_current_session_history_entry(target_entry);
  340. // 3. Set navigable's ongoing navigation to "traversal".
  341. navigable->set_ongoing_navigation(Traversal::Tag);
  342. }
  343. // 9. Let totalChangeJobs be the size of changingNavigables.
  344. auto total_change_jobs = changing_navigables.size();
  345. // 10. Let completedChangeJobs be 0.
  346. IGNORE_USE_IN_ESCAPING_LAMBDA size_t completed_change_jobs = 0;
  347. struct ChangingNavigableContinuationState {
  348. JS::Handle<DOM::Document> displayed_document;
  349. JS::Handle<SessionHistoryEntry> target_entry;
  350. JS::Handle<Navigable> navigable;
  351. bool update_only = false;
  352. JS::Handle<SessionHistoryEntry> populated_target_entry;
  353. bool populated_cloned_target_session_history_entry = false;
  354. };
  355. // 11. Let changingNavigableContinuations be an empty queue of changing navigable continuation states.
  356. // NOTE: This queue is used to split the operations on changingNavigables into two parts. Specifically, changingNavigableContinuations holds data for the second part.
  357. IGNORE_USE_IN_ESCAPING_LAMBDA Queue<ChangingNavigableContinuationState> changing_navigable_continuations;
  358. // 12. For each navigable of changingNavigables, queue a global task on the navigation and traversal task source of navigable's active window to run the steps:
  359. for (auto& navigable : changing_navigables) {
  360. queue_global_task(Task::Source::NavigationAndTraversal, *navigable->active_window(), JS::create_heap_function(heap(), [&] {
  361. // NOTE: This check is not in the spec but we should not continue navigation if navigable has been destroyed.
  362. if (navigable->has_been_destroyed()) {
  363. completed_change_jobs++;
  364. return;
  365. }
  366. // 1. Let displayedEntry be navigable's active session history entry.
  367. auto displayed_entry = navigable->active_session_history_entry();
  368. // 2. Let targetEntry be navigable's current session history entry.
  369. auto target_entry = navigable->current_session_history_entry();
  370. // 3. Let changingNavigableContinuation be a changing navigable continuation state with:
  371. auto changing_navigable_continuation = ChangingNavigableContinuationState {
  372. .displayed_document = displayed_entry->document(),
  373. .target_entry = target_entry,
  374. .navigable = navigable,
  375. .update_only = false,
  376. .populated_target_entry = {},
  377. .populated_cloned_target_session_history_entry = false,
  378. };
  379. // 4. If displayedEntry is targetEntry and targetEntry's document state's reload pending is false, then:
  380. if (synchronous_navigation == SynchronousNavigation::Yes && !target_entry->document_state()->reload_pending()) {
  381. // 1. Set changingNavigableContinuation's update-only to true.
  382. changing_navigable_continuation.update_only = true;
  383. // 2. Enqueue changingNavigableContinuation on changingNavigableContinuations.
  384. changing_navigable_continuations.enqueue(move(changing_navigable_continuation));
  385. // 3. Abort these steps.
  386. return;
  387. }
  388. // 5. Switch on navigationType:
  389. if (navigation_type.has_value()) {
  390. switch (navigation_type.value()) {
  391. case Bindings::NavigationType::Reload:
  392. // - "reload": Assert: targetEntry's document state's reload pending is true.
  393. VERIFY(target_entry->document_state()->reload_pending());
  394. break;
  395. case Bindings::NavigationType::Traverse:
  396. // - "traverse": Assert: targetEntry's document state's ever populated is true.
  397. VERIFY(target_entry->document_state()->ever_populated());
  398. break;
  399. case Bindings::NavigationType::Replace:
  400. // FIXME: Add ever populated check
  401. // - "replace": Assert: targetEntry's step is displayedEntry's step and targetEntry's document state's ever populated is false.
  402. VERIFY(target_entry->step() == displayed_entry->step());
  403. break;
  404. case Bindings::NavigationType::Push:
  405. // FIXME: Add ever populated check, and fix the bug where top level traversable's step is not updated when a child navigable navigates
  406. // - "push": Assert: targetEntry's step is displayedEntry's step + 1 and targetEntry's document state's ever populated is false.
  407. VERIFY(target_entry->step().get<int>() > displayed_entry->step().get<int>());
  408. break;
  409. }
  410. }
  411. // 6. Let oldOrigin be targetEntry's document state's origin.
  412. auto old_origin = target_entry->document_state()->origin();
  413. // FIXME: 7. If navigable is not traversable, and targetEntry is not navigable's current session history entry,
  414. // and oldOrigin is the same as navigable's current session history entry's document state's origin,
  415. // then fire a traverse navigate event given targetEntry and userInvolvementForNavigateEvents.
  416. auto after_document_populated = [old_origin, changing_navigable_continuation, &changing_navigable_continuations, &vm, &navigable](bool populated_cloned_target_she, JS::NonnullGCPtr<SessionHistoryEntry> target_entry) mutable {
  417. changing_navigable_continuation.populated_target_entry = target_entry;
  418. changing_navigable_continuation.populated_cloned_target_session_history_entry = populated_cloned_target_she;
  419. // 1. If targetEntry's document is null, then set changingNavigableContinuation's update-only to true.
  420. if (!target_entry->document()) {
  421. changing_navigable_continuation.update_only = true;
  422. }
  423. else {
  424. // 2. If targetEntry's document's origin is not oldOrigin, then set targetEntry's classic history API state to StructuredSerializeForStorage(null).
  425. if (target_entry->document()->origin() != old_origin) {
  426. target_entry->set_classic_history_api_state(MUST(structured_serialize_for_storage(vm, JS::js_null())));
  427. }
  428. // 3. If all of the following are true:
  429. // - navigable's parent is null;
  430. // - targetEntry's document's browsing context is not an auxiliary browsing context whose opener browsing context is non-null; and
  431. // - targetEntry's document's origin is not oldOrigin,
  432. // then set targetEntry's document state's navigable target name to the empty string.
  433. if (navigable->parent() != nullptr
  434. && target_entry->document()->browsing_context()->opener_browsing_context() == nullptr
  435. && target_entry->document_state()->origin() != old_origin) {
  436. target_entry->document_state()->set_navigable_target_name(String {});
  437. }
  438. }
  439. // 4. Enqueue changingNavigableContinuation on changingNavigableContinuations.
  440. changing_navigable_continuations.enqueue(move(changing_navigable_continuation));
  441. };
  442. // 8. If targetEntry's document is null, or targetEntry's document state's reload pending is true, then:
  443. if (!target_entry->document() || target_entry->document_state()->reload_pending()) {
  444. // FIXME: 1. Let navTimingType be "back_forward" if targetEntry's document is null; otherwise "reload".
  445. // 2. Let targetSnapshotParams be the result of snapshotting target snapshot params given navigable.
  446. auto target_snapshot_params = navigable->snapshot_target_snapshot_params();
  447. // 3. Let potentiallyTargetSpecificSourceSnapshotParams be sourceSnapshotParams.
  448. Optional<SourceSnapshotParams> potentially_target_specific_source_snapshot_params = source_snapshot_params;
  449. // 4. If potentiallyTargetSpecificSourceSnapshotParams is null, then set it to the result of snapshotting source snapshot params given navigable's active document.
  450. if (!potentially_target_specific_source_snapshot_params.has_value()) {
  451. potentially_target_specific_source_snapshot_params = navigable->active_document()->snapshot_source_snapshot_params();
  452. }
  453. // 5. Set targetEntry's document state's reload pending to false.
  454. target_entry->document_state()->set_reload_pending(false);
  455. // 6. Let allowPOST be targetEntry's document state's reload pending.
  456. auto allow_POST = target_entry->document_state()->reload_pending();
  457. // https://github.com/whatwg/html/issues/9869
  458. // Reloading requires population of the active session history entry, making it inactive.
  459. // This results in a situation where tasks that unload the previous document and activate a new
  460. // document cannot run. To resolve this, the target entry is cloned before it is populated.
  461. // After the unloading of the previous document is completed, all fields potentially affected by the
  462. // population are copied from the cloned target entry to the actual target entry.
  463. auto populated_target_entry = target_entry->clone();
  464. // 7. In parallel, attempt to populate the history entry's document for targetEntry, given navigable, potentiallyTargetSpecificSourceSnapshotParams,
  465. // targetSnapshotParams, with allowPOST set to allowPOST and completionSteps set to queue a global task on the navigation and traversal task source given
  466. // navigable's active window to run afterDocumentPopulated.
  467. Platform::EventLoopPlugin::the().deferred_invoke([populated_target_entry, potentially_target_specific_source_snapshot_params, target_snapshot_params, this, allow_POST, navigable, after_document_populated] {
  468. navigable->populate_session_history_entry_document(populated_target_entry, *potentially_target_specific_source_snapshot_params, target_snapshot_params, {}, Empty {}, CSPNavigationType::Other, allow_POST, [this, after_document_populated, populated_target_entry]() mutable {
  469. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), JS::create_heap_function(this->heap(), [after_document_populated, populated_target_entry]() mutable {
  470. after_document_populated(true, populated_target_entry);
  471. }));
  472. })
  473. .release_value_but_fixme_should_propagate_errors();
  474. });
  475. }
  476. // Otherwise, run afterDocumentPopulated immediately.
  477. else {
  478. after_document_populated(false, *target_entry);
  479. }
  480. }));
  481. }
  482. auto check_if_document_population_tasks_completed = JS::SafeFunction<bool()>([&] {
  483. return changing_navigable_continuations.size() + completed_change_jobs == total_change_jobs;
  484. });
  485. if (synchronous_navigation == SynchronousNavigation::Yes) {
  486. // NOTE: Synchronous navigation should never require document population, so it is safe to process only NavigationAndTraversal source.
  487. main_thread_event_loop().spin_processing_tasks_with_source_until(Task::Source::NavigationAndTraversal, move(check_if_document_population_tasks_completed));
  488. } else {
  489. // NOTE: Process all task sources while waiting because reloading or back/forward navigation might require fetching to populate a document.
  490. main_thread_event_loop().spin_until(move(check_if_document_population_tasks_completed));
  491. }
  492. // 13. Let navigablesThatMustWaitBeforeHandlingSyncNavigation be an empty set.
  493. Vector<JS::GCPtr<Navigable>> navigables_that_must_wait_before_handling_sync_navigation;
  494. // 14. While completedChangeJobs does not equal totalChangeJobs:
  495. while (!changing_navigable_continuations.is_empty()) {
  496. // NOTE: Synchronous navigations that are intended to take place before this traversal jump the queue at this point,
  497. // so they can be added to the correct place in traversable's session history entries before this traversal
  498. // potentially unloads their document. More details can be found here (https://html.spec.whatwg.org/multipage/browsing-the-web.html#sync-navigation-steps-queue-jumping-examples)
  499. // 1. If traversable's running nested apply history step is false, then:
  500. if (!m_running_nested_apply_history_step) {
  501. // 1. While traversable's session history traversal queue's algorithm set contains one or more synchronous
  502. // navigation steps with a target navigable not contained in navigablesThatMustWaitBeforeHandlingSyncNavigation:
  503. // 1. Let steps be the first item in traversable's session history traversal queue's algorithm set
  504. // that is synchronous navigation steps with a target navigable not contained in navigablesThatMustWaitBeforeHandlingSyncNavigation.
  505. // 2. Remove steps from traversable's session history traversal queue's algorithm set.
  506. for (auto entry = m_session_history_traversal_queue->first_synchronous_navigation_steps_with_target_navigable_not_contained_in(navigables_that_must_wait_before_handling_sync_navigation);
  507. entry;
  508. entry = m_session_history_traversal_queue->first_synchronous_navigation_steps_with_target_navigable_not_contained_in(navigables_that_must_wait_before_handling_sync_navigation)) {
  509. // 3. Set traversable's running nested apply history step to true.
  510. m_running_nested_apply_history_step = true;
  511. // 4. Run steps.
  512. entry->execute_steps();
  513. // 5. Set traversable's running nested apply history step to false.
  514. m_running_nested_apply_history_step = false;
  515. }
  516. }
  517. // 2. Let changingNavigableContinuation be the result of dequeuing from changingNavigableContinuations.
  518. auto changing_navigable_continuation = changing_navigable_continuations.dequeue();
  519. // 3. If changingNavigableContinuation is nothing, then continue.
  520. // 4. Let displayedDocument be changingNavigableContinuation's displayed document.
  521. auto displayed_document = changing_navigable_continuation.displayed_document;
  522. // 5. Let targetEntry be changingNavigableContinuation's target entry.
  523. JS::GCPtr<SessionHistoryEntry> const populated_target_entry = changing_navigable_continuation.populated_target_entry.ptr();
  524. // 6. Let navigable be changingNavigableContinuation's navigable.
  525. auto navigable = changing_navigable_continuation.navigable;
  526. // NOTE: This check is not in the spec but we should not continue navigation if navigable has been destroyed.
  527. if (navigable->has_been_destroyed())
  528. continue;
  529. // 7. Let (scriptHistoryLength, scriptHistoryIndex) be the result of getting the history object length and index given traversable and targetStep.
  530. auto history_object_length_and_index = get_the_history_object_length_and_index(target_step);
  531. auto script_history_length = history_object_length_and_index.script_history_length;
  532. auto script_history_index = history_object_length_and_index.script_history_index;
  533. // 8. Append navigable to navigablesThatMustWaitBeforeHandlingSyncNavigation.
  534. navigables_that_must_wait_before_handling_sync_navigation.append(*navigable);
  535. // 9. Let entriesForNavigationAPI be the result of getting session history entries for the navigation API given navigable and targetStep.
  536. auto entries_for_navigation_api = get_session_history_entries_for_the_navigation_api(*navigable, target_step);
  537. // 12. In both cases, let afterPotentialUnloads be the following steps:
  538. bool const update_only = changing_navigable_continuation.update_only;
  539. JS::GCPtr<SessionHistoryEntry> const target_entry = changing_navigable_continuation.target_entry.ptr();
  540. bool const populated_cloned_target_session_history_entry = changing_navigable_continuation.populated_cloned_target_session_history_entry;
  541. auto after_potential_unload = JS::create_heap_function(this->heap(), [navigable, update_only, target_entry, populated_target_entry, populated_cloned_target_session_history_entry, displayed_document, &completed_change_jobs, script_history_length, script_history_index, entries_for_navigation_api = move(entries_for_navigation_api), &heap = this->heap()] {
  542. if (populated_cloned_target_session_history_entry) {
  543. target_entry->set_document_state(populated_target_entry->document_state());
  544. target_entry->set_url(populated_target_entry->url());
  545. target_entry->set_classic_history_api_state(populated_target_entry->classic_history_api_state());
  546. }
  547. // 1. If changingNavigableContinuation's update-only is false, then activate history entry targetEntry for navigable.
  548. if (!update_only)
  549. navigable->activate_history_entry(*target_entry);
  550. // 2. Let updateDocument be an algorithm step which performs update document for history step application given
  551. // targetEntry's document, targetEntry, changingNavigableContinuation's update-only, scriptHistoryLength,
  552. // scriptHistoryIndex, navigationType, entriesForNavigationAPI, and displayedEntry.
  553. auto update_document = JS::SafeFunction<void()>([script_history_length, script_history_index, entries_for_navigation_api = move(entries_for_navigation_api), target_entry, update_only] {
  554. target_entry->document()->update_for_history_step_application(*target_entry, update_only, script_history_length, script_history_index, entries_for_navigation_api);
  555. });
  556. // 3. If targetEntry's document is equal to displayedDocument, then perform updateDocument.
  557. if (target_entry->document().ptr() == displayed_document.ptr()) {
  558. update_document();
  559. }
  560. // 5. Otherwise, queue a global task on the navigation and traversal task source given targetEntry's document's relevant global object to perform updateDocument
  561. else {
  562. queue_global_task(Task::Source::NavigationAndTraversal, relevant_global_object(*target_entry->document()), JS::create_heap_function(heap, [update_document = move(update_document)]() {
  563. update_document();
  564. }));
  565. }
  566. // 6. Increment completedChangeJobs.
  567. completed_change_jobs++;
  568. });
  569. // 10. If changingNavigableContinuation's update-only is true, or targetEntry's document is displayedDocument, then:
  570. if (changing_navigable_continuation.update_only || populated_target_entry->document().ptr() == displayed_document.ptr()) {
  571. // 1. Set the ongoing navigation for navigable to null.
  572. navigable->set_ongoing_navigation({});
  573. // 2. Queue a global task on the navigation and traversal task source given navigable's active window to perform afterPotentialUnloads.
  574. queue_global_task(Task::Source::NavigationAndTraversal, *navigable->active_window(), after_potential_unload);
  575. }
  576. // 11. Otherwise:
  577. else {
  578. // 1. Assert: navigationType is not null.
  579. VERIFY(navigation_type.has_value());
  580. // 2. Deactivate displayedDocument, given userNavigationInvolvement, targetEntry, navigationType, and afterPotentialUnloads.
  581. deactivate_a_document_for_cross_document_navigation(*displayed_document, user_involvement_for_navigate_events, *populated_target_entry, after_potential_unload);
  582. }
  583. }
  584. main_thread_event_loop().spin_processing_tasks_with_source_until(Task::Source::NavigationAndTraversal, [&] {
  585. return completed_change_jobs == total_change_jobs;
  586. });
  587. // 15. Let totalNonchangingJobs be the size of nonchangingNavigablesThatStillNeedUpdates.
  588. auto total_non_changing_jobs = non_changing_navigables_that_still_need_updates.size();
  589. // 16. Let completedNonchangingJobs be 0.
  590. IGNORE_USE_IN_ESCAPING_LAMBDA auto completed_non_changing_jobs = 0u;
  591. // 17. Let (scriptHistoryLength, scriptHistoryIndex) be the result of getting the history object length and index given traversable and targetStep.
  592. auto length_and_index = get_the_history_object_length_and_index(target_step);
  593. IGNORE_USE_IN_ESCAPING_LAMBDA auto script_history_length = length_and_index.script_history_length;
  594. IGNORE_USE_IN_ESCAPING_LAMBDA auto script_history_index = length_and_index.script_history_index;
  595. // 18. For each navigable of nonchangingNavigablesThatStillNeedUpdates, queue a global task on the navigation and traversal task source given navigable's active window to run the steps:
  596. for (auto& navigable : non_changing_navigables_that_still_need_updates) {
  597. if (navigable->has_been_destroyed()) {
  598. ++completed_non_changing_jobs;
  599. continue;
  600. }
  601. queue_global_task(Task::Source::NavigationAndTraversal, *navigable->active_window(), JS::create_heap_function(heap(), [&] {
  602. // NOTE: This check is not in the spec but we should not continue navigation if navigable has been destroyed.
  603. if (navigable->has_been_destroyed()) {
  604. ++completed_non_changing_jobs;
  605. return;
  606. }
  607. // 1. Let document be navigable's active document.
  608. auto document = navigable->active_document();
  609. // 2. Set document's history object's index to scriptHistoryIndex.
  610. document->history()->m_index = script_history_index;
  611. // 3. Set document's history object's length to scriptHistoryLength.
  612. document->history()->m_length = script_history_length;
  613. // 4. Increment completedNonchangingJobs.
  614. ++completed_non_changing_jobs;
  615. }));
  616. }
  617. // 19. Wait for completedNonchangingJobs to equal totalNonchangingJobs.
  618. // AD-HOC: Since currently populate_session_history_entry_document does not run in parallel
  619. // we call spin_until to interrupt execution of this function and let document population
  620. // to complete.
  621. main_thread_event_loop().spin_processing_tasks_with_source_until(Task::Source::NavigationAndTraversal, [&] {
  622. return completed_non_changing_jobs == total_non_changing_jobs;
  623. });
  624. // 20. Set traversable's current session history step to targetStep.
  625. m_current_session_history_step = target_step;
  626. // Not in the spec:
  627. auto back_enabled = m_current_session_history_step > 0;
  628. VERIFY(m_session_history_entries.size() > 0);
  629. auto forward_enabled = can_go_forward();
  630. page().client().page_did_update_navigation_buttons_state(back_enabled, forward_enabled);
  631. page().client().page_did_change_url(current_session_history_entry()->url());
  632. // 21. Return "applied".
  633. return HistoryStepResult::Applied;
  634. }
  635. Vector<JS::NonnullGCPtr<SessionHistoryEntry>> TraversableNavigable::get_session_history_entries_for_the_navigation_api(JS::NonnullGCPtr<Navigable> navigable, int target_step)
  636. {
  637. // 1. Let rawEntries be the result of getting session history entries for navigable.
  638. auto raw_entries = navigable->get_session_history_entries();
  639. if (raw_entries.is_empty())
  640. return {};
  641. // 2. Let entriesForNavigationAPI be a new empty list.
  642. Vector<JS::NonnullGCPtr<SessionHistoryEntry>> entries_for_navigation_api;
  643. // 3. Let startingIndex be the index of the session history entry in rawEntries who has the greatest step less than or equal to targetStep.
  644. // FIXME: Use min/max_element algorithm or some such here
  645. int starting_index = 0;
  646. auto max_step = 0;
  647. for (auto i = 0u; i < raw_entries.size(); ++i) {
  648. auto const& entry = raw_entries[i];
  649. if (entry->step().has<int>()) {
  650. auto step = entry->step().get<int>();
  651. if (step <= target_step && step > max_step) {
  652. starting_index = static_cast<int>(i);
  653. }
  654. }
  655. }
  656. // 4. Append rawEntries[startingIndex] to entriesForNavigationAPI.
  657. entries_for_navigation_api.append(raw_entries[starting_index]);
  658. // 5. Let startingOrigin be rawEntries[startingIndex]'s document state's origin.
  659. auto starting_origin = raw_entries[starting_index]->document_state()->origin();
  660. // 6. Let i be startingIndex − 1.
  661. auto i = starting_index - 1;
  662. // 7. While i > 0:
  663. while (i > 0) {
  664. auto& entry = raw_entries[static_cast<unsigned>(i)];
  665. // 1. If rawEntries[i]'s document state's origin is not same origin with startingOrigin, then break.
  666. auto entry_origin = entry->document_state()->origin();
  667. if (starting_origin.has_value() && entry_origin.has_value() && !entry_origin->is_same_origin(*starting_origin))
  668. break;
  669. // 2. Prepend rawEntries[i] to entriesForNavigationAPI.
  670. entries_for_navigation_api.prepend(entry);
  671. // 3. Set i to i − 1.
  672. --i;
  673. }
  674. // 8. Set i to startingIndex + 1.
  675. i = starting_index + 1;
  676. // 9. While i < rawEntries's size:
  677. while (i < static_cast<int>(raw_entries.size())) {
  678. auto& entry = raw_entries[static_cast<unsigned>(i)];
  679. // 1. If rawEntries[i]'s document state's origin is not same origin with startingOrigin, then break.
  680. auto entry_origin = entry->document_state()->origin();
  681. if (starting_origin.has_value() && entry_origin.has_value() && !entry_origin->is_same_origin(*starting_origin))
  682. break;
  683. // 2. Append rawEntries[i] to entriesForNavigationAPI.
  684. entries_for_navigation_api.append(entry);
  685. // 3. Set i to i + 1.
  686. ++i;
  687. }
  688. // 10. Return entriesForNavigationAPI.
  689. return entries_for_navigation_api;
  690. }
  691. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#clear-the-forward-session-history
  692. void TraversableNavigable::clear_the_forward_session_history()
  693. {
  694. // FIXME: 1. Assert: this is running within navigable's session history traversal queue.
  695. // 2. Let step be the navigable's current session history step.
  696. auto step = current_session_history_step();
  697. // 3. Let entryLists be the ordered set « navigable's session history entries ».
  698. Vector<Vector<JS::NonnullGCPtr<SessionHistoryEntry>>&> entry_lists;
  699. entry_lists.append(session_history_entries());
  700. // 4. For each entryList of entryLists:
  701. while (!entry_lists.is_empty()) {
  702. auto& entry_list = entry_lists.take_first();
  703. // 1. Remove every session history entry from entryList that has a step greater than step.
  704. entry_list.remove_all_matching([step](auto& entry) {
  705. return entry->step().template get<int>() > step;
  706. });
  707. // 2. For each entry of entryList:
  708. for (auto& entry : entry_list) {
  709. // 1. For each nestedHistory of entry's document state's nested histories, append nestedHistory's entries list to entryLists.
  710. for (auto& nested_history : entry->document_state()->nested_histories()) {
  711. entry_lists.append(nested_history.entries);
  712. }
  713. }
  714. }
  715. }
  716. bool TraversableNavigable::can_go_forward() const
  717. {
  718. auto step = current_session_history_step();
  719. Vector<Vector<JS::NonnullGCPtr<SessionHistoryEntry>> const&> entry_lists;
  720. entry_lists.append(session_history_entries());
  721. while (!entry_lists.is_empty()) {
  722. auto const& entry_list = entry_lists.take_first();
  723. for (auto const& entry : entry_list) {
  724. if (entry->step().template get<int>() > step)
  725. return true;
  726. for (auto& nested_history : entry->document_state()->nested_histories())
  727. entry_lists.append(nested_history.entries);
  728. }
  729. }
  730. return false;
  731. }
  732. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#traverse-the-history-by-a-delta
  733. void TraversableNavigable::traverse_the_history_by_delta(int delta, Optional<DOM::Document&> source_document)
  734. {
  735. // 1. Let sourceSnapshotParams and initiatorToCheck be null.
  736. Optional<SourceSnapshotParams> source_snapshot_params = {};
  737. JS::GCPtr<Navigable> initiator_to_check = nullptr;
  738. // 2. Let userInvolvement be "browser UI".
  739. UserNavigationInvolvement user_involvement = UserNavigationInvolvement::BrowserUI;
  740. // 1. If sourceDocument is given, then:
  741. if (source_document.has_value()) {
  742. // 1. Set sourceSnapshotParams to the result of snapshotting source snapshot params given sourceDocument.
  743. source_snapshot_params = source_document->snapshot_source_snapshot_params();
  744. // 2. Set initiatorToCheck to sourceDocument's node navigable.
  745. initiator_to_check = source_document->navigable();
  746. // 3. Set userInvolvement to "none".
  747. user_involvement = UserNavigationInvolvement::None;
  748. }
  749. // 4. Append the following session history traversal steps to traversable:
  750. append_session_history_traversal_steps([this, delta, source_snapshot_params = move(source_snapshot_params), initiator_to_check, user_involvement] {
  751. // 1. Let allSteps be the result of getting all used history steps for traversable.
  752. auto all_steps = get_all_used_history_steps();
  753. // 2. Let currentStepIndex be the index of traversable's current session history step within allSteps.
  754. auto current_step_index = *all_steps.find_first_index(current_session_history_step());
  755. // 3. Let targetStepIndex be currentStepIndex plus delta
  756. auto target_step_index = current_step_index + delta;
  757. // 4. If allSteps[targetStepIndex] does not exist, then abort these steps.
  758. if (target_step_index >= all_steps.size()) {
  759. return;
  760. }
  761. // 5. Apply the traverse history step allSteps[targetStepIndex] to traversable, given sourceSnapshotParams,
  762. // initiatorToCheck, and userInvolvement.
  763. apply_the_traverse_history_step(all_steps[target_step_index], source_snapshot_params, initiator_to_check, user_involvement);
  764. });
  765. }
  766. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#update-for-navigable-creation/destruction
  767. TraversableNavigable::HistoryStepResult TraversableNavigable::update_for_navigable_creation_or_destruction()
  768. {
  769. // 1. Let step be traversable's current session history step.
  770. auto step = current_session_history_step();
  771. // 2. Return the result of applying the history step to traversable given false, null, null, null, and null.
  772. return apply_the_history_step(step, false, {}, {}, {}, {}, SynchronousNavigation::No);
  773. }
  774. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#apply-the-reload-history-step
  775. TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_reload_history_step()
  776. {
  777. // 1. Let step be traversable's current session history step.
  778. auto step = current_session_history_step();
  779. // 2. Return the result of applying the history step step to traversable given true, null, null, null, and "reload".
  780. return apply_the_history_step(step, true, {}, {}, {}, Bindings::NavigationType::Reload, SynchronousNavigation::No);
  781. }
  782. TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_push_or_replace_history_step(int step, HistoryHandlingBehavior history_handling, SynchronousNavigation synchronous_navigation)
  783. {
  784. // 1. Return the result of applying the history step step to traversable given false, null, null, null, and historyHandling.
  785. auto navigation_type = history_handling == HistoryHandlingBehavior::Replace ? Bindings::NavigationType::Replace : Bindings::NavigationType::Push;
  786. return apply_the_history_step(step, false, {}, {}, {}, navigation_type, synchronous_navigation);
  787. }
  788. TraversableNavigable::HistoryStepResult TraversableNavigable::apply_the_traverse_history_step(int step, Optional<SourceSnapshotParams> source_snapshot_params, JS::GCPtr<Navigable> initiator_to_check, UserNavigationInvolvement user_involvement)
  789. {
  790. // 1. Return the result of applying the history step step to traversable given true, sourceSnapshotParams, initiatorToCheck, userInvolvement, and "traverse".
  791. return apply_the_history_step(step, true, move(source_snapshot_params), initiator_to_check, user_involvement, Bindings::NavigationType::Traverse, SynchronousNavigation::No);
  792. }
  793. // https://html.spec.whatwg.org/multipage/document-sequences.html#close-a-top-level-traversable
  794. void TraversableNavigable::close_top_level_traversable()
  795. {
  796. VERIFY(is_top_level_traversable());
  797. // 1. Let toUnload be traversable's active document's inclusive descendant navigables.
  798. auto to_unload = active_document()->inclusive_descendant_navigables();
  799. // FIXME: 2. If the result of checking if unloading is user-canceled for toUnload is true, then return.
  800. // 3. Unload the active documents of each of toUnload.
  801. for (auto navigable : to_unload) {
  802. navigable->active_document()->unload();
  803. }
  804. // 4. Destroy traversable.
  805. destroy_top_level_traversable();
  806. }
  807. // https://html.spec.whatwg.org/multipage/document-sequences.html#destroy-a-top-level-traversable
  808. void TraversableNavigable::destroy_top_level_traversable()
  809. {
  810. VERIFY(is_top_level_traversable());
  811. // 1. Let browsingContext be traversable's active browsing context.
  812. auto browsing_context = active_browsing_context();
  813. // 2. For each historyEntry in traversable's session history entries:
  814. for (auto& history_entry : m_session_history_entries) {
  815. // 1. Let document be historyEntry's document.
  816. auto document = history_entry->document();
  817. // 2. If document is not null, then destroy document.
  818. if (document)
  819. document->destroy();
  820. }
  821. // 3. Remove browsingContext.
  822. if (!browsing_context) {
  823. dbgln("TraversableNavigable::destroy_top_level_traversable: No browsing context?");
  824. } else {
  825. browsing_context->remove();
  826. }
  827. // 4. Remove traversable from the user interface (e.g., close or hide its tab in a tabbed browser).
  828. page().client().page_did_close_top_level_traversable();
  829. // 5. Remove traversable from the user agent's top-level traversable set.
  830. user_agent_top_level_traversable_set().remove(this);
  831. // FIXME: Figure out why we need to do this... we shouldn't be leaking Navigables for all time.
  832. // However, without this, we can keep stale destroyed traversables around.
  833. set_has_been_destroyed();
  834. all_navigables().remove(this);
  835. }
  836. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#finalize-a-same-document-navigation
  837. void finalize_a_same_document_navigation(JS::NonnullGCPtr<TraversableNavigable> traversable, JS::NonnullGCPtr<Navigable> target_navigable, JS::NonnullGCPtr<SessionHistoryEntry> target_entry, JS::GCPtr<SessionHistoryEntry> entry_to_replace, HistoryHandlingBehavior history_handling)
  838. {
  839. // NOTE: This is not in the spec but we should not navigate destroyed navigable.
  840. if (target_navigable->has_been_destroyed())
  841. return;
  842. // FIXME: 1. Assert: this is running on traversable's session history traversal queue.
  843. // 2. If targetNavigable's active session history entry is not targetEntry, then return.
  844. if (target_navigable->active_session_history_entry() != target_entry) {
  845. return;
  846. }
  847. // 3. Let targetStep be null.
  848. Optional<int> target_step;
  849. // 4. Let targetEntries be the result of getting session history entries for targetNavigable.
  850. auto& target_entries = target_navigable->get_session_history_entries();
  851. // 5. If entryToReplace is null, then:
  852. // FIXME: Checking containment of entryToReplace should not be needed.
  853. // For more details see https://github.com/whatwg/html/issues/10232#issuecomment-2037543137
  854. if (!entry_to_replace || !target_entries.contains_slow(JS::NonnullGCPtr { *entry_to_replace })) {
  855. // 1. Clear the forward session history of traversable.
  856. traversable->clear_the_forward_session_history();
  857. // 2. Set targetStep to traversable's current session history step + 1.
  858. target_step = traversable->current_session_history_step() + 1;
  859. // 3. Set targetEntry's step to targetStep.
  860. target_entry->set_step(*target_step);
  861. // 4. Append targetEntry to targetEntries.
  862. target_entries.append(target_entry);
  863. } else {
  864. // 1. Replace entryToReplace with targetEntry in targetEntries.
  865. *(target_entries.find(*entry_to_replace)) = target_entry;
  866. // 2. Set targetEntry's step to entryToReplace's step.
  867. target_entry->set_step(entry_to_replace->step());
  868. // 3. Set targetStep to traversable's current session history step.
  869. target_step = traversable->current_session_history_step();
  870. }
  871. // 6. Apply the push/replace history step targetStep to traversable given historyHandling.
  872. traversable->apply_the_push_or_replace_history_step(*target_step, history_handling, TraversableNavigable::SynchronousNavigation::Yes);
  873. }
  874. // https://html.spec.whatwg.org/multipage/interaction.html#system-visibility-state
  875. void TraversableNavigable::set_system_visibility_state(VisibilityState visibility_state)
  876. {
  877. if (m_system_visibility_state == visibility_state)
  878. return;
  879. m_system_visibility_state = visibility_state;
  880. // When a user-agent determines that the system visibility state for
  881. // traversable navigable traversable has changed to newState, it must run the following steps:
  882. // 1. Let navigables be the inclusive descendant navigables of traversable's active document.
  883. auto navigables = active_document()->inclusive_descendant_navigables();
  884. // 2. For each navigable of navigables:
  885. for (auto& navigable : navigables) {
  886. // 1. Let document be navigable's active document.
  887. auto document = navigable->active_document();
  888. VERIFY(document);
  889. // 2. Queue a global task on the user interaction task source given document's relevant global object
  890. // to update the visibility state of document with newState.
  891. queue_global_task(Task::Source::UserInteraction, relevant_global_object(*document), JS::create_heap_function(heap(), [visibility_state, document] {
  892. document->update_the_visibility_state(visibility_state);
  893. }));
  894. }
  895. }
  896. }