Document.cpp 39 KB

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