Navigable.cpp 64 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332
  1. /*
  2. * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2023, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #include <LibWeb/Crypto/Crypto.h>
  8. #include <LibWeb/DOM/Document.h>
  9. #include <LibWeb/DOM/DocumentLoading.h>
  10. #include <LibWeb/Fetch/Fetching/Fetching.h>
  11. #include <LibWeb/Fetch/Infrastructure/FetchAlgorithms.h>
  12. #include <LibWeb/Fetch/Infrastructure/FetchController.h>
  13. #include <LibWeb/Fetch/Infrastructure/URL.h>
  14. #include <LibWeb/HTML/BrowsingContext.h>
  15. #include <LibWeb/HTML/DocumentState.h>
  16. #include <LibWeb/HTML/HistoryHandlingBehavior.h>
  17. #include <LibWeb/HTML/Navigable.h>
  18. #include <LibWeb/HTML/Navigation.h>
  19. #include <LibWeb/HTML/NavigationParams.h>
  20. #include <LibWeb/HTML/POSTResource.h>
  21. #include <LibWeb/HTML/SandboxingFlagSet.h>
  22. #include <LibWeb/HTML/SessionHistoryEntry.h>
  23. #include <LibWeb/HTML/StructuredSerialize.h>
  24. #include <LibWeb/HTML/TraversableNavigable.h>
  25. #include <LibWeb/Infra/Strings.h>
  26. #include <LibWeb/Platform/EventLoopPlugin.h>
  27. #include <LibWeb/XHR/FormData.h>
  28. namespace Web::HTML {
  29. class ResponseHolder : public JS::Cell {
  30. JS_CELL(ResponseHolder, JS::Cell);
  31. public:
  32. [[nodiscard]] static JS::NonnullGCPtr<ResponseHolder> create(JS::VM& vm)
  33. {
  34. return vm.heap().allocate_without_realm<ResponseHolder>();
  35. }
  36. [[nodiscard]] JS::GCPtr<Fetch::Infrastructure::Response> response() const { return m_response; }
  37. void set_response(JS::GCPtr<Fetch::Infrastructure::Response> response) { m_response = response; }
  38. virtual void visit_edges(Cell::Visitor& visitor) override
  39. {
  40. visitor.visit(m_response);
  41. }
  42. private:
  43. JS::GCPtr<Fetch::Infrastructure::Response> m_response;
  44. };
  45. static HashTable<Navigable*>& all_navigables()
  46. {
  47. static HashTable<Navigable*> set;
  48. return set;
  49. }
  50. // https://html.spec.whatwg.org/multipage/document-sequences.html#child-navigable
  51. Vector<JS::Handle<Navigable>> Navigable::child_navigables() const
  52. {
  53. Vector<JS::Handle<Navigable>> results;
  54. for (auto& entry : all_navigables()) {
  55. if (entry->parent() == this)
  56. results.append(entry);
  57. }
  58. return results;
  59. }
  60. Navigable::Navigable()
  61. {
  62. all_navigables().set(this);
  63. }
  64. Navigable::~Navigable()
  65. {
  66. all_navigables().remove(this);
  67. }
  68. void Navigable::visit_edges(Cell::Visitor& visitor)
  69. {
  70. Base::visit_edges(visitor);
  71. visitor.visit(m_parent);
  72. visitor.visit(m_current_session_history_entry);
  73. visitor.visit(m_active_session_history_entry);
  74. visitor.visit(m_container);
  75. }
  76. JS::GCPtr<Navigable> Navigable::navigable_with_active_document(JS::NonnullGCPtr<DOM::Document> document)
  77. {
  78. for (auto* navigable : all_navigables()) {
  79. if (navigable->active_document() == document)
  80. return navigable;
  81. }
  82. return nullptr;
  83. }
  84. // https://html.spec.whatwg.org/multipage/document-sequences.html#initialize-the-navigable
  85. ErrorOr<void> Navigable::initialize_navigable(JS::NonnullGCPtr<DocumentState> document_state, JS::GCPtr<Navigable> parent)
  86. {
  87. static int next_id = 0;
  88. m_id = TRY(String::number(next_id++));
  89. // 1. Let entry be a new session history entry, with
  90. JS::NonnullGCPtr<SessionHistoryEntry> entry = *heap().allocate_without_realm<SessionHistoryEntry>();
  91. // URL: document's URL
  92. entry->url = document_state->document()->url();
  93. // document state: documentState
  94. entry->document_state = document_state;
  95. // 2. Set navigable's current session history entry to entry.
  96. m_current_session_history_entry = entry;
  97. // 3. Set navigable's active session history entry to entry.
  98. m_active_session_history_entry = entry;
  99. // 4. Set navigable's parent to parent.
  100. m_parent = parent;
  101. return {};
  102. }
  103. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-the-target-history-entry
  104. JS::GCPtr<SessionHistoryEntry> Navigable::get_the_target_history_entry(int target_step) const
  105. {
  106. // 1. Let entries be the result of getting session history entries for navigable.
  107. auto& entries = get_session_history_entries();
  108. // 2. Return the item in entries that has the greatest step less than or equal to step.
  109. JS::GCPtr<SessionHistoryEntry> result = nullptr;
  110. for (auto& entry : entries) {
  111. auto entry_step = entry->step.get<int>();
  112. if (entry_step <= target_step) {
  113. if (!result || result->step.get<int>() < entry_step) {
  114. result = entry;
  115. }
  116. }
  117. }
  118. return result;
  119. }
  120. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#activate-history-entry
  121. void Navigable::activate_history_entry(JS::GCPtr<SessionHistoryEntry> entry)
  122. {
  123. // FIXME: 1. Save persisted state to the navigable's active session history entry.
  124. // 2. Let newDocument be entry's document.
  125. JS::GCPtr<DOM::Document> new_document = entry->document_state->document().ptr();
  126. // 3. Assert: newDocument's is initial about:blank is false, i.e., we never traverse
  127. // back to the initial about:blank Document because it always gets replaced when we
  128. // navigate away from it.
  129. VERIFY(!new_document->is_initial_about_blank());
  130. // 4. Set navigable's active session history entry to entry.
  131. m_active_session_history_entry = entry;
  132. // 5. Make active newDocument.
  133. new_document->make_active();
  134. // Not in the spec:
  135. if (is<TraversableNavigable>(*this) && parent() == nullptr) {
  136. if (auto* page = active_browsing_context()->page()) {
  137. page->client().page_did_start_loading(entry->url, false);
  138. }
  139. }
  140. }
  141. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-document
  142. JS::GCPtr<DOM::Document> Navigable::active_document()
  143. {
  144. // A navigable's active document is its active session history entry's document.
  145. return m_active_session_history_entry->document_state->document();
  146. }
  147. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-bc
  148. JS::GCPtr<BrowsingContext> Navigable::active_browsing_context()
  149. {
  150. // A navigable's active browsing context is its active document's browsing context.
  151. // If this navigable is a traversable navigable, then its active browsing context will be a top-level browsing context.
  152. if (auto document = active_document())
  153. return document->browsing_context();
  154. return nullptr;
  155. }
  156. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-wp
  157. JS::GCPtr<HTML::WindowProxy> Navigable::active_window_proxy()
  158. {
  159. // A navigable's active WindowProxy is its active browsing context's associated WindowProxy.
  160. if (auto browsing_context = active_browsing_context())
  161. return browsing_context->window_proxy();
  162. return nullptr;
  163. }
  164. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-window
  165. JS::GCPtr<HTML::Window> Navigable::active_window()
  166. {
  167. // A navigable's active window is its active WindowProxy's [[Window]].
  168. if (auto window_proxy = active_window_proxy())
  169. return window_proxy->window();
  170. return nullptr;
  171. }
  172. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-target
  173. String Navigable::target_name() const
  174. {
  175. // A navigable's target name is its active session history entry's document state's navigable target name.
  176. return active_session_history_entry()->document_state->navigable_target_name();
  177. }
  178. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-container
  179. JS::GCPtr<NavigableContainer> Navigable::container() const
  180. {
  181. // The container of a navigable navigable is the navigable container whose nested navigable is navigable, or null if there is no such element.
  182. return NavigableContainer::navigable_container_with_content_navigable(const_cast<Navigable&>(*this));
  183. }
  184. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-container-document
  185. JS::GCPtr<DOM::Document> Navigable::container_document() const
  186. {
  187. auto container = this->container();
  188. // 1. If navigable's container is null, then return null.
  189. if (!container)
  190. return nullptr;
  191. // 2. Return navigable's container's node document.
  192. return container->document();
  193. }
  194. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-traversable
  195. JS::GCPtr<TraversableNavigable> Navigable::traversable_navigable() const
  196. {
  197. // 1. Let navigable be inputNavigable.
  198. auto navigable = const_cast<Navigable*>(this);
  199. // 2. While navigable is not a traversable navigable, set navigable to navigable's parent.
  200. while (navigable && !is<TraversableNavigable>(*navigable))
  201. navigable = navigable->parent();
  202. // 3. Return navigable.
  203. return static_cast<TraversableNavigable*>(navigable);
  204. }
  205. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-top
  206. JS::GCPtr<TraversableNavigable> Navigable::top_level_traversable()
  207. {
  208. // 1. Let navigable be inputNavigable.
  209. auto navigable = this;
  210. // 2. While navigable's parent is not null, set navigable to navigable's parent.
  211. while (navigable->parent())
  212. navigable = navigable->parent();
  213. // 3. Return navigable.
  214. return verify_cast<TraversableNavigable>(navigable);
  215. }
  216. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#set-the-ongoing-navigation
  217. void Navigable::set_ongoing_navigation(Variant<Empty, Traversal, String> ongoing_navigation)
  218. {
  219. // 1. If navigable's ongoing navigation is equal to newValue, then return.
  220. if (m_ongoing_navigation == ongoing_navigation)
  221. return;
  222. // FIXME: 2. Inform the navigation API about aborting navigation given navigable.
  223. // 3. Set navigable's ongoing navigation to newValue.
  224. m_ongoing_navigation = ongoing_navigation;
  225. }
  226. Navigable::ChosenNavigable Navigable::choose_a_navigable(StringView name, TokenizedFeature::NoOpener, ActivateTab)
  227. {
  228. // 1. Let chosen be null.
  229. JS::GCPtr<Navigable> chosen = nullptr;
  230. // 2. Let windowType be "existing or none".
  231. auto window_type = WindowType::ExistingOrNone;
  232. // 3. Let sandboxingFlagSet be current's active document's active sandboxing flag set.
  233. [[maybe_unused]] auto sandboxing_flag_set = active_document()->active_sandboxing_flag_set();
  234. // 4. If name is the empty string or an ASCII case-insensitive match for "_self", then set chosen to currentNavigable.
  235. if (name.is_empty() || Infra::is_ascii_case_insensitive_match(name, "_self"sv)) {
  236. chosen = this;
  237. }
  238. // 5. Otherwise, if name is an ASCII case-insensitive match for "_parent",
  239. // set chosen to currentNavigable's parent, if any, and currentNavigable otherwise.
  240. else if (Infra::is_ascii_case_insensitive_match(name, "_parent"sv)) {
  241. if (auto parent = this->parent())
  242. chosen = parent;
  243. else
  244. chosen = this;
  245. }
  246. // 6. Otherwise, if name is an ASCII case-insensitive match for "_top",
  247. // set chosen to currentNavigable's traversable navigable.
  248. else if (Infra::is_ascii_case_insensitive_match(name, "_top"sv)) {
  249. chosen = traversable_navigable();
  250. }
  251. // 7. Otherwise, if name is not an ASCII case-insensitive match for "_blank",
  252. // there exists a navigable whose target name is the same as name, currentNavigable's
  253. // active browsing context is familiar with that navigable's active browsing context,
  254. // and the user agent determines that the two browsing contexts are related enough that
  255. // it is ok if they reach each other, set chosen to that navigable. If there are multiple
  256. // matching navigables, the user agent should pick one in some arbitrary consistent manner,
  257. // such as the most recently opened, most recently focused, or more closely related, and set
  258. // chosen to it.
  259. else if (!Infra::is_ascii_case_insensitive_match(name, "_blank"sv)) {
  260. TODO();
  261. }
  262. // Otherwise, a new top-level traversable is being requested, and what happens depends on the
  263. // user agent's configuration and abilities — it is determined by the rules given for the first
  264. // applicable option from the following list:
  265. else {
  266. TODO();
  267. }
  268. return { chosen.ptr(), window_type };
  269. }
  270. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-session-history-entries
  271. Vector<JS::NonnullGCPtr<SessionHistoryEntry>>& Navigable::get_session_history_entries() const
  272. {
  273. // 1. Let traversable be navigable's traversable navigable.
  274. auto traversable = traversable_navigable();
  275. // FIXME 2. Assert: this is running within traversable's session history traversal queue.
  276. // 3. If navigable is traversable, return traversable's session history entries.
  277. if (this == traversable)
  278. return traversable->session_history_entries();
  279. // 4. Let docStates be an empty ordered set of document states.
  280. Vector<JS::GCPtr<DocumentState>> doc_states;
  281. // 5. For each entry of traversable's session history entries, append entry's document state to docStates.
  282. for (auto& entry : traversable->session_history_entries())
  283. doc_states.append(entry->document_state);
  284. // 6. For each docState of docStates:
  285. while (!doc_states.is_empty()) {
  286. auto doc_state = doc_states.take_first();
  287. // 1. For each nestedHistory of docState's nested histories:
  288. for (auto& nested_history : doc_state->nested_histories()) {
  289. // 1. If nestedHistory's id equals navigable's id, return nestedHistory's entries.
  290. if (nested_history.id == id())
  291. return nested_history.entries;
  292. // 2. For each entry of nestedHistory's entries, append entry's document state to docStates.
  293. for (auto& entry : nested_history.entries)
  294. doc_states.append(entry->document_state);
  295. }
  296. }
  297. VERIFY_NOT_REACHED();
  298. }
  299. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#create-navigation-params-from-a-srcdoc-resource
  300. static WebIDL::ExceptionOr<NavigationParams> create_navigation_params_from_a_srcdoc_resource(JS::GCPtr<SessionHistoryEntry> entry, JS::GCPtr<Navigable> navigable, SourceSnapshotParams const&, Optional<String> navigation_id)
  301. {
  302. auto& vm = navigable->vm();
  303. auto& realm = navigable->active_window()->realm();
  304. // 1. Let documentResource be entry's document state's resource.
  305. auto document_resource = entry->document_state->resource();
  306. VERIFY(document_resource.has<String>());
  307. // 2. Let response be a new response with
  308. // URL: about:srcdoc
  309. // header list: (`Content-Type`, `text/html`)
  310. // body: the UTF-8 encoding of documentResource, as a body
  311. auto response = Fetch::Infrastructure::Response::create(vm);
  312. response->url_list().append(AK::URL("about:srcdoc"));
  313. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, "text/html"sv));
  314. TRY_OR_THROW_OOM(vm, response->header_list()->append(move(header)));
  315. response->set_body(TRY(Fetch::Infrastructure::byte_sequence_as_body(realm, document_resource.get<String>().bytes())));
  316. // FIXME: 3. Let responseOrigin be the result of determining the origin given response's URL, targetSnapshotParams's sandboxing flags, null, and entry's document state's origin.
  317. // 4. Let coop be a new cross-origin opener policy.
  318. CrossOriginOpenerPolicy coop;
  319. // 5. Let coopEnforcementResult be a new cross-origin opener policy enforcement result with
  320. // url: response's URL
  321. // FIXME: origin: responseOrigin
  322. // cross-origin opener policy: coop
  323. CrossOriginOpenerPolicyEnforcementResult coop_enforcement_result {
  324. .url = *response->url(),
  325. .origin = Origin {},
  326. .cross_origin_opener_policy = coop
  327. };
  328. // FIXME: 6. Let policyContainer be the result of determining navigation params policy container given response's URL, entry's document state's history policy container, null, navigable's container document's policy container, and null.
  329. // 7. Return a new navigation params, with
  330. // id: navigationId
  331. // request: null
  332. // response: response
  333. // FIXME: origin: responseOrigin
  334. // FIXME: policy container: policyContainer
  335. // FIXME: final sandboxing flag set: targetSnapshotParams's sandboxing flags
  336. // cross-origin opener policy: coop
  337. // COOP enforcement result: coopEnforcementResult
  338. // reserved environment: null
  339. // navigable: navigable
  340. // FIXME: navigation timing type: navTimingType
  341. // fetch controller: null
  342. // commit early hints: null
  343. HTML::NavigationParams navigation_params {
  344. .id = navigation_id,
  345. .request = {},
  346. .response = *response,
  347. .origin = Origin {},
  348. .policy_container = PolicyContainer {},
  349. .final_sandboxing_flag_set = SandboxingFlagSet {},
  350. .cross_origin_opener_policy = move(coop),
  351. .coop_enforcement_result = move(coop_enforcement_result),
  352. .reserved_environment = {},
  353. .browsing_context = navigable->active_browsing_context(),
  354. .navigable = navigable,
  355. };
  356. return { navigation_params };
  357. }
  358. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#create-navigation-params-by-fetching
  359. static WebIDL::ExceptionOr<Optional<NavigationParams>> create_navigation_params_by_fetching(JS::GCPtr<SessionHistoryEntry> entry, JS::GCPtr<Navigable> navigable, SourceSnapshotParams const& source_snapshot_params, Optional<String> navigation_id)
  360. {
  361. auto& vm = navigable->vm();
  362. auto& realm = navigable->active_window()->realm();
  363. // FIXME: 1. Assert: this is running in parallel.
  364. // 2. Let documentResource be entry's document state's resource.
  365. auto document_resource = entry->document_state->resource();
  366. // 3. Let request be a new request, with
  367. // url: entry's URL
  368. // client: sourceSnapshotParams's fetch client
  369. // destination: "document"
  370. // credentials mode: "include"
  371. // use-URL-credentials flag: set
  372. // redirect mode: "manual"
  373. // replaces client id: navigable's active document's relevant settings object's id
  374. // mode: "navigate"
  375. // referrer: entry's document state's request referrer
  376. // FIXME: referrer policy: entry's document state's request referrer policy
  377. auto request = Fetch::Infrastructure::Request::create(vm);
  378. request->set_url(entry->url);
  379. request->set_client(source_snapshot_params.fetch_client);
  380. request->set_destination(Fetch::Infrastructure::Request::Destination::Document);
  381. request->set_credentials_mode(Fetch::Infrastructure::Request::CredentialsMode::Include);
  382. request->set_use_url_credentials(true);
  383. request->set_redirect_mode(Fetch::Infrastructure::Request::RedirectMode::Manual);
  384. auto replaces_client_id = TRY_OR_THROW_OOM(vm, String::from_deprecated_string(navigable->active_document()->relevant_settings_object().id));
  385. request->set_replaces_client_id(replaces_client_id);
  386. request->set_mode(Fetch::Infrastructure::Request::Mode::Navigate);
  387. request->set_referrer(entry->document_state->request_referrer());
  388. // 4. If documentResource is a POST resource, then:
  389. if (document_resource.has<POSTResource>()) {
  390. // 1. Set request's method to `POST`.
  391. request->set_method(TRY_OR_THROW_OOM(vm, ByteBuffer::copy("post"sv.bytes())));
  392. // 2. Set request's body to documentResource's request body.
  393. request->set_body(document_resource.get<POSTResource>().request_body.value());
  394. // 3. Set `Content-Type` to documentResource's request content-type in request's header list.
  395. auto request_content_type = document_resource.get<POSTResource>().request_content_type;
  396. auto request_content_type_string = [request_content_type]() {
  397. switch (request_content_type) {
  398. case POSTResource::RequestContentType::ApplicationXWWWFormUrlencoded:
  399. return "application/x-www-form-urlencoded"sv;
  400. case POSTResource::RequestContentType::MultipartFormData:
  401. return "multipart/form-data"sv;
  402. case POSTResource::RequestContentType::TextPlain:
  403. return "text/plain"sv;
  404. default:
  405. VERIFY_NOT_REACHED();
  406. }
  407. }();
  408. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, request_content_type_string));
  409. TRY_OR_THROW_OOM(vm, request->header_list()->append(move(header)));
  410. }
  411. // 5. If entry's document state's reload pending is true, then set request's reload-navigation flag.
  412. if (entry->document_state->reload_pending())
  413. request->set_reload_navigation(true);
  414. // 6. Otherwise, if entry's document state's ever populated is true, then set request's history-navigation flag.
  415. if (entry->document_state->ever_populated())
  416. request->set_history_navigation(true);
  417. // 9. Let response be null.
  418. // NOTE: We use a heap-allocated cell to hold the response pointer because the processResponse callback below
  419. // might use it after this stack is freed.
  420. auto response_holder = ResponseHolder::create(vm);
  421. // 10. Let responseOrigin be null.
  422. Optional<HTML::Origin> response_origin;
  423. // 11. Let fetchController be null.
  424. JS::GCPtr<Fetch::Infrastructure::FetchController> fetch_controller = nullptr;
  425. // 13. Let finalSandboxFlags be an empty sandboxing flag set.
  426. SandboxingFlagSet final_sandbox_flags = {};
  427. // 16. Let locationURL be null.
  428. ErrorOr<Optional<AK::URL>> location_url { OptionalNone {} };
  429. // 17. Let currentURL be request's current URL.
  430. AK::URL current_url = request->current_url();
  431. // FIXME: 18. Let commitEarlyHints be null.
  432. // 19. While true:
  433. while (true) {
  434. // FIXME: 1. If request's reserved client is not null and currentURL's origin is not the same as request's reserved client's creation URL's origin, then:
  435. // FIXME: 2. If request's reserved client is null, then:
  436. // FIXME: 3. If the result of should navigation request of type be blocked by Content Security Policy? given request and cspNavigationType is "Blocked", then set response to a network error and break. [CSP]
  437. // 4. Set response to null.
  438. response_holder->set_response(nullptr);
  439. // 5. If fetchController is null, then set fetchController to the result of fetching request,
  440. // with processEarlyHintsResponse set to processEarlyHintsResponseas defined below, processResponse
  441. // set to processResponse as defined below, and useParallelQueue set to true.
  442. if (!fetch_controller) {
  443. // FIXME: Let processEarlyHintsResponse be the following algorithm given a response earlyResponse:
  444. // Let processResponse be the following algorithm given a response fetchedResponse:
  445. auto process_response = [response_holder](JS::NonnullGCPtr<Fetch::Infrastructure::Response> fetch_response) {
  446. // 1. Set response to fetchedResponse.
  447. response_holder->set_response(fetch_response);
  448. };
  449. fetch_controller = TRY(Fetch::Fetching::fetch(
  450. realm,
  451. request,
  452. Fetch::Infrastructure::FetchAlgorithms::create(vm,
  453. {
  454. .process_request_body_chunk_length = {},
  455. .process_request_end_of_body = {},
  456. .process_early_hints_response = {},
  457. .process_response = move(process_response),
  458. .process_response_end_of_body = {},
  459. .process_response_consume_body = {},
  460. }),
  461. Fetch::Fetching::UseParallelQueue::Yes));
  462. }
  463. // 6. Otherwise, process the next manual redirect for fetchController.
  464. else {
  465. fetch_controller->process_next_manual_redirect();
  466. }
  467. // 7. Wait until either response is non-null, or navigable's ongoing navigation changes to no longer equal navigationId.
  468. Platform::EventLoopPlugin::the().spin_until([&]() {
  469. if (response_holder->response() != nullptr)
  470. return true;
  471. if (navigation_id.has_value() && (!navigable->ongoing_navigation().has<String>() || navigable->ongoing_navigation().get<String>() != *navigation_id))
  472. return true;
  473. return false;
  474. });
  475. // If the latter condition occurs, then abort fetchController, and return. Otherwise, proceed onward.
  476. if (navigation_id.has_value() && (!navigable->ongoing_navigation().has<String>() || navigable->ongoing_navigation().get<String>() != *navigation_id)) {
  477. fetch_controller->abort(realm, {});
  478. return OptionalNone {};
  479. }
  480. // 8. If request's body is null, then set entry's document state's resource to null.
  481. if (!request->body().has<Empty>()) {
  482. entry->document_state->set_resource(Empty {});
  483. }
  484. // 11. Set responseOrigin to the result of determining the origin given response's URL, finalSandboxFlags,
  485. // entry's document state's initiator origin, and null.
  486. response_origin = determine_the_origin(*response_holder->response()->url(), final_sandbox_flags, entry->document_state->initiator_origin(), {});
  487. // 14. Set locationURL to response's location URL given currentURL's fragment.
  488. auto location_url = response_holder->response()->location_url(current_url.fragment());
  489. VERIFY(!location_url.is_error());
  490. // 15. If locationURL is failure or null, then break.
  491. if (location_url.is_error() || !location_url.value().has_value()) {
  492. break;
  493. }
  494. // 16. Assert: locationURL is a URL.
  495. VERIFY(location_url.value()->is_valid());
  496. // FIXME: 17. Set entry's serialized state to StructuredSerializeForStorage(null).
  497. // 18. Let oldDocState be entry's document state.
  498. auto old_doc_state = entry->document_state;
  499. // 19. Set entry's document state to a new document state, with
  500. // history policy container: a clone of the oldDocState's history policy container if it is non-null; null otherwise
  501. // request referrer: oldDocState's request referrer
  502. // request referrer policy: oldDocState's request referrer policy
  503. // origin: oldDocState's origin
  504. // resource: oldDocState's resource
  505. // ever populated: oldDocState's ever populated
  506. // navigable target name: oldDocState's navigable target name
  507. entry->document_state = navigable->heap().allocate_without_realm<DocumentState>();
  508. entry->document_state->set_history_policy_container(old_doc_state->history_policy_container());
  509. entry->document_state->set_request_referrer(old_doc_state->request_referrer());
  510. entry->document_state->set_request_referrer_policy(old_doc_state->request_referrer_policy());
  511. entry->document_state->set_origin(old_doc_state->origin());
  512. entry->document_state->set_resource(old_doc_state->resource());
  513. entry->document_state->set_ever_populated(old_doc_state->ever_populated());
  514. entry->document_state->set_navigable_target_name(old_doc_state->navigable_target_name());
  515. // 20. If locationURL's scheme is not an HTTP(S) scheme, then:
  516. if (!Fetch::Infrastructure::is_http_or_https_scheme(location_url.value()->scheme())) {
  517. // 1. Set entry's document state's resource to null.
  518. entry->document_state->set_resource(Empty {});
  519. // 2. Break.
  520. break;
  521. }
  522. // 21. Set currentURL to locationURL.
  523. current_url = location_url.value().value();
  524. // 22. Set entry's URL to currentURL.
  525. entry->url = current_url;
  526. }
  527. // FIXME: 20. If locationURL is a URL whose scheme is not a fetch scheme, then return a new non-fetch scheme navigation params, with
  528. // initiator origin request's current URL's origin
  529. if (!location_url.is_error() && location_url.value().has_value() && !Fetch::Infrastructure::is_fetch_scheme(location_url.value().value().scheme())) {
  530. TODO();
  531. }
  532. // 21. If any of the following are true:
  533. // - response is a network error;
  534. // - locationURL is failure; or
  535. // - locationURL is a URL whose scheme is a fetch scheme
  536. // then return null.
  537. if (response_holder->response()->is_network_error() || location_url.is_error() || (location_url.value().has_value() && Fetch::Infrastructure::is_fetch_scheme(location_url.value().value().scheme()))) {
  538. return OptionalNone {};
  539. }
  540. // 22. Assert: locationURL is null and response is not a network error.
  541. VERIFY(!location_url.value().has_value());
  542. VERIFY(!response_holder->response()->is_network_error());
  543. // FIXME: 23. Let resultPolicyContainer be the result of determining navigation params policy container given response's
  544. // URL, entry's document state's history policy container, sourceSnapshotParams's source policy container,
  545. // null, and responsePolicyContainer.
  546. // 25. Return a new navigation params, with
  547. // id: navigationId
  548. // request: request
  549. // response: response
  550. // origin: responseOrigin
  551. // FIXME: policy container: resultPolicyContainer
  552. // FIXME: final sandboxing flag set: finalSandboxFlags
  553. // FIXME: cross-origin opener policy: responseCOOP
  554. // FIXME: COOP enforcement result: coopEnforcementResult
  555. // FIXME: reserved environment: request's reserved client
  556. // navigable: navigable
  557. // FIXME: navigation timing type: navTimingType
  558. // fetch controller: fetchController
  559. // FIXME: commit early hints: commitEarlyHints
  560. HTML::NavigationParams navigation_params {
  561. .id = navigation_id,
  562. .request = request,
  563. .response = *response_holder->response(),
  564. .origin = *response_origin,
  565. .policy_container = PolicyContainer {},
  566. .final_sandboxing_flag_set = SandboxingFlagSet {},
  567. .cross_origin_opener_policy = CrossOriginOpenerPolicy {},
  568. .coop_enforcement_result = CrossOriginOpenerPolicyEnforcementResult {},
  569. .reserved_environment = {},
  570. .browsing_context = navigable->active_browsing_context(),
  571. .navigable = navigable,
  572. .fetch_controller = fetch_controller,
  573. };
  574. return { navigation_params };
  575. }
  576. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#attempt-to-populate-the-history-entry's-document
  577. WebIDL::ExceptionOr<void> Navigable::populate_session_history_entry_document(JS::GCPtr<SessionHistoryEntry> entry, Optional<NavigationParams> navigation_params, Optional<String> navigation_id, SourceSnapshotParams const& source_snapshot_params, bool allow_POST, Function<void()> completion_steps)
  578. {
  579. // FIXME: 1. Assert: this is running in parallel.
  580. // 2. Assert: if navigationParams is non-null, then navigationParams's response is non-null.
  581. if (navigation_params.has_value())
  582. VERIFY(navigation_params->response);
  583. // 3. Let currentBrowsingContext be navigable's active browsing context.
  584. [[maybe_unused]] auto current_browsing_context = active_browsing_context();
  585. // 4. Let documentResource be entry's document state's resource.
  586. auto document_resource = entry->document_state->resource();
  587. // 5. If navigationParams is null, then:
  588. if (!navigation_params.has_value()) {
  589. // 1. If documentResource is a string, then set navigationParams to the result
  590. // of creating navigation params from a srcdoc resource given entry, navigable,
  591. // targetSnapshotParams, navigationId, and navTimingType.
  592. if (document_resource.has<String>()) {
  593. navigation_params = create_navigation_params_from_a_srcdoc_resource(entry, this, source_snapshot_params, navigation_id).release_value_but_fixme_should_propagate_errors();
  594. }
  595. // 2. Otherwise, if both of the following are true:
  596. // - entry's URL's scheme is a fetch scheme; and
  597. // - documentResource is null, or allowPOST is true and documentResource's request body is not failure (FIXME: check if request body is not failure)
  598. else if (Fetch::Infrastructure::is_fetch_scheme(entry->url.scheme()) && (document_resource.has<Empty>() || allow_POST)) {
  599. navigation_params = create_navigation_params_by_fetching(entry, this, source_snapshot_params, navigation_id).release_value_but_fixme_should_propagate_errors();
  600. }
  601. // FIXME: 3. Otherwise, if entry's URL's scheme is not a fetch scheme, then set navigationParams to a new non-fetch scheme navigation params, with
  602. // initiator origin: entry's document state's initiator origin
  603. else {
  604. TODO();
  605. }
  606. }
  607. // 6. Queue a global task on the navigation and traversal task source, given navigable's active window, to run these steps:
  608. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this, entry, navigation_params, navigation_id, completion_steps = move(completion_steps)] {
  609. // 1. If navigable's ongoing navigation no longer equals navigationId, then run completionSteps and return.
  610. if (navigation_id.has_value() && (!ongoing_navigation().has<String>() || ongoing_navigation().get<String>() != *navigation_id)) {
  611. completion_steps();
  612. return;
  613. }
  614. // 2. Let failure be false.
  615. auto failure = false;
  616. // FIXME: 3. If navigationParams is a non-fetch scheme navigation params, then set entry's document state's document to the result of running attempt to create a non-fetch
  617. // scheme document given entry's URL, navigable, targetSnapshotParams's sandboxing flags, navigationId, navTimingType, sourceSnapshotParams's has transient
  618. // activation, and navigationParams's initiator origin.
  619. // 4. Otherwise, if navigationParams is null, then set failure to true.
  620. if (!navigation_params.has_value()) {
  621. failure = true;
  622. }
  623. // FIXME: 5. Otherwise, if the result of should navigation response to navigation request of type in target be blocked by Content Security Policy? given navigationParams's request,
  624. // navigationParams's response, navigationParams's policy container's CSP list, cspNavigationType, and navigable is "Blocked", then set failure to true.
  625. // FIXME: 6. Otherwise, if navigationParams's reserved environment is non-null and the result of checking a navigation response's adherence to its embedder policy given
  626. // navigationParams's response, navigable, and navigationParams's policy container's embedder policy is false, then set failure to true.
  627. // 8. If failure is true, then:
  628. if (failure) {
  629. // 1. Set entry's document state's document to the result of creating a document for inline content that doesn't have a DOM, given navigable, null, and navTimingType.
  630. // The inline content should indicate to the user the sort of error that occurred.
  631. // FIXME: Use SourceGenerator to produce error page from file:///res/html/error.html
  632. // and display actual error from fetch response.
  633. auto error_html = String::formatted("<h1>Failed to load {}</h1>"sv, entry->url).release_value_but_fixme_should_propagate_errors();
  634. entry->document_state->set_document(create_document_for_inline_content(this, navigation_id, error_html));
  635. // 2. Set entry's document state's document's salvageable to false.
  636. entry->document_state->document()->set_salvageable(false);
  637. // FIXME: 3. If navigationParams is not null, then:
  638. if (navigation_params.has_value()) {
  639. TODO();
  640. }
  641. }
  642. // FIXME: 9. Otherwise, if navigationParams's response's status is 204 or 205, then:
  643. else if (navigation_params->response->status() == 204 || navigation_params->response->status() == 205) {
  644. // 1. Run completionSteps.
  645. completion_steps();
  646. // 2. Return.
  647. return;
  648. }
  649. // FIXME: 10. Otherwise, if navigationParams's response has a `Content-Disposition`
  650. // header specifying the attachment disposition type, then:
  651. // 11. Otherwise:
  652. else {
  653. // 1. Let document be the result of loading a document given navigationParams, sourceSnapshotParams,
  654. // and entry's document state's initiator origin.
  655. auto document = load_document(navigation_params);
  656. // 2. If document is null, then run completionSteps and return.
  657. if (!document) {
  658. VERIFY_NOT_REACHED();
  659. completion_steps();
  660. return;
  661. }
  662. // 3. Set entry's document state's document to document.
  663. entry->document_state->set_document(document.ptr());
  664. // 4. Set entry's document state's origin to document's origin.
  665. entry->document_state->set_origin(document->origin());
  666. }
  667. // FIXME: 12. If entry's document state's request referrer is "client", then set it to request's referrer.
  668. // 13. If entry's document state's document is not null, then set entry's document state's ever populated to true.
  669. if (entry->document_state->document()) {
  670. entry->document_state->set_ever_populated(true);
  671. }
  672. // 14. Run completionSteps.
  673. completion_steps();
  674. });
  675. return {};
  676. }
  677. // To navigate a navigable navigable to a URL url using a Document sourceDocument,
  678. // with an optional POST resource, string, or null documentResource (default null),
  679. // an optional response-or-null response (default null), an optional boolean exceptionsEnabled (default false),
  680. // an optional NavigationHistoryBehavior historyHandling (default "auto"),
  681. // an optional serialized state-or-null navigationAPIState (default null),
  682. // an optional entry list or null formDataEntryList (default null),
  683. // an optional referrer policy referrerPolicy (default the empty string),
  684. // and an optional user navigation involvement userInvolvement (default "none"):
  685. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate
  686. WebIDL::ExceptionOr<void> Navigable::navigate(
  687. AK::URL const& url,
  688. JS::NonnullGCPtr<DOM::Document> source_document,
  689. Variant<Empty, String, POSTResource> document_resource,
  690. JS::GCPtr<Fetch::Infrastructure::Response> response,
  691. bool exceptions_enabled,
  692. Bindings::NavigationHistoryBehavior history_handling,
  693. Optional<SerializationRecord> navigation_api_state,
  694. Optional<Vector<XHR::FormDataEntry>&> form_data_entry_list,
  695. ReferrerPolicy::ReferrerPolicy referrer_policy,
  696. UserNaviagationInvolvement user_involvement)
  697. {
  698. auto& active_document = *this->active_document();
  699. auto& realm = active_document.realm();
  700. auto& vm = this->vm();
  701. // 1. Let cspNavigationType be "form-submission" if formDataEntryList is non-null; otherwise "other".
  702. auto csp_navigation_type = form_data_entry_list.has_value() ? CSPNavigationType::FormSubmission : CSPNavigationType::Other;
  703. // 2. Let sourceSnapshotParams be the result of snapshotting source snapshot params given sourceDocument.
  704. auto source_snapshot_params = source_document->snapshot_source_snapshot_params();
  705. // 3. Let initiatorOriginSnapshot be sourceDocument's origin.
  706. auto initiator_origin_snapshot = source_document->origin();
  707. // 4. Let initiatorBaseURLSnapshot be sourceDocument's document base URL.
  708. auto initiator_base_url_snapshot = source_document->base_url();
  709. // 5. If sourceDocument's node navigable is not allowed by sandboxing to navigate navigable given and sourceSnapshotParams, then:
  710. if (!source_document->navigable()->allowed_by_sandboxing_to_navigate(*this, source_snapshot_params)) {
  711. // 1. If exceptionsEnabled is true, then throw a "SecurityError" DOMException.
  712. if (exceptions_enabled) {
  713. return WebIDL::SecurityError::create(realm, "Source document's node navigable is not allowed to navigate"_fly_string);
  714. }
  715. // 2 Return.
  716. return {};
  717. }
  718. // 6. Let navigationId be the result of generating a random UUID.
  719. String navigation_id = TRY_OR_THROW_OOM(vm, Crypto::generate_random_uuid());
  720. // FIXME: 7. If the surrounding agent is equal to navigable's active document's relevant agent, then continue these steps.
  721. // Otherwise, queue a global task on the navigation and traversal task source given navigable's active window to continue these steps.
  722. // 8. If navigable's active document's unload counter is greater than 0,
  723. // then invoke WebDriver BiDi navigation failed with a WebDriver BiDi navigation status whose id is navigationId,
  724. // status is "canceled", and url is url, and return.
  725. if (active_document.unload_counter() > 0) {
  726. // FIXME: invoke WebDriver BiDi navigation failed with a WebDriver BiDi navigation status whose id is navigationId,
  727. // status is "canceled", and url is url
  728. return {};
  729. }
  730. // 9. If historyHandling is "auto", then:
  731. if (history_handling == Bindings::NavigationHistoryBehavior::Auto) {
  732. // FIXME: Fix spec typo targetNavigable --> navigable
  733. // 1. If url equals navigable's active document's URL,
  734. // and initiatorOriginSnapshot is same origin with targetNavigable's active document's origin,
  735. // then set historyHandling to "replace".
  736. if (url == active_document.url() && initiator_origin_snapshot.is_same_origin(active_document.origin()))
  737. history_handling = Bindings::NavigationHistoryBehavior::Replace;
  738. // 2. Otherwise, set historyHandling to "push".
  739. else
  740. history_handling = Bindings::NavigationHistoryBehavior::Push;
  741. }
  742. // 10. If the navigation must be a replace given url and navigable's active document, then set historyHandling to "replace".
  743. if (navigation_must_be_a_replace(url, active_document))
  744. history_handling = Bindings::NavigationHistoryBehavior::Replace;
  745. // 11. If all of the following are true:
  746. // - documentResource is null;
  747. // - response is null;
  748. // - url equals navigable's active session history entry's URL with exclude fragments set to true; and
  749. // - url's fragment is non-null
  750. if (document_resource.has<Empty>()
  751. && !response
  752. && url.equals(active_session_history_entry()->url, AK::URL::ExcludeFragment::Yes)
  753. && url.fragment().has_value()) {
  754. // 1. Navigate to a fragment given navigable, url, historyHandling, and navigationId.
  755. TRY(navigate_to_a_fragment(url, to_history_handling_behavior(history_handling), navigation_id));
  756. // 2. Return.
  757. return {};
  758. }
  759. // 12. If navigable's parent is non-null, then set navigable's is delaying load events to true.
  760. if (parent() != nullptr)
  761. set_delaying_load_events(true);
  762. // 13. Let targetBrowsingContext be navigable's active browsing context.
  763. [[maybe_unused]] auto target_browsing_context = active_browsing_context();
  764. // 14. Let targetSnapshotParams be the result of snapshotting target snapshot params given navigable.
  765. [[maybe_unused]] auto target_snapshot_params = snapshot_target_snapshot_params();
  766. // 15. Invoke WebDriver BiDi navigation started with targetBrowsingContext, and a new WebDriver BiDi navigation status whose id is navigationId, url is url, and status is "pending".
  767. // 16. If navigable's ongoing navigation is "traversal", then:
  768. if (ongoing_navigation().has<Traversal>()) {
  769. // FIXME: 1. Invoke WebDriver BiDi navigation failed with targetBrowsingContext and a new WebDriver BiDi navigation status whose id is navigationId, status is "canceled", and url is url.
  770. // 2. Return.
  771. return {};
  772. }
  773. // 17. Set navigable's ongoing navigation to navigationId.
  774. set_ongoing_navigation(navigation_id);
  775. // 18. If url's scheme is "javascript", then:
  776. if (url.scheme() == "javascript"sv) {
  777. // 1. Queue a global task on the navigation and traversal task source given navigable's active window to navigate to a javascript: URL given navigable, url, historyHandling, initiatorOriginSnapshot, and cspNavigationType.
  778. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this, url, history_handling, initiator_origin_snapshot, csp_navigation_type] {
  779. (void)navigate_to_a_javascript_url(url, to_history_handling_behavior(history_handling), initiator_origin_snapshot, csp_navigation_type);
  780. });
  781. // 2. Return.
  782. return {};
  783. }
  784. // 19. If all of the following are true:
  785. // - userInvolvement is not "browser UI";
  786. // - navigable's active document's origin is same origin-domain with sourceDocument's origin;
  787. // - navigable's active document's is initial about:blank is false; and
  788. // - url's scheme is a fetch scheme
  789. // then:
  790. if (user_involvement != UserNaviagationInvolvement::BrowserUI && active_document.origin().is_same_origin_domain(source_document->origin()) && !active_document.is_initial_about_blank() && Fetch::Infrastructure::is_fetch_scheme(url.scheme())) {
  791. // 1. Let navigation be navigable's active window's navigation API.
  792. auto navigation = active_window()->navigation();
  793. // 2. Let entryListForFiring be formDataEntryList if documentResource is a POST resource; otherwise, null.
  794. auto entry_list_for_firing = [&]() -> Optional<Vector<XHR::FormDataEntry>&> {
  795. if (document_resource.has<POSTResource>())
  796. return form_data_entry_list;
  797. return {};
  798. }();
  799. // 3. Let navigationAPIStateForFiring be navigationAPIState if navigationAPIState is not null;
  800. // otherwise, StructuredSerializeForStorage(undefined).
  801. auto navigation_api_state_for_firing = navigation_api_state.value_or(MUST(structured_serialize_for_storage(vm, JS::js_undefined())));
  802. // FIXME: 4. Let continue be the result of firing a push/replace/reload navigate event at navigation
  803. // with navigationType set to historyHandling, isSameDocument set to false, userInvolvement set to userInvolvement,
  804. // formDataEntryList set to entryListForFiring, destinationURL set to url, and navigationAPIState set to navigationAPIStateForFiring.
  805. (void)navigation;
  806. (void)entry_list_for_firing;
  807. (void)navigation_api_state_for_firing;
  808. // FIXME: 5. If continue is false, then return.
  809. }
  810. // 20. In parallel, run these steps:
  811. Platform::EventLoopPlugin::the().deferred_invoke([this, source_snapshot_params = move(source_snapshot_params), document_resource, url, navigation_id, referrer_policy, initiator_origin_snapshot, response, history_handling, initiator_base_url_snapshot] {
  812. // FIXME: 1. Let unloadPromptCanceled be the result of checking if unloading is user-canceled for navigable's active document's inclusive descendant navigables.
  813. // FIXME: 2. If unloadPromptCanceled is true, or navigable's ongoing navigation is no longer navigationId, then:
  814. if (!ongoing_navigation().has<String>() || ongoing_navigation().get<String>() != navigation_id) {
  815. // FIXME: 1. Invoke WebDriver BiDi navigation failed with targetBrowsingContext and a new WebDriver BiDi navigation status whose id is navigationId, status is "canceled", and url is url.
  816. // 2. Abort these steps.
  817. return;
  818. }
  819. // 3. Queue a global task on the navigation and traversal task source given navigable's active window to abort navigable's active document.
  820. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this] {
  821. VERIFY(this->active_document());
  822. this->active_document()->abort();
  823. });
  824. // 4. Let documentState be a new document state with
  825. // request referrer policy: referrerPolicy
  826. // initiator origin: initiatorOriginSnapshot
  827. // resource: documentResource
  828. // navigable target name: navigable's target name
  829. JS::NonnullGCPtr<DocumentState> document_state = *heap().allocate_without_realm<DocumentState>();
  830. document_state->set_request_referrer_policy(referrer_policy);
  831. document_state->set_initiator_origin(initiator_origin_snapshot);
  832. document_state->set_resource(document_resource);
  833. document_state->set_navigable_target_name(target_name());
  834. // 5. If url matches about:blank or is about:srcdoc, then set documentState's origin to documentState's initiator origin.
  835. // FIXME: should this say "matches about:srcdoc"
  836. if (url_matches_about_blank(url) || url == "about:srcdoc"sv) {
  837. // 1. Set documentState's origin to initiatorOriginSnapshot.
  838. document_state->set_origin(document_state->initiator_origin());
  839. // 2. Set documentState's about base URL to initiatorBaseURLSnapshot.
  840. document_state->set_about_base_url(initiator_base_url_snapshot);
  841. }
  842. // 6. Let historyEntry be a new session history entry, with its URL set to url and its document state set to documentState.
  843. JS::NonnullGCPtr<SessionHistoryEntry> history_entry = *heap().allocate_without_realm<SessionHistoryEntry>();
  844. history_entry->url = url;
  845. history_entry->document_state = document_state;
  846. // 8. Let navigationParams be null.
  847. Optional<NavigationParams> navigation_params;
  848. // FIXME: 9. If response is non-null:
  849. if (response) {
  850. }
  851. // 10. Attempt to populate the history entry's document
  852. // for historyEntry, given navigable, "navigate", sourceSnapshotParams,
  853. // targetSnapshotParams, navigationId, navigationParams, cspNavigationType, with allowPOST
  854. // set to true and completionSteps set to the following step:
  855. populate_session_history_entry_document(history_entry, navigation_params, navigation_id, source_snapshot_params, true, [this, history_entry, history_handling, navigation_id] {
  856. traversable_navigable()->append_session_history_traversal_steps([this, history_entry, history_handling] {
  857. finalize_a_cross_document_navigation(*this, to_history_handling_behavior(history_handling), history_entry);
  858. });
  859. }).release_value_but_fixme_should_propagate_errors();
  860. });
  861. return {};
  862. }
  863. WebIDL::ExceptionOr<void> Navigable::navigate_to_a_fragment(AK::URL const& url, HistoryHandlingBehavior history_handling, String navigation_id)
  864. {
  865. (void)navigation_id;
  866. // FIXME: 1. Let navigation be navigable's active window's navigation API.
  867. // FIXME: 2. Let destinationNavigationAPIState be navigable's active session history entry's navigation API state.
  868. // FIXME: 3. If navigationAPIState is not null, then set destinationNavigationAPIState to navigationAPIState.
  869. // FIXME: 4. Let continue be the result of firing a push/replace/reload navigate event at navigation with navigationType set to historyHandling, isSameDocument set to true,
  870. // userInvolvement set to userInvolvement, and destinationURL set to url, and navigationAPIState set to destinationNavigationAPIState.
  871. // FIXME: 5. If continue is false, then return.
  872. // 6. Let historyEntry be a new session history entry, with
  873. // URL: url
  874. // document state: navigable's active session history entry's document state
  875. // navigation API state: destinationNavigationAPIState
  876. // scroll restoration mode: navigable's active session history entry's scroll restoration mode
  877. JS::NonnullGCPtr<SessionHistoryEntry> history_entry = heap().allocate_without_realm<SessionHistoryEntry>();
  878. history_entry->url = url;
  879. history_entry->document_state = active_session_history_entry()->document_state;
  880. history_entry->scroll_restoration_mode = active_session_history_entry()->scroll_restoration_mode;
  881. // 7. Let entryToReplace be navigable's active session history entry if historyHandling is "replace", otherwise null.
  882. auto entry_to_replace = history_handling == HistoryHandlingBehavior::Replace ? active_session_history_entry() : nullptr;
  883. // FIXME: 8. Let history be navigable's active document's history object.
  884. // FIXME: 9. Let scriptHistoryIndex be history's index.
  885. // FIXME: 10. Let scriptHistoryIndex be history's index.
  886. // 11. If historyHandling is "push", then:
  887. if (history_handling == HistoryHandlingBehavior::Push) {
  888. // FIXME: 1. Set history's state to null.
  889. // FIXME: 2. Increment scriptHistoryIndex.
  890. // FIXME: 3. Set scriptHistoryLength to scriptHistoryIndex + 1.
  891. }
  892. // 12. Set navigable's active session history entry to historyEntry.
  893. m_active_session_history_entry = history_entry;
  894. // FIXME: 13. Update document for history step application given navigable's active document, historyEntry, true, scriptHistoryIndex, and scriptHistoryLength.
  895. // FIXME: 14. Update the navigation API entries for a same-document navigation given navigation, historyEntry, and historyHandling.
  896. // 15. Scroll to the fragment given navigable's active document.
  897. // FIXME: Specification doesn't say when document url needs to update during fragment navigation
  898. active_document()->set_url(url);
  899. active_document()->scroll_to_the_fragment();
  900. // 16. Let traversable be navigable's traversable navigable.
  901. auto traversable = traversable_navigable();
  902. // 17. Append the following session history synchronous navigation steps involving navigable to traversable:
  903. traversable->append_session_history_traversal_steps([&] {
  904. // 1. Finalize a same-document navigation given traversable, navigable, historyEntry, and entryToReplace.
  905. finalize_a_same_document_navigation(*traversable, *this, history_entry, entry_to_replace);
  906. // FIXME: 2. Invoke WebDriver BiDi fragment navigated with navigable's active browsing context and a new WebDriver BiDi
  907. // navigation status whose id is navigationId, url is url, and status is "complete".
  908. });
  909. return {};
  910. }
  911. WebIDL::ExceptionOr<void> Navigable::navigate_to_a_javascript_url(AK::URL const&, HistoryHandlingBehavior, Origin const& initiator_origin, CSPNavigationType csp_navigation_type)
  912. {
  913. (void)initiator_origin;
  914. (void)csp_navigation_type;
  915. TODO();
  916. }
  917. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#reload
  918. void Navigable::reload()
  919. {
  920. // 1. Set navigable's active session history entry's document state's reload pending to true.
  921. active_session_history_entry()->document_state->set_reload_pending(true);
  922. // 2. Let traversable be navigable's traversable navigable.
  923. auto traversable = traversable_navigable();
  924. // 3. Append the following session history traversal steps to traversable:
  925. traversable->append_session_history_traversal_steps([traversable] {
  926. // 1. Apply pending history changes to traversable with true.
  927. traversable->apply_pending_history_changes();
  928. });
  929. }
  930. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#the-navigation-must-be-a-replace
  931. bool navigation_must_be_a_replace(AK::URL const& url, DOM::Document const& document)
  932. {
  933. return url.scheme() == "javascript"sv || document.is_initial_about_blank();
  934. }
  935. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#allowed-to-navigate
  936. bool Navigable::allowed_by_sandboxing_to_navigate(Navigable const& target, SourceSnapshotParams const& source_snapshot_params)
  937. {
  938. auto& source = *this;
  939. auto is_ancestor_of = [](Navigable const& a, Navigable const& b) {
  940. for (auto parent = b.parent(); parent; parent = parent->parent()) {
  941. if (parent.ptr() == &a)
  942. return true;
  943. }
  944. return false;
  945. };
  946. // A navigable source is allowed by sandboxing to navigate a second navigable target,
  947. // given a source snapshot params sourceSnapshotParams, if the following steps return true:
  948. // 1. If source is target, then return true.
  949. if (&source == &target)
  950. return true;
  951. // 2. If source is an ancestor of target, then return true.
  952. if (is_ancestor_of(source, target))
  953. return true;
  954. // 3. If target is an ancestor of source, then:
  955. if (is_ancestor_of(target, source)) {
  956. // 1. If target is not a top-level traversable, then return true.
  957. if (!target.is_top_level_traversable())
  958. return true;
  959. // 2. If sourceSnapshotParams's has transient activation is true, and sourceSnapshotParams's sandboxing flags's
  960. // sandboxed top-level navigation with user activation browsing context flag is set, then return false.
  961. if (source_snapshot_params.has_transient_activation && has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedTopLevelNavigationWithUserActivation))
  962. return false;
  963. // 3. If sourceSnapshotParams's has transient activation is false, and sourceSnapshotParams's sandboxing flags's
  964. // sandboxed top-level navigation without user activation browsing context flag is set, then return false.
  965. if (!source_snapshot_params.has_transient_activation && has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedTopLevelNavigationWithoutUserActivation))
  966. return false;
  967. // 4. Return true.
  968. return true;
  969. }
  970. // 4. If target is a top-level traversable:
  971. if (target.is_top_level_traversable()) {
  972. // FIXME: 1. If source is the one permitted sandboxed navigator of target, then return true.
  973. // 2. If sourceSnapshotParams's sandboxing flags's sandboxed navigation browsing context flag is set, then return false.
  974. if (has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedNavigation))
  975. return false;
  976. // 3. Return true.
  977. return true;
  978. }
  979. // 5. If sourceSnapshotParams's sandboxing flags's sandboxed navigation browsing context flag is set, then return false.
  980. // 6. Return true.
  981. return !has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedNavigation);
  982. }
  983. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#snapshotting-target-snapshot-params
  984. TargetSnapshotParams Navigable::snapshot_target_snapshot_params()
  985. {
  986. // To snapshot target snapshot params given a navigable targetNavigable, return a new target snapshot params
  987. // with sandboxing flags set to the result of determining the creation sandboxing flags given targetNavigable's
  988. // active browsing context and targetNavigable's container.
  989. return { determine_the_creation_sandboxing_flags(*active_browsing_context(), container()) };
  990. }
  991. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#finalize-a-cross-document-navigation
  992. void finalize_a_cross_document_navigation(JS::NonnullGCPtr<Navigable> navigable, HistoryHandlingBehavior history_handling, JS::NonnullGCPtr<SessionHistoryEntry> history_entry)
  993. {
  994. // 1. FIXME: Assert: this is running on navigable's traversable navigable's session history traversal queue.
  995. // 2. Set navigable's is delaying load events to false.
  996. navigable->set_delaying_load_events(false);
  997. // 3. If historyEntry's document is null, then return.
  998. if (!history_entry->document_state->document())
  999. return;
  1000. // 4. If all of the following are true:
  1001. // - navigable's parent is null;
  1002. // - historyEntry's document's browsing context is not an auxiliary browsing context whose opener browsing context is non-null; and
  1003. // - historyEntry's document's origin is not navigable's active document's origin
  1004. // then set historyEntry's document state's navigable target name to the empty string.
  1005. if (navigable->parent() == nullptr && history_entry->document_state->document()->browsing_context()->opener_browsing_context() != nullptr && history_entry->document_state->document()->origin() != navigable->active_document()->origin())
  1006. history_entry->document_state->set_navigable_target_name(String {});
  1007. // 5. Let entryToReplace be navigable's active session history entry if historyHandling is "replace", otherwise null.
  1008. auto entry_to_replace = history_handling == HistoryHandlingBehavior::Replace ? navigable->active_session_history_entry() : nullptr;
  1009. // 6. Let traversable be navigable's traversable navigable.
  1010. auto traversable = navigable->traversable_navigable();
  1011. // 7. Let targetStep be null.
  1012. int target_step;
  1013. // 8. Let targetEntries be the result of getting session history entries for navigable.
  1014. auto& target_entries = navigable->get_session_history_entries();
  1015. // 9. If entryToReplace is null, then:
  1016. if (entry_to_replace == nullptr) {
  1017. // 1. Clear the forward session history of traversable.
  1018. traversable->clear_the_forward_session_history();
  1019. // 2. Set targetStep to traversable's current session history step + 1.
  1020. target_step = traversable->current_session_history_step() + 1;
  1021. // 3. Set historyEntry's step to targetStep.
  1022. history_entry->step = target_step;
  1023. // 4. Append historyEntry to targetEntries.
  1024. target_entries.append(history_entry);
  1025. } else {
  1026. // 1. Replace entryToReplace with historyEntry in targetEntries.
  1027. *(target_entries.find(*entry_to_replace)) = history_entry;
  1028. // 2. Set historyEntry's step to entryToReplace's step.
  1029. history_entry->step = entry_to_replace->step;
  1030. // 3. If historyEntry's document state's origin is same origin with entryToReplace's document state's origin,
  1031. // then set historyEntry's navigation API key to entryToReplace's navigation API key.
  1032. if (history_entry->document_state->origin().has_value() && entry_to_replace->document_state->origin().has_value() && history_entry->document_state->origin()->is_same_origin(*entry_to_replace->document_state->origin())) {
  1033. history_entry->navigation_api_key = entry_to_replace->navigation_api_key;
  1034. }
  1035. // 4. Set targetStep to traversable's current session history step.
  1036. target_step = traversable->current_session_history_step();
  1037. }
  1038. // FIXME: 10. Apply the push/replace history step targetStep to traversable.
  1039. traversable->apply_the_history_step(target_step);
  1040. }
  1041. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#url-and-history-update-steps
  1042. void perform_url_and_history_update_steps(DOM::Document& document, AK::URL new_url, HistoryHandlingBehavior history_handling)
  1043. {
  1044. // 1. Let navigable be document's node navigable.
  1045. auto navigable = document.navigable();
  1046. // 2. Let activeEntry be navigable's active session history entry.
  1047. auto active_entry = navigable->active_session_history_entry();
  1048. // 3. Let newEntry be a new session history entry, with
  1049. // URL: newURL
  1050. // serialized state: if serializedData is not null, serializedData; otherwise activeEntry's classic history API state
  1051. // document state: activeEntry's document state
  1052. // scroll restoration mode: activeEntry's scroll restoration mode
  1053. // persisted user state: activeEntry's persisted user state
  1054. JS::NonnullGCPtr<SessionHistoryEntry> new_entry = document.heap().allocate_without_realm<SessionHistoryEntry>();
  1055. new_entry->url = new_url;
  1056. new_entry->document_state = active_entry->document_state;
  1057. new_entry->scroll_restoration_mode = active_entry->scroll_restoration_mode;
  1058. // 4. If document's is initial about:blank is true, then set historyHandling to "replace".
  1059. if (document.is_initial_about_blank()) {
  1060. history_handling = HistoryHandlingBehavior::Replace;
  1061. }
  1062. // 5. Let entryToReplace be activeEntry if historyHandling is "replace", otherwise null.
  1063. auto entry_to_replace = history_handling == HistoryHandlingBehavior::Replace ? active_entry : nullptr;
  1064. // 6. If historyHandling is "push", then:
  1065. if (history_handling == HistoryHandlingBehavior::Push) {
  1066. // FIXME: 1. Increment document's history object's index.
  1067. // FIXME: 2. Set document's history object's length to its index + 1.
  1068. TODO();
  1069. }
  1070. // FIXME: 7. If serializedData is not null, then restore the history object state given document and newEntry.
  1071. // 8. Set document's URL to newURL.
  1072. document.set_url(new_url);
  1073. // FIXME: 9. Set document's latest entry to newEntry.
  1074. // 10. Set navigable's active session history entry to newEntry.
  1075. navigable->set_active_session_history_entry(new_entry);
  1076. // FIXME: 11. Update the navigation API entries for a same-document navigation given document's relevant global object's navigation API, newEntry, and historyHandling.
  1077. // 12. Let traversable be navigable's traversable navigable.
  1078. auto traversable = navigable->traversable_navigable();
  1079. // 13. Append the following session history synchronous navigation steps involving navigable to traversable:
  1080. traversable->append_session_history_traversal_steps([traversable, navigable, new_entry, entry_to_replace] {
  1081. // 1. Finalize a same-document navigation given traversable, navigable, newEntry, and entryToReplace.
  1082. finalize_a_same_document_navigation(*traversable, *navigable, new_entry, entry_to_replace);
  1083. });
  1084. }
  1085. }