Document.cpp 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179
  1. /*
  2. * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
  5. * Copyright (c) 2021, Sam Atkins <atkinssj@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <AK/CharacterTypes.h>
  10. #include <AK/StringBuilder.h>
  11. #include <AK/Utf8View.h>
  12. #include <LibCore/Timer.h>
  13. #include <LibJS/Interpreter.h>
  14. #include <LibJS/Parser.h>
  15. #include <LibJS/Runtime/FunctionObject.h>
  16. #include <LibWeb/Bindings/MainThreadVM.h>
  17. #include <LibWeb/Bindings/WindowObject.h>
  18. #include <LibWeb/CSS/MediaQueryListEvent.h>
  19. #include <LibWeb/CSS/StyleComputer.h>
  20. #include <LibWeb/Cookie/ParsedCookie.h>
  21. #include <LibWeb/DOM/Comment.h>
  22. #include <LibWeb/DOM/CustomEvent.h>
  23. #include <LibWeb/DOM/DOMException.h>
  24. #include <LibWeb/DOM/DOMImplementation.h>
  25. #include <LibWeb/DOM/Document.h>
  26. #include <LibWeb/DOM/DocumentFragment.h>
  27. #include <LibWeb/DOM/DocumentType.h>
  28. #include <LibWeb/DOM/Element.h>
  29. #include <LibWeb/DOM/ElementFactory.h>
  30. #include <LibWeb/DOM/Event.h>
  31. #include <LibWeb/DOM/ExceptionOr.h>
  32. #include <LibWeb/DOM/HTMLCollection.h>
  33. #include <LibWeb/DOM/Range.h>
  34. #include <LibWeb/DOM/ShadowRoot.h>
  35. #include <LibWeb/DOM/Text.h>
  36. #include <LibWeb/DOM/Window.h>
  37. #include <LibWeb/Dump.h>
  38. #include <LibWeb/HTML/AttributeNames.h>
  39. #include <LibWeb/HTML/BrowsingContext.h>
  40. #include <LibWeb/HTML/EventLoop/EventLoop.h>
  41. #include <LibWeb/HTML/EventNames.h>
  42. #include <LibWeb/HTML/HTMLAnchorElement.h>
  43. #include <LibWeb/HTML/HTMLAreaElement.h>
  44. #include <LibWeb/HTML/HTMLBodyElement.h>
  45. #include <LibWeb/HTML/HTMLEmbedElement.h>
  46. #include <LibWeb/HTML/HTMLFormElement.h>
  47. #include <LibWeb/HTML/HTMLFrameSetElement.h>
  48. #include <LibWeb/HTML/HTMLHeadElement.h>
  49. #include <LibWeb/HTML/HTMLHtmlElement.h>
  50. #include <LibWeb/HTML/HTMLIFrameElement.h>
  51. #include <LibWeb/HTML/HTMLImageElement.h>
  52. #include <LibWeb/HTML/HTMLScriptElement.h>
  53. #include <LibWeb/HTML/HTMLTitleElement.h>
  54. #include <LibWeb/HTML/MessageEvent.h>
  55. #include <LibWeb/HTML/Scripting/ExceptionReporter.h>
  56. #include <LibWeb/HTML/Scripting/WindowEnvironmentSettingsObject.h>
  57. #include <LibWeb/Layout/BlockFormattingContext.h>
  58. #include <LibWeb/Layout/InitialContainingBlock.h>
  59. #include <LibWeb/Layout/TreeBuilder.h>
  60. #include <LibWeb/Namespace.h>
  61. #include <LibWeb/Origin.h>
  62. #include <LibWeb/Page/Page.h>
  63. #include <LibWeb/SVG/TagNames.h>
  64. #include <LibWeb/UIEvents/EventNames.h>
  65. #include <LibWeb/UIEvents/FocusEvent.h>
  66. #include <LibWeb/UIEvents/KeyboardEvent.h>
  67. #include <LibWeb/UIEvents/MouseEvent.h>
  68. namespace Web::DOM {
  69. Document::Document(const AK::URL& url)
  70. : ParentNode(*this, NodeType::DOCUMENT_NODE)
  71. , m_style_computer(make<CSS::StyleComputer>(*this))
  72. , m_style_sheets(CSS::StyleSheetList::create(*this))
  73. , m_url(url)
  74. , m_window(Window::create_with_document(*this))
  75. , m_implementation(DOMImplementation::create({}, *this))
  76. , m_history(HTML::History::create(*this))
  77. {
  78. HTML::main_thread_event_loop().register_document({}, *this);
  79. m_style_update_timer = Core::Timer::create_single_shot(0, [this] {
  80. update_style();
  81. });
  82. m_layout_update_timer = Core::Timer::create_single_shot(0, [this] {
  83. force_layout();
  84. });
  85. }
  86. Document::~Document()
  87. {
  88. }
  89. void Document::removed_last_ref()
  90. {
  91. VERIFY(!ref_count());
  92. VERIFY(!m_deletion_has_begun);
  93. if (m_referencing_node_count) {
  94. // The document has reached ref_count==0 but still has nodes keeping it alive.
  95. // At this point, sever all the node links we control.
  96. // If nodes remain elsewhere (e.g JS wrappers), they will keep the document alive.
  97. // NOTE: This makes sure we stay alive across for the duration of the cleanup below.
  98. increment_referencing_node_count();
  99. m_focused_element = nullptr;
  100. m_hovered_node = nullptr;
  101. m_pending_parsing_blocking_script = nullptr;
  102. m_inspected_node = nullptr;
  103. m_scripts_to_execute_when_parsing_has_finished.clear();
  104. m_scripts_to_execute_as_soon_as_possible.clear();
  105. m_associated_inert_template_document = nullptr;
  106. m_interpreter = nullptr;
  107. {
  108. // Gather up all the descendants of this document and prune them from the tree.
  109. // FIXME: This could definitely be more elegant.
  110. NonnullRefPtrVector<Node> descendants;
  111. for_each_in_inclusive_subtree([&](auto& node) {
  112. if (&node != this)
  113. descendants.append(node);
  114. return IterationDecision::Continue;
  115. });
  116. for (auto& node : descendants) {
  117. VERIFY(&node.document() == this);
  118. VERIFY(!node.is_document());
  119. if (node.parent())
  120. node.remove();
  121. }
  122. }
  123. m_in_removed_last_ref = false;
  124. decrement_referencing_node_count();
  125. return;
  126. }
  127. m_in_removed_last_ref = false;
  128. m_deletion_has_begun = true;
  129. HTML::main_thread_event_loop().unregister_document({}, *this);
  130. delete this;
  131. }
  132. Origin Document::origin() const
  133. {
  134. if (!m_url.is_valid())
  135. return {};
  136. return { m_url.protocol(), m_url.host(), m_url.port_or_default() };
  137. }
  138. void Document::set_origin(const Origin& origin)
  139. {
  140. m_url.set_protocol(origin.protocol());
  141. m_url.set_host(origin.host());
  142. m_url.set_port(origin.port());
  143. }
  144. void Document::schedule_style_update()
  145. {
  146. if (m_style_update_timer->is_active())
  147. return;
  148. m_style_update_timer->start();
  149. }
  150. void Document::schedule_layout_update()
  151. {
  152. if (m_layout_update_timer->is_active())
  153. return;
  154. m_layout_update_timer->start();
  155. }
  156. bool Document::is_child_allowed(const Node& node) const
  157. {
  158. switch (node.type()) {
  159. case NodeType::DOCUMENT_NODE:
  160. case NodeType::TEXT_NODE:
  161. return false;
  162. case NodeType::COMMENT_NODE:
  163. return true;
  164. case NodeType::DOCUMENT_TYPE_NODE:
  165. return !first_child_of_type<DocumentType>();
  166. case NodeType::ELEMENT_NODE:
  167. return !first_child_of_type<Element>();
  168. default:
  169. return false;
  170. }
  171. }
  172. Element* Document::document_element()
  173. {
  174. return first_child_of_type<Element>();
  175. }
  176. const Element* Document::document_element() const
  177. {
  178. return first_child_of_type<Element>();
  179. }
  180. HTML::HTMLHtmlElement* Document::html_element()
  181. {
  182. auto* html = document_element();
  183. if (is<HTML::HTMLHtmlElement>(html))
  184. return verify_cast<HTML::HTMLHtmlElement>(html);
  185. return nullptr;
  186. }
  187. HTML::HTMLHeadElement* Document::head()
  188. {
  189. auto* html = html_element();
  190. if (!html)
  191. return nullptr;
  192. return html->first_child_of_type<HTML::HTMLHeadElement>();
  193. }
  194. HTML::HTMLElement* Document::body()
  195. {
  196. auto* html = html_element();
  197. if (!html)
  198. return nullptr;
  199. auto* first_body = html->first_child_of_type<HTML::HTMLBodyElement>();
  200. if (first_body)
  201. return first_body;
  202. auto* first_frameset = html->first_child_of_type<HTML::HTMLFrameSetElement>();
  203. if (first_frameset)
  204. return first_frameset;
  205. return nullptr;
  206. }
  207. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-body
  208. ExceptionOr<void> Document::set_body(HTML::HTMLElement* new_body)
  209. {
  210. if (!is<HTML::HTMLBodyElement>(new_body) && !is<HTML::HTMLFrameSetElement>(new_body))
  211. return DOM::HierarchyRequestError::create("Invalid document body element, must be 'body' or 'frameset'");
  212. auto* existing_body = body();
  213. if (existing_body) {
  214. auto replace_result = existing_body->parent()->replace_child(*new_body, *existing_body);
  215. if (replace_result.is_exception())
  216. return replace_result.exception();
  217. return {};
  218. }
  219. auto* document_element = this->document_element();
  220. if (!document_element)
  221. return DOM::HierarchyRequestError::create("Missing document element");
  222. auto append_result = document_element->append_child(*new_body);
  223. if (append_result.is_exception())
  224. return append_result.exception();
  225. return {};
  226. }
  227. String Document::title() const
  228. {
  229. auto* head_element = head();
  230. if (!head_element)
  231. return {};
  232. auto* title_element = head_element->first_child_of_type<HTML::HTMLTitleElement>();
  233. if (!title_element)
  234. return {};
  235. auto raw_title = title_element->text_content();
  236. StringBuilder builder;
  237. bool last_was_space = false;
  238. for (auto code_point : Utf8View(raw_title)) {
  239. if (is_ascii_space(code_point)) {
  240. last_was_space = true;
  241. } else {
  242. if (last_was_space && !builder.is_empty())
  243. builder.append(' ');
  244. builder.append_code_point(code_point);
  245. last_was_space = false;
  246. }
  247. }
  248. return builder.to_string();
  249. }
  250. void Document::set_title(const String& title)
  251. {
  252. auto* head_element = const_cast<HTML::HTMLHeadElement*>(head());
  253. if (!head_element)
  254. return;
  255. RefPtr<HTML::HTMLTitleElement> title_element = head_element->first_child_of_type<HTML::HTMLTitleElement>();
  256. if (!title_element) {
  257. title_element = static_ptr_cast<HTML::HTMLTitleElement>(create_element(HTML::TagNames::title));
  258. head_element->append_child(*title_element);
  259. }
  260. title_element->remove_all_children(true);
  261. title_element->append_child(adopt_ref(*new Text(*this, title)));
  262. if (auto* page = this->page()) {
  263. if (browsing_context() == &page->top_level_browsing_context())
  264. page->client().page_did_change_title(title);
  265. }
  266. }
  267. void Document::attach_to_browsing_context(Badge<HTML::BrowsingContext>, HTML::BrowsingContext& browsing_context)
  268. {
  269. m_browsing_context = browsing_context;
  270. update_layout();
  271. }
  272. void Document::detach_from_browsing_context(Badge<HTML::BrowsingContext>, HTML::BrowsingContext& browsing_context)
  273. {
  274. VERIFY(&browsing_context == m_browsing_context);
  275. tear_down_layout_tree();
  276. m_browsing_context = nullptr;
  277. }
  278. void Document::tear_down_layout_tree()
  279. {
  280. if (!m_layout_root)
  281. return;
  282. // Gather up all the layout nodes in a vector and detach them from parents
  283. // while the vector keeps them alive.
  284. NonnullRefPtrVector<Layout::Node> layout_nodes;
  285. m_layout_root->for_each_in_inclusive_subtree([&](auto& layout_node) {
  286. layout_nodes.append(layout_node);
  287. return IterationDecision::Continue;
  288. });
  289. for (auto& layout_node : layout_nodes) {
  290. if (layout_node.parent())
  291. layout_node.parent()->remove_child(layout_node);
  292. }
  293. m_layout_root = nullptr;
  294. }
  295. Color Document::background_color(const Palette& palette) const
  296. {
  297. auto default_color = palette.base();
  298. auto* body_element = body();
  299. if (!body_element)
  300. return default_color;
  301. auto* body_layout_node = body_element->layout_node();
  302. if (!body_layout_node)
  303. return default_color;
  304. auto color = body_layout_node->computed_values().background_color();
  305. if (!color.alpha())
  306. return default_color;
  307. return color;
  308. }
  309. Vector<CSS::BackgroundLayerData> const* Document::background_layers() const
  310. {
  311. auto* body_element = body();
  312. if (!body_element)
  313. return {};
  314. auto* body_layout_node = body_element->layout_node();
  315. if (!body_layout_node)
  316. return {};
  317. return &body_layout_node->background_layers();
  318. }
  319. // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#parse-a-url
  320. AK::URL Document::parse_url(String const& url) const
  321. {
  322. // FIXME: Make sure we do this according to spec.
  323. return m_url.complete_url(url);
  324. }
  325. void Document::set_needs_layout()
  326. {
  327. if (m_needs_layout)
  328. return;
  329. m_needs_layout = true;
  330. schedule_layout_update();
  331. }
  332. void Document::force_layout()
  333. {
  334. tear_down_layout_tree();
  335. update_layout();
  336. }
  337. void Document::ensure_layout()
  338. {
  339. if (m_needs_layout || !m_layout_root)
  340. update_layout();
  341. }
  342. void Document::update_layout()
  343. {
  344. if (!m_needs_layout && m_layout_root)
  345. return;
  346. if (!browsing_context())
  347. return;
  348. update_style();
  349. if (!m_layout_root) {
  350. Layout::TreeBuilder tree_builder;
  351. m_layout_root = static_ptr_cast<Layout::InitialContainingBlock>(tree_builder.build(*this));
  352. }
  353. Layout::BlockFormattingContext root_formatting_context(*m_layout_root, nullptr);
  354. root_formatting_context.run(*m_layout_root, Layout::LayoutMode::Default);
  355. m_layout_root->set_needs_display();
  356. if (browsing_context()->is_top_level()) {
  357. if (auto* page = this->page())
  358. page->client().page_did_layout();
  359. }
  360. m_needs_layout = false;
  361. m_layout_update_timer->stop();
  362. }
  363. static void update_style_recursively(DOM::Node& node)
  364. {
  365. if (is<Element>(node))
  366. static_cast<Element&>(node).recompute_style();
  367. node.set_needs_style_update(false);
  368. if (node.child_needs_style_update()) {
  369. node.for_each_child([&](auto& child) {
  370. if (child.needs_style_update() || child.child_needs_style_update())
  371. update_style_recursively(child);
  372. return IterationDecision::Continue;
  373. });
  374. }
  375. node.set_child_needs_style_update(false);
  376. }
  377. void Document::update_style()
  378. {
  379. if (!browsing_context())
  380. return;
  381. if (!needs_style_update() && !child_needs_style_update())
  382. return;
  383. update_style_recursively(*this);
  384. m_style_update_timer->stop();
  385. set_needs_layout();
  386. }
  387. void Document::set_link_color(Color color)
  388. {
  389. m_link_color = color;
  390. }
  391. void Document::set_active_link_color(Color color)
  392. {
  393. m_active_link_color = color;
  394. }
  395. void Document::set_visited_link_color(Color color)
  396. {
  397. m_visited_link_color = color;
  398. }
  399. const Layout::InitialContainingBlock* Document::layout_node() const
  400. {
  401. return static_cast<const Layout::InitialContainingBlock*>(Node::layout_node());
  402. }
  403. Layout::InitialContainingBlock* Document::layout_node()
  404. {
  405. return static_cast<Layout::InitialContainingBlock*>(Node::layout_node());
  406. }
  407. void Document::set_inspected_node(Node* node)
  408. {
  409. if (m_inspected_node == node)
  410. return;
  411. if (m_inspected_node && m_inspected_node->layout_node())
  412. m_inspected_node->layout_node()->set_needs_display();
  413. m_inspected_node = node;
  414. if (m_inspected_node && m_inspected_node->layout_node())
  415. m_inspected_node->layout_node()->set_needs_display();
  416. }
  417. void Document::set_hovered_node(Node* node)
  418. {
  419. if (m_hovered_node == node)
  420. return;
  421. RefPtr<Node> old_hovered_node = move(m_hovered_node);
  422. m_hovered_node = node;
  423. invalidate_style();
  424. }
  425. NonnullRefPtr<HTMLCollection> Document::get_elements_by_name(String const& name)
  426. {
  427. return HTMLCollection::create(*this, [name](Element const& element) {
  428. return element.name() == name;
  429. });
  430. }
  431. NonnullRefPtr<HTMLCollection> Document::get_elements_by_class_name(FlyString const& class_name)
  432. {
  433. return HTMLCollection::create(*this, [class_name, quirks_mode = document().in_quirks_mode()](Element const& element) {
  434. return element.has_class(class_name, quirks_mode ? CaseSensitivity::CaseInsensitive : CaseSensitivity::CaseSensitive);
  435. });
  436. }
  437. // https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-applets
  438. NonnullRefPtr<HTMLCollection> Document::applets()
  439. {
  440. // FIXME: This should return the same HTMLCollection object every time,
  441. // but that would cause a reference cycle since HTMLCollection refs the root.
  442. return HTMLCollection::create(*this, [](auto&) { return false; });
  443. }
  444. // https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-anchors
  445. NonnullRefPtr<HTMLCollection> Document::anchors()
  446. {
  447. // FIXME: This should return the same HTMLCollection object every time,
  448. // but that would cause a reference cycle since HTMLCollection refs the root.
  449. return HTMLCollection::create(*this, [](Element const& element) {
  450. return is<HTML::HTMLAnchorElement>(element) && element.has_attribute(HTML::AttributeNames::name);
  451. });
  452. }
  453. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-images
  454. NonnullRefPtr<HTMLCollection> Document::images()
  455. {
  456. // FIXME: This should return the same HTMLCollection object every time,
  457. // but that would cause a reference cycle since HTMLCollection refs the root.
  458. return HTMLCollection::create(*this, [](Element const& element) {
  459. return is<HTML::HTMLImageElement>(element);
  460. });
  461. }
  462. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-embeds
  463. NonnullRefPtr<HTMLCollection> Document::embeds()
  464. {
  465. // FIXME: This should return the same HTMLCollection object every time,
  466. // but that would cause a reference cycle since HTMLCollection refs the root.
  467. return HTMLCollection::create(*this, [](Element const& element) {
  468. return is<HTML::HTMLEmbedElement>(element);
  469. });
  470. }
  471. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-plugins
  472. NonnullRefPtr<HTMLCollection> Document::plugins()
  473. {
  474. return embeds();
  475. }
  476. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-links
  477. NonnullRefPtr<HTMLCollection> Document::links()
  478. {
  479. // FIXME: This should return the same HTMLCollection object every time,
  480. // but that would cause a reference cycle since HTMLCollection refs the root.
  481. return HTMLCollection::create(*this, [](Element const& element) {
  482. return (is<HTML::HTMLAnchorElement>(element) || is<HTML::HTMLAreaElement>(element)) && element.has_attribute(HTML::AttributeNames::href);
  483. });
  484. }
  485. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-forms
  486. NonnullRefPtr<HTMLCollection> Document::forms()
  487. {
  488. // FIXME: This should return the same HTMLCollection object every time,
  489. // but that would cause a reference cycle since HTMLCollection refs the root.
  490. return HTMLCollection::create(*this, [](Element const& element) {
  491. return is<HTML::HTMLFormElement>(element);
  492. });
  493. }
  494. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-scripts
  495. NonnullRefPtr<HTMLCollection> Document::scripts()
  496. {
  497. // FIXME: This should return the same HTMLCollection object every time,
  498. // but that would cause a reference cycle since HTMLCollection refs the root.
  499. return HTMLCollection::create(*this, [](Element const& element) {
  500. return is<HTML::HTMLScriptElement>(element);
  501. });
  502. }
  503. Color Document::link_color() const
  504. {
  505. if (m_link_color.has_value())
  506. return m_link_color.value();
  507. if (!page())
  508. return Color::Blue;
  509. return page()->palette().link();
  510. }
  511. Color Document::active_link_color() const
  512. {
  513. if (m_active_link_color.has_value())
  514. return m_active_link_color.value();
  515. if (!page())
  516. return Color::Red;
  517. return page()->palette().active_link();
  518. }
  519. Color Document::visited_link_color() const
  520. {
  521. if (m_visited_link_color.has_value())
  522. return m_visited_link_color.value();
  523. if (!page())
  524. return Color::Magenta;
  525. return page()->palette().visited_link();
  526. }
  527. // https://html.spec.whatwg.org/multipage/webappapis.html#relevant-settings-object
  528. HTML::EnvironmentSettingsObject& Document::relevant_settings_object()
  529. {
  530. // Then, the relevant settings object for a platform object o is the environment settings object of the relevant Realm for o.
  531. return verify_cast<HTML::EnvironmentSettingsObject>(*realm().host_defined());
  532. }
  533. JS::Realm& Document::realm()
  534. {
  535. return interpreter().realm();
  536. }
  537. JS::Interpreter& Document::interpreter()
  538. {
  539. if (!m_interpreter) {
  540. // FIXME: This is all ad-hoc. It loosely follows steps 6.4 to 6.9 of https://html.spec.whatwg.org/#initialise-the-document-object
  541. auto& vm = Bindings::main_thread_vm();
  542. // https://html.spec.whatwg.org/multipage/webappapis.html#creating-a-new-javascript-realm
  543. // FIXME: Put all this into it's own function that can be used outside of Document.
  544. // 1. Perform InitializeHostDefinedRealm() with the provided customizations for creating the global object and the global this binding.
  545. // FIXME: Use WindowProxy as the global this value.
  546. m_interpreter = JS::Interpreter::create<Bindings::WindowObject>(vm, *m_window);
  547. // 2. Let realm execution context be the running JavaScript execution context.
  548. auto& realm_execution_context = vm.running_execution_context();
  549. // 3. Remove realm execution context from the JavaScript execution context stack.
  550. vm.execution_context_stack().remove_first_matching([&realm_execution_context](auto* execution_context) {
  551. return execution_context == &realm_execution_context;
  552. });
  553. // FIXME: 4. Let realm be realm execution context's Realm component.
  554. // FIXME: 5. Set realm's agent to agent.
  555. // FIXME: 6. If agent's agent cluster's cross-origin isolation mode is "none", then:
  556. // 1. Let global be realm's global object.
  557. // 2. Let status be ! global.[[Delete]]("SharedArrayBuffer").
  558. // 3. Assert: status is true.
  559. // FIXME: 7. Return realm execution context. (Requires being in it's own function as mentioned above)
  560. // == End of "create a JavaScript realm" ==
  561. // FIXME: 6. Let topLevelCreationURL be creationURL.
  562. // FIXME: 7. Let topLevelOrigin be navigationParams's origin.
  563. // FIXME: 8. If browsingContext is not a top-level browsing context, then:
  564. // 1. Let parentEnvironment be browsingContext's container's relevant settings object.
  565. // 2. Set topLevelCreationURL to parentEnvironment's top-level creation URL.
  566. // 3. Set topLevelOrigin to parentEnvironment's top-level origin.
  567. // FIXME: 9. Set up a window environment settings object with creationURL, realm execution context, navigationParams's reserved environment, topLevelCreationURL, and topLevelOrigin.
  568. // (This is missing reserved environment, topLevelCreationURL and topLevelOrigin. It also assumes creationURL is the document's URL, when it's really "navigationParams's response's URL.")
  569. HTML::WindowEnvironmentSettingsObject::setup(m_url, realm_execution_context);
  570. // NOTE: We must hook `on_call_stack_emptied` after the interpreter was created, as the initialization of the
  571. // WindowsObject can invoke some internal calls, which will eventually lead to this hook being called without
  572. // `m_interpreter` being fully initialized yet.
  573. // TODO: Hook up vm.on_promise_unhandled_rejection and vm.on_promise_rejection_handled
  574. // See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#promise_rejection_events
  575. vm.on_call_stack_emptied = [this] {
  576. auto& vm = m_interpreter->vm();
  577. vm.run_queued_promise_jobs();
  578. vm.run_queued_finalization_registry_cleanup_jobs();
  579. // FIXME: This isn't exactly the right place for this.
  580. HTML::main_thread_event_loop().perform_a_microtask_checkpoint();
  581. vm.finish_execution_generation();
  582. };
  583. }
  584. return *m_interpreter;
  585. }
  586. JS::Value Document::run_javascript(StringView source, StringView filename)
  587. {
  588. // FIXME: The only user of this function now is javascript: URLs. Refactor them to follow the spec: https://html.spec.whatwg.org/multipage/browsing-the-web.html#javascript-protocol
  589. auto& interpreter = document().interpreter();
  590. auto script_or_error = JS::Script::parse(source, interpreter.realm(), filename);
  591. if (script_or_error.is_error()) {
  592. // FIXME: Add error logging back.
  593. return JS::js_undefined();
  594. }
  595. auto result = interpreter.run(script_or_error.value());
  596. if (result.is_error()) {
  597. // FIXME: I'm sure the spec could tell us something about error propagation here!
  598. HTML::report_exception(result);
  599. return {};
  600. }
  601. return result.value();
  602. }
  603. // https://dom.spec.whatwg.org/#dom-document-createelement
  604. // FIXME: This only implements step 6 of the algorithm and does not take in options.
  605. NonnullRefPtr<Element> Document::create_element(const String& tag_name)
  606. {
  607. // FIXME: Let namespace be the HTML namespace, if this is an HTML document or this’s content type is "application/xhtml+xml", and null otherwise.
  608. return DOM::create_element(*this, tag_name, Namespace::HTML);
  609. }
  610. // https://dom.spec.whatwg.org/#internal-createelementns-steps
  611. // FIXME: This only implements step 4 of the algorithm and does not take in options.
  612. NonnullRefPtr<Element> Document::create_element_ns(const String& namespace_, const String& qualified_name)
  613. {
  614. return DOM::create_element(*this, qualified_name, namespace_);
  615. }
  616. NonnullRefPtr<DocumentFragment> Document::create_document_fragment()
  617. {
  618. return adopt_ref(*new DocumentFragment(*this));
  619. }
  620. NonnullRefPtr<Text> Document::create_text_node(const String& data)
  621. {
  622. return adopt_ref(*new Text(*this, data));
  623. }
  624. NonnullRefPtr<Comment> Document::create_comment(const String& data)
  625. {
  626. return adopt_ref(*new Comment(*this, data));
  627. }
  628. NonnullRefPtr<Range> Document::create_range()
  629. {
  630. return Range::create(*this);
  631. }
  632. // https://dom.spec.whatwg.org/#dom-document-createevent
  633. NonnullRefPtr<Event> Document::create_event(const String& interface)
  634. {
  635. auto interface_lowercase = interface.to_lowercase();
  636. RefPtr<Event> event;
  637. if (interface_lowercase == "beforeunloadevent") {
  638. event = Event::create(""); // FIXME: Create BeforeUnloadEvent
  639. } else if (interface_lowercase == "compositionevent") {
  640. event = Event::create(""); // FIXME: Create CompositionEvent
  641. } else if (interface_lowercase == "customevent") {
  642. event = CustomEvent::create("");
  643. } else if (interface_lowercase == "devicemotionevent") {
  644. event = Event::create(""); // FIXME: Create DeviceMotionEvent
  645. } else if (interface_lowercase == "deviceorientationevent") {
  646. event = Event::create(""); // FIXME: Create DeviceOrientationEvent
  647. } else if (interface_lowercase == "dragevent") {
  648. event = Event::create(""); // FIXME: Create DragEvent
  649. } else if (interface_lowercase.is_one_of("event", "events")) {
  650. event = Event::create("");
  651. } else if (interface_lowercase == "focusevent") {
  652. event = UIEvents::FocusEvent::create("");
  653. } else if (interface_lowercase == "hashchangeevent") {
  654. event = Event::create(""); // FIXME: Create HashChangeEvent
  655. } else if (interface_lowercase == "htmlevents") {
  656. event = Event::create("");
  657. } else if (interface_lowercase == "keyboardevent") {
  658. event = UIEvents::KeyboardEvent::create("");
  659. } else if (interface_lowercase == "messageevent") {
  660. event = HTML::MessageEvent::create("");
  661. } else if (interface_lowercase.is_one_of("mouseevent", "mouseevents")) {
  662. event = UIEvents::MouseEvent::create("", 0, 0, 0, 0);
  663. } else if (interface_lowercase == "storageevent") {
  664. event = Event::create(""); // FIXME: Create StorageEvent
  665. } else if (interface_lowercase == "svgevents") {
  666. event = Event::create("");
  667. } else if (interface_lowercase == "textevent") {
  668. event = Event::create(""); // FIXME: Create CompositionEvent
  669. } else if (interface_lowercase == "touchevent") {
  670. event = Event::create(""); // FIXME: Create TouchEvent
  671. } else if (interface_lowercase.is_one_of("uievent", "uievents")) {
  672. event = UIEvents::UIEvent::create("");
  673. } else {
  674. // FIXME:
  675. // 3. If constructor is null, then throw a "NotSupportedError" DOMException.
  676. // 4. If the interface indicated by constructor is not exposed on the relevant global object of this, then throw a "NotSupportedError" DOMException.
  677. TODO();
  678. }
  679. // Setting type to empty string is handled by each constructor.
  680. // FIXME:
  681. // 7. Initialize event’s timeStamp attribute to a DOMHighResTimeStamp representing the high resolution time from the time origin to now.
  682. event->set_is_trusted(false);
  683. event->set_initialized(false);
  684. return event.release_nonnull();
  685. }
  686. void Document::set_pending_parsing_blocking_script(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement* script)
  687. {
  688. m_pending_parsing_blocking_script = script;
  689. }
  690. NonnullRefPtr<HTML::HTMLScriptElement> Document::take_pending_parsing_blocking_script(Badge<HTML::HTMLParser>)
  691. {
  692. return m_pending_parsing_blocking_script.release_nonnull();
  693. }
  694. void Document::add_script_to_execute_when_parsing_has_finished(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement& script)
  695. {
  696. m_scripts_to_execute_when_parsing_has_finished.append(script);
  697. }
  698. NonnullRefPtrVector<HTML::HTMLScriptElement> Document::take_scripts_to_execute_when_parsing_has_finished(Badge<HTML::HTMLParser>)
  699. {
  700. return move(m_scripts_to_execute_when_parsing_has_finished);
  701. }
  702. void Document::add_script_to_execute_as_soon_as_possible(Badge<HTML::HTMLScriptElement>, HTML::HTMLScriptElement& script)
  703. {
  704. m_scripts_to_execute_as_soon_as_possible.append(script);
  705. }
  706. NonnullRefPtrVector<HTML::HTMLScriptElement> Document::take_scripts_to_execute_as_soon_as_possible(Badge<HTML::HTMLParser>)
  707. {
  708. return move(m_scripts_to_execute_as_soon_as_possible);
  709. }
  710. // https://dom.spec.whatwg.org/#dom-document-importnode
  711. ExceptionOr<NonnullRefPtr<Node>> Document::import_node(NonnullRefPtr<Node> node, bool deep)
  712. {
  713. // 1. If node is a document or shadow root, then throw a "NotSupportedError" DOMException.
  714. if (is<Document>(*node) || is<ShadowRoot>(*node))
  715. return DOM::NotSupportedError::create("Cannot import a document or shadow root.");
  716. // 2. Return a clone of node, with this and the clone children flag set if deep is true.
  717. return node->clone_node(this, deep);
  718. }
  719. // https://dom.spec.whatwg.org/#concept-node-adopt
  720. void Document::adopt_node(Node& node)
  721. {
  722. auto& old_document = node.document();
  723. if (node.parent())
  724. node.remove();
  725. if (&old_document != this) {
  726. // FIXME: This should be shadow-including.
  727. node.for_each_in_inclusive_subtree([&](auto& inclusive_descendant) {
  728. inclusive_descendant.set_document({}, *this);
  729. // FIXME: If inclusiveDescendant is an element, then set the node document of each attribute in inclusiveDescendant’s attribute list to document.
  730. return IterationDecision::Continue;
  731. });
  732. // FIXME: For each inclusiveDescendant in node’s shadow-including inclusive descendants that is custom,
  733. // enqueue a custom element callback reaction with inclusiveDescendant, callback name "adoptedCallback",
  734. // and an argument list containing oldDocument and document.
  735. // FIXME: This should be shadow-including.
  736. node.for_each_in_inclusive_subtree([&](auto& inclusive_descendant) {
  737. inclusive_descendant.adopted_from(old_document);
  738. return IterationDecision::Continue;
  739. });
  740. }
  741. }
  742. // https://dom.spec.whatwg.org/#dom-document-adoptnode
  743. ExceptionOr<NonnullRefPtr<Node>> Document::adopt_node_binding(NonnullRefPtr<Node> node)
  744. {
  745. if (is<Document>(*node))
  746. return DOM::NotSupportedError::create("Cannot adopt a document into a document");
  747. if (is<ShadowRoot>(*node))
  748. return DOM::HierarchyRequestError::create("Cannot adopt a shadow root into a document");
  749. if (is<DocumentFragment>(*node) && verify_cast<DocumentFragment>(*node).host())
  750. return node;
  751. adopt_node(*node);
  752. return node;
  753. }
  754. const DocumentType* Document::doctype() const
  755. {
  756. return first_child_of_type<DocumentType>();
  757. }
  758. const String& Document::compat_mode() const
  759. {
  760. static String back_compat = "BackCompat";
  761. static String css1_compat = "CSS1Compat";
  762. if (m_quirks_mode == QuirksMode::Yes)
  763. return back_compat;
  764. return css1_compat;
  765. }
  766. bool Document::is_editable() const
  767. {
  768. return m_editable;
  769. }
  770. void Document::set_focused_element(Element* element)
  771. {
  772. if (m_focused_element == element)
  773. return;
  774. if (m_focused_element)
  775. m_focused_element->did_lose_focus();
  776. m_focused_element = element;
  777. if (m_focused_element)
  778. m_focused_element->did_receive_focus();
  779. if (m_layout_root)
  780. m_layout_root->set_needs_display();
  781. }
  782. void Document::set_active_element(Element* element)
  783. {
  784. if (m_active_element == element)
  785. return;
  786. m_active_element = element;
  787. if (m_layout_root)
  788. m_layout_root->set_needs_display();
  789. }
  790. String Document::ready_state() const
  791. {
  792. switch (m_readiness) {
  793. case HTML::DocumentReadyState::Loading:
  794. return "loading"sv;
  795. case HTML::DocumentReadyState::Interactive:
  796. return "interactive"sv;
  797. case HTML::DocumentReadyState::Complete:
  798. return "complete"sv;
  799. }
  800. VERIFY_NOT_REACHED();
  801. }
  802. // https://html.spec.whatwg.org/#update-the-current-document-readiness
  803. void Document::update_readiness(HTML::DocumentReadyState readiness_value)
  804. {
  805. // 1. If document's current document readiness equals readinessValue, then return.
  806. if (m_readiness == readiness_value)
  807. return;
  808. // The spec doesn't actually mention updating the current readiness value.
  809. // FIXME: https://github.com/whatwg/html/issues/7120
  810. m_readiness = readiness_value;
  811. // FIXME: 2. If document is associated with an HTML parser, then:
  812. // FIXME: 1. If document is associated with an HTML parser, then:
  813. // FIXME: 2. If readinessValue is "complete", and document's load timing info's DOM complete time is 0, then set document's load timing info's DOM complete time to now.
  814. // FIXME: 3. Otherwise, if readinessValue is "interactive", and document's load timing info's DOM interactive time is 0, then set document's load timing info's DOM interactive time to now.
  815. // 3. Fire an event named readystatechange at document.
  816. dispatch_event(Event::create(HTML::EventNames::readystatechange));
  817. }
  818. Page* Document::page()
  819. {
  820. return m_browsing_context ? m_browsing_context->page() : nullptr;
  821. }
  822. const Page* Document::page() const
  823. {
  824. return m_browsing_context ? m_browsing_context->page() : nullptr;
  825. }
  826. EventTarget* Document::get_parent(const Event& event)
  827. {
  828. if (event.type() == HTML::EventNames::load)
  829. return nullptr;
  830. return &window();
  831. }
  832. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#completely-finish-loading
  833. void Document::completely_finish_loading()
  834. {
  835. // 1. Assert: document's browsing context is non-null.
  836. VERIFY(browsing_context());
  837. // FIXME: 2. Set document's completely loaded time to the current time.
  838. // 3. Let container be document's browsing context's container.
  839. auto* container = browsing_context()->container();
  840. // If container is an iframe element, then queue an element task on the DOM manipulation task source given container to run the iframe load event steps given container.
  841. if (container && is<HTML::HTMLIFrameElement>(*container)) {
  842. container->queue_an_element_task(HTML::Task::Source::DOMManipulation, [container]() mutable {
  843. run_iframe_load_event_steps(static_cast<HTML::HTMLIFrameElement&>(*container));
  844. });
  845. }
  846. // Otherwise, if container is non-null, then queue an element task on the DOM manipulation task source given container to fire an event named load at container.
  847. else if (container) {
  848. container->queue_an_element_task(HTML::Task::Source::DOMManipulation, [container]() mutable {
  849. container->dispatch_event(DOM::Event::create(HTML::EventNames::load));
  850. });
  851. }
  852. }
  853. String Document::cookie(Cookie::Source source)
  854. {
  855. if (auto* page = this->page())
  856. return page->client().page_did_request_cookie(m_url, source);
  857. return {};
  858. }
  859. void Document::set_cookie(String cookie_string, Cookie::Source source)
  860. {
  861. auto cookie = Cookie::parse_cookie(cookie_string);
  862. if (!cookie.has_value())
  863. return;
  864. if (auto* page = this->page())
  865. page->client().page_did_set_cookie(m_url, cookie.value(), source);
  866. }
  867. String Document::dump_dom_tree_as_json() const
  868. {
  869. StringBuilder builder;
  870. JsonObjectSerializer json(builder);
  871. serialize_tree_as_json(json);
  872. json.finish();
  873. return builder.to_string();
  874. }
  875. // https://html.spec.whatwg.org/multipage/semantics.html#has-a-style-sheet-that-is-blocking-scripts
  876. bool Document::has_a_style_sheet_that_is_blocking_scripts() const
  877. {
  878. // A Document has a style sheet that is blocking scripts if its script-blocking style sheet counter is greater than 0,
  879. if (m_script_blocking_style_sheet_counter > 0)
  880. return true;
  881. // ...or if that Document has a non-null browsing context whose container document is non-null and has a script-blocking style sheet counter greater than 0.
  882. if (!browsing_context() || !browsing_context()->container_document())
  883. return false;
  884. return browsing_context()->container_document()->m_script_blocking_style_sheet_counter > 0;
  885. }
  886. String Document::referrer() const
  887. {
  888. // FIXME: Return the document's actual referrer.
  889. return "";
  890. }
  891. // https://html.spec.whatwg.org/multipage/browsers.html#fully-active
  892. bool Document::is_fully_active() const
  893. {
  894. // A Document d is said to be fully active when d's browsing context is non-null, d's browsing context's active document is d,
  895. // and either d's browsing context is a top-level browsing context, or d's browsing context's container document is fully active.
  896. return browsing_context() && browsing_context()->active_document() == this && (browsing_context()->is_top_level() || browsing_context()->container_document()->is_fully_active());
  897. }
  898. // https://html.spec.whatwg.org/multipage/browsers.html#active-document
  899. bool Document::is_active() const
  900. {
  901. // A browsing context's active document is its active window's associated Document.
  902. return browsing_context() && browsing_context()->active_document() == this;
  903. }
  904. // https://html.spec.whatwg.org/multipage/history.html#dom-document-location
  905. Bindings::LocationObject* Document::location()
  906. {
  907. // The Document object's location attribute's getter must return this Document object's relevant global object's Location object,
  908. // if this Document object is fully active, and null otherwise.
  909. if (!is_fully_active())
  910. return nullptr;
  911. return window().wrapper()->location_object();
  912. }
  913. // https://html.spec.whatwg.org/multipage/interaction.html#dom-document-hidden
  914. bool Document::hidden() const
  915. {
  916. return false;
  917. }
  918. // https://html.spec.whatwg.org/multipage/interaction.html#dom-document-visibilitystate
  919. String Document::visibility_state() const
  920. {
  921. return hidden() ? "hidden" : "visible";
  922. }
  923. // https://drafts.csswg.org/cssom-view/#run-the-resize-steps
  924. void Document::run_the_resize_steps()
  925. {
  926. // 1. If doc’s viewport has had its width or height changed
  927. // (e.g. as a result of the user resizing the browser window, or changing the page zoom scale factor,
  928. // or an iframe element’s dimensions are changed) since the last time these steps were run,
  929. // fire an event named resize at the Window object associated with doc.
  930. if (!browsing_context())
  931. return;
  932. auto viewport_size = browsing_context()->viewport_rect().size();
  933. if (m_last_viewport_size == viewport_size)
  934. return;
  935. m_last_viewport_size = viewport_size;
  936. dispatch_event(DOM::Event::create(UIEvents::EventNames::resize));
  937. update_layout();
  938. }
  939. void Document::add_media_query_list(NonnullRefPtr<CSS::MediaQueryList>& media_query_list)
  940. {
  941. m_media_query_lists.append(media_query_list);
  942. }
  943. // https://drafts.csswg.org/cssom-view/#evaluate-media-queries-and-report-changes
  944. void Document::evaluate_media_queries_and_report_changes()
  945. {
  946. // NOTE: Not in the spec, but we take this opportunity to prune null WeakPtrs.
  947. m_media_query_lists.remove_all_matching([](auto& it) {
  948. return it.is_null();
  949. });
  950. // 1. For each MediaQueryList object target that has doc as its document,
  951. // in the order they were created, oldest first, run these substeps:
  952. for (auto& media_query_list_ptr : m_media_query_lists) {
  953. // 1.1. If target’s matches state has changed since the last time these steps
  954. // were run, fire an event at target using the MediaQueryListEvent constructor,
  955. // with its type attribute initialized to change, its isTrusted attribute
  956. // initialized to true, its media attribute initialized to target’s media,
  957. // and its matches attribute initialized to target’s matches state.
  958. if (media_query_list_ptr.is_null())
  959. continue;
  960. auto media_query_list = media_query_list_ptr.strong_ref();
  961. bool did_match = media_query_list->matches();
  962. bool now_matches = media_query_list->evaluate();
  963. if (did_match != now_matches) {
  964. CSS::MediaQueryListEventInit init;
  965. init.media = media_query_list->media();
  966. init.matches = now_matches;
  967. auto event = CSS::MediaQueryListEvent::create(HTML::EventNames::change, init);
  968. event->set_is_trusted(true);
  969. media_query_list->dispatch_event(event);
  970. }
  971. }
  972. // Also not in the spec, but this is as good a place as any to evaluate @media rules!
  973. for (auto& style_sheet : style_sheets().sheets()) {
  974. style_sheet.evaluate_media_queries(window());
  975. }
  976. }
  977. NonnullRefPtr<DOMImplementation> Document::implementation() const
  978. {
  979. return *m_implementation;
  980. }
  981. bool Document::has_focus() const
  982. {
  983. // FIXME: Return whether we actually have focus.
  984. return true;
  985. }
  986. }