Navigable.cpp 78 KB

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