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