TraversableNavigable.cpp 59 KB

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