Navigable.cpp 107 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169
  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/DOM/Event.h>
  11. #include <LibWeb/Fetch/Fetching/Fetching.h>
  12. #include <LibWeb/Fetch/Infrastructure/FetchAlgorithms.h>
  13. #include <LibWeb/Fetch/Infrastructure/FetchController.h>
  14. #include <LibWeb/Fetch/Infrastructure/URL.h>
  15. #include <LibWeb/HTML/BrowsingContext.h>
  16. #include <LibWeb/HTML/DocumentState.h>
  17. #include <LibWeb/HTML/HTMLIFrameElement.h>
  18. #include <LibWeb/HTML/HistoryHandlingBehavior.h>
  19. #include <LibWeb/HTML/Navigable.h>
  20. #include <LibWeb/HTML/Navigation.h>
  21. #include <LibWeb/HTML/NavigationParams.h>
  22. #include <LibWeb/HTML/POSTResource.h>
  23. #include <LibWeb/HTML/Parser/HTMLParser.h>
  24. #include <LibWeb/HTML/SandboxingFlagSet.h>
  25. #include <LibWeb/HTML/Scripting/ClassicScript.h>
  26. #include <LibWeb/HTML/SessionHistoryEntry.h>
  27. #include <LibWeb/HTML/StructuredSerialize.h>
  28. #include <LibWeb/HTML/TraversableNavigable.h>
  29. #include <LibWeb/HTML/Window.h>
  30. #include <LibWeb/HTML/WindowProxy.h>
  31. #include <LibWeb/Infra/Strings.h>
  32. #include <LibWeb/Layout/Node.h>
  33. #include <LibWeb/Loader/GeneratedPagesLoader.h>
  34. #include <LibWeb/Page/Page.h>
  35. #include <LibWeb/Painting/Paintable.h>
  36. #include <LibWeb/Painting/ViewportPaintable.h>
  37. #include <LibWeb/Platform/EventLoopPlugin.h>
  38. #include <LibWeb/XHR/FormData.h>
  39. namespace Web::HTML {
  40. JS_DEFINE_ALLOCATOR(Navigable);
  41. class ResponseHolder : public JS::Cell {
  42. JS_CELL(ResponseHolder, JS::Cell);
  43. JS_DECLARE_ALLOCATOR(ResponseHolder);
  44. public:
  45. [[nodiscard]] static JS::NonnullGCPtr<ResponseHolder> create(JS::VM& vm)
  46. {
  47. return vm.heap().allocate_without_realm<ResponseHolder>();
  48. }
  49. [[nodiscard]] JS::GCPtr<Fetch::Infrastructure::Response> response() const { return m_response; }
  50. void set_response(JS::GCPtr<Fetch::Infrastructure::Response> response) { m_response = response; }
  51. virtual void visit_edges(Cell::Visitor& visitor) override
  52. {
  53. Base::visit_edges(visitor);
  54. visitor.visit(m_response);
  55. }
  56. private:
  57. JS::GCPtr<Fetch::Infrastructure::Response> m_response;
  58. };
  59. JS_DEFINE_ALLOCATOR(ResponseHolder);
  60. HashTable<Navigable*>& all_navigables()
  61. {
  62. static HashTable<Navigable*> set;
  63. return set;
  64. }
  65. // https://html.spec.whatwg.org/multipage/document-sequences.html#child-navigable
  66. Vector<JS::Handle<Navigable>> Navigable::child_navigables() const
  67. {
  68. Vector<JS::Handle<Navigable>> results;
  69. for (auto& entry : all_navigables()) {
  70. if (entry->current_session_history_entry()->step() == SessionHistoryEntry::Pending::Tag)
  71. continue;
  72. if (entry->parent() == this)
  73. results.append(entry);
  74. }
  75. return results;
  76. }
  77. bool Navigable::is_traversable() const
  78. {
  79. return is<TraversableNavigable>(*this);
  80. }
  81. Navigable::Navigable()
  82. {
  83. all_navigables().set(this);
  84. }
  85. Navigable::~Navigable()
  86. {
  87. all_navigables().remove(this);
  88. }
  89. void Navigable::visit_edges(Cell::Visitor& visitor)
  90. {
  91. Base::visit_edges(visitor);
  92. visitor.visit(m_parent);
  93. visitor.visit(m_current_session_history_entry);
  94. visitor.visit(m_active_session_history_entry);
  95. visitor.visit(m_container);
  96. }
  97. void Navigable::set_delaying_load_events(bool value)
  98. {
  99. if (value) {
  100. auto document = container_document();
  101. VERIFY(document);
  102. m_delaying_the_load_event.emplace(*document);
  103. } else {
  104. m_delaying_the_load_event.clear();
  105. }
  106. }
  107. JS::GCPtr<Navigable> Navigable::navigable_with_active_document(JS::NonnullGCPtr<DOM::Document> document)
  108. {
  109. for (auto* navigable : all_navigables()) {
  110. if (navigable->active_document() == document)
  111. return navigable;
  112. }
  113. return nullptr;
  114. }
  115. // https://html.spec.whatwg.org/multipage/document-sequences.html#initialize-the-navigable
  116. ErrorOr<void> Navigable::initialize_navigable(JS::NonnullGCPtr<DocumentState> document_state, JS::GCPtr<Navigable> parent)
  117. {
  118. static int next_id = 0;
  119. m_id = TRY(String::number(next_id++));
  120. // 1. Assert: documentState's document is non-null.
  121. VERIFY(document_state->document());
  122. // 2. Let entry be a new session history entry, with
  123. JS::NonnullGCPtr<SessionHistoryEntry> entry = *heap().allocate_without_realm<SessionHistoryEntry>();
  124. // URL: document's URL
  125. entry->set_url(document_state->document()->url());
  126. // document state: documentState
  127. entry->set_document_state(document_state);
  128. // 3. Set navigable's current session history entry to entry.
  129. m_current_session_history_entry = entry;
  130. // 4. Set navigable's active session history entry to entry.
  131. m_active_session_history_entry = entry;
  132. // 5. Set navigable's parent to parent.
  133. m_parent = parent;
  134. return {};
  135. }
  136. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-the-target-history-entry
  137. JS::GCPtr<SessionHistoryEntry> Navigable::get_the_target_history_entry(int target_step) const
  138. {
  139. // 1. Let entries be the result of getting session history entries for navigable.
  140. auto& entries = get_session_history_entries();
  141. // 2. Return the item in entries that has the greatest step less than or equal to step.
  142. JS::GCPtr<SessionHistoryEntry> result = nullptr;
  143. for (auto& entry : entries) {
  144. auto entry_step = entry->step().get<int>();
  145. if (entry_step <= target_step) {
  146. if (!result || result->step().get<int>() < entry_step) {
  147. result = entry;
  148. }
  149. }
  150. }
  151. return result;
  152. }
  153. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#activate-history-entry
  154. void Navigable::activate_history_entry(JS::GCPtr<SessionHistoryEntry> entry)
  155. {
  156. // FIXME: 1. Save persisted state to the navigable's active session history entry.
  157. // 2. Let newDocument be entry's document.
  158. JS::GCPtr<DOM::Document> new_document = entry->document().ptr();
  159. // 3. Assert: newDocument's is initial about:blank is false, i.e., we never traverse
  160. // back to the initial about:blank Document because it always gets replaced when we
  161. // navigate away from it.
  162. VERIFY(!new_document->is_initial_about_blank());
  163. // 4. Set navigable's active session history entry to entry.
  164. m_active_session_history_entry = entry;
  165. // 5. Make active newDocument.
  166. new_document->make_active();
  167. // Not in the spec:
  168. VERIFY(active_browsing_context());
  169. active_browsing_context()->page().client().page_did_create_new_document(*new_document);
  170. }
  171. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-document
  172. JS::GCPtr<DOM::Document> Navigable::active_document()
  173. {
  174. // A navigable's active document is its active session history entry's document.
  175. return m_active_session_history_entry->document();
  176. }
  177. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-bc
  178. JS::GCPtr<BrowsingContext> Navigable::active_browsing_context()
  179. {
  180. // A navigable's active browsing context is its active document's browsing context.
  181. // If this navigable is a traversable navigable, then its active browsing context will be a top-level browsing context.
  182. if (auto document = active_document())
  183. return document->browsing_context();
  184. return nullptr;
  185. }
  186. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-wp
  187. JS::GCPtr<HTML::WindowProxy> Navigable::active_window_proxy()
  188. {
  189. // A navigable's active WindowProxy is its active browsing context's associated WindowProxy.
  190. if (auto browsing_context = active_browsing_context())
  191. return browsing_context->window_proxy();
  192. return nullptr;
  193. }
  194. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-window
  195. JS::GCPtr<HTML::Window> Navigable::active_window()
  196. {
  197. // A navigable's active window is its active WindowProxy's [[Window]].
  198. if (auto window_proxy = active_window_proxy())
  199. return window_proxy->window();
  200. return nullptr;
  201. }
  202. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-target
  203. String Navigable::target_name() const
  204. {
  205. // A navigable's target name is its active session history entry's document state's navigable target name.
  206. return active_session_history_entry()->document_state()->navigable_target_name();
  207. }
  208. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-container
  209. JS::GCPtr<NavigableContainer> Navigable::container() const
  210. {
  211. // The container of a navigable navigable is the navigable container whose nested navigable is navigable, or null if there is no such element.
  212. return NavigableContainer::navigable_container_with_content_navigable(const_cast<Navigable&>(*this));
  213. }
  214. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-container-document
  215. JS::GCPtr<DOM::Document> Navigable::container_document() const
  216. {
  217. auto container = this->container();
  218. // 1. If navigable's container is null, then return null.
  219. if (!container)
  220. return nullptr;
  221. // 2. Return navigable's container's node document.
  222. return container->document();
  223. }
  224. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-traversable
  225. JS::GCPtr<TraversableNavigable> Navigable::traversable_navigable() const
  226. {
  227. // 1. Let navigable be inputNavigable.
  228. auto navigable = const_cast<Navigable*>(this);
  229. // 2. While navigable is not a traversable navigable, set navigable to navigable's parent.
  230. while (navigable && !is<TraversableNavigable>(*navigable))
  231. navigable = navigable->parent();
  232. // 3. Return navigable.
  233. return static_cast<TraversableNavigable*>(navigable);
  234. }
  235. // https://html.spec.whatwg.org/multipage/document-sequences.html#nav-top
  236. JS::GCPtr<TraversableNavigable> Navigable::top_level_traversable()
  237. {
  238. // 1. Let navigable be inputNavigable.
  239. auto navigable = this;
  240. // 2. While navigable's parent is not null, set navigable to navigable's parent.
  241. while (navigable->parent())
  242. navigable = navigable->parent();
  243. // 3. Return navigable.
  244. return verify_cast<TraversableNavigable>(navigable);
  245. }
  246. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#set-the-ongoing-navigation
  247. void Navigable::set_ongoing_navigation(Variant<Empty, Traversal, String> ongoing_navigation)
  248. {
  249. // 1. If navigable's ongoing navigation is equal to newValue, then return.
  250. if (m_ongoing_navigation == ongoing_navigation)
  251. return;
  252. // 2. Inform the navigation API about aborting navigation given navigable.
  253. inform_the_navigation_api_about_aborting_navigation();
  254. // 3. Set navigable's ongoing navigation to newValue.
  255. m_ongoing_navigation = ongoing_navigation;
  256. }
  257. // https://html.spec.whatwg.org/multipage/document-sequences.html#the-rules-for-choosing-a-navigable
  258. Navigable::ChosenNavigable Navigable::choose_a_navigable(StringView name, TokenizedFeature::NoOpener no_opener, ActivateTab activate_tab)
  259. {
  260. // NOTE: Implementation for step 7 here.
  261. JS::GCPtr<Navigable> same_name_navigable = nullptr;
  262. if (!Infra::is_ascii_case_insensitive_match(name, "_blank"sv)) {
  263. for (auto& n : all_navigables()) {
  264. if (n->target_name() == name && !n->has_been_destroyed()) {
  265. same_name_navigable = n;
  266. }
  267. }
  268. }
  269. // 1. Let chosen be null.
  270. JS::GCPtr<Navigable> chosen = nullptr;
  271. // 2. Let windowType be "existing or none".
  272. auto window_type = WindowType::ExistingOrNone;
  273. // 3. Let sandboxingFlagSet be current's active document's active sandboxing flag set.
  274. auto sandboxing_flag_set = active_document()->active_sandboxing_flag_set();
  275. // 4. If name is the empty string or an ASCII case-insensitive match for "_self", then set chosen to currentNavigable.
  276. if (name.is_empty() || Infra::is_ascii_case_insensitive_match(name, "_self"sv)) {
  277. chosen = this;
  278. }
  279. // 5. Otherwise, if name is an ASCII case-insensitive match for "_parent",
  280. // set chosen to currentNavigable's parent, if any, and currentNavigable otherwise.
  281. else if (Infra::is_ascii_case_insensitive_match(name, "_parent"sv)) {
  282. if (auto parent = this->parent())
  283. chosen = parent;
  284. else
  285. chosen = this;
  286. }
  287. // 6. Otherwise, if name is an ASCII case-insensitive match for "_top",
  288. // set chosen to currentNavigable's traversable navigable.
  289. else if (Infra::is_ascii_case_insensitive_match(name, "_top"sv)) {
  290. chosen = traversable_navigable();
  291. }
  292. // 7. Otherwise, if name is not an ASCII case-insensitive match for "_blank",
  293. // there exists a navigable whose target name is the same as name, currentNavigable's
  294. // active browsing context is familiar with that navigable's active browsing context,
  295. // and the user agent determines that the two browsing contexts are related enough that
  296. // it is ok if they reach each other, set chosen to that navigable. If there are multiple
  297. // matching navigables, the user agent should pick one in some arbitrary consistent manner,
  298. // such as the most recently opened, most recently focused, or more closely related, and set
  299. // chosen to it.
  300. else if (same_name_navigable != nullptr && (active_browsing_context()->is_familiar_with(*same_name_navigable->active_browsing_context()))) {
  301. // FIXME: Handle multiple name-match case
  302. // FIXME: When are these contexts 'not related enough' ?
  303. chosen = same_name_navigable;
  304. }
  305. // 8. Otherwise, a new top-level traversable is being requested, and what happens depends on the
  306. // user agent's configuration and abilities — it is determined by the rules given for the first
  307. // applicable option from the following list:
  308. else {
  309. // --> If current's active window does not have transient activation and the user agent has been configured to
  310. // not show popups (i.e., the user agent has a "popup blocker" enabled)
  311. if (!active_window()->has_transient_activation() && traversable_navigable()->page().should_block_pop_ups()) {
  312. // FIXME: The user agent may inform the user that a popup has been blocked.
  313. dbgln("Pop-up blocked!");
  314. }
  315. // --> If sandboxingFlagSet has the sandboxed auxiliary navigation browsing context flag set
  316. else if (has_flag(sandboxing_flag_set, SandboxingFlagSet::SandboxedAuxiliaryNavigation)) {
  317. // FIXME: The user agent may report to a developer console that a popup has been blocked.
  318. dbgln("Pop-up blocked!");
  319. }
  320. // --> If the user agent has been configured such that in this instance it will create a new top-level traversable
  321. else if (true) { // FIXME: When is this the case?
  322. // 1. Set windowType to "new and unrestricted".
  323. window_type = WindowType::NewAndUnrestricted;
  324. // 2. Let currentDocument be currentNavigable's active document.
  325. auto current_document = active_document();
  326. // 3. If currentDocument's cross-origin opener policy's value is "same-origin" or "same-origin-plus-COEP",
  327. // and currentDocument's origin is not same origin with currentDocument's relevant settings object's top-level origin, then:
  328. if ((current_document->cross_origin_opener_policy().value == CrossOriginOpenerPolicyValue::SameOrigin || current_document->cross_origin_opener_policy().value == CrossOriginOpenerPolicyValue::SameOriginPlusCOEP)
  329. && !current_document->origin().is_same_origin(relevant_settings_object(*current_document).top_level_origin)) {
  330. // 1. Set noopener to true.
  331. no_opener = TokenizedFeature::NoOpener::Yes;
  332. // 2. Set name to "_blank".
  333. name = "_blank"sv;
  334. // 3. Set windowType to "new with no opener".
  335. window_type = WindowType::NewWithNoOpener;
  336. }
  337. // NOTE: In the presence of a cross-origin opener policy,
  338. // nested documents that are cross-origin with their top-level browsing context's active document always set noopener to true.
  339. // 4. Let chosen be null.
  340. chosen = nullptr;
  341. // 5. Let targetName be the empty string.
  342. String target_name;
  343. // 6. If name is not an ASCII case-insensitive match for "_blank", then set targetName to name.
  344. if (!Infra::is_ascii_case_insensitive_match(name, "_blank"sv))
  345. target_name = MUST(String::from_utf8(name));
  346. auto create_new_traversable_closure = [this, window_type, no_opener, target_name, activate_tab](JS::GCPtr<BrowsingContext> opener) -> JS::NonnullGCPtr<Navigable> {
  347. // FIXME: The popup state for window.open is calculated after this call (somehow?)
  348. // Probably want to deviate from the spec and pass the popup state in here
  349. auto hints = WebViewHints {
  350. .popup = window_type != WindowType::ExistingOrNone,
  351. };
  352. auto [page, window_handle] = traversable_navigable()->page().client().page_did_request_new_web_view(activate_tab, hints, no_opener);
  353. auto traversable = TraversableNavigable::create_a_new_top_level_traversable(*page, opener, target_name).release_value_but_fixme_should_propagate_errors();
  354. page->set_top_level_traversable(traversable);
  355. traversable->set_window_handle(window_handle);
  356. return traversable;
  357. };
  358. auto create_new_traversable = JS::create_heap_function(heap(), move(create_new_traversable_closure));
  359. // 7. If noopener is true, then set chosen to the result of creating a new top-level traversable given null and targetName.
  360. if (no_opener == TokenizedFeature::NoOpener::Yes) {
  361. chosen = create_new_traversable->function()(nullptr);
  362. }
  363. // 8. Otherwise:
  364. else {
  365. // 1. Set chosen to the result of creating a new top-level traversable given currentNavigable's active browsing context and targetName.
  366. chosen = create_new_traversable->function()(active_browsing_context());
  367. // FIXME: 2. If sandboxingFlagSet's sandboxed navigation browsing context flag is set,
  368. // then set chosen's active browsing context's one permitted sandboxed navigator to currentNavigable's active browsing context.
  369. }
  370. // FIXME: 5. If sandboxingFlagSet's sandbox propagates to auxiliary browsing contexts flag is set,
  371. // then all the flags that are set in sandboxingFlagSet must be set in chosen's active browsing context's popup sandboxing flag set.
  372. // Our BrowsingContexts do not have SandboxingFlagSets yet, only documents do
  373. }
  374. // --> If the user agent has been configured such that in this instance t will reuse current
  375. else if (false) { // FIXME: When is this the case?
  376. // Set chosen to current.
  377. chosen = *this;
  378. }
  379. // --> If the user agent has been configured such that in this instance it will not find a browsing context
  380. else if (false) { // FIXME: When is this the case?
  381. // Do nothing.
  382. }
  383. }
  384. return { chosen.ptr(), window_type };
  385. }
  386. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#getting-session-history-entries
  387. Vector<JS::NonnullGCPtr<SessionHistoryEntry>>& Navigable::get_session_history_entries() const
  388. {
  389. // 1. Let traversable be navigable's traversable navigable.
  390. auto traversable = traversable_navigable();
  391. // FIXME 2. Assert: this is running within traversable's session history traversal queue.
  392. // 3. If navigable is traversable, return traversable's session history entries.
  393. if (this == traversable)
  394. return traversable->session_history_entries();
  395. // 4. Let docStates be an empty ordered set of document states.
  396. Vector<JS::GCPtr<DocumentState>> doc_states;
  397. // 5. For each entry of traversable's session history entries, append entry's document state to docStates.
  398. for (auto& entry : traversable->session_history_entries())
  399. doc_states.append(entry->document_state());
  400. // 6. For each docState of docStates:
  401. while (!doc_states.is_empty()) {
  402. auto doc_state = doc_states.take_first();
  403. // 1. For each nestedHistory of docState's nested histories:
  404. for (auto& nested_history : doc_state->nested_histories()) {
  405. // 1. If nestedHistory's id equals navigable's id, return nestedHistory's entries.
  406. if (nested_history.id == id())
  407. return nested_history.entries;
  408. // 2. For each entry of nestedHistory's entries, append entry's document state to docStates.
  409. for (auto& entry : nested_history.entries)
  410. doc_states.append(entry->document_state());
  411. }
  412. }
  413. VERIFY_NOT_REACHED();
  414. }
  415. // https://html.spec.whatwg.org/multipage/browsers.html#determining-navigation-params-policy-container
  416. static PolicyContainer determine_navigation_params_policy_container(URL::URL const& response_url,
  417. Optional<PolicyContainer> history_policy_container,
  418. Optional<PolicyContainer> initiator_policy_container,
  419. Optional<PolicyContainer> parent_policy_container,
  420. Optional<PolicyContainer> response_policy_container)
  421. {
  422. // NOTE: The clone a policy container AO is just a C++ copy
  423. // 1. If historyPolicyContainer is not null, then:
  424. if (history_policy_container.has_value()) {
  425. // FIXME: 1. Assert: responseURL requires storing the policy container in history.
  426. // 2. Return a clone of historyPolicyContainer.
  427. return *history_policy_container;
  428. }
  429. // 2. If responseURL is about:srcdoc, then:
  430. if (response_url == "about:srcdoc"sv) {
  431. // 1. Assert: parentPolicyContainer is not null.
  432. VERIFY(parent_policy_container.has_value());
  433. // 2. Return a clone of parentPolicyContainer.
  434. return *parent_policy_container;
  435. }
  436. // 3. If responseURL is local and initiatorPolicyContainer is not null, then return a clone of initiatorPolicyContainer.
  437. if (Fetch::Infrastructure::is_local_url(response_url) && initiator_policy_container.has_value())
  438. return *initiator_policy_container;
  439. // 4. If responsePolicyContainer is not null, then return responsePolicyContainer.
  440. // FIXME: File a spec issue to say "a clone of" here for consistency
  441. if (response_policy_container.has_value())
  442. return *response_policy_container;
  443. // 5. Return a new policy container.
  444. return {};
  445. }
  446. // https://html.spec.whatwg.org/multipage/browsers.html#obtain-coop
  447. static CrossOriginOpenerPolicy obtain_a_cross_origin_opener_policy(JS::NonnullGCPtr<Fetch::Infrastructure::Response>, Fetch::Infrastructure::Request::ReservedClientType const& reserved_client)
  448. {
  449. // 1. Let policy be a new cross-origin opener policy.
  450. CrossOriginOpenerPolicy policy = {};
  451. // AD-HOC: We don't yet setup environments in all cases
  452. if (reserved_client.has<Empty>())
  453. return policy;
  454. auto& reserved_environment = reserved_client.visit(
  455. [](Empty const&) -> Environment& { VERIFY_NOT_REACHED(); },
  456. [](Environment* env) -> Environment& { return *env; },
  457. [](JS::GCPtr<EnvironmentSettingsObject> eso) -> Environment& { return *eso; });
  458. // 2. If reservedEnvironment is a non-secure context, then return policy.
  459. if (is_non_secure_context(reserved_environment))
  460. return policy;
  461. // FIXME: We don't yet have the technology to extract structured data from Fetch headers
  462. // FIXME: 3. Let parsedItem be the result of getting a structured field value given `Cross-Origin-Opener-Policy` and "item" from response's header list.
  463. // FIXME: 4. If parsedItem is not null, then:
  464. // FIXME: nested steps...
  465. // FIXME: 5. Set parsedItem to the result of getting a structured field value given `Cross-Origin-Opener-Policy-Report-Only` and "item" from response's header list.
  466. // FIXME: 6. If parsedItem is not null, then:
  467. // FIXME: nested steps...
  468. // 7. Return policy.
  469. return policy;
  470. }
  471. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#attempt-to-create-a-non-fetch-scheme-document
  472. static JS::GCPtr<DOM::Document> attempt_to_create_a_non_fetch_scheme_document(NonFetchSchemeNavigationParams const& params)
  473. {
  474. // FIXME: Implement this algorithm to hand off to external software or display inline content
  475. dbgln("(FIXME) Don't know how to navigate to {}", params.url);
  476. return nullptr;
  477. }
  478. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#create-navigation-params-from-a-srcdoc-resource
  479. static WebIDL::ExceptionOr<NavigationParams> create_navigation_params_from_a_srcdoc_resource(JS::GCPtr<SessionHistoryEntry> entry, JS::GCPtr<Navigable> navigable, TargetSnapshotParams const& target_snapshot_params, Optional<String> navigation_id)
  480. {
  481. auto& vm = navigable->vm();
  482. auto& realm = navigable->active_window()->realm();
  483. // 1. Let documentResource be entry's document state's resource.
  484. auto document_resource = entry->document_state()->resource();
  485. VERIFY(document_resource.has<String>());
  486. // 2. Let response be a new response with
  487. // URL: about:srcdoc
  488. // header list: (`Content-Type`, `text/html`)
  489. // body: the UTF-8 encoding of documentResource, as a body
  490. auto response = Fetch::Infrastructure::Response::create(vm);
  491. response->url_list().append(URL::URL("about:srcdoc"));
  492. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, "text/html"sv));
  493. TRY_OR_THROW_OOM(vm, response->header_list()->append(move(header)));
  494. response->set_body(TRY(Fetch::Infrastructure::byte_sequence_as_body(realm, document_resource.get<String>().bytes())));
  495. // 3. Let responseOrigin be the result of determining the origin given response's URL, targetSnapshotParams's sandboxing flags, and entry's document state's origin.
  496. auto response_origin = determine_the_origin(*response->url(), target_snapshot_params.sandboxing_flags, entry->document_state()->origin());
  497. // 4. Let coop be a new cross-origin opener policy.
  498. CrossOriginOpenerPolicy coop = {};
  499. // 5. Let coopEnforcementResult be a new cross-origin opener policy enforcement result with
  500. // url: response's URL
  501. // origin: responseOrigin
  502. // cross-origin opener policy: coop
  503. CrossOriginOpenerPolicyEnforcementResult coop_enforcement_result {
  504. .url = *response->url(),
  505. .origin = response_origin,
  506. .cross_origin_opener_policy = coop
  507. };
  508. // 6. Let policyContainer be the result of determining navigation params policy container given response's URL,
  509. // entry's document state's history policy container, null, navigable's container document's policy container, and null.
  510. Optional<PolicyContainer> history_policy_container = entry->document_state()->history_policy_container().visit(
  511. [](PolicyContainer const& c) -> Optional<PolicyContainer> { return c; },
  512. [](DocumentState::Client) -> Optional<PolicyContainer> { return {}; });
  513. PolicyContainer policy_container;
  514. if (navigable->container()) {
  515. // NOTE: Specification assumes that only navigables corresponding to iframes can be navigated to about:srcdoc.
  516. // We also use srcdoc to implement load_html() for top level navigables so we need to null check container
  517. // because it might be null.
  518. policy_container = determine_navigation_params_policy_container(*response->url(), history_policy_container, {}, navigable->container_document()->policy_container(), {});
  519. }
  520. // 7. Return a new navigation params, with
  521. // id: navigationId
  522. // navigable: navigable
  523. // request: null
  524. // response: response
  525. // fetch controller: null
  526. // commit early hints: null
  527. // COOP enforcement result: coopEnforcementResult
  528. // reserved environment: null
  529. // origin: responseOrigin
  530. // policy container: policyContainer
  531. // final sandboxing flag set: targetSnapshotParams's sandboxing flags
  532. // cross-origin opener policy: coop
  533. // FIXME: navigation timing type: navTimingType
  534. // about base URL: entry's document state's about base URL
  535. return NavigationParams {
  536. .id = move(navigation_id),
  537. .navigable = navigable,
  538. .request = nullptr,
  539. .response = *response,
  540. .fetch_controller = nullptr,
  541. .commit_early_hints = nullptr,
  542. .coop_enforcement_result = move(coop_enforcement_result),
  543. .reserved_environment = {},
  544. .origin = move(response_origin),
  545. .policy_container = policy_container,
  546. .final_sandboxing_flag_set = target_snapshot_params.sandboxing_flags,
  547. .cross_origin_opener_policy = move(coop),
  548. .about_base_url = entry->document_state()->about_base_url(),
  549. };
  550. }
  551. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#create-navigation-params-by-fetching
  552. static WebIDL::ExceptionOr<Variant<Empty, NavigationParams, NonFetchSchemeNavigationParams>> create_navigation_params_by_fetching(JS::GCPtr<SessionHistoryEntry> entry, JS::GCPtr<Navigable> navigable, SourceSnapshotParams const& source_snapshot_params, TargetSnapshotParams const& target_snapshot_params, CSPNavigationType csp_navigation_type, Optional<String> navigation_id)
  553. {
  554. auto& vm = navigable->vm();
  555. auto& realm = navigable->active_window()->realm();
  556. auto& active_document = *navigable->active_document();
  557. (void)csp_navigation_type;
  558. // FIXME: 1. Assert: this is running in parallel.
  559. // 2. Let documentResource be entry's document state's resource.
  560. auto document_resource = entry->document_state()->resource();
  561. // 3. Let request be a new request, with
  562. // url: entry's URL
  563. // client: sourceSnapshotParams's fetch client
  564. // destination: "document"
  565. // credentials mode: "include"
  566. // use-URL-credentials flag: set
  567. // redirect mode: "manual"
  568. // replaces client id: navigable's active document's relevant settings object's id
  569. // mode: "navigate"
  570. // referrer: entry's document state's request referrer
  571. // referrer policy: entry's document state's request referrer policy
  572. auto request = Fetch::Infrastructure::Request::create(vm);
  573. request->set_url(entry->url());
  574. request->set_client(source_snapshot_params.fetch_client);
  575. request->set_destination(Fetch::Infrastructure::Request::Destination::Document);
  576. request->set_credentials_mode(Fetch::Infrastructure::Request::CredentialsMode::Include);
  577. request->set_use_url_credentials(true);
  578. request->set_redirect_mode(Fetch::Infrastructure::Request::RedirectMode::Manual);
  579. request->set_replaces_client_id(active_document.relevant_settings_object().id);
  580. request->set_mode(Fetch::Infrastructure::Request::Mode::Navigate);
  581. request->set_referrer(entry->document_state()->request_referrer());
  582. // 4. If documentResource is a POST resource, then:
  583. if (document_resource.has<POSTResource>()) {
  584. // 1. Set request's method to `POST`.
  585. request->set_method(TRY_OR_THROW_OOM(vm, ByteBuffer::copy("POST"sv.bytes())));
  586. // 2. Set request's body to documentResource's request body.
  587. request->set_body(document_resource.get<POSTResource>().request_body.value());
  588. // 3. Set `Content-Type` to documentResource's request content-type in request's header list.
  589. auto request_content_type = document_resource.get<POSTResource>().request_content_type;
  590. auto request_content_type_string = [request_content_type]() {
  591. switch (request_content_type) {
  592. case POSTResource::RequestContentType::ApplicationXWWWFormUrlencoded:
  593. return "application/x-www-form-urlencoded"sv;
  594. case POSTResource::RequestContentType::MultipartFormData:
  595. return "multipart/form-data"sv;
  596. case POSTResource::RequestContentType::TextPlain:
  597. return "text/plain"sv;
  598. default:
  599. VERIFY_NOT_REACHED();
  600. }
  601. }();
  602. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, request_content_type_string));
  603. TRY_OR_THROW_OOM(vm, request->header_list()->append(move(header)));
  604. }
  605. // 5. If entry's document state's reload pending is true, then set request's reload-navigation flag.
  606. if (entry->document_state()->reload_pending())
  607. request->set_reload_navigation(true);
  608. // 6. Otherwise, if entry's document state's ever populated is true, then set request's history-navigation flag.
  609. if (entry->document_state()->ever_populated())
  610. request->set_history_navigation(true);
  611. // 7. If sourceSnapshotParams's has transient activation is true, then set request's user-activation to true.
  612. if (source_snapshot_params.has_transient_activation)
  613. request->set_user_activation(true);
  614. // 8. If navigable's container is non-null:
  615. if (navigable->container() != nullptr) {
  616. // 1. If the navigable's container has a browsing context scope origin, then set request's origin to that browsing context scope origin.
  617. // FIXME: From "browsing context scope origin": This definition is broken and needs investigation to see what it was intended to express: see issue #4703.
  618. // The referenced issue suggests that it is a no-op to retrieve the browsing context scope origin.
  619. // 2. Set request's destination to navigable's container's local name.
  620. // FIXME: Are there other container types? If so, we need a helper here
  621. Web::Fetch::Infrastructure::Request::Destination destination = is<HTMLIFrameElement>(*navigable->container()) ? Web::Fetch::Infrastructure::Request::Destination::IFrame
  622. : Web::Fetch::Infrastructure::Request::Destination::Object;
  623. request->set_destination(destination);
  624. // 3. If sourceSnapshotParams's fetch client is navigable's container document's relevant settings object,
  625. // then set request's initiator type to navigable's container's local name.
  626. // NOTE: This ensure that only container-initiated navigations are reported to resource timing.
  627. if (source_snapshot_params.fetch_client == &navigable->container_document()->relevant_settings_object()) {
  628. // FIXME: Are there other container types? If so, we need a helper here
  629. Web::Fetch::Infrastructure::Request::InitiatorType initiator_type = is<HTMLIFrameElement>(*navigable->container()) ? Web::Fetch::Infrastructure::Request::InitiatorType::IFrame
  630. : Web::Fetch::Infrastructure::Request::InitiatorType::Object;
  631. request->set_initiator_type(initiator_type);
  632. }
  633. }
  634. // 9. Let response be null.
  635. // NOTE: We use a heap-allocated cell to hold the response pointer because the processResponse callback below
  636. // might use it after this stack is freed.
  637. auto response_holder = ResponseHolder::create(vm);
  638. // 10. Let responseOrigin be null.
  639. Optional<HTML::Origin> response_origin;
  640. // 11. Let fetchController be null.
  641. JS::GCPtr<Fetch::Infrastructure::FetchController> fetch_controller = nullptr;
  642. // 12. Let coopEnforcementResult be a new cross-origin opener policy enforcement result, with
  643. // - url: navigable's active document's URL
  644. // - origin: navigable's active document's origin
  645. // - cross-origin opener policy: navigable's active document's cross-origin opener policy
  646. // - current context is navigation source: true if navigable's active document's origin is same origin with
  647. // entry's document state's initiator origin otherwise false
  648. CrossOriginOpenerPolicyEnforcementResult coop_enforcement_result = {
  649. .url = active_document.url(),
  650. .origin = active_document.origin(),
  651. .cross_origin_opener_policy = active_document.cross_origin_opener_policy(),
  652. .current_context_is_navigation_source = entry->document_state()->initiator_origin().has_value() && active_document.origin().is_same_origin(*entry->document_state()->initiator_origin())
  653. };
  654. // 13. Let finalSandboxFlags be an empty sandboxing flag set.
  655. SandboxingFlagSet final_sandbox_flags = {};
  656. // 14. Let responsePolicyContainer be null.
  657. Optional<PolicyContainer> response_policy_container = {};
  658. // 15. Let responseCOOP be a new cross-origin opener policy.
  659. CrossOriginOpenerPolicy response_coop = {};
  660. // 16. Let locationURL be null.
  661. ErrorOr<Optional<URL::URL>> location_url { OptionalNone {} };
  662. // 17. Let currentURL be request's current URL.
  663. URL::URL current_url = request->current_url();
  664. // 18. Let commitEarlyHints be null.
  665. Function<void(DOM::Document&)> commit_early_hints = nullptr;
  666. // 19. While true:
  667. while (true) {
  668. // 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:
  669. // FIXME: 2. If request's reserved client is null, then:
  670. // 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]
  671. // 4. Set response to null.
  672. response_holder->set_response(nullptr);
  673. // 5. If fetchController is null, then set fetchController to the result of fetching request,
  674. // with processEarlyHintsResponse set to processEarlyHintsResponseas defined below, processResponse
  675. // set to processResponse as defined below, and useParallelQueue set to true.
  676. if (!fetch_controller) {
  677. // FIXME: Let processEarlyHintsResponse be the following algorithm given a response earlyResponse:
  678. // Let processResponse be the following algorithm given a response fetchedResponse:
  679. auto process_response = [response_holder](JS::NonnullGCPtr<Fetch::Infrastructure::Response> fetch_response) {
  680. // 1. Set response to fetchedResponse.
  681. response_holder->set_response(fetch_response);
  682. };
  683. fetch_controller = TRY(Fetch::Fetching::fetch(
  684. realm,
  685. request,
  686. Fetch::Infrastructure::FetchAlgorithms::create(vm,
  687. {
  688. .process_request_body_chunk_length = {},
  689. .process_request_end_of_body = {},
  690. .process_early_hints_response = {},
  691. .process_response = move(process_response),
  692. .process_response_end_of_body = {},
  693. .process_response_consume_body = {},
  694. }),
  695. Fetch::Fetching::UseParallelQueue::Yes));
  696. }
  697. // 6. Otherwise, process the next manual redirect for fetchController.
  698. else {
  699. fetch_controller->process_next_manual_redirect();
  700. }
  701. // 7. Wait until either response is non-null, or navigable's ongoing navigation changes to no longer equal navigationId.
  702. Platform::EventLoopPlugin::the().spin_until([&]() {
  703. if (response_holder->response() != nullptr)
  704. return true;
  705. if (navigation_id.has_value() && (!navigable->ongoing_navigation().has<String>() || navigable->ongoing_navigation().get<String>() != *navigation_id))
  706. return true;
  707. return false;
  708. });
  709. // If the latter condition occurs, then abort fetchController, and return. Otherwise, proceed onward.
  710. if (navigation_id.has_value() && (!navigable->ongoing_navigation().has<String>() || navigable->ongoing_navigation().get<String>() != *navigation_id)) {
  711. fetch_controller->abort(realm, {});
  712. return Empty {};
  713. }
  714. // 8. If request's body is null, then set entry's document state's resource to null.
  715. if (!request->body().has<Empty>()) {
  716. entry->document_state()->set_resource(Empty {});
  717. }
  718. // FIXME 9. Set responsePolicyContainer to the result of creating a policy container from a fetch response given response and request's reserved client.
  719. // FIXME 10. Set finalSandboxFlags to the union of targetSnapshotParams's sandboxing flags and responsePolicyContainer's CSP list's CSP-derived sandboxing flags.
  720. // 11. Set responseOrigin to the result of determining the origin given response's URL, finalSandboxFlags, and entry's document state's initiator origin.
  721. response_origin = determine_the_origin(*response_holder->response()->url(), final_sandbox_flags, entry->document_state()->initiator_origin());
  722. // 12. If navigable is a top-level traversable, then:
  723. if (navigable->is_top_level_traversable()) {
  724. // 1. Set responseCOOP to the result of obtaining a cross-origin opener policy given response and request's reserved client.
  725. response_coop = obtain_a_cross_origin_opener_policy(*response_holder->response(), request->reserved_client());
  726. // FIXME: 2. Set coopEnforcementResult to the result of enforcing the response's cross-origin opener policy given navigable's active browsing context,
  727. // response's URL, responseOrigin, responseCOOP, coopEnforcementResult and request's referrer.
  728. // FIXME: 3. If finalSandboxFlags is not empty and responseCOOP's value is not "unsafe-none", then set response to an appropriate network error and break.
  729. // NOTE: This results in a network error as one cannot simultaneously provide a clean slate to a response
  730. // using cross-origin opener policy and sandbox the result of navigating to that response.
  731. }
  732. // 13. FIXME If response is not a network error, navigable is a child navigable, and the result of performing a cross-origin resource policy check
  733. // with navigable's container document's origin, navigable's container document's relevant settings object, request's destination, response,
  734. // and true is blocked, then set response to a network error and break.
  735. // NOTE: Here we're running the cross-origin resource policy check against the parent navigable rather than navigable itself
  736. // This is because we care about the same-originness of the embedded content against the parent context, not the navigation source.
  737. // 14. Set locationURL to response's location URL given currentURL's fragment.
  738. location_url = response_holder->response()->location_url(current_url.fragment());
  739. VERIFY(!location_url.is_error());
  740. // 15. If locationURL is failure or null, then break.
  741. if (location_url.is_error() || !location_url.value().has_value()) {
  742. break;
  743. }
  744. // 16. Assert: locationURL is a URL.
  745. VERIFY(location_url.value()->is_valid());
  746. // 17. Set entry's classic history API state to StructuredSerializeForStorage(null).
  747. entry->set_classic_history_api_state(MUST(structured_serialize_for_storage(vm, JS::js_null())));
  748. // 18. Let oldDocState be entry's document state.
  749. auto old_doc_state = entry->document_state();
  750. // 19. Set entry's document state to a new document state, with
  751. // history policy container: a clone of the oldDocState's history policy container if it is non-null; null otherwise
  752. // request referrer: oldDocState's request referrer
  753. // request referrer policy: oldDocState's request referrer policy
  754. // origin: oldDocState's origin
  755. // resource: oldDocState's resource
  756. // ever populated: oldDocState's ever populated
  757. // navigable target name: oldDocState's navigable target name
  758. auto new_document_state = navigable->heap().allocate_without_realm<DocumentState>();
  759. new_document_state->set_history_policy_container(old_doc_state->history_policy_container());
  760. new_document_state->set_request_referrer(old_doc_state->request_referrer());
  761. new_document_state->set_request_referrer_policy(old_doc_state->request_referrer_policy());
  762. new_document_state->set_origin(old_doc_state->origin());
  763. new_document_state->set_resource(old_doc_state->resource());
  764. new_document_state->set_ever_populated(old_doc_state->ever_populated());
  765. new_document_state->set_navigable_target_name(old_doc_state->navigable_target_name());
  766. entry->set_document_state(new_document_state);
  767. // 20. If locationURL's scheme is not an HTTP(S) scheme, then:
  768. if (!Fetch::Infrastructure::is_http_or_https_scheme(location_url.value()->scheme())) {
  769. // 1. Set entry's document state's resource to null.
  770. entry->document_state()->set_resource(Empty {});
  771. // 2. Break.
  772. break;
  773. }
  774. // 21. Set currentURL to locationURL.
  775. current_url = location_url.value().value();
  776. // 22. Set entry's URL to currentURL.
  777. entry->set_url(current_url);
  778. }
  779. // 20. If locationURL is a URL whose scheme is not a fetch scheme, then return a new non-fetch scheme navigation params, with
  780. if (!location_url.is_error() && location_url.value().has_value() && !Fetch::Infrastructure::is_fetch_scheme(location_url.value().value().scheme())) {
  781. // - id: navigationId
  782. // - navigable: navigable
  783. // - URL: locationURL
  784. // - target snapshot sandboxing flags: targetSnapshotParams's sandboxing flags
  785. // - source snapshot has transient activation: sourceSnapshotParams's has transient activation
  786. // - initiator origin: responseOrigin
  787. // FIXME: - navigation timing type: navTimingType
  788. return NonFetchSchemeNavigationParams {
  789. .id = navigation_id,
  790. .navigable = navigable,
  791. .url = location_url.release_value().value(),
  792. .target_snapshot_sandboxing_flags = target_snapshot_params.sandboxing_flags,
  793. .source_snapshot_has_transient_activation = source_snapshot_params.has_transient_activation,
  794. .initiator_origin = move(*response_origin),
  795. };
  796. }
  797. // 21. If any of the following are true:
  798. // - response is a network error;
  799. // - locationURL is failure; or
  800. // - locationURL is a URL whose scheme is a fetch scheme
  801. // then return null.
  802. 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()))) {
  803. return Empty {};
  804. }
  805. // 22. Assert: locationURL is null and response is not a network error.
  806. VERIFY(!location_url.value().has_value());
  807. VERIFY(!response_holder->response()->is_network_error());
  808. // 23. Let resultPolicyContainer be the result of determining navigation params policy container given response's URL,
  809. // entry's document state's history policy container, sourceSnapshotParams's source policy container, null, and responsePolicyContainer.
  810. Optional<PolicyContainer> history_policy_container = entry->document_state()->history_policy_container().visit(
  811. [](PolicyContainer const& c) -> Optional<PolicyContainer> { return c; },
  812. [](DocumentState::Client) -> Optional<PolicyContainer> { return {}; });
  813. auto result_policy_container = determine_navigation_params_policy_container(*response_holder->response()->url(), history_policy_container, source_snapshot_params.source_policy_container, {}, response_policy_container);
  814. // 24. If navigable's container is an iframe, and response's timing allow passed flag is set, then set container's pending resource-timing start time to null.
  815. if (navigable->container() && is<HTML::HTMLIFrameElement>(*navigable->container()) && response_holder->response()->timing_allow_passed())
  816. static_cast<HTML::HTMLIFrameElement&>(*navigable->container()).set_pending_resource_start_time({});
  817. // 25. Return a new navigation params, with
  818. // id: navigationId
  819. // navigable: navigable
  820. // request: request
  821. // response: response
  822. // fetch controller: fetchController
  823. // commit early hints: commitEarlyHints
  824. // cross-origin opener policy: responseCOOP
  825. // reserved environment: request's reserved client
  826. // origin: responseOrigin
  827. // policy container: resultPolicyContainer
  828. // final sandboxing flag set: finalSandboxFlags
  829. // COOP enforcement result: coopEnforcementResult
  830. // FIXME: navigation timing type: navTimingType
  831. // about base URL: entry's document state's about base URL
  832. HTML::NavigationParams navigation_params {
  833. .id = navigation_id,
  834. .navigable = navigable,
  835. .request = request,
  836. .response = *response_holder->response(),
  837. .fetch_controller = fetch_controller,
  838. .commit_early_hints = move(commit_early_hints),
  839. .coop_enforcement_result = coop_enforcement_result,
  840. .reserved_environment = request->reserved_client(),
  841. .origin = *response_origin,
  842. .policy_container = result_policy_container,
  843. .final_sandboxing_flag_set = final_sandbox_flags,
  844. .cross_origin_opener_policy = response_coop,
  845. .about_base_url = entry->document_state()->about_base_url(),
  846. };
  847. return navigation_params;
  848. }
  849. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#attempt-to-populate-the-history-entry's-document
  850. WebIDL::ExceptionOr<void> Navigable::populate_session_history_entry_document(
  851. JS::GCPtr<SessionHistoryEntry> entry,
  852. SourceSnapshotParams const& source_snapshot_params,
  853. TargetSnapshotParams const& target_snapshot_params,
  854. Optional<String> navigation_id,
  855. Variant<Empty, NavigationParams, NonFetchSchemeNavigationParams> navigation_params,
  856. CSPNavigationType csp_navigation_type,
  857. bool allow_POST,
  858. Function<void()> completion_steps)
  859. {
  860. // FIXME: 1. Assert: this is running in parallel.
  861. // 2. Assert: if navigationParams is non-null, then navigationParams's response is non-null.
  862. // NavigationParams' response field is NonnullGCPtr
  863. if (!navigation_params.has<Empty>())
  864. VERIFY(navigation_params.has<NavigationParams>());
  865. // 3. Let currentBrowsingContext be navigable's active browsing context.
  866. [[maybe_unused]] auto current_browsing_context = active_browsing_context();
  867. // 4. Let documentResource be entry's document state's resource.
  868. auto document_resource = entry->document_state()->resource();
  869. // 5. If navigationParams is null, then:
  870. if (navigation_params.has<Empty>()) {
  871. // 1. If documentResource is a string, then set navigationParams to the result
  872. // of creating navigation params from a srcdoc resource given entry, navigable,
  873. // targetSnapshotParams, navigationId, and navTimingType.
  874. if (document_resource.has<String>()) {
  875. navigation_params = TRY(create_navigation_params_from_a_srcdoc_resource(entry, this, target_snapshot_params, navigation_id));
  876. }
  877. // 2. Otherwise, if both of the following are true:
  878. // - entry's URL's scheme is a fetch scheme; and
  879. // - documentResource is null, or allowPOST is true and documentResource's request body is not failure (FIXME: check if request body is not failure)
  880. else if (Fetch::Infrastructure::is_fetch_scheme(entry->url().scheme()) && (document_resource.has<Empty>() || allow_POST)) {
  881. navigation_params = TRY(create_navigation_params_by_fetching(entry, this, source_snapshot_params, target_snapshot_params, csp_navigation_type, navigation_id));
  882. }
  883. // 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:
  884. else if (!Fetch::Infrastructure::is_fetch_scheme(entry->url().scheme())) {
  885. // - id: navigationId
  886. // - navigable: navigable
  887. // - URL: entry's URL
  888. // - target snapshot sandboxing flags: targetSnapshotParams's sandboxing flags
  889. // - source snapshot has transient activation: sourceSnapshotParams's has transient activation
  890. // - initiator origin: entry's document state's initiator origin
  891. // FIXME: - navigation timing type: navTimingType
  892. navigation_params = NonFetchSchemeNavigationParams {
  893. .id = navigation_id,
  894. .navigable = this,
  895. .url = entry->url(),
  896. .target_snapshot_sandboxing_flags = target_snapshot_params.sandboxing_flags,
  897. .source_snapshot_has_transient_activation = source_snapshot_params.has_transient_activation,
  898. .initiator_origin = *entry->document_state()->initiator_origin(),
  899. };
  900. }
  901. }
  902. // NOTE: Not in the spec but queuing task on the next step will fail because active_window() does not exist for destroyed navigable.
  903. if (has_been_destroyed())
  904. return {};
  905. // 6. Queue a global task on the navigation and traversal task source, given navigable's active window, to run these steps:
  906. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this, entry, navigation_params = move(navigation_params), navigation_id, completion_steps = move(completion_steps)]() mutable {
  907. // NOTE: This check is not in the spec but we should not continue navigation if navigable has been destroyed.
  908. if (has_been_destroyed())
  909. return;
  910. // 1. If navigable's ongoing navigation no longer equals navigationId, then run completionSteps and return.
  911. if (navigation_id.has_value() && (!ongoing_navigation().has<String>() || ongoing_navigation().get<String>() != *navigation_id)) {
  912. completion_steps();
  913. return;
  914. }
  915. // 2. Let failure be false.
  916. auto failure = false;
  917. // 3. If navigationParams is a non-fetch scheme navigation params, then set entry's document state's document to the result of
  918. // running attempt to create a non-fetch scheme document navigationParams
  919. if (navigation_params.has<NonFetchSchemeNavigationParams>()) {
  920. // FIXME: https://github.com/whatwg/html/issues/9767
  921. // We probably are expected to skip to steps 13 and 14 and return after doing this
  922. entry->document_state()->set_document(attempt_to_create_a_non_fetch_scheme_document(navigation_params.get<NonFetchSchemeNavigationParams>()));
  923. if (entry->document()) {
  924. entry->document_state()->set_ever_populated(true);
  925. }
  926. completion_steps();
  927. return;
  928. }
  929. // 4. Otherwise, if navigationParams is null, then set failure to true.
  930. if (navigation_params.has<Empty>()) {
  931. failure = true;
  932. }
  933. // 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,
  934. // navigationParams's response, navigationParams's policy container's CSP list, cspNavigationType, and navigable is "Blocked", then set failure to true.
  935. // 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
  936. // navigationParams's response, navigable, and navigationParams's policy container's embedder policy is false, then set failure to true.
  937. // FIXME: 7. Otherwise, if the result of checking a navigation response's adherence to `X-Frame-Options` given navigationParams's response, navigable,
  938. // navigationParams's policy container's CSP list, and navigationParams's origin is false, then set failure to true.
  939. // 8. If failure is true, then:
  940. if (failure) {
  941. // 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.
  942. // The inline content should indicate to the user the sort of error that occurred.
  943. // FIXME: Add error message to generated error page
  944. auto error_html = load_error_page(entry->url()).release_value_but_fixme_should_propagate_errors();
  945. entry->document_state()->set_document(create_document_for_inline_content(this, navigation_id, [error_html](auto& document) {
  946. auto parser = HTML::HTMLParser::create(document, error_html, "utf-8"sv);
  947. document.set_url(URL::URL("about:error"));
  948. parser->run();
  949. }));
  950. // 2. Set entry's document state's document's salvageable to false.
  951. entry->document()->set_salvageable(false);
  952. // FIXME: 3. If navigationParams is not null, then:
  953. if (!navigation_params.has<Empty>()) {
  954. // 1. FIXME: Run the environment discarding steps for navigationParams's reserved environment.
  955. // 2. Invoke WebDriver BiDi navigation failed with currentBrowsingContext and a new WebDriver BiDi navigation status
  956. // whose id is navigationId, status is "canceled", and url is navigationParams's response's URL.
  957. }
  958. }
  959. // FIXME: 9. Otherwise, if navigationParams's response's status is 204 or 205, then:
  960. else if (navigation_params.get<NavigationParams>().response->status() == 204 || navigation_params.get<NavigationParams>().response->status() == 205) {
  961. // 1. Run completionSteps.
  962. completion_steps();
  963. // 2. Return.
  964. return;
  965. }
  966. // FIXME: 10. Otherwise, if navigationParams's response has a `Content-Disposition`
  967. // header specifying the attachment disposition type, then:
  968. // 11. Otherwise:
  969. else {
  970. // 1. Let document be the result of loading a document given navigationParams, sourceSnapshotParams,
  971. // and entry's document state's initiator origin.
  972. auto document = load_document(navigation_params.get<NavigationParams>());
  973. // 2. If document is null, then run completionSteps and return.
  974. if (!document) {
  975. completion_steps();
  976. return;
  977. }
  978. // 3. Set entry's document state's document to document.
  979. entry->document_state()->set_document(document.ptr());
  980. // 4. Set entry's document state's origin to document's origin.
  981. entry->document_state()->set_origin(document->origin());
  982. }
  983. // FIXME: 12. If entry's document state's request referrer is "client", then set it to request's referrer.
  984. // https://github.com/whatwg/html/issues/9767
  985. // What is "request" here?
  986. // 13. If entry's document state's document is not null, then set entry's document state's ever populated to true.
  987. if (entry->document()) {
  988. entry->document_state()->set_ever_populated(true);
  989. }
  990. // 14. Run completionSteps.
  991. completion_steps();
  992. });
  993. return {};
  994. }
  995. // To navigate a navigable navigable to a URL url using a Document sourceDocument,
  996. // with an optional POST resource, string, or null documentResource (default null),
  997. // an optional response-or-null response (default null), an optional boolean exceptionsEnabled (default false),
  998. // an optional NavigationHistoryBehavior historyHandling (default "auto"),
  999. // an optional serialized state-or-null navigationAPIState (default null),
  1000. // an optional entry list or null formDataEntryList (default null),
  1001. // an optional referrer policy referrerPolicy (default the empty string),
  1002. // and an optional user navigation involvement userInvolvement (default "none"):
  1003. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate
  1004. WebIDL::ExceptionOr<void> Navigable::navigate(NavigateParams params)
  1005. {
  1006. auto const& url = params.url;
  1007. auto source_document = params.source_document;
  1008. auto const& document_resource = params.document_resource;
  1009. auto response = params.response;
  1010. auto exceptions_enabled = params.exceptions_enabled;
  1011. auto history_handling = params.history_handling;
  1012. auto const& navigation_api_state = params.navigation_api_state;
  1013. auto const& form_data_entry_list = params.form_data_entry_list;
  1014. auto referrer_policy = params.referrer_policy;
  1015. auto user_involvement = params.user_involvement;
  1016. auto& active_document = *this->active_document();
  1017. auto& realm = active_document.realm();
  1018. auto& vm = this->vm();
  1019. // 1. Let cspNavigationType be "form-submission" if formDataEntryList is non-null; otherwise "other".
  1020. auto csp_navigation_type = form_data_entry_list.has_value() ? CSPNavigationType::FormSubmission : CSPNavigationType::Other;
  1021. // 2. Let sourceSnapshotParams be the result of snapshotting source snapshot params given sourceDocument.
  1022. auto source_snapshot_params = source_document->snapshot_source_snapshot_params();
  1023. // 3. Let initiatorOriginSnapshot be sourceDocument's origin.
  1024. auto initiator_origin_snapshot = source_document->origin();
  1025. // 4. Let initiatorBaseURLSnapshot be sourceDocument's document base URL.
  1026. auto initiator_base_url_snapshot = source_document->base_url();
  1027. // 5. If sourceDocument's node navigable is not allowed by sandboxing to navigate navigable given and sourceSnapshotParams, then:
  1028. if (!source_document->navigable()->allowed_by_sandboxing_to_navigate(*this, source_snapshot_params)) {
  1029. // 1. If exceptionsEnabled is true, then throw a "SecurityError" DOMException.
  1030. if (exceptions_enabled) {
  1031. return WebIDL::SecurityError::create(realm, "Source document's node navigable is not allowed to navigate"_fly_string);
  1032. }
  1033. // 2 Return.
  1034. return {};
  1035. }
  1036. // 6. Let navigationId be the result of generating a random UUID.
  1037. String navigation_id = TRY_OR_THROW_OOM(vm, Crypto::generate_random_uuid());
  1038. // FIXME: 7. If the surrounding agent is equal to navigable's active document's relevant agent, then continue these steps.
  1039. // Otherwise, queue a global task on the navigation and traversal task source given navigable's active window to continue these steps.
  1040. // 8. If navigable's active document's unload counter is greater than 0,
  1041. // then invoke WebDriver BiDi navigation failed with a WebDriver BiDi navigation status whose id is navigationId,
  1042. // status is "canceled", and url is url, and return.
  1043. if (active_document.unload_counter() > 0) {
  1044. // FIXME: invoke WebDriver BiDi navigation failed with a WebDriver BiDi navigation status whose id is navigationId,
  1045. // status is "canceled", and url is url
  1046. return {};
  1047. }
  1048. // 9. If historyHandling is "auto", then:
  1049. if (history_handling == Bindings::NavigationHistoryBehavior::Auto) {
  1050. // FIXME: Fix spec typo targetNavigable --> navigable
  1051. // 1. If url equals navigable's active document's URL,
  1052. // and initiatorOriginSnapshot is same origin with targetNavigable's active document's origin,
  1053. // then set historyHandling to "replace".
  1054. if (url.equals(active_document.url(), URL::ExcludeFragment::Yes) && initiator_origin_snapshot.is_same_origin(active_document.origin()))
  1055. history_handling = Bindings::NavigationHistoryBehavior::Replace;
  1056. // 2. Otherwise, set historyHandling to "push".
  1057. else
  1058. history_handling = Bindings::NavigationHistoryBehavior::Push;
  1059. }
  1060. // 10. If the navigation must be a replace given url and navigable's active document, then set historyHandling to "replace".
  1061. if (navigation_must_be_a_replace(url, active_document))
  1062. history_handling = Bindings::NavigationHistoryBehavior::Replace;
  1063. // 11. If all of the following are true:
  1064. // - documentResource is null;
  1065. // - response is null;
  1066. // - url equals navigable's active session history entry's URL with exclude fragments set to true; and
  1067. // - url's fragment is non-null
  1068. if (document_resource.has<Empty>()
  1069. && !response
  1070. && url.equals(active_session_history_entry()->url(), URL::ExcludeFragment::Yes)
  1071. && url.fragment().has_value()) {
  1072. // 1. Navigate to a fragment given navigable, url, historyHandling, userInvolvement, navigationAPIState, and navigationId.
  1073. TRY(navigate_to_a_fragment(url, to_history_handling_behavior(history_handling), user_involvement, navigation_api_state, navigation_id));
  1074. traversable_navigable()->process_session_history_traversal_queue();
  1075. // 2. Return.
  1076. return {};
  1077. }
  1078. // 12. If navigable's parent is non-null, then set navigable's is delaying load events to true.
  1079. if (parent() != nullptr)
  1080. set_delaying_load_events(true);
  1081. // 13. Let targetBrowsingContext be navigable's active browsing context.
  1082. [[maybe_unused]] auto target_browsing_context = active_browsing_context();
  1083. // 14. Let targetSnapshotParams be the result of snapshotting target snapshot params given navigable.
  1084. auto target_snapshot_params = snapshot_target_snapshot_params();
  1085. // FIXME: 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".
  1086. // 16. If navigable's ongoing navigation is "traversal", then:
  1087. if (ongoing_navigation().has<Traversal>()) {
  1088. // 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.
  1089. // 2. Return.
  1090. return {};
  1091. }
  1092. // 17. Set navigable's ongoing navigation to navigationId.
  1093. set_ongoing_navigation(navigation_id);
  1094. // 18. If url's scheme is "javascript", then:
  1095. if (url.scheme() == "javascript"sv) {
  1096. // 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.
  1097. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this, url, history_handling, initiator_origin_snapshot, csp_navigation_type, navigation_id] {
  1098. (void)navigate_to_a_javascript_url(url, to_history_handling_behavior(history_handling), initiator_origin_snapshot, csp_navigation_type, navigation_id);
  1099. });
  1100. // 2. Return.
  1101. return {};
  1102. }
  1103. // 19. If all of the following are true:
  1104. // - userInvolvement is not "browser UI";
  1105. // - navigable's active document's origin is same origin-domain with sourceDocument's origin;
  1106. // - navigable's active document's is initial about:blank is false; and
  1107. // - url's scheme is a fetch scheme
  1108. // then:
  1109. if (user_involvement != UserNavigationInvolvement::BrowserUI && active_document.origin().is_same_origin_domain(source_document->origin()) && !active_document.is_initial_about_blank() && Fetch::Infrastructure::is_fetch_scheme(url.scheme())) {
  1110. // 1. Let navigation be navigable's active window's navigation API.
  1111. auto navigation = active_window()->navigation();
  1112. // 2. Let entryListForFiring be formDataEntryList if documentResource is a POST resource; otherwise, null.
  1113. auto entry_list_for_firing = [&]() -> Optional<Vector<XHR::FormDataEntry>&> {
  1114. if (document_resource.has<POSTResource>())
  1115. return form_data_entry_list;
  1116. return {};
  1117. }();
  1118. // 3. Let navigationAPIStateForFiring be navigationAPIState if navigationAPIState is not null;
  1119. // otherwise, StructuredSerializeForStorage(undefined).
  1120. auto navigation_api_state_for_firing = navigation_api_state.value_or(MUST(structured_serialize_for_storage(vm, JS::js_undefined())));
  1121. // FIXME: 4. Let continue be the result of firing a push/replace/reload navigate event at navigation
  1122. // with navigationType set to historyHandling, isSameDocument set to false, userInvolvement set to userInvolvement,
  1123. // formDataEntryList set to entryListForFiring, destinationURL set to url, and navigationAPIState set to navigationAPIStateForFiring.
  1124. (void)navigation;
  1125. (void)entry_list_for_firing;
  1126. (void)navigation_api_state_for_firing;
  1127. // FIXME: 5. If continue is false, then return.
  1128. }
  1129. if (is_top_level_traversable()) {
  1130. active_browsing_context()->page().client().page_did_start_loading(url, false);
  1131. }
  1132. // 20. In parallel, run these steps:
  1133. Platform::EventLoopPlugin::the().deferred_invoke([this, source_snapshot_params, target_snapshot_params, csp_navigation_type, document_resource, url, navigation_id, referrer_policy, initiator_origin_snapshot, response, history_handling, initiator_base_url_snapshot] {
  1134. // NOTE: Not in the spec but subsequent steps will fail because destroyed navigable does not have active document.
  1135. if (has_been_destroyed()) {
  1136. set_delaying_load_events(false);
  1137. return;
  1138. }
  1139. // FIXME: 1. Let unloadPromptCanceled be the result of checking if unloading is user-canceled for navigable's active document's inclusive descendant navigables.
  1140. // FIXME: 2. If unloadPromptCanceled is true, or navigable's ongoing navigation is no longer navigationId, then:
  1141. if (!ongoing_navigation().has<String>() || ongoing_navigation().get<String>() != navigation_id) {
  1142. // 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.
  1143. // 2. Abort these steps.
  1144. set_delaying_load_events(false);
  1145. return;
  1146. }
  1147. // 3. Queue a global task on the navigation and traversal task source given navigable's active window to abort a document and its descendants given navigable's active document.
  1148. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this] {
  1149. VERIFY(this->active_document());
  1150. this->active_document()->abort_a_document_and_its_descendants();
  1151. });
  1152. // 4. Let documentState be a new document state with
  1153. // request referrer policy: referrerPolicy
  1154. // initiator origin: initiatorOriginSnapshot
  1155. // resource: documentResource
  1156. // navigable target name: navigable's target name
  1157. JS::NonnullGCPtr<DocumentState> document_state = *heap().allocate_without_realm<DocumentState>();
  1158. document_state->set_request_referrer_policy(referrer_policy);
  1159. document_state->set_initiator_origin(initiator_origin_snapshot);
  1160. document_state->set_resource(document_resource);
  1161. document_state->set_navigable_target_name(target_name());
  1162. // 5. If url matches about:blank or is about:srcdoc, then set documentState's origin to documentState's initiator origin.
  1163. if (url_matches_about_blank(url) || url_matches_about_srcdoc(url)) {
  1164. // document_resource cannot have an Empty if the url is about:srcdoc since we rely on document_resource
  1165. // having a String to call create_navigation_params_from_a_srcdoc_resource
  1166. if (url_matches_about_srcdoc(url) && document_resource.has<Empty>()) {
  1167. document_state->set_resource({ String {} });
  1168. }
  1169. // 1. Set documentState's origin to initiatorOriginSnapshot.
  1170. document_state->set_origin(document_state->initiator_origin());
  1171. // 2. Set documentState's about base URL to initiatorBaseURLSnapshot.
  1172. document_state->set_about_base_url(initiator_base_url_snapshot);
  1173. }
  1174. // 6. Let historyEntry be a new session history entry, with its URL set to url and its document state set to documentState.
  1175. JS::NonnullGCPtr<SessionHistoryEntry> history_entry = *heap().allocate_without_realm<SessionHistoryEntry>();
  1176. history_entry->set_url(url);
  1177. history_entry->set_document_state(document_state);
  1178. // 7. Let navigationParams be null.
  1179. Variant<Empty, NavigationParams, NonFetchSchemeNavigationParams> navigation_params = Empty {};
  1180. // FIXME: 8. If response is non-null:
  1181. if (response) {
  1182. }
  1183. // 9. Attempt to populate the history entry's document
  1184. // for historyEntry, given navigable, "navigate", sourceSnapshotParams,
  1185. // targetSnapshotParams, navigationId, navigationParams, cspNavigationType, with allowPOST
  1186. // set to true and completionSteps set to the following step:
  1187. populate_session_history_entry_document(history_entry, source_snapshot_params, target_snapshot_params, navigation_id, move(navigation_params), csp_navigation_type, true, [this, history_entry, history_handling, navigation_id] {
  1188. // 1. Append session history traversal steps to navigable's traversable to finalize a cross-document navigation given navigable, historyHandling, and historyEntry.
  1189. traversable_navigable()->append_session_history_traversal_steps([this, history_entry, history_handling, navigation_id] {
  1190. if (this->has_been_destroyed()) {
  1191. // NOTE: This check is not in the spec but we should not continue navigation if navigable has been destroyed.
  1192. set_delaying_load_events(false);
  1193. return;
  1194. }
  1195. if (this->ongoing_navigation() != navigation_id) {
  1196. // NOTE: This check is not in the spec but we should not continue navigation if ongoing navigation id has changed.
  1197. set_delaying_load_events(false);
  1198. return;
  1199. }
  1200. finalize_a_cross_document_navigation(*this, to_history_handling_behavior(history_handling), history_entry);
  1201. });
  1202. }).release_value_but_fixme_should_propagate_errors();
  1203. });
  1204. return {};
  1205. }
  1206. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate-fragid
  1207. WebIDL::ExceptionOr<void> Navigable::navigate_to_a_fragment(URL::URL const& url, HistoryHandlingBehavior history_handling, UserNavigationInvolvement user_involvement, Optional<SerializationRecord> navigation_api_state, String navigation_id)
  1208. {
  1209. (void)navigation_id;
  1210. // 1. Let navigation be navigable's active window's navigation API.
  1211. auto navigation = active_window()->navigation();
  1212. // 2. Let destinationNavigationAPIState be navigable's active session history entry's navigation API state.
  1213. // 3. If navigationAPIState is not null, then set destinationNavigationAPIState to navigationAPIState.
  1214. auto destination_navigation_api_state = navigation_api_state.has_value() ? *navigation_api_state : active_session_history_entry()->navigation_api_state();
  1215. // 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,
  1216. // userInvolvement set to userInvolvement, and destinationURL set to url, and navigationAPIState set to destinationNavigationAPIState.
  1217. auto navigation_type = history_handling == HistoryHandlingBehavior::Push ? Bindings::NavigationType::Push : Bindings::NavigationType::Replace;
  1218. bool const continue_ = navigation->fire_a_push_replace_reload_navigate_event(navigation_type, url, true, user_involvement, {}, destination_navigation_api_state);
  1219. // 5. If continue is false, then return.
  1220. if (!continue_)
  1221. return {};
  1222. // 6. Let historyEntry be a new session history entry, with
  1223. // URL: url
  1224. // document state: navigable's active session history entry's document state
  1225. // navigation API state: destinationNavigationAPIState
  1226. // scroll restoration mode: navigable's active session history entry's scroll restoration mode
  1227. JS::NonnullGCPtr<SessionHistoryEntry> history_entry = heap().allocate_without_realm<SessionHistoryEntry>();
  1228. history_entry->set_url(url);
  1229. history_entry->set_document_state(active_session_history_entry()->document_state());
  1230. history_entry->set_navigation_api_state(destination_navigation_api_state);
  1231. history_entry->set_scroll_restoration_mode(active_session_history_entry()->scroll_restoration_mode());
  1232. // 7. Let entryToReplace be navigable's active session history entry if historyHandling is "replace", otherwise null.
  1233. auto entry_to_replace = history_handling == HistoryHandlingBehavior::Replace ? active_session_history_entry() : nullptr;
  1234. // 8. Let history be navigable's active document's history object.
  1235. auto history = active_document()->history();
  1236. // 9. Let scriptHistoryIndex be history's index.
  1237. auto script_history_index = history->m_index;
  1238. // 10. Let scriptHistoryLength be history's length.
  1239. auto script_history_length = history->m_length;
  1240. // 11. If historyHandling is "push", then:
  1241. if (history_handling == HistoryHandlingBehavior::Push) {
  1242. // 1. Set history's state to null.
  1243. history->set_state(JS::js_null());
  1244. // 2. Increment scriptHistoryIndex.
  1245. script_history_index++;
  1246. // 3. Set scriptHistoryLength to scriptHistoryIndex + 1.
  1247. script_history_length = script_history_index + 1;
  1248. }
  1249. // 12. Set navigable's active session history entry to historyEntry.
  1250. m_active_session_history_entry = history_entry;
  1251. // 13. Update document for history step application given navigable's active document, historyEntry, true, scriptHistoryIndex, and scriptHistoryLength.
  1252. // AD HOC: Skip updating the navigation api entries twice here
  1253. active_document()->update_for_history_step_application(*history_entry, true, script_history_length, script_history_index, {}, false);
  1254. // 14. Update the navigation API entries for a same-document navigation given navigation, historyEntry, and historyHandling.
  1255. navigation->update_the_navigation_api_entries_for_a_same_document_navigation(history_entry, navigation_type);
  1256. // 15. Scroll to the fragment given navigable's active document.
  1257. // FIXME: Specification doesn't say when document url needs to update during fragment navigation
  1258. active_document()->set_url(url);
  1259. active_document()->scroll_to_the_fragment();
  1260. // 16. Let traversable be navigable's traversable navigable.
  1261. auto traversable = traversable_navigable();
  1262. // 17. Append the following session history synchronous navigation steps involving navigable to traversable:
  1263. traversable->append_session_history_synchronous_navigation_steps(*this, [this, traversable, history_entry, entry_to_replace, navigation_id, history_handling] {
  1264. // 1. Finalize a same-document navigation given traversable, navigable, historyEntry, and entryToReplace.
  1265. finalize_a_same_document_navigation(*traversable, *this, history_entry, entry_to_replace, history_handling);
  1266. // FIXME: 2. Invoke WebDriver BiDi fragment navigated with navigable's active browsing context and a new WebDriver BiDi
  1267. // navigation status whose id is navigationId, url is url, and status is "complete".
  1268. (void)navigation_id;
  1269. });
  1270. return {};
  1271. }
  1272. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#evaluate-a-javascript:-url
  1273. WebIDL::ExceptionOr<JS::GCPtr<DOM::Document>> Navigable::evaluate_javascript_url(URL::URL const& url, Origin const& new_document_origin, String navigation_id)
  1274. {
  1275. auto& vm = this->vm();
  1276. auto& realm = active_window()->realm();
  1277. // 1. Let urlString be the result of running the URL serializer on url.
  1278. auto url_string = url.serialize();
  1279. // 2. Let encodedScriptSource be the result of removing the leading "javascript:" from urlString.
  1280. auto encoded_script_source = url_string.substring_view(11, url_string.length() - 11);
  1281. // 3. Let scriptSource be the UTF-8 decoding of the percent-decoding of encodedScriptSource.
  1282. auto script_source = URL::percent_decode(encoded_script_source);
  1283. // 4. Let settings be targetNavigable's active document's relevant settings object.
  1284. auto& settings = active_document()->relevant_settings_object();
  1285. // 5. Let baseURL be settings's API base URL.
  1286. auto base_url = settings.api_base_url();
  1287. // 6. Let script be the result of creating a classic script given scriptSource, settings, baseURL, and the default classic script fetch options.
  1288. auto script = HTML::ClassicScript::create("(javascript url)", script_source, settings, base_url);
  1289. // 7. Let evaluationStatus be the result of running the classic script script.
  1290. auto evaluation_status = script->run();
  1291. // 8. Let result be null.
  1292. String result;
  1293. // 9. If evaluationStatus is a normal completion, and evaluationStatus.[[Value]] is a String, then set result to evaluationStatus.[[Value]].
  1294. if (evaluation_status.type() == JS::Completion::Type::Normal && evaluation_status.value()->is_string()) {
  1295. result = evaluation_status.value()->as_string().utf8_string();
  1296. } else {
  1297. // 10. Otherwise, return null.
  1298. return nullptr;
  1299. }
  1300. // 11. Let response be a new response with
  1301. // URL: targetNavigable's active document's URL
  1302. // header list: «(`Content-Type`, `text/html;charset=utf-8`)»
  1303. // body: the UTF-8 encoding of result, as a body
  1304. auto response = Fetch::Infrastructure::Response::create(vm);
  1305. response->url_list().append(active_document()->url());
  1306. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, "text/html"sv));
  1307. TRY_OR_THROW_OOM(vm, response->header_list()->append(move(header)));
  1308. response->set_body(TRY(Fetch::Infrastructure::byte_sequence_as_body(realm, result.bytes())));
  1309. // 12. Let policyContainer be targetNavigable's active document's policy container.
  1310. auto const& policy_container = active_document()->policy_container();
  1311. // FIXME: 13. Let finalSandboxFlags be policyContainer's CSP list's CSP-derived sandboxing flags.
  1312. auto final_sandbox_flags = SandboxingFlagSet {};
  1313. // 14. Let coop be targetNavigable's active document's cross-origin opener policy.
  1314. auto const& coop = active_document()->cross_origin_opener_policy();
  1315. // 15. Let coopEnforcementResult be a new cross-origin opener policy enforcement result with
  1316. // url: url
  1317. // origin: newDocumentOrigin
  1318. // cross-origin opener policy: coop
  1319. CrossOriginOpenerPolicyEnforcementResult coop_enforcement_result {
  1320. .url = url,
  1321. .origin = new_document_origin,
  1322. .cross_origin_opener_policy = coop,
  1323. };
  1324. // 16. Let navigationParams be a new navigation params, with
  1325. // id: navigationId
  1326. // navigable: targetNavigable
  1327. // request: null
  1328. // response: response
  1329. // fetch controller: null
  1330. // commit early hints: null
  1331. // COOP enforcement result: coopEnforcementResult
  1332. // reserved environment: null
  1333. // origin: newDocumentOrigin
  1334. // policy container: policyContainer
  1335. // final sandboxing flag set: finalSandboxFlags
  1336. // cross-origin opener policy: coop
  1337. // FIXME: navigation timing type: "navigate"
  1338. // about base URL: targetNavigable's active document's about base URL
  1339. NavigationParams navigation_params {
  1340. .id = navigation_id,
  1341. .navigable = this,
  1342. .request = {},
  1343. .response = response,
  1344. .fetch_controller = nullptr,
  1345. .commit_early_hints = nullptr,
  1346. .coop_enforcement_result = move(coop_enforcement_result),
  1347. .reserved_environment = {},
  1348. .origin = new_document_origin,
  1349. .policy_container = policy_container,
  1350. .final_sandboxing_flag_set = final_sandbox_flags,
  1351. .cross_origin_opener_policy = coop,
  1352. .about_base_url = active_document()->about_base_url(),
  1353. };
  1354. // 17. Return the result of loading an HTML document given navigationParams.
  1355. return load_document(navigation_params);
  1356. }
  1357. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate-to-a-javascript:-url
  1358. WebIDL::ExceptionOr<void> Navigable::navigate_to_a_javascript_url(URL::URL const& url, HistoryHandlingBehavior history_handling, Origin const& initiator_origin, CSPNavigationType csp_navigation_type, String navigation_id)
  1359. {
  1360. // 1. Assert: historyHandling is "replace".
  1361. VERIFY(history_handling == HistoryHandlingBehavior::Replace);
  1362. // 2. Set the ongoing navigation for targetNavigable to null.
  1363. set_ongoing_navigation({});
  1364. // 3. If initiatorOrigin is not same origin-domain with targetNavigable's active document's origin, then return.
  1365. if (!initiator_origin.is_same_origin_domain(active_document()->origin()))
  1366. return {};
  1367. // FIXME: 4. Let request be a new request whose URL is url.
  1368. // 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.
  1369. (void)csp_navigation_type;
  1370. // 6. Let newDocument be the result of evaluating a javascript: URL given targetNavigable, url, and initiatorOrigin.
  1371. auto new_document = TRY(evaluate_javascript_url(url, initiator_origin, navigation_id));
  1372. // 7. If newDocument is null, then return.
  1373. if (!new_document) {
  1374. // NOTE: In this case, some JavaScript code was executed, but no new Document was created, so we will not perform a navigation.
  1375. return {};
  1376. }
  1377. // 8. Assert: initiatorOrigin is newDocument's origin.
  1378. VERIFY(initiator_origin == new_document->origin());
  1379. // 9. Let entryToReplace be targetNavigable's active session history entry.
  1380. auto entry_to_replace = active_session_history_entry();
  1381. // 10. Let oldDocState be entryToReplace's document state.
  1382. auto old_doc_state = entry_to_replace->document_state();
  1383. // 11. Let documentState be a new document state with
  1384. // document: newDocument
  1385. // history policy container: a clone of the oldDocState's history policy container if it is non-null; null otherwise
  1386. // request referrer: oldDocState's request referrer
  1387. // request referrer policy: oldDocState's request referrer policy
  1388. // initiator origin: initiatorOrigin
  1389. // origin: initiatorOrigin
  1390. // about base URL: oldDocState's about base URL
  1391. // resource: null
  1392. // ever populated: true
  1393. // navigable target name: oldDocState's navigable target name
  1394. JS::NonnullGCPtr<DocumentState> document_state = *heap().allocate_without_realm<DocumentState>();
  1395. document_state->set_document(new_document);
  1396. document_state->set_history_policy_container(old_doc_state->history_policy_container());
  1397. document_state->set_request_referrer(old_doc_state->request_referrer());
  1398. document_state->set_request_referrer_policy(old_doc_state->request_referrer_policy());
  1399. document_state->set_initiator_origin(initiator_origin);
  1400. document_state->set_origin(initiator_origin);
  1401. document_state->set_about_base_url(old_doc_state->about_base_url());
  1402. document_state->set_ever_populated(true);
  1403. document_state->set_navigable_target_name(old_doc_state->navigable_target_name());
  1404. // 12. Let historyEntry be a new session history entry, with
  1405. // URL: entryToReplace's URL
  1406. // document state: documentState
  1407. JS::NonnullGCPtr<SessionHistoryEntry> history_entry = *heap().allocate_without_realm<SessionHistoryEntry>();
  1408. history_entry->set_url(entry_to_replace->url());
  1409. history_entry->set_document_state(document_state);
  1410. // 13. Append session history traversal steps to targetNavigable's traversable to finalize a cross-document navigation with targetNavigable, historyHandling, and historyEntry.
  1411. traversable_navigable()->append_session_history_traversal_steps([this, history_entry, history_handling, navigation_id] {
  1412. finalize_a_cross_document_navigation(*this, history_handling, history_entry);
  1413. });
  1414. return {};
  1415. }
  1416. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#reload
  1417. void Navigable::reload()
  1418. {
  1419. // 1. Set navigable's active session history entry's document state's reload pending to true.
  1420. active_session_history_entry()->document_state()->set_reload_pending(true);
  1421. // 2. Let traversable be navigable's traversable navigable.
  1422. auto traversable = traversable_navigable();
  1423. // 3. Append the following session history traversal steps to traversable:
  1424. traversable->append_session_history_traversal_steps([traversable] {
  1425. // 1. Apply the reload history step to traversable.
  1426. traversable->apply_the_reload_history_step();
  1427. });
  1428. }
  1429. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#the-navigation-must-be-a-replace
  1430. bool navigation_must_be_a_replace(URL::URL const& url, DOM::Document const& document)
  1431. {
  1432. return url.scheme() == "javascript"sv || document.is_initial_about_blank();
  1433. }
  1434. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#allowed-to-navigate
  1435. bool Navigable::allowed_by_sandboxing_to_navigate(Navigable const& target, SourceSnapshotParams const& source_snapshot_params)
  1436. {
  1437. auto& source = *this;
  1438. auto is_ancestor_of = [](Navigable const& a, Navigable const& b) {
  1439. for (auto parent = b.parent(); parent; parent = parent->parent()) {
  1440. if (parent.ptr() == &a)
  1441. return true;
  1442. }
  1443. return false;
  1444. };
  1445. // A navigable source is allowed by sandboxing to navigate a second navigable target,
  1446. // given a source snapshot params sourceSnapshotParams, if the following steps return true:
  1447. // 1. If source is target, then return true.
  1448. if (&source == &target)
  1449. return true;
  1450. // 2. If source is an ancestor of target, then return true.
  1451. if (is_ancestor_of(source, target))
  1452. return true;
  1453. // 3. If target is an ancestor of source, then:
  1454. if (is_ancestor_of(target, source)) {
  1455. // 1. If target is not a top-level traversable, then return true.
  1456. if (!target.is_top_level_traversable())
  1457. return true;
  1458. // 2. If sourceSnapshotParams's has transient activation is true, and sourceSnapshotParams's sandboxing flags's
  1459. // sandboxed top-level navigation with user activation browsing context flag is set, then return false.
  1460. if (source_snapshot_params.has_transient_activation && has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedTopLevelNavigationWithUserActivation))
  1461. return false;
  1462. // 3. If sourceSnapshotParams's has transient activation is false, and sourceSnapshotParams's sandboxing flags's
  1463. // sandboxed top-level navigation without user activation browsing context flag is set, then return false.
  1464. if (!source_snapshot_params.has_transient_activation && has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedTopLevelNavigationWithoutUserActivation))
  1465. return false;
  1466. // 4. Return true.
  1467. return true;
  1468. }
  1469. // 4. If target is a top-level traversable:
  1470. if (target.is_top_level_traversable()) {
  1471. // FIXME: 1. If source is the one permitted sandboxed navigator of target, then return true.
  1472. // 2. If sourceSnapshotParams's sandboxing flags's sandboxed navigation browsing context flag is set, then return false.
  1473. if (has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedNavigation))
  1474. return false;
  1475. // 3. Return true.
  1476. return true;
  1477. }
  1478. // 5. If sourceSnapshotParams's sandboxing flags's sandboxed navigation browsing context flag is set, then return false.
  1479. // 6. Return true.
  1480. return !has_flag(source_snapshot_params.sandboxing_flags, SandboxingFlagSet::SandboxedNavigation);
  1481. }
  1482. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#snapshotting-target-snapshot-params
  1483. TargetSnapshotParams Navigable::snapshot_target_snapshot_params()
  1484. {
  1485. // To snapshot target snapshot params given a navigable targetNavigable, return a new target snapshot params
  1486. // with sandboxing flags set to the result of determining the creation sandboxing flags given targetNavigable's
  1487. // active browsing context and targetNavigable's container.
  1488. return { determine_the_creation_sandboxing_flags(*active_browsing_context(), container()) };
  1489. }
  1490. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#finalize-a-cross-document-navigation
  1491. void finalize_a_cross_document_navigation(JS::NonnullGCPtr<Navigable> navigable, HistoryHandlingBehavior history_handling, JS::NonnullGCPtr<SessionHistoryEntry> history_entry)
  1492. {
  1493. // NOTE: This is not in the spec but we should not navigate destroyed navigable.
  1494. if (navigable->has_been_destroyed())
  1495. return;
  1496. // 1. FIXME: Assert: this is running on navigable's traversable navigable's session history traversal queue.
  1497. // 2. Set navigable's is delaying load events to false.
  1498. navigable->set_delaying_load_events(false);
  1499. // 3. If historyEntry's document is null, then return.
  1500. if (!history_entry->document())
  1501. return;
  1502. // 4. If all of the following are true:
  1503. // - navigable's parent is null;
  1504. // - historyEntry's document's browsing context is not an auxiliary browsing context whose opener browsing context is non-null; and
  1505. // - historyEntry's document's origin is not navigable's active document's origin
  1506. // then set historyEntry's document state's navigable target name to the empty string.
  1507. if (navigable->parent() == nullptr && history_entry->document()->browsing_context()->opener_browsing_context() != nullptr && history_entry->document()->origin() != navigable->active_document()->origin())
  1508. history_entry->document_state()->set_navigable_target_name(String {});
  1509. // 5. Let entryToReplace be navigable's active session history entry if historyHandling is "replace", otherwise null.
  1510. auto entry_to_replace = history_handling == HistoryHandlingBehavior::Replace ? navigable->active_session_history_entry() : nullptr;
  1511. // 6. Let traversable be navigable's traversable navigable.
  1512. auto traversable = navigable->traversable_navigable();
  1513. // 7. Let targetStep be null.
  1514. int target_step;
  1515. // 8. Let targetEntries be the result of getting session history entries for navigable.
  1516. auto& target_entries = navigable->get_session_history_entries();
  1517. // 9. If entryToReplace is null, then:
  1518. if (entry_to_replace == nullptr) {
  1519. // 1. Clear the forward session history of traversable.
  1520. traversable->clear_the_forward_session_history();
  1521. // 2. Set targetStep to traversable's current session history step + 1.
  1522. target_step = traversable->current_session_history_step() + 1;
  1523. // 3. Set historyEntry's step to targetStep.
  1524. history_entry->set_step(target_step);
  1525. // 4. Append historyEntry to targetEntries.
  1526. target_entries.append(history_entry);
  1527. } else {
  1528. // 1. Replace entryToReplace with historyEntry in targetEntries.
  1529. *(target_entries.find(*entry_to_replace)) = history_entry;
  1530. // 2. Set historyEntry's step to entryToReplace's step.
  1531. history_entry->set_step(entry_to_replace->step());
  1532. // 3. If historyEntry's document state's origin is same origin with entryToReplace's document state's origin,
  1533. // then set historyEntry's navigation API key to entryToReplace's navigation API key.
  1534. 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())) {
  1535. history_entry->set_navigation_api_key(entry_to_replace->navigation_api_key());
  1536. }
  1537. // 4. Set targetStep to traversable's current session history step.
  1538. target_step = traversable->current_session_history_step();
  1539. }
  1540. // 10. Apply the push/replace history step targetStep to traversable.
  1541. traversable->apply_the_push_or_replace_history_step(target_step, history_handling, TraversableNavigable::SynchronousNavigation::No);
  1542. }
  1543. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#url-and-history-update-steps
  1544. void perform_url_and_history_update_steps(DOM::Document& document, URL::URL new_url, Optional<SerializationRecord> serialized_data, HistoryHandlingBehavior history_handling)
  1545. {
  1546. // 1. Let navigable be document's node navigable.
  1547. auto navigable = document.navigable();
  1548. // 2. Let activeEntry be navigable's active session history entry.
  1549. auto active_entry = navigable->active_session_history_entry();
  1550. // FIXME: Spec should be updated to say "classic history api state" instead of serialized state
  1551. // 3. Let newEntry be a new session history entry, with
  1552. // URL: newURL
  1553. // serialized state: if serializedData is not null, serializedData; otherwise activeEntry's classic history API state
  1554. // document state: activeEntry's document state
  1555. // scroll restoration mode: activeEntry's scroll restoration mode
  1556. // FIXME: persisted user state: activeEntry's persisted user state
  1557. JS::NonnullGCPtr<SessionHistoryEntry> new_entry = document.heap().allocate_without_realm<SessionHistoryEntry>();
  1558. new_entry->set_url(new_url);
  1559. new_entry->set_classic_history_api_state(serialized_data.value_or(active_entry->classic_history_api_state()));
  1560. new_entry->set_document_state(active_entry->document_state());
  1561. new_entry->set_scroll_restoration_mode(active_entry->scroll_restoration_mode());
  1562. // 4. If document's is initial about:blank is true, then set historyHandling to "replace".
  1563. if (document.is_initial_about_blank()) {
  1564. history_handling = HistoryHandlingBehavior::Replace;
  1565. }
  1566. // 5. Let entryToReplace be activeEntry if historyHandling is "replace", otherwise null.
  1567. auto entry_to_replace = history_handling == HistoryHandlingBehavior::Replace ? active_entry : nullptr;
  1568. // 6. If historyHandling is "push", then:
  1569. if (history_handling == HistoryHandlingBehavior::Push) {
  1570. // 1. Increment document's history object's index.
  1571. document.history()->m_index++;
  1572. // 2. Set document's history object's length to its index + 1.
  1573. document.history()->m_length = document.history()->m_index + 1;
  1574. }
  1575. // If serializedData is not null, then restore the history object state given document and newEntry.
  1576. if (serialized_data.has_value())
  1577. document.restore_the_history_object_state(new_entry);
  1578. // 8. Set document's URL to newURL.
  1579. document.set_url(new_url);
  1580. // 9. Set document's latest entry to newEntry.
  1581. document.set_latest_entry(new_entry);
  1582. // 10. Set navigable's active session history entry to newEntry.
  1583. navigable->set_active_session_history_entry(new_entry);
  1584. // 11. Update the navigation API entries for a same-document navigation given document's relevant global object's navigation API, newEntry, and historyHandling.
  1585. auto& relevant_global_object = verify_cast<Window>(HTML::relevant_global_object(document));
  1586. auto navigation_type = history_handling == HistoryHandlingBehavior::Push ? Bindings::NavigationType::Push : Bindings::NavigationType::Replace;
  1587. relevant_global_object.navigation()->update_the_navigation_api_entries_for_a_same_document_navigation(new_entry, navigation_type);
  1588. // 12. Let traversable be navigable's traversable navigable.
  1589. auto traversable = navigable->traversable_navigable();
  1590. // 13. Append the following session history synchronous navigation steps involving navigable to traversable:
  1591. traversable->append_session_history_synchronous_navigation_steps(*navigable, [traversable, navigable, new_entry, entry_to_replace, history_handling] {
  1592. // 1. Finalize a same-document navigation given traversable, navigable, newEntry, and entryToReplace.
  1593. finalize_a_same_document_navigation(*traversable, *navigable, new_entry, entry_to_replace, history_handling);
  1594. });
  1595. // FIXME: Implement synchronous session history steps.
  1596. traversable->process_session_history_traversal_queue();
  1597. }
  1598. void Navigable::scroll_offset_did_change()
  1599. {
  1600. // https://w3c.github.io/csswg-drafts/cssom-view-1/#scrolling-events
  1601. // Whenever a viewport gets scrolled (whether in response to user interaction or by an API), the user agent must run these steps:
  1602. // 1. Let doc be the viewport’s associated Document.
  1603. auto doc = active_document();
  1604. VERIFY(doc);
  1605. // 2. If doc is already in doc’s pending scroll event targets, abort these steps.
  1606. for (auto& target : doc->pending_scroll_event_targets()) {
  1607. if (target.ptr() == doc)
  1608. return;
  1609. }
  1610. // 3. Append doc to doc’s pending scroll event targets.
  1611. doc->pending_scroll_event_targets().append(*doc);
  1612. }
  1613. CSSPixelRect Navigable::to_top_level_rect(CSSPixelRect const& a_rect)
  1614. {
  1615. auto rect = a_rect;
  1616. rect.set_location(to_top_level_position(a_rect.location()));
  1617. return rect;
  1618. }
  1619. CSSPixelPoint Navigable::to_top_level_position(CSSPixelPoint a_position)
  1620. {
  1621. auto position = a_position;
  1622. for (auto ancestor = parent(); ancestor; ancestor = ancestor->parent()) {
  1623. if (is<TraversableNavigable>(*ancestor))
  1624. break;
  1625. if (!ancestor->container())
  1626. return {};
  1627. if (!ancestor->container()->paintable())
  1628. return {};
  1629. position.translate_by(ancestor->container()->paintable()->box_type_agnostic_position());
  1630. }
  1631. return position;
  1632. }
  1633. void Navigable::set_viewport_rect(CSSPixelRect const& rect)
  1634. {
  1635. bool did_change = false;
  1636. if (m_size != rect.size()) {
  1637. m_size = rect.size();
  1638. if (auto document = active_document()) {
  1639. // NOTE: Resizing the viewport changes the reference value for viewport-relative CSS lengths.
  1640. document->invalidate_style();
  1641. document->set_needs_layout();
  1642. }
  1643. did_change = true;
  1644. m_needs_repaint = true;
  1645. }
  1646. if (m_viewport_scroll_offset != rect.location()) {
  1647. m_viewport_scroll_offset = rect.location();
  1648. scroll_offset_did_change();
  1649. did_change = true;
  1650. m_needs_repaint = true;
  1651. }
  1652. if (did_change && active_document()) {
  1653. active_document()->inform_all_viewport_clients_about_the_current_viewport_rect();
  1654. }
  1655. // Schedule the HTML event loop to ensure that a `resize` event gets fired.
  1656. HTML::main_thread_event_loop().schedule();
  1657. }
  1658. void Navigable::perform_scroll_of_viewport(CSSPixelPoint position)
  1659. {
  1660. auto viewport_rect = this->viewport_rect();
  1661. viewport_rect.set_location(position);
  1662. set_viewport_rect(viewport_rect);
  1663. set_needs_display();
  1664. if (is_traversable() && active_browsing_context())
  1665. active_browsing_context()->page().client().page_did_request_scroll_to(position);
  1666. }
  1667. void Navigable::set_size(CSSPixelSize size)
  1668. {
  1669. if (m_size == size)
  1670. return;
  1671. m_size = size;
  1672. if (auto document = active_document()) {
  1673. document->invalidate_style();
  1674. document->set_needs_layout();
  1675. }
  1676. if (auto document = active_document()) {
  1677. document->inform_all_viewport_clients_about_the_current_viewport_rect();
  1678. }
  1679. // Schedule the HTML event loop to ensure that a `resize` event gets fired.
  1680. HTML::main_thread_event_loop().schedule();
  1681. }
  1682. void Navigable::set_needs_display()
  1683. {
  1684. set_needs_display(viewport_rect());
  1685. }
  1686. void Navigable::set_needs_display(CSSPixelRect const&)
  1687. {
  1688. // FIXME: Ignore updates outside the visible viewport rect.
  1689. // This requires accounting for fixed-position elements in the input rect, which we don't do yet.
  1690. m_needs_repaint = true;
  1691. if (is<TraversableNavigable>(*this)) {
  1692. // Schedule the main thread event loop, which will, in turn, schedule a repaint.
  1693. Web::HTML::main_thread_event_loop().schedule();
  1694. return;
  1695. }
  1696. if (container() && container()->paintable())
  1697. container()->paintable()->set_needs_display();
  1698. }
  1699. // https://html.spec.whatwg.org/#rendering-opportunity
  1700. bool Navigable::has_a_rendering_opportunity() const
  1701. {
  1702. // A navigable has a rendering opportunity if the user agent is currently able to present
  1703. // the contents of the navigable to the user,
  1704. // accounting for hardware refresh rate constraints and user agent throttling for performance reasons,
  1705. // but considering content presentable even if it's outside the viewport.
  1706. // A navigable has no rendering opportunities if its active document is render-blocked
  1707. // or if it is suppressed for view transitions;
  1708. // otherwise, rendering opportunities are determined based on hardware constraints
  1709. // such as display refresh rates and other factors such as page performance
  1710. // or whether the document's visibility state is "visible".
  1711. // Rendering opportunities typically occur at regular intervals.
  1712. // FIXME: Return `false` here if we're an inactive browser tab.
  1713. auto browsing_context = const_cast<Navigable*>(this)->active_browsing_context();
  1714. if (!browsing_context)
  1715. return false;
  1716. return browsing_context->page().client().is_ready_to_paint();
  1717. }
  1718. // https://html.spec.whatwg.org/multipage/nav-history-apis.html#inform-the-navigation-api-about-aborting-navigation
  1719. void Navigable::inform_the_navigation_api_about_aborting_navigation()
  1720. {
  1721. // FIXME: 1. If this algorithm is running on navigable's active window's relevant agent's event loop, then continue on to the following steps.
  1722. // Otherwise, queue a global task on the navigation and traversal task source given navigable's active window to run the following steps.
  1723. queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this] {
  1724. // 2. Let navigation be navigable's active window's navigation API.
  1725. auto navigation = active_window()->navigation();
  1726. // 3. If navigation's ongoing navigate event is null, then return.
  1727. if (navigation->ongoing_navigate_event() == nullptr)
  1728. return;
  1729. // 4. Abort the ongoing navigation given navigation.
  1730. navigation->abort_the_ongoing_navigation();
  1731. });
  1732. }
  1733. void Navigable::paint(Painting::RecordingPainter& recording_painter, PaintConfig config)
  1734. {
  1735. auto document = active_document();
  1736. if (!document)
  1737. return;
  1738. auto const& page = traversable_navigable()->page();
  1739. auto viewport_rect = page.css_to_device_rect(this->viewport_rect());
  1740. Gfx::IntRect bitmap_rect { {}, viewport_rect.size().to_type<int>() };
  1741. auto background_color = document->background_color();
  1742. recording_painter.fill_rect(bitmap_rect, background_color);
  1743. if (!document->paintable())
  1744. return;
  1745. Web::PaintContext context(recording_painter, page.palette(), page.client().device_pixels_per_css_pixel());
  1746. context.set_device_viewport_rect(viewport_rect);
  1747. context.set_should_show_line_box_borders(config.should_show_line_box_borders);
  1748. context.set_should_paint_overlay(config.paint_overlay);
  1749. context.set_has_focus(config.has_focus);
  1750. document->update_paint_and_hit_testing_properties_if_needed();
  1751. auto& viewport_paintable = *document->paintable();
  1752. // NOTE: We only need to refresh the scroll state for traversables because they are responsible
  1753. // for tracking the state of all nested navigables.
  1754. if (is_traversable()) {
  1755. viewport_paintable.refresh_scroll_state();
  1756. viewport_paintable.refresh_clip_state();
  1757. }
  1758. viewport_paintable.paint_all_phases(context);
  1759. // FIXME: Support scrollable frames inside iframes.
  1760. if (is_traversable()) {
  1761. Vector<Gfx::IntPoint> scroll_offsets_by_frame_id;
  1762. scroll_offsets_by_frame_id.resize(viewport_paintable.scroll_state.size());
  1763. for (auto [_, scrollable_frame] : viewport_paintable.scroll_state) {
  1764. auto scroll_offset = context.rounded_device_point(scrollable_frame->offset).to_type<int>();
  1765. scroll_offsets_by_frame_id[scrollable_frame->id] = scroll_offset;
  1766. }
  1767. recording_painter.commands_list().apply_scroll_offsets(scroll_offsets_by_frame_id);
  1768. }
  1769. m_needs_repaint = false;
  1770. }
  1771. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#event-uni
  1772. UserNavigationInvolvement user_navigation_involvement(DOM::Event const& event)
  1773. {
  1774. // For convenience at certain call sites, the user navigation involvement for an Event event is defined as follows:
  1775. // 1. Assert: this algorithm is being called as part of an activation behavior definition.
  1776. // 2. Assert: event's type is "click".
  1777. VERIFY(event.type() == "click"_fly_string);
  1778. // 3. If event's isTrusted is initialized to true, then return "activation".
  1779. // 4. Return "none".
  1780. return event.is_trusted() ? UserNavigationInvolvement::Activation : UserNavigationInvolvement::None;
  1781. }
  1782. }