Navigation.cpp 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205
  1. /*
  2. * Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <LibJS/Heap/Heap.h>
  7. #include <LibJS/Runtime/Realm.h>
  8. #include <LibJS/Runtime/VM.h>
  9. #include <LibWeb/Bindings/ExceptionOrUtils.h>
  10. #include <LibWeb/Bindings/Intrinsics.h>
  11. #include <LibWeb/Bindings/NavigationPrototype.h>
  12. #include <LibWeb/DOM/AbortController.h>
  13. #include <LibWeb/DOM/Document.h>
  14. #include <LibWeb/HTML/ErrorEvent.h>
  15. #include <LibWeb/HTML/History.h>
  16. #include <LibWeb/HTML/NavigateEvent.h>
  17. #include <LibWeb/HTML/Navigation.h>
  18. #include <LibWeb/HTML/NavigationCurrentEntryChangeEvent.h>
  19. #include <LibWeb/HTML/NavigationDestination.h>
  20. #include <LibWeb/HTML/NavigationHistoryEntry.h>
  21. #include <LibWeb/HTML/NavigationTransition.h>
  22. #include <LibWeb/HTML/Scripting/ExceptionReporter.h>
  23. #include <LibWeb/HTML/TraversableNavigable.h>
  24. #include <LibWeb/HTML/Window.h>
  25. #include <LibWeb/WebIDL/AbstractOperations.h>
  26. #include <LibWeb/XHR/FormData.h>
  27. namespace Web::HTML {
  28. static NavigationResult navigation_api_method_tracker_derived_result(JS::NonnullGCPtr<NavigationAPIMethodTracker> api_method_tracker);
  29. NavigationAPIMethodTracker::NavigationAPIMethodTracker(JS::NonnullGCPtr<Navigation> navigation,
  30. Optional<String> key,
  31. JS::Value info,
  32. Optional<SerializationRecord> serialized_state,
  33. JS::GCPtr<NavigationHistoryEntry> commited_to_entry,
  34. JS::NonnullGCPtr<WebIDL::Promise> committed_promise,
  35. JS::NonnullGCPtr<WebIDL::Promise> finished_promise)
  36. : navigation(navigation)
  37. , key(move(key))
  38. , info(info)
  39. , serialized_state(move(serialized_state))
  40. , commited_to_entry(commited_to_entry)
  41. , committed_promise(committed_promise)
  42. , finished_promise(finished_promise)
  43. {
  44. }
  45. void NavigationAPIMethodTracker::visit_edges(Cell::Visitor& visitor)
  46. {
  47. Base::visit_edges(visitor);
  48. visitor.visit(navigation);
  49. visitor.visit(info);
  50. visitor.visit(commited_to_entry);
  51. visitor.visit(committed_promise);
  52. visitor.visit(finished_promise);
  53. }
  54. JS::NonnullGCPtr<Navigation> Navigation::create(JS::Realm& realm)
  55. {
  56. return realm.heap().allocate<Navigation>(realm, realm);
  57. }
  58. Navigation::Navigation(JS::Realm& realm)
  59. : DOM::EventTarget(realm)
  60. {
  61. }
  62. Navigation::~Navigation() = default;
  63. void Navigation::initialize(JS::Realm& realm)
  64. {
  65. Base::initialize(realm);
  66. set_prototype(&Bindings::ensure_web_prototype<Bindings::NavigationPrototype>(realm, "Navigation"));
  67. }
  68. void Navigation::visit_edges(JS::Cell::Visitor& visitor)
  69. {
  70. Base::visit_edges(visitor);
  71. for (auto& entry : m_entry_list)
  72. visitor.visit(entry);
  73. visitor.visit(m_transition);
  74. visitor.visit(m_ongoing_navigate_event);
  75. visitor.visit(m_ongoing_api_method_tracker);
  76. visitor.visit(m_upcoming_non_traverse_api_method_tracker);
  77. for (auto& key_and_tracker : m_upcoming_traverse_api_method_trackers)
  78. visitor.visit(key_and_tracker.value);
  79. }
  80. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-entries
  81. Vector<JS::NonnullGCPtr<NavigationHistoryEntry>> Navigation::entries() const
  82. {
  83. // The entries() method steps are:
  84. // 1. If this has entries and events disabled, then return the empty list.
  85. if (has_entries_and_events_disabled())
  86. return {};
  87. // 2. Return this's entry list.
  88. // NOTE: Recall that because of Web IDL's sequence type conversion rules,
  89. // this will create a new JavaScript array object on each call.
  90. // That is, navigation.entries() !== navigation.entries().
  91. return m_entry_list;
  92. }
  93. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#navigation-current-entry
  94. JS::GCPtr<NavigationHistoryEntry> Navigation::current_entry() const
  95. {
  96. // The current entry of a Navigation navigation is the result of running the following steps:
  97. // 1. If navigation has entries and events disabled, then return null.
  98. if (has_entries_and_events_disabled())
  99. return nullptr;
  100. // FIXME 2. Assert: navigation's current entry index is not −1.
  101. // FIXME: This should not happen once Navigable's algorithms properly set up NHEs.
  102. if (m_current_entry_index == -1)
  103. return nullptr;
  104. // 3. Return navigation's entry list[navigation's current entry index].
  105. return m_entry_list[m_current_entry_index];
  106. }
  107. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-updatecurrententry
  108. WebIDL::ExceptionOr<void> Navigation::update_current_entry(NavigationUpdateCurrentEntryOptions options)
  109. {
  110. // The updateCurrentEntry(options) method steps are:
  111. // 1. Let current be the current entry of this.
  112. auto current = current_entry();
  113. // 2. If current is null, then throw an "InvalidStateError" DOMException.
  114. if (current == nullptr)
  115. return WebIDL::InvalidStateError::create(realm(), "Cannot update current NavigationHistoryEntry when there is no current entry"_fly_string);
  116. // 3. Let serializedState be StructuredSerializeForStorage(options["state"]), rethrowing any exceptions.
  117. auto serialized_state = TRY(structured_serialize_for_storage(vm(), options.state));
  118. // 4. Set current's session history entry's navigation API state to serializedState.
  119. current->session_history_entry().navigation_api_state = serialized_state;
  120. // 5. Fire an event named currententrychange at this using NavigationCurrentEntryChangeEvent,
  121. // with its navigationType attribute initialized to null and its from initialized to current.
  122. NavigationCurrentEntryChangeEventInit event_init = {};
  123. event_init.navigation_type = {};
  124. event_init.from = current;
  125. dispatch_event(HTML::NavigationCurrentEntryChangeEvent::create(realm(), HTML::EventNames::currententrychange, event_init));
  126. return {};
  127. }
  128. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-cangoback
  129. bool Navigation::can_go_back() const
  130. {
  131. // The canGoBack getter steps are:
  132. // 1. If this has entries and events disabled, then return false.
  133. if (has_entries_and_events_disabled())
  134. return false;
  135. // FIXME 2. Assert: navigation's current entry index is not −1.
  136. // FIXME: This should not happen once Navigable's algorithms properly set up NHEs.
  137. if (m_current_entry_index == -1)
  138. return false;
  139. // 3. If this's current entry index is 0, then return false.
  140. // 4. Return true.
  141. return (m_current_entry_index != 0);
  142. }
  143. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-cangoforward
  144. bool Navigation::can_go_forward() const
  145. {
  146. // The canGoForward getter steps are:
  147. // 1. If this has entries and events disabled, then return false.
  148. if (has_entries_and_events_disabled())
  149. return false;
  150. // FIXME 2. Assert: navigation's current entry index is not −1.
  151. // FIXME: This should not happen once Navigable's algorithms properly set up NHEs.
  152. if (m_current_entry_index == -1)
  153. return false;
  154. // 3. If this's current entry index is equal to this's entry list's size, then return false.
  155. // 4. Return true.
  156. return (m_current_entry_index != static_cast<i64>(m_entry_list.size()));
  157. }
  158. HistoryHandlingBehavior to_history_handling_behavior(Bindings::NavigationHistoryBehavior b)
  159. {
  160. // A history handling behavior is a NavigationHistoryBehavior that is either "push" or "replace",
  161. // i.e., that has been resolved away from any initial "auto" value.
  162. VERIFY(b != Bindings::NavigationHistoryBehavior::Auto);
  163. switch (b) {
  164. case Bindings::NavigationHistoryBehavior::Push:
  165. return HistoryHandlingBehavior::Push;
  166. case Bindings::NavigationHistoryBehavior::Replace:
  167. return HistoryHandlingBehavior::Replace;
  168. case Bindings::NavigationHistoryBehavior::Auto:
  169. VERIFY_NOT_REACHED();
  170. };
  171. VERIFY_NOT_REACHED();
  172. }
  173. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-navigate
  174. WebIDL::ExceptionOr<NavigationResult> Navigation::navigate(String url, NavigationNavigateOptions const& options)
  175. {
  176. auto& realm = this->realm();
  177. auto& vm = this->vm();
  178. // The navigate(options) method steps are:
  179. // 1. Parse url relative to this's relevant settings object.
  180. // If that returns failure, then return an early error result for a "SyntaxError" DOMException.
  181. // Otherwise, let urlRecord be the resulting URL record.
  182. auto url_record = relevant_settings_object(*this).parse_url(url);
  183. if (!url_record.is_valid())
  184. return early_error_result(WebIDL::SyntaxError::create(realm, "Cannot navigate to Invalid URL"_fly_string));
  185. // 2. Let document be this's relevant global object's associated Document.
  186. auto& document = verify_cast<HTML::Window>(relevant_global_object(*this)).associated_document();
  187. // 3. If options["history"] is "push", and the navigation must be a replace given urlRecord and document,
  188. // then return an early error result for a "NotSupportedError" DOMException.
  189. if (options.history == Bindings::NavigationHistoryBehavior::Push && navigation_must_be_a_replace(url_record, document))
  190. return early_error_result(WebIDL::NotSupportedError::create(realm, "Navigation must be a replace, but push was requested"_fly_string));
  191. // 4. Let state be options["state"], if it exists; otherwise, undefined.
  192. auto state = options.state.value_or(JS::js_undefined());
  193. // 5. Let serializedState be StructuredSerializeForStorage(state).
  194. // If this throws an exception, then return an early error result for that exception.
  195. // FIXME: Fix this spec grammaro in the note
  196. // NOTE: It is importantly to perform this step early, since serialization can invoke web developer code,
  197. // which in turn might change various things we check in later steps.
  198. auto serialized_state_or_error = structured_serialize_for_storage(vm, state);
  199. if (serialized_state_or_error.is_error()) {
  200. return early_error_result(serialized_state_or_error.release_error());
  201. }
  202. auto serialized_state = serialized_state_or_error.release_value();
  203. // 6. If document is not fully active, then return an early error result for an "InvalidStateError" DOMException.
  204. if (!document.is_fully_active())
  205. return early_error_result(WebIDL::InvalidStateError::create(realm, "Document is not fully active"_fly_string));
  206. // 7. If document's unload counter is greater than 0, then return an early error result for an "InvalidStateError" DOMException.
  207. if (document.unload_counter() > 0)
  208. return early_error_result(WebIDL::InvalidStateError::create(realm, "Document already unloaded"_fly_string));
  209. // 8. Let info be options["info"], if it exists; otherwise, undefined.
  210. auto info = options.info.value_or(JS::js_undefined());
  211. // 9. Let apiMethodTracker be the result of maybe setting the upcoming non-traverse API method tracker for this
  212. // given info and serializedState.
  213. auto api_method_tracker = maybe_set_the_upcoming_non_traverse_api_method_tracker(info, serialized_state);
  214. // 10. Navigate document's node navigable to urlRecord using document,
  215. // with historyHandling set to options["history"] and navigationAPIState set to serializedState.
  216. // FIXME: Fix spec typo here
  217. // NOTE: Unlike location.assign() and friends, which are exposed across origin-domain boundaries,
  218. // navigation.navigate() can only be accessed by code with direct synchronous access to the
  219. /// window.navigation property. Thus, we avoid the complications about attributing the source document
  220. // of the navigation, and we don't need to deal with the allowed by sandboxing to navigate check and its
  221. // acccompanying exceptionsEnabled flag. We just treat all navigations as if they come from the Document
  222. // corresponding to this Navigation object itself (i.e., document).
  223. [[maybe_unused]] auto history_handling_behavior = to_history_handling_behavior(options.history);
  224. // FIXME: Actually call navigate once Navigables are implemented enough to guarantee a node navigable on
  225. // an active document that's not being unloaded.
  226. // document.navigable().navigate(url, document, history behavior, state)
  227. // 11. If this's upcoming non-traverse API method tracker is apiMethodTracker, then:
  228. // NOTE: If the upcoming non-traverse API method tracker is still apiMethodTracker, this means that the navigate
  229. // algorithm bailed out before ever getting to the inner navigate event firing algorithm which would promote
  230. // that upcoming API method tracker to ongoing.
  231. if (m_upcoming_non_traverse_api_method_tracker == api_method_tracker) {
  232. m_upcoming_non_traverse_api_method_tracker = nullptr;
  233. return early_error_result(WebIDL::AbortError::create(realm, "Navigation aborted"_fly_string));
  234. }
  235. // 12. Return a navigation API method tracker-derived result for apiMethodTracker.
  236. return navigation_api_method_tracker_derived_result(api_method_tracker);
  237. }
  238. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-reload
  239. WebIDL::ExceptionOr<NavigationResult> Navigation::reload(NavigationReloadOptions const& options)
  240. {
  241. auto& realm = this->realm();
  242. auto& vm = this->vm();
  243. // The reload(options) method steps are:
  244. // 1. Let document be this's relevant global object's associated Document.
  245. auto& document = verify_cast<HTML::Window>(relevant_global_object(*this)).associated_document();
  246. // 2. Let serializedState be StructuredSerializeForStorage(undefined).
  247. auto serialized_state = MUST(structured_serialize_for_storage(vm, JS::js_undefined()));
  248. // 3. If options["state"] exists, then set serializedState to StructuredSerializeForStorage(options["state"]).
  249. // If this throws an exception, then return an early error result for that exception.
  250. // NOTE: It is importantly to perform this step early, since serialization can invoke web developer
  251. // code, which in turn might change various things we check in later steps.
  252. if (options.state.has_value()) {
  253. auto serialized_state_or_error = structured_serialize_for_storage(vm, options.state.value());
  254. if (serialized_state_or_error.is_error())
  255. return early_error_result(serialized_state_or_error.release_error());
  256. serialized_state = serialized_state_or_error.release_value();
  257. }
  258. // 4. Otherwise:
  259. else {
  260. // 1. Let current be the current entry of this.
  261. auto current = current_entry();
  262. // 2. If current is not null, then set serializedState to current's session history entry's navigation API state.
  263. if (current != nullptr)
  264. serialized_state = current->session_history_entry().navigation_api_state;
  265. }
  266. // 5. If document is not fully active, then return an early error result for an "InvalidStateError" DOMException.
  267. if (!document.is_fully_active())
  268. return early_error_result(WebIDL::InvalidStateError::create(realm, "Document is not fully active"_fly_string));
  269. // 6. If document's unload counter is greater than 0, then return an early error result for an "InvalidStateError" DOMException.
  270. if (document.unload_counter() > 0)
  271. return early_error_result(WebIDL::InvalidStateError::create(realm, "Document already unloaded"_fly_string));
  272. // 7. Let info be options["info"], if it exists; otherwise, undefined.
  273. auto info = options.info.value_or(JS::js_undefined());
  274. // 8. Let apiMethodTracker be the result of maybe setting the upcoming non-traverse API method tracker for this given info and serializedState.
  275. auto api_method_tracker = maybe_set_the_upcoming_non_traverse_api_method_tracker(info, serialized_state);
  276. // 9. Reload document's node navigable with navigationAPIState set to serializedState.
  277. // FIXME: Actually call reload once Navigables are implemented enough to guarantee a node navigable on
  278. // an active document that's not being unloaded.
  279. // document.navigable().reload(state)
  280. return navigation_api_method_tracker_derived_result(api_method_tracker);
  281. }
  282. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-traverseto
  283. WebIDL::ExceptionOr<NavigationResult> Navigation::traverse_to(String key, NavigationOptions const& options)
  284. {
  285. auto& realm = this->realm();
  286. // The traverseTo(key, options) method steps are:
  287. // 1. If this's current entry index is −1, then return an early error result for an "InvalidStateError" DOMException.
  288. if (m_current_entry_index == -1)
  289. return early_error_result(WebIDL::InvalidStateError::create(realm, "Cannot traverseTo: no current session history entry"_fly_string));
  290. // 2. If this's entry list does not contain a NavigationHistoryEntry whose session history entry's navigation API key equals key,
  291. // then return an early error result for an "InvalidStateError" DOMException.
  292. auto it = m_entry_list.find_if([&key](auto const& entry) {
  293. return entry->session_history_entry().navigation_api_key == key;
  294. });
  295. if (it == m_entry_list.end())
  296. return early_error_result(WebIDL::InvalidStateError::create(realm, "Cannot traverseTo: key not found in session history list"_fly_string));
  297. // 3. Return the result of performing a navigation API traversal given this, key, and options.
  298. return perform_a_navigation_api_traversal(key, options);
  299. }
  300. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#performing-a-navigation-api-traversal
  301. WebIDL::ExceptionOr<NavigationResult> Navigation::back(NavigationOptions const& options)
  302. {
  303. auto& realm = this->realm();
  304. // The back(options) method steps are:
  305. // 1. If this's current entry index is −1 or 0, then return an early error result for an "InvalidStateError" DOMException.
  306. if (m_current_entry_index == -1 || m_current_entry_index == 0)
  307. return early_error_result(WebIDL::InvalidStateError::create(realm, "Cannot navigate back: no previous session history entry"_fly_string));
  308. // 2. Let key be this's entry list[this's current entry index − 1]'s session history entry's navigation API key.
  309. auto key = m_entry_list[m_current_entry_index - 1]->session_history_entry().navigation_api_key;
  310. // 3. Return the result of performing a navigation API traversal given this, key, and options.
  311. return perform_a_navigation_api_traversal(key, options);
  312. }
  313. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigation-forward
  314. WebIDL::ExceptionOr<NavigationResult> Navigation::forward(NavigationOptions const& options)
  315. {
  316. auto& realm = this->realm();
  317. // The forward(options) method steps are:
  318. // 1. If this's current entry index is −1 or is equal to this's entry list's size − 1,
  319. // then return an early error result for an "InvalidStateError" DOMException.
  320. if (m_current_entry_index == -1 || m_current_entry_index == static_cast<i64>(m_entry_list.size() - 1))
  321. return early_error_result(WebIDL::InvalidStateError::create(realm, "Cannot navigate forward: no next session history entry"_fly_string));
  322. // 2. Let key be this's entry list[this's current entry index + 1]'s session history entry's navigation API key.
  323. auto key = m_entry_list[m_current_entry_index + 1]->session_history_entry().navigation_api_key;
  324. // 3. Return the result of performing a navigation API traversal given this, key, and options.
  325. return perform_a_navigation_api_traversal(key, options);
  326. }
  327. void Navigation::set_onnavigate(WebIDL::CallbackType* event_handler)
  328. {
  329. set_event_handler_attribute(HTML::EventNames::navigate, event_handler);
  330. }
  331. WebIDL::CallbackType* Navigation::onnavigate()
  332. {
  333. return event_handler_attribute(HTML::EventNames::navigate);
  334. }
  335. void Navigation::set_onnavigatesuccess(WebIDL::CallbackType* event_handler)
  336. {
  337. set_event_handler_attribute(HTML::EventNames::navigatesuccess, event_handler);
  338. }
  339. WebIDL::CallbackType* Navigation::onnavigatesuccess()
  340. {
  341. return event_handler_attribute(HTML::EventNames::navigatesuccess);
  342. }
  343. void Navigation::set_onnavigateerror(WebIDL::CallbackType* event_handler)
  344. {
  345. set_event_handler_attribute(HTML::EventNames::navigateerror, event_handler);
  346. }
  347. WebIDL::CallbackType* Navigation::onnavigateerror()
  348. {
  349. return event_handler_attribute(HTML::EventNames::navigateerror);
  350. }
  351. void Navigation::set_oncurrententrychange(WebIDL::CallbackType* event_handler)
  352. {
  353. set_event_handler_attribute(HTML::EventNames::currententrychange, event_handler);
  354. }
  355. WebIDL::CallbackType* Navigation::oncurrententrychange()
  356. {
  357. return event_handler_attribute(HTML::EventNames::currententrychange);
  358. }
  359. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#has-entries-and-events-disabled
  360. bool Navigation::has_entries_and_events_disabled() const
  361. {
  362. // A Navigation navigation has entries and events disabled if the following steps return true:
  363. // 1. Let document be navigation's relevant global object's associated Document.
  364. auto const& document = verify_cast<HTML::Window>(relevant_global_object(*this)).associated_document();
  365. // 2. If document is not fully active, then return true.
  366. if (!document.is_fully_active())
  367. return true;
  368. // 3. If document's is initial about:blank is true, then return true.
  369. if (document.is_initial_about_blank())
  370. return true;
  371. // 4. If document's origin is opaque, then return true.
  372. if (document.origin().is_opaque())
  373. return true;
  374. // 5. Return false.
  375. return false;
  376. }
  377. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#getting-the-navigation-api-entry-index
  378. i64 Navigation::get_the_navigation_api_entry_index(SessionHistoryEntry const& she) const
  379. {
  380. // To get the navigation API entry index of a session history entry she within a Navigation navigation:
  381. // 1. Let index be 0.
  382. i64 index = 0;
  383. // 2. For each nhe of navigation's entry list:
  384. for (auto const& nhe : m_entry_list) {
  385. // 1. If nhe's session history entry is equal to she, then return index.
  386. if (&nhe->session_history_entry() == &she)
  387. return index;
  388. // 2. Increment index by 1.
  389. ++index;
  390. }
  391. // 3. Return −1.
  392. return -1;
  393. }
  394. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#navigation-api-early-error-result
  395. NavigationResult Navigation::early_error_result(AnyException e)
  396. {
  397. auto& vm = this->vm();
  398. // An early error result for an exception e is a NavigationResult dictionary instance given by
  399. // «[ "committed" → a promise rejected with e, "finished" → a promise rejected with e ]».
  400. auto throw_completion = Bindings::dom_exception_to_throw_completion(vm, e);
  401. return {
  402. .committed = WebIDL::create_rejected_promise(realm(), *throw_completion.value())->promise(),
  403. .finished = WebIDL::create_rejected_promise(realm(), *throw_completion.value())->promise(),
  404. };
  405. }
  406. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#navigation-api-method-tracker-derived-result
  407. NavigationResult navigation_api_method_tracker_derived_result(JS::NonnullGCPtr<NavigationAPIMethodTracker> api_method_tracker)
  408. {
  409. // A navigation API method tracker-derived result for a navigation API method tracker is a NavigationResult
  410. /// dictionary instance given by «[ "committed" apiMethodTracker's committed promise, "finished" → apiMethodTracker's finished promise ]».
  411. return {
  412. api_method_tracker->committed_promise->promise(),
  413. api_method_tracker->finished_promise->promise(),
  414. };
  415. }
  416. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#upcoming-non-traverse-api-method-tracker
  417. JS::NonnullGCPtr<NavigationAPIMethodTracker> Navigation::maybe_set_the_upcoming_non_traverse_api_method_tracker(JS::Value info, Optional<SerializationRecord> serialized_state)
  418. {
  419. auto& realm = relevant_realm(*this);
  420. auto& vm = this->vm();
  421. // To maybe set the upcoming non-traverse API method tracker given a Navigation navigation,
  422. // a JavaScript value info, and a serialized state-or-null serializedState:
  423. // 1. Let committedPromise and finishedPromise be new promises created in navigation's relevant realm.
  424. auto committed_promise = WebIDL::create_promise(realm);
  425. auto finished_promise = WebIDL::create_promise(realm);
  426. // 2. Mark as handled finishedPromise.
  427. // NOTE: The web developer doesn’t necessarily care about finishedPromise being rejected:
  428. // - They might only care about committedPromise.
  429. // - They could be doing multiple synchronous navigations within the same task,
  430. // in which case all but the last will be aborted (causing their finishedPromise to reject).
  431. // This could be an application bug, but also could just be an emergent feature of disparate
  432. // parts of the application overriding each others' actions.
  433. // - They might prefer to listen to other transition-failure signals instead of finishedPromise, e.g.,
  434. // the navigateerror event, or the navigation.transition.finished promise.
  435. // As such, we mark it as handled to ensure that it never triggers unhandledrejection events.
  436. WebIDL::mark_promise_as_handled(finished_promise);
  437. // 3. Let apiMethodTracker be a new navigation API method tracker with:
  438. // navigation object: navigation
  439. // key: null
  440. // info: info
  441. // serialized state: serializedState
  442. // comitted-to entry: null
  443. // comitted promise: committedPromise
  444. // finished promise: finishedPromise
  445. auto api_method_tracker = vm.heap().allocate_without_realm<NavigationAPIMethodTracker>(
  446. /* .navigation = */ *this,
  447. /* .key = */ OptionalNone {},
  448. /* .info = */ info,
  449. /* .serialized_state = */ move(serialized_state),
  450. /* .commited_to_entry = */ nullptr,
  451. /* .committed_promise = */ committed_promise,
  452. /* .finished_promise = */ finished_promise);
  453. // 4. Assert: navigation's upcoming non-traverse API method tracker is null.
  454. VERIFY(m_upcoming_non_traverse_api_method_tracker == nullptr);
  455. // 5. If navigation does not have entries and events disabled,
  456. // then set navigation's upcoming non-traverse API method tracker to apiMethodTracker.
  457. // NOTE: If navigation has entries and events disabled, then committedPromise and finishedPromise will never fulfill
  458. // (since we never create a NavigationHistoryEntry object for such Documents, and so we have nothing to resolve them with);
  459. // there is no NavigationHistoryEntry to apply serializedState to; and there is no navigate event to include info with.
  460. // So, we don't need to track this API method call after all.
  461. if (!has_entries_and_events_disabled())
  462. m_upcoming_non_traverse_api_method_tracker = api_method_tracker;
  463. // 6. Return apiMethodTracker.
  464. return api_method_tracker;
  465. }
  466. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#add-an-upcoming-traverse-api-method-tracker
  467. JS::NonnullGCPtr<NavigationAPIMethodTracker> Navigation::add_an_upcoming_traverse_api_method_tracker(String destination_key, JS::Value info)
  468. {
  469. auto& vm = this->vm();
  470. auto& realm = relevant_realm(*this);
  471. // To add an upcoming traverse API method tracker given a Navigation navigation, a string destinationKey, and a JavaScript value info:
  472. // 1. Let committedPromise and finishedPromise be new promises created in navigation's relevant realm.
  473. auto committed_promise = WebIDL::create_promise(realm);
  474. auto finished_promise = WebIDL::create_promise(realm);
  475. // 2. Mark as handled finishedPromise.
  476. // NOTE: See the previous discussion about why this is done
  477. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#note-mark-as-handled-navigation-api-finished
  478. WebIDL::mark_promise_as_handled(*finished_promise);
  479. // 3. Let apiMethodTracker be a new navigation API method tracker with:
  480. // navigation object: navigation
  481. // key: destinationKey
  482. // info: info
  483. // serialized state: null
  484. // comitted-to entry: null
  485. // comitted promise: committedPromise
  486. // finished promise: finishedPromise
  487. auto api_method_tracker = vm.heap().allocate_without_realm<NavigationAPIMethodTracker>(
  488. /* .navigation = */ *this,
  489. /* .key = */ destination_key,
  490. /* .info = */ info,
  491. /* .serialized_state = */ OptionalNone {},
  492. /* .commited_to_entry = */ nullptr,
  493. /* .committed_promise = */ committed_promise,
  494. /* .finished_promise = */ finished_promise);
  495. // 4. Set navigation's upcoming traverse API method trackers[key] to apiMethodTracker.
  496. // FIXME: Fix spec typo key --> destinationKey
  497. m_upcoming_traverse_api_method_trackers.set(destination_key, api_method_tracker);
  498. // 5. Return apiMethodTracker.
  499. return api_method_tracker;
  500. }
  501. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#performing-a-navigation-api-traversal
  502. WebIDL::ExceptionOr<NavigationResult> Navigation::perform_a_navigation_api_traversal(String key, NavigationOptions const& options)
  503. {
  504. auto& realm = this->realm();
  505. // To perform a navigation API traversal given a Navigation navigation, a string key, and a NavigationOptions options:
  506. // 1. Let document be this's relevant global object's associated Document.
  507. auto& document = verify_cast<HTML::Window>(relevant_global_object(*this)).associated_document();
  508. // 2. If document is not fully active, then return an early error result for an "InvalidStateError" DOMException.
  509. if (!document.is_fully_active())
  510. return early_error_result(WebIDL::InvalidStateError::create(realm, "Document is not fully active"_fly_string));
  511. // 3. If document's unload counter is greater than 0, then return an early error result for an "InvalidStateError" DOMException.
  512. if (document.unload_counter() > 0)
  513. return early_error_result(WebIDL::InvalidStateError::create(realm, "Document already unloaded"_fly_string));
  514. // 4. Let current be the current entry of navigation.
  515. auto current = current_entry();
  516. // 5. If key equals current's session history entry's navigation API key, then return
  517. // «[ "committed" → a promise resolved with current, "finished" → a promise resolved with current ]».
  518. if (key == current->session_history_entry().navigation_api_key) {
  519. return NavigationResult {
  520. .committed = WebIDL::create_resolved_promise(realm, current)->promise(),
  521. .finished = WebIDL::create_resolved_promise(realm, current)->promise()
  522. };
  523. }
  524. // 6. If navigation's upcoming traverse API method trackers[key] exists,
  525. // then return a navigation API method tracker-derived result for navigation's upcoming traverse API method trackers[key].
  526. if (auto maybe_tracker = m_upcoming_traverse_api_method_trackers.get(key); maybe_tracker.has_value())
  527. return navigation_api_method_tracker_derived_result(maybe_tracker.value());
  528. // 7. Let info be options["info"], if it exists; otherwise, undefined.
  529. auto info = options.info.value_or(JS::js_undefined());
  530. // 8. Let apiMethodTracker be the result of adding an upcoming traverse API method tracker for navigation given key and info.
  531. auto api_method_tracker = add_an_upcoming_traverse_api_method_tracker(key, info);
  532. // 9. Let navigable be document's node navigable.
  533. auto navigable = document.navigable();
  534. // 10. Let traversable be navigable's traversable navigable.
  535. auto traversable = navigable->traversable_navigable();
  536. // 11. Let sourceSnapshotParams be the result of snapshotting source snapshot params given document.
  537. auto source_snapshot_params = document.snapshot_source_snapshot_params();
  538. // 12. Append the following session history traversal steps to traversable:
  539. traversable->append_session_history_traversal_steps([key, api_method_tracker, navigable, source_snapshot_params, this] {
  540. // 1. Let navigableSHEs be the result of getting session history entries given navigable.
  541. auto navigable_shes = navigable->get_session_history_entries();
  542. // 2. Let targetSHE be the session history entry in navigableSHEs whose navigation API key is key. If no such entry exists, then:
  543. auto it = navigable_shes.find_if([&key](auto const& entry) {
  544. return entry->navigation_api_key == key;
  545. });
  546. if (it == navigable_shes.end()) {
  547. // NOTE: This path is taken if navigation's entry list was outdated compared to navigableSHEs,
  548. // which can occur for brief periods while all the relevant threads and processes are being synchronized in reaction to a history change.
  549. // 1. Queue a global task on the navigation and traversal task source given navigation's relevant global object
  550. // to reject the finished promise for apiMethodTracker with an "InvalidStateError" DOMException.
  551. queue_global_task(HTML::Task::Source::NavigationAndTraversal, relevant_global_object(*this), [this, api_method_tracker] {
  552. auto& reject_realm = relevant_realm(*this);
  553. WebIDL::reject_promise(reject_realm, api_method_tracker->finished_promise,
  554. WebIDL::InvalidStateError::create(reject_realm, "Cannot traverse with stale session history entry"_fly_string));
  555. });
  556. // 2. Abort these steps.
  557. return;
  558. }
  559. auto target_she = *it;
  560. // 3. If targetSHE is navigable's active session history entry, then abort these steps.
  561. // NOTE: This can occur if a previously queued traversal already took us to this session history entry.
  562. // In that case the previous traversal will have dealt with apiMethodTracker already.
  563. if (target_she == navigable->active_session_history_entry())
  564. return;
  565. // FIXME: 4. Let result be the result of applying the traverse history step given by targetSHE's step to traversable,
  566. // given sourceSnapshotParams, navigable, and "none".
  567. (void)source_snapshot_params;
  568. // NOTE: When result is "canceled-by-beforeunload" or "initiator-disallowed", the navigate event was never fired,
  569. // aborting the ongoing navigation would not be correct; it would result in a navigateerror event without a
  570. // preceding navigate event. In the "canceled-by-navigate" case, navigate is fired, but the inner navigate event
  571. // firing algorithm will take care of aborting the ongoing navigation.
  572. // FIXME: 5. If result is "canceled-by-beforeunload", then queue a global task on the navigation and traversal task source
  573. // given navigation's relevant global object to reject the finished promise for apiMethodTracker with a
  574. // new "AbortError"DOMException created in navigation's relevant realm.
  575. // FIXME: 6. If result is "initiator-disallowed", then queue a global task on the navigation and traversal task source
  576. // given navigation's relevant global object to reject the finished promise for apiMethodTracker with a
  577. // new "SecurityError" DOMException created in navigation's relevant realm.
  578. });
  579. // 13. Return a navigation API method tracker-derived result for apiMethodTracker.
  580. return navigation_api_method_tracker_derived_result(api_method_tracker);
  581. }
  582. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#abort-the-ongoing-navigation
  583. void Navigation::abort_the_ongoing_navigation(Optional<JS::NonnullGCPtr<WebIDL::DOMException>> error)
  584. {
  585. auto& realm = relevant_realm(*this);
  586. // To abort the ongoing navigation given a Navigation navigation and an optional DOMException error:
  587. // 1. Let event be navigation's ongoing navigate event.
  588. auto event = ongoing_navigate_event();
  589. // 2. Assert: event is not null.
  590. VERIFY(event != nullptr);
  591. // 3. Set navigation's focus changed during ongoing navigation to false.
  592. m_focus_changed_during_ongoing_navigation = false;
  593. // 4. Set navigation's suppress normal scroll restoration during ongoing navigation to false.
  594. m_suppress_scroll_restoration_during_ongoing_navigation = false;
  595. // 5. If error was not given, then let error be a new "AbortError" DOMException created in navigation's relevant realm.
  596. if (!error.has_value())
  597. error = WebIDL::AbortError::create(realm, "Navigation aborted"_fly_string);
  598. VERIFY(error.has_value());
  599. // 6. If event's dispatch flag is set, then set event's canceled flag to true.
  600. if (event->dispatched())
  601. event->set_cancelled(true);
  602. // 7. Signal abort on event's abort controller given error.
  603. event->abort_controller()->abort(error.value());
  604. // 8. Set navigation's ongoing navigate event to null.
  605. m_ongoing_navigate_event = nullptr;
  606. // 9. Fire an event named navigateerror at navigation using ErrorEvent, with error initialized to error,
  607. // and message, filename, lineno, and colno initialized to appropriate values that can be extracted
  608. // from error and the current JavaScript stack in the same underspecified way that the report the exception algorithm does.
  609. ErrorEventInit event_init = {};
  610. event_init.error = error.value();
  611. // FIXME: Extract information from the exception and the JS context in the wishy-washy way the spec says here.
  612. event_init.filename = String {};
  613. event_init.colno = 0;
  614. event_init.lineno = 0;
  615. event_init.message = String {};
  616. dispatch_event(ErrorEvent::create(realm, EventNames::navigateerror, event_init));
  617. // 10. If navigation's ongoing API method tracker is non-null, then reject the finished promise for apiMethodTracker with error.
  618. if (m_ongoing_api_method_tracker != nullptr)
  619. WebIDL::reject_promise(realm, m_ongoing_api_method_tracker->finished_promise, error.value());
  620. // 11. If navigation's transition is not null, then:
  621. if (m_transition != nullptr) {
  622. // 1. Reject navigation's transition's finished promise with error.
  623. m_transition->finished()->reject(error.value());
  624. // 2. Set navigation's transition to null.
  625. m_transition = nullptr;
  626. }
  627. }
  628. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#promote-an-upcoming-api-method-tracker-to-ongoing
  629. void Navigation::promote_an_upcoming_api_method_tracker_to_ongoing(Optional<String> destination_key)
  630. {
  631. // 1. Assert: navigation's ongoing API method tracker is null.
  632. VERIFY(m_ongoing_api_method_tracker == nullptr);
  633. // 2. If destinationKey is not null, then:
  634. if (destination_key.has_value()) {
  635. // 1. Assert: navigation's upcoming non-traverse API method tracker is null.
  636. VERIFY(m_upcoming_non_traverse_api_method_tracker == nullptr);
  637. // 2. If navigation's upcoming traverse API method trackers[destinationKey] exists, then:
  638. if (auto tracker = m_upcoming_traverse_api_method_trackers.get(destination_key.value()); tracker.has_value()) {
  639. // 1. Set navigation's ongoing API method tracker to navigation's upcoming traverse API method trackers[destinationKey].
  640. m_ongoing_api_method_tracker = tracker.value();
  641. // 2. Remove navigation's upcoming traverse API method trackers[destinationKey].
  642. m_upcoming_traverse_api_method_trackers.remove(destination_key.value());
  643. }
  644. }
  645. // 3. Otherwise:
  646. else {
  647. VERIFY(m_upcoming_non_traverse_api_method_tracker != nullptr);
  648. // 1. Set navigation's ongoing API method tracker to navigation's upcoming non-traverse API method tracker.
  649. m_ongoing_api_method_tracker = m_upcoming_non_traverse_api_method_tracker;
  650. // 2. Set navigation's upcoming non-traverse API method tracker to null.
  651. m_upcoming_non_traverse_api_method_tracker = nullptr;
  652. }
  653. }
  654. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#navigation-api-method-tracker-clean-up
  655. void Navigation::clean_up(JS::NonnullGCPtr<NavigationAPIMethodTracker> api_method_tracker)
  656. {
  657. // 1. Let navigation be apiMethodTracker's navigation object.
  658. VERIFY(api_method_tracker->navigation == this);
  659. // 2. If navigation's ongoing API method tracker is apiMethodTracker, then set navigation's ongoing API method tracker to null.
  660. if (m_ongoing_api_method_tracker == api_method_tracker) {
  661. m_ongoing_api_method_tracker = nullptr;
  662. }
  663. // 3. Otherwise:
  664. else {
  665. // 1. Let key be apiMethodTracker's key.
  666. auto& key = api_method_tracker->key;
  667. // 2. Assert: key is not null.
  668. VERIFY(key.has_value());
  669. // 3. Assert: navigation's upcoming traverse API method trackers[key] exists.
  670. VERIFY(m_upcoming_traverse_api_method_trackers.contains(*key));
  671. // 4. Remove navigation's upcoming traverse API method trackers[key].
  672. m_upcoming_traverse_api_method_trackers.remove(*key);
  673. }
  674. }
  675. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#resolve-the-finished-promise
  676. void Navigation::resolve_the_finished_promise(JS::NonnullGCPtr<NavigationAPIMethodTracker> api_method_tracker)
  677. {
  678. auto& realm = this->realm();
  679. // 1. Resolve apiMethodTracker's committed promise with its committed-to entry.
  680. // NOTE: Usually, notify about the committed-to entry has previously been called on apiMethodTracker,
  681. // and so this will do nothing. However, in some cases resolve the finished promise is called
  682. // directly, in which case this step is necessary.
  683. WebIDL::resolve_promise(realm, api_method_tracker->committed_promise, api_method_tracker->commited_to_entry);
  684. // 2. Resolve apiMethodTracker's finished promise with its committed-to entry.
  685. WebIDL::resolve_promise(realm, api_method_tracker->finished_promise, api_method_tracker->commited_to_entry);
  686. // 3. Clean up apiMethodTracker.
  687. clean_up(api_method_tracker);
  688. }
  689. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#reject-the-finished-promise
  690. void Navigation::reject_the_finished_promise(JS::NonnullGCPtr<NavigationAPIMethodTracker> api_method_tracker, JS::Value exception)
  691. {
  692. auto& realm = this->realm();
  693. // 1. Reject apiMethodTracker's committed promise with exception.
  694. // NOTE: This will do nothing if apiMethodTracker's committed promise was previously resolved
  695. // via notify about the committed-to entry.
  696. WebIDL::reject_promise(realm, api_method_tracker->committed_promise, exception);
  697. // 2. Reject apiMethodTracker's finished promise with exception.
  698. WebIDL::reject_promise(realm, api_method_tracker->finished_promise, exception);
  699. // 3. Clean up apiMethodTracker.
  700. clean_up(api_method_tracker);
  701. }
  702. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#inner-navigate-event-firing-algorithm
  703. bool Navigation::inner_navigate_event_firing_algorithm(
  704. Bindings::NavigationType navigation_type,
  705. JS::NonnullGCPtr<NavigationDestination> destination,
  706. UserNavigationInvolvement user_involvement,
  707. Optional<Vector<XHR::FormDataEntry>&> form_data_entry_list,
  708. Optional<String> download_request_filename,
  709. Optional<SerializationRecord> classic_history_api_state)
  710. {
  711. auto& realm = relevant_realm(*this);
  712. // 1. If navigation has entries and events disabled, then:
  713. // NOTE: These assertions holds because traverseTo(), back(), and forward() will immediately fail when entries and events are disabled
  714. // (since there are no entries to traverse to), and if our starting point is instead navigate() or reload(),
  715. // then we avoided setting the upcoming non-traverse API method tracker in the first place.
  716. if (has_entries_and_events_disabled()) {
  717. // 1. Assert: navigation's ongoing API method tracker is null.
  718. VERIFY(m_ongoing_api_method_tracker == nullptr);
  719. // 2. Assert: navigation's upcoming non-traverse API method tracker is null.
  720. VERIFY(m_upcoming_non_traverse_api_method_tracker == nullptr);
  721. // 3. Assert: navigation's upcoming traverse API method trackers is empty.
  722. VERIFY(m_upcoming_traverse_api_method_trackers.is_empty());
  723. // 4. Return true.
  724. return true;
  725. }
  726. // 2. Let destinationKey be null.
  727. Optional<String> destination_key = {};
  728. // 3. If destination's entry is non-null, then set destinationKey to destination's entry's key.
  729. if (destination->navigation_history_entry() != nullptr)
  730. destination_key = destination->navigation_history_entry()->key();
  731. // 4. Assert: destinationKey is not the empty string.
  732. VERIFY(destination_key != ""sv);
  733. // 5. Promote an upcoming API method tracker to ongoing given navigation and destinationKey.
  734. promote_an_upcoming_api_method_tracker_to_ongoing(destination_key);
  735. // 6. Let apiMethodTracker be navigation's ongoing API method tracker.
  736. auto api_method_tracker = m_ongoing_api_method_tracker;
  737. // 7. Let navigable be navigation's relevant global object's navigable.
  738. auto& relevant_global_object = verify_cast<HTML::Window>(Web::HTML::relevant_global_object(*this));
  739. auto navigable = relevant_global_object.navigable();
  740. // 8. Let document be navigation's relevant global object's associated Document.
  741. auto& document = relevant_global_object.associated_document();
  742. // Note: We create the Event in this algorithm instead of passing it in,
  743. // and have all the following "initialize" steps set up the event init
  744. NavigateEventInit event_init = {};
  745. // 9. If document can have its URL rewritten to destination's URL,
  746. // and either destination's is same document is true or navigationType is not "traverse",
  747. // then initialize event's canIntercept to true. Otherwise, initialize it to false.
  748. event_init.can_intercept = can_have_its_url_rewritten(document, destination->raw_url()) && (destination->same_document() || navigation_type != Bindings::NavigationType::Traverse);
  749. // 10. Let traverseCanBeCanceled be true if all of the following are true:
  750. // - navigable is a top-level traversable;
  751. // - destination's is same document is true; and
  752. // - either userInvolvement is not "browser UI", or navigation's relevant global object has transient activation.
  753. // Otherwise, let it be false.
  754. bool const traverse_can_be_canceled = navigable->is_top_level_traversable()
  755. && destination->same_document()
  756. && (user_involvement != UserNavigationInvolvement::BrowserUI || relevant_global_object.has_transient_activation());
  757. // FIXME: Fix spec grammaro, extra 'the -> set'
  758. // 11. If either:
  759. // - navigationType is not "traverse"; or
  760. // - traverseCanBeCanceled is true
  761. // the initialize event's cancelable to true. Otherwise, initialize it to false.
  762. event_init.cancelable = (navigation_type != Bindings::NavigationType::Traverse) || traverse_can_be_canceled;
  763. // 12. Initialize event's type to "navigate".
  764. // AD-HOC: Happens later, when calling the factory function
  765. // 13. Initialize event's navigationType to navigationType.
  766. event_init.navigation_type = navigation_type;
  767. // 14. Initialize event's destination to destination.
  768. event_init.destination = destination;
  769. // 15. Initialize event's downloadRequest to downloadRequestFilename.
  770. event_init.download_request = move(download_request_filename);
  771. // 16. If apiMethodTracker is not null, then initialize event's info to apiMethodTracker's info. Otherwise, initialize it to undefined.
  772. // NOTE: At this point apiMethodTracker's info is no longer needed and can be nulled out instead of keeping it alive for the lifetime of the navigation API method tracker.
  773. if (api_method_tracker) {
  774. event_init.info = api_method_tracker->info;
  775. api_method_tracker->info = JS::js_undefined();
  776. } else {
  777. event_init.info = JS::js_undefined();
  778. }
  779. // FIXME: 17: Initialize event's hasUAVisualTransition to true if a visual transition, to display a cached rendered state
  780. // of the document's latest entry, was done by the user agent. Otherwise, initialize it to false.
  781. event_init.has_ua_visual_transition = false;
  782. // 18. Set event's abort controller to a new AbortController created in navigation's relevant realm.
  783. // AD-HOC: Set on the NavigateEvent later after construction
  784. auto abort_controller = MUST(DOM::AbortController::construct_impl(realm));
  785. // 19. Initialize event's signal to event's abort controller's signal.
  786. event_init.signal = abort_controller->signal();
  787. // 20. Let currentURL be document's URL.
  788. auto current_url = document.url();
  789. // 21. If all of the following are true:
  790. // - destination's is same document is true;
  791. // - destination's URL equals currentURL with exclude fragments set to true; and
  792. // - destination's URL's fragment is not identical to currentURL's fragment,
  793. // then initialize event's hashChange to true. Otherwise, initialize it to false.
  794. event_init.hash_change = (destination->same_document()
  795. && destination->raw_url().equals(current_url, AK::URL::ExcludeFragment::Yes)
  796. && destination->raw_url().fragment() != current_url.fragment());
  797. // 22. If userInvolvement is not "none", then initialize event's userInitiated to true. Otherwise, initialize it to false.
  798. event_init.user_initiated = user_involvement != UserNavigationInvolvement::None;
  799. // 23. If formDataEntryList is not null, then initialize event's formData to a new FormData created in navigation's relevant realm,
  800. // associated to formDataEntryList. Otherwise, initialize it to null.
  801. if (form_data_entry_list.has_value()) {
  802. event_init.form_data = MUST(XHR::FormData::construct_impl(realm, form_data_entry_list.release_value()));
  803. } else {
  804. event_init.form_data = nullptr;
  805. }
  806. // AD-HOC: *Now* we have all the info required to create the event
  807. auto event = NavigateEvent::construct_impl(realm, EventNames::navigate, event_init);
  808. event->set_abort_controller(abort_controller);
  809. // AD-HOC: This is supposed to be set in "fire a <type> navigate event", and is only non-null when
  810. // we're doing a push or replace. We set it here because we create the event here
  811. event->set_classic_history_api_state(move(classic_history_api_state));
  812. // 24. Assert: navigation's ongoing navigate event is null.
  813. VERIFY(m_ongoing_navigate_event == nullptr);
  814. // 25. Set navigation's ongoing navigate event to event.
  815. m_ongoing_navigate_event = event;
  816. // 26. Set navigation's focus changed during ongoing navigation to false.
  817. m_focus_changed_during_ongoing_navigation = false;
  818. // 27. Set navigation's suppress normal scroll restoration during ongoing navigation to false.
  819. m_suppress_scroll_restoration_during_ongoing_navigation = false;
  820. // 28. Let dispatchResult be the result of dispatching event at navigation.
  821. auto dispatch_result = dispatch_event(*event);
  822. // 29. If dispatchResult is false:
  823. if (!dispatch_result) {
  824. // FIXME: 1. If navigationType is "traverse", then consume history-action user activation.
  825. // 2. If event's abort controller's signal is not aborted, then abort the ongoing navigation given navigation.
  826. if (!event->abort_controller()->signal()->aborted())
  827. abort_the_ongoing_navigation();
  828. // 3. Return false.
  829. return false;
  830. }
  831. // 30. Let endResultIsSameDocument be true if event's interception state
  832. // is not "none" or event's destination's is same document is true.
  833. bool const end_result_is_same_document = (event->interception_state() != NavigateEvent::InterceptionState::None) || event->destination()->same_document();
  834. // 31. Prepare to run script given navigation's relevant settings object.
  835. // NOTE: There's a massive spec note here
  836. relevant_settings_object(*this).prepare_to_run_script();
  837. // 32. If event's interception state is not "none":
  838. if (event->interception_state() != NavigateEvent::InterceptionState::None) {
  839. // 1. Set event's interception state to "committed".
  840. event->set_interception_state(NavigateEvent::InterceptionState::Committed);
  841. // 2. Let fromNHE be the current entry of navigation.
  842. auto from_nhe = current_entry();
  843. // 3. Assert: fromNHE is not null.
  844. VERIFY(from_nhe != nullptr);
  845. // 4. Set navigation's transition to a new NavigationTransition created in navigation's relevant realm,
  846. // whose navigation type is navigationType, from entry is fromNHE, and whose finished promise is a new promise
  847. // created in navigation's relevant realm.
  848. m_transition = NavigationTransition::create(realm, navigation_type, *from_nhe, JS::Promise::create(realm));
  849. // 5. Mark as handled navigation's transition's finished promise.
  850. m_transition->finished()->set_is_handled();
  851. // 6. If navigationType is "traverse", then set navigation's suppress normal scroll restoration during ongoing navigation to true.
  852. // NOTE: If event's scroll behavior was set to "after-transition", then scroll restoration will happen as part of finishing
  853. // the relevant NavigateEvent. Otherwise, there will be no scroll restoration. That is, no navigation which is intercepted
  854. // by intercept() goes through the normal scroll restoration process; scroll restoration for such navigations
  855. // is either done manually, by the web developer, or is done after the transition.
  856. if (navigation_type == Bindings::NavigationType::Traverse)
  857. m_suppress_scroll_restoration_during_ongoing_navigation = true;
  858. // FIXME: Fix spec typo "serialied"
  859. // 7. If navigationType is "push" or "replace", then run the URL and history update steps given document and
  860. // event's destination's URL, with serialiedData set to event's classic history API state and historyHandling
  861. // set to navigationType.
  862. // FIXME: Pass the serialized data to this algorithm
  863. if (navigation_type == Bindings::NavigationType::Push || navigation_type == Bindings::NavigationType::Replace) {
  864. auto history_handling = navigation_type == Bindings::NavigationType::Push ? HistoryHandlingBehavior::Push : HistoryHandlingBehavior::Replace;
  865. perform_url_and_history_update_steps(document, event->destination()->raw_url(), history_handling);
  866. }
  867. // Big spec note about reload here
  868. }
  869. // 33. If endResultIsSameDocument is true:
  870. if (end_result_is_same_document) {
  871. // 1. Let promisesList be an empty list.
  872. JS::MarkedVector<JS::NonnullGCPtr<WebIDL::Promise>> promises_list(realm.heap());
  873. // 2. For each handler of event's navigation handler list:
  874. for (auto const& handler : event->navigation_handler_list()) {
  875. // 1. Append the result of invoking handler with an empty arguments list to promisesList.
  876. auto result = WebIDL::invoke_callback(handler, {});
  877. if (result.is_abrupt()) {
  878. // FIXME: https://github.com/whatwg/html/issues/9774
  879. report_exception(result.release_error(), realm);
  880. continue;
  881. }
  882. // This *should* be equivalent to converting a promise to a promise capability
  883. promises_list.append(WebIDL::create_resolved_promise(realm, result.value().value()));
  884. }
  885. // 3. If promisesList's size is 0, then set promisesList to « a promise resolved with undefined ».
  886. // NOTE: There is a subtle timing difference between how waiting for all schedules its success and failure
  887. // steps when given zero promises versus ≥1 promises. For most uses of waiting for all, this does not matter.
  888. // However, with this API, there are so many events and promise handlers which could fire around the same time
  889. // that the difference is pretty easily observable: it can cause the event/promise handler sequence to vary.
  890. // (Some of the events and promises involved include: navigatesuccess / navigateerror, currententrychange,
  891. // dispose, apiMethodTracker's promises, and the navigation.transition.finished promise.)
  892. if (promises_list.size() == 0) {
  893. promises_list.append(WebIDL::create_resolved_promise(realm, JS::js_undefined()));
  894. }
  895. // 4. Wait for all of promisesList, with the following success steps:
  896. WebIDL::wait_for_all(
  897. realm, promises_list, [&](JS::MarkedVector<JS::Value> const&) -> void {
  898. // FIXME: Spec issue: Event's relevant global objects' *associated document*
  899. // 1. If event's relevant global object is not fully active, then abort these steps.
  900. if (!relevant_global_object.associated_document().is_fully_active())
  901. return;
  902. // 2. If event's abort controller's signal is aborted, then abort these steps.
  903. if (event->abort_controller()->signal()->aborted())
  904. return;
  905. // 3. Assert: event equals navigation's ongoing navigate event.
  906. VERIFY(event == m_ongoing_navigate_event);
  907. // 4. Set navigation's ongoing navigate event to null.
  908. m_ongoing_navigate_event = nullptr;
  909. // 5. Finish event given true.
  910. event->finish(true);
  911. // FIXME: Implement https://dom.spec.whatwg.org/#concept-event-fire somewhere
  912. // 6. Fire an event named navigatesuccess at navigation.
  913. dispatch_event(DOM::Event::create(realm, EventNames::navigatesuccess));
  914. // 7. If navigation's transition is not null, then resolve navigation's transition's finished promise with undefined.
  915. if (m_transition != nullptr)
  916. m_transition->finished()->fulfill(JS::js_undefined());
  917. // 8. Set navigation's transition to null.
  918. m_transition = nullptr;
  919. // 9. If apiMethodTracker is non-null, then resolve the finished promise for apiMethodTracker.
  920. if (api_method_tracker)
  921. resolve_the_finished_promise(*api_method_tracker); },
  922. // and the following failure steps given reason rejectionReason:
  923. [&](JS::Value rejection_reason) -> void {
  924. // FIXME: Spec issue: Event's relevant global objects' *associated document*
  925. // 1. If event's relevant global object is not fully active, then abort these steps.
  926. if (!relevant_global_object.associated_document().is_fully_active())
  927. return;
  928. // 2. If event's abort controller's signal is aborted, then abort these steps.
  929. if (event->abort_controller()->signal()->aborted())
  930. return;
  931. // 3. Assert: event equals navigation's ongoing navigate event.
  932. VERIFY(event == m_ongoing_navigate_event);
  933. // 4. Set navigation's ongoing navigate event to null.
  934. m_ongoing_navigate_event = nullptr;
  935. // 5. Finish event given false.
  936. event->finish(false);
  937. // 6. Fire an event named navigateerror at navigation using ErrorEvent, with error initialized to rejectionReason, and message,
  938. // filename, lineno, and colno initialized to appropriate values that can be extracted from rejectionReason in the same
  939. // underspecified way that the report the exception algorithm does.
  940. ErrorEventInit event_init = {};
  941. event_init.error = rejection_reason;
  942. // FIXME: Extract information from the exception and the JS context in the wishy-washy way the spec says here.
  943. event_init.filename = String {};
  944. event_init.colno = 0;
  945. event_init.lineno = 0;
  946. event_init.message = String {};
  947. dispatch_event(ErrorEvent::create(realm, EventNames::navigateerror, event_init));
  948. // 7. If navigation's transition is not null, then reject navigation's transition's finished promise with rejectionReason.
  949. if (m_transition)
  950. m_transition->finished()->reject(rejection_reason);
  951. // 8. Set navigation's transition to null.
  952. m_transition = nullptr;
  953. // 9. If apiMethodTracker is non-null, then reject the finished promise for apiMethodTracker with rejectionReason.
  954. if (api_method_tracker)
  955. reject_the_finished_promise(*api_method_tracker, rejection_reason);
  956. });
  957. }
  958. // 34. Otherwise, if apiMethodTracker is non-null, then clean up apiMethodTracker.
  959. else if (api_method_tracker) {
  960. clean_up(*api_method_tracker);
  961. }
  962. // 35. Clean up after running script given navigation's relevant settings object.
  963. relevant_settings_object(*this).clean_up_after_running_script();
  964. // 36. If event's interception state is "none", then return true.
  965. // 37. Return false.
  966. return event->interception_state() == NavigateEvent::InterceptionState::None;
  967. }
  968. }