Document.cpp 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172
  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. auto viewport_rect = browsing_context()->viewport_rect();
  349. update_style();
  350. if (!m_layout_root) {
  351. Layout::TreeBuilder tree_builder;
  352. m_layout_root = static_ptr_cast<Layout::InitialContainingBlock>(tree_builder.build(*this));
  353. }
  354. Layout::BlockFormattingContext root_formatting_context(*m_layout_root, nullptr);
  355. m_layout_root->build_stacking_context_tree();
  356. m_layout_root->set_content_size(viewport_rect.size().to_type<float>());
  357. root_formatting_context.run(*m_layout_root, Layout::LayoutMode::Default);
  358. m_layout_root->set_needs_display();
  359. if (browsing_context()->is_top_level()) {
  360. if (auto* page = this->page())
  361. page->client().page_did_layout();
  362. }
  363. m_needs_layout = false;
  364. m_layout_update_timer->stop();
  365. }
  366. static void update_style_recursively(DOM::Node& node)
  367. {
  368. if (is<Element>(node))
  369. static_cast<Element&>(node).recompute_style();
  370. node.set_needs_style_update(false);
  371. if (node.child_needs_style_update()) {
  372. node.for_each_child([&](auto& child) {
  373. if (child.needs_style_update() || child.child_needs_style_update())
  374. update_style_recursively(child);
  375. return IterationDecision::Continue;
  376. });
  377. }
  378. node.set_child_needs_style_update(false);
  379. }
  380. void Document::update_style()
  381. {
  382. if (!browsing_context())
  383. return;
  384. if (!needs_style_update() && !child_needs_style_update())
  385. return;
  386. update_style_recursively(*this);
  387. m_style_update_timer->stop();
  388. set_needs_layout();
  389. }
  390. void Document::set_link_color(Color color)
  391. {
  392. m_link_color = color;
  393. }
  394. void Document::set_active_link_color(Color color)
  395. {
  396. m_active_link_color = color;
  397. }
  398. void Document::set_visited_link_color(Color color)
  399. {
  400. m_visited_link_color = color;
  401. }
  402. const Layout::InitialContainingBlock* Document::layout_node() const
  403. {
  404. return static_cast<const Layout::InitialContainingBlock*>(Node::layout_node());
  405. }
  406. Layout::InitialContainingBlock* Document::layout_node()
  407. {
  408. return static_cast<Layout::InitialContainingBlock*>(Node::layout_node());
  409. }
  410. void Document::set_inspected_node(Node* node)
  411. {
  412. if (m_inspected_node == node)
  413. return;
  414. if (m_inspected_node && m_inspected_node->layout_node())
  415. m_inspected_node->layout_node()->set_needs_display();
  416. m_inspected_node = node;
  417. if (m_inspected_node && m_inspected_node->layout_node())
  418. m_inspected_node->layout_node()->set_needs_display();
  419. }
  420. void Document::set_hovered_node(Node* node)
  421. {
  422. if (m_hovered_node == node)
  423. return;
  424. RefPtr<Node> old_hovered_node = move(m_hovered_node);
  425. m_hovered_node = node;
  426. invalidate_style();
  427. }
  428. NonnullRefPtr<HTMLCollection> Document::get_elements_by_name(String const& name)
  429. {
  430. return HTMLCollection::create(*this, [name](Element const& element) {
  431. return element.name() == name;
  432. });
  433. }
  434. NonnullRefPtr<HTMLCollection> Document::get_elements_by_class_name(FlyString const& class_name)
  435. {
  436. return HTMLCollection::create(*this, [class_name, quirks_mode = document().in_quirks_mode()](Element const& element) {
  437. return element.has_class(class_name, quirks_mode ? CaseSensitivity::CaseInsensitive : CaseSensitivity::CaseSensitive);
  438. });
  439. }
  440. // https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-applets
  441. NonnullRefPtr<HTMLCollection> Document::applets()
  442. {
  443. // FIXME: This should return the same HTMLCollection object every time,
  444. // but that would cause a reference cycle since HTMLCollection refs the root.
  445. return HTMLCollection::create(*this, [](auto&) { return false; });
  446. }
  447. // https://html.spec.whatwg.org/multipage/obsolete.html#dom-document-anchors
  448. NonnullRefPtr<HTMLCollection> Document::anchors()
  449. {
  450. // FIXME: This should return the same HTMLCollection object every time,
  451. // but that would cause a reference cycle since HTMLCollection refs the root.
  452. return HTMLCollection::create(*this, [](Element const& element) {
  453. return is<HTML::HTMLAnchorElement>(element) && element.has_attribute(HTML::AttributeNames::name);
  454. });
  455. }
  456. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-images
  457. NonnullRefPtr<HTMLCollection> Document::images()
  458. {
  459. // FIXME: This should return the same HTMLCollection object every time,
  460. // but that would cause a reference cycle since HTMLCollection refs the root.
  461. return HTMLCollection::create(*this, [](Element const& element) {
  462. return is<HTML::HTMLImageElement>(element);
  463. });
  464. }
  465. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-embeds
  466. NonnullRefPtr<HTMLCollection> Document::embeds()
  467. {
  468. // FIXME: This should return the same HTMLCollection object every time,
  469. // but that would cause a reference cycle since HTMLCollection refs the root.
  470. return HTMLCollection::create(*this, [](Element const& element) {
  471. return is<HTML::HTMLEmbedElement>(element);
  472. });
  473. }
  474. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-plugins
  475. NonnullRefPtr<HTMLCollection> Document::plugins()
  476. {
  477. return embeds();
  478. }
  479. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-links
  480. NonnullRefPtr<HTMLCollection> Document::links()
  481. {
  482. // FIXME: This should return the same HTMLCollection object every time,
  483. // but that would cause a reference cycle since HTMLCollection refs the root.
  484. return HTMLCollection::create(*this, [](Element const& element) {
  485. return (is<HTML::HTMLAnchorElement>(element) || is<HTML::HTMLAreaElement>(element)) && element.has_attribute(HTML::AttributeNames::href);
  486. });
  487. }
  488. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-forms
  489. NonnullRefPtr<HTMLCollection> Document::forms()
  490. {
  491. // FIXME: This should return the same HTMLCollection object every time,
  492. // but that would cause a reference cycle since HTMLCollection refs the root.
  493. return HTMLCollection::create(*this, [](Element const& element) {
  494. return is<HTML::HTMLFormElement>(element);
  495. });
  496. }
  497. // https://html.spec.whatwg.org/multipage/dom.html#dom-document-scripts
  498. NonnullRefPtr<HTMLCollection> Document::scripts()
  499. {
  500. // FIXME: This should return the same HTMLCollection object every time,
  501. // but that would cause a reference cycle since HTMLCollection refs the root.
  502. return HTMLCollection::create(*this, [](Element const& element) {
  503. return is<HTML::HTMLScriptElement>(element);
  504. });
  505. }
  506. Color Document::link_color() const
  507. {
  508. if (m_link_color.has_value())
  509. return m_link_color.value();
  510. if (!page())
  511. return Color::Blue;
  512. return page()->palette().link();
  513. }
  514. Color Document::active_link_color() const
  515. {
  516. if (m_active_link_color.has_value())
  517. return m_active_link_color.value();
  518. if (!page())
  519. return Color::Red;
  520. return page()->palette().active_link();
  521. }
  522. Color Document::visited_link_color() const
  523. {
  524. if (m_visited_link_color.has_value())
  525. return m_visited_link_color.value();
  526. if (!page())
  527. return Color::Magenta;
  528. return page()->palette().visited_link();
  529. }
  530. // https://html.spec.whatwg.org/multipage/webappapis.html#relevant-settings-object
  531. HTML::EnvironmentSettingsObject& Document::relevant_settings_object()
  532. {
  533. // Then, the relevant settings object for a platform object o is the environment settings object of the relevant Realm for o.
  534. return verify_cast<HTML::EnvironmentSettingsObject>(*realm().host_defined());
  535. }
  536. JS::Realm& Document::realm()
  537. {
  538. return interpreter().realm();
  539. }
  540. JS::Interpreter& Document::interpreter()
  541. {
  542. if (!m_interpreter) {
  543. // 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
  544. auto& vm = Bindings::main_thread_vm();
  545. // https://html.spec.whatwg.org/multipage/webappapis.html#creating-a-new-javascript-realm
  546. // FIXME: Put all this into it's own function that can be used outside of Document.
  547. // 1. Perform InitializeHostDefinedRealm() with the provided customizations for creating the global object and the global this binding.
  548. // FIXME: Use WindowProxy as the global this value.
  549. m_interpreter = JS::Interpreter::create<Bindings::WindowObject>(vm, *m_window);
  550. // 2. Let realm execution context be the running JavaScript execution context.
  551. auto& realm_execution_context = vm.running_execution_context();
  552. // 3. Remove realm execution context from the JavaScript execution context stack.
  553. vm.execution_context_stack().remove_first_matching([&realm_execution_context](auto* execution_context) {
  554. return execution_context == &realm_execution_context;
  555. });
  556. // FIXME: 4. Let realm be realm execution context's Realm component.
  557. // FIXME: 5. Set realm's agent to agent.
  558. // FIXME: 6. If agent's agent cluster's cross-origin isolation mode is "none", then:
  559. // 1. Let global be realm's global object.
  560. // 2. Let status be ! global.[[Delete]]("SharedArrayBuffer").
  561. // 3. Assert: status is true.
  562. // FIXME: 7. Return realm execution context. (Requires being in it's own function as mentioned above)
  563. // == End of "create a JavaScript realm" ==
  564. // FIXME: 6. Let topLevelCreationURL be creationURL.
  565. // FIXME: 7. Let topLevelOrigin be navigationParams's origin.
  566. // FIXME: 8. If browsingContext is not a top-level browsing context, then:
  567. // 1. Let parentEnvironment be browsingContext's container's relevant settings object.
  568. // 2. Set topLevelCreationURL to parentEnvironment's top-level creation URL.
  569. // 3. Set topLevelOrigin to parentEnvironment's top-level origin.
  570. // FIXME: 9. Set up a window environment settings object with creationURL, realm execution context, navigationParams's reserved environment, topLevelCreationURL, and topLevelOrigin.
  571. // (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.")
  572. HTML::WindowEnvironmentSettingsObject::setup(m_url, realm_execution_context);
  573. }
  574. return *m_interpreter;
  575. }
  576. JS::Value Document::run_javascript(StringView source, StringView filename)
  577. {
  578. // 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
  579. auto& interpreter = document().interpreter();
  580. auto script_or_error = JS::Script::parse(source, interpreter.realm(), filename);
  581. if (script_or_error.is_error()) {
  582. // FIXME: Add error logging back.
  583. return JS::js_undefined();
  584. }
  585. auto result = interpreter.run(script_or_error.value());
  586. if (result.is_error()) {
  587. // FIXME: I'm sure the spec could tell us something about error propagation here!
  588. HTML::report_exception(result);
  589. return {};
  590. }
  591. return result.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 = UIEvents::FocusEvent::create("");
  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. if (m_focused_element)
  765. m_focused_element->did_lose_focus();
  766. m_focused_element = element;
  767. if (m_focused_element)
  768. m_focused_element->did_receive_focus();
  769. if (m_layout_root)
  770. m_layout_root->set_needs_display();
  771. }
  772. void Document::set_active_element(Element* element)
  773. {
  774. if (m_active_element == element)
  775. return;
  776. m_active_element = element;
  777. if (m_layout_root)
  778. m_layout_root->set_needs_display();
  779. }
  780. String Document::ready_state() const
  781. {
  782. switch (m_readiness) {
  783. case HTML::DocumentReadyState::Loading:
  784. return "loading"sv;
  785. case HTML::DocumentReadyState::Interactive:
  786. return "interactive"sv;
  787. case HTML::DocumentReadyState::Complete:
  788. return "complete"sv;
  789. }
  790. VERIFY_NOT_REACHED();
  791. }
  792. // https://html.spec.whatwg.org/#update-the-current-document-readiness
  793. void Document::update_readiness(HTML::DocumentReadyState readiness_value)
  794. {
  795. // 1. If document's current document readiness equals readinessValue, then return.
  796. if (m_readiness == readiness_value)
  797. return;
  798. // The spec doesn't actually mention updating the current readiness value.
  799. // FIXME: https://github.com/whatwg/html/issues/7120
  800. m_readiness = readiness_value;
  801. // FIXME: 2. If document is associated with an HTML parser, then:
  802. // FIXME: 1. If document is associated with an HTML parser, then:
  803. // 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.
  804. // 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.
  805. // 3. Fire an event named readystatechange at document.
  806. dispatch_event(Event::create(HTML::EventNames::readystatechange));
  807. }
  808. Page* Document::page()
  809. {
  810. return m_browsing_context ? m_browsing_context->page() : nullptr;
  811. }
  812. const Page* Document::page() const
  813. {
  814. return m_browsing_context ? m_browsing_context->page() : nullptr;
  815. }
  816. EventTarget* Document::get_parent(const Event& event)
  817. {
  818. if (event.type() == HTML::EventNames::load)
  819. return nullptr;
  820. return &window();
  821. }
  822. // https://html.spec.whatwg.org/multipage/browsing-the-web.html#completely-finish-loading
  823. void Document::completely_finish_loading()
  824. {
  825. // 1. Assert: document's browsing context is non-null.
  826. VERIFY(browsing_context());
  827. // FIXME: 2. Set document's completely loaded time to the current time.
  828. // 3. Let container be document's browsing context's container.
  829. auto* container = browsing_context()->container();
  830. // 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.
  831. if (container && is<HTML::HTMLIFrameElement>(*container)) {
  832. container->queue_an_element_task(HTML::Task::Source::DOMManipulation, [container]() mutable {
  833. run_iframe_load_event_steps(static_cast<HTML::HTMLIFrameElement&>(*container));
  834. });
  835. }
  836. // 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.
  837. else if (container) {
  838. container->queue_an_element_task(HTML::Task::Source::DOMManipulation, [container]() mutable {
  839. container->dispatch_event(DOM::Event::create(HTML::EventNames::load));
  840. });
  841. }
  842. }
  843. String Document::cookie(Cookie::Source source)
  844. {
  845. if (auto* page = this->page())
  846. return page->client().page_did_request_cookie(m_url, source);
  847. return {};
  848. }
  849. void Document::set_cookie(String const& cookie_string, Cookie::Source source)
  850. {
  851. auto cookie = Cookie::parse_cookie(cookie_string);
  852. if (!cookie.has_value())
  853. return;
  854. if (auto* page = this->page())
  855. page->client().page_did_set_cookie(m_url, cookie.value(), source);
  856. }
  857. String Document::dump_dom_tree_as_json() const
  858. {
  859. StringBuilder builder;
  860. JsonObjectSerializer json(builder);
  861. serialize_tree_as_json(json);
  862. json.finish();
  863. return builder.to_string();
  864. }
  865. // https://html.spec.whatwg.org/multipage/semantics.html#has-a-style-sheet-that-is-blocking-scripts
  866. bool Document::has_a_style_sheet_that_is_blocking_scripts() const
  867. {
  868. // A Document has a style sheet that is blocking scripts if its script-blocking style sheet counter is greater than 0,
  869. if (m_script_blocking_style_sheet_counter > 0)
  870. return true;
  871. // ...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.
  872. if (!browsing_context() || !browsing_context()->container_document())
  873. return false;
  874. return browsing_context()->container_document()->m_script_blocking_style_sheet_counter > 0;
  875. }
  876. String Document::referrer() const
  877. {
  878. // FIXME: Return the document's actual referrer.
  879. return "";
  880. }
  881. // https://html.spec.whatwg.org/multipage/browsers.html#fully-active
  882. bool Document::is_fully_active() const
  883. {
  884. // 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,
  885. // and either d's browsing context is a top-level browsing context, or d's browsing context's container document is fully active.
  886. return browsing_context() && browsing_context()->active_document() == this && (browsing_context()->is_top_level() || browsing_context()->container_document()->is_fully_active());
  887. }
  888. // https://html.spec.whatwg.org/multipage/browsers.html#active-document
  889. bool Document::is_active() const
  890. {
  891. // A browsing context's active document is its active window's associated Document.
  892. return browsing_context() && browsing_context()->active_document() == this;
  893. }
  894. // https://html.spec.whatwg.org/multipage/history.html#dom-document-location
  895. Bindings::LocationObject* Document::location()
  896. {
  897. // The Document object's location attribute's getter must return this Document object's relevant global object's Location object,
  898. // if this Document object is fully active, and null otherwise.
  899. if (!is_fully_active())
  900. return nullptr;
  901. return window().wrapper()->location_object();
  902. }
  903. // https://html.spec.whatwg.org/multipage/interaction.html#dom-document-hidden
  904. bool Document::hidden() const
  905. {
  906. return false;
  907. }
  908. // https://html.spec.whatwg.org/multipage/interaction.html#dom-document-visibilitystate
  909. String Document::visibility_state() const
  910. {
  911. return hidden() ? "hidden" : "visible";
  912. }
  913. // https://drafts.csswg.org/cssom-view/#run-the-resize-steps
  914. void Document::run_the_resize_steps()
  915. {
  916. // 1. If doc’s viewport has had its width or height changed
  917. // (e.g. as a result of the user resizing the browser window, or changing the page zoom scale factor,
  918. // or an iframe element’s dimensions are changed) since the last time these steps were run,
  919. // fire an event named resize at the Window object associated with doc.
  920. if (!browsing_context())
  921. return;
  922. auto viewport_size = browsing_context()->viewport_rect().size();
  923. if (m_last_viewport_size == viewport_size)
  924. return;
  925. m_last_viewport_size = viewport_size;
  926. dispatch_event(DOM::Event::create(UIEvents::EventNames::resize));
  927. update_layout();
  928. }
  929. void Document::add_media_query_list(NonnullRefPtr<CSS::MediaQueryList>& media_query_list)
  930. {
  931. m_media_query_lists.append(media_query_list);
  932. }
  933. // https://drafts.csswg.org/cssom-view/#evaluate-media-queries-and-report-changes
  934. void Document::evaluate_media_queries_and_report_changes()
  935. {
  936. // NOTE: Not in the spec, but we take this opportunity to prune null WeakPtrs.
  937. m_media_query_lists.remove_all_matching([](auto& it) {
  938. return it.is_null();
  939. });
  940. // 1. For each MediaQueryList object target that has doc as its document,
  941. // in the order they were created, oldest first, run these substeps:
  942. for (auto& media_query_list_ptr : m_media_query_lists) {
  943. // 1.1. If target’s matches state has changed since the last time these steps
  944. // were run, fire an event at target using the MediaQueryListEvent constructor,
  945. // with its type attribute initialized to change, its isTrusted attribute
  946. // initialized to true, its media attribute initialized to target’s media,
  947. // and its matches attribute initialized to target’s matches state.
  948. if (media_query_list_ptr.is_null())
  949. continue;
  950. auto media_query_list = media_query_list_ptr.strong_ref();
  951. bool did_match = media_query_list->matches();
  952. bool now_matches = media_query_list->evaluate();
  953. if (did_match != now_matches) {
  954. CSS::MediaQueryListEventInit init;
  955. init.media = media_query_list->media();
  956. init.matches = now_matches;
  957. auto event = CSS::MediaQueryListEvent::create(HTML::EventNames::change, init);
  958. event->set_is_trusted(true);
  959. media_query_list->dispatch_event(event);
  960. }
  961. }
  962. // Also not in the spec, but this is as good a place as any to evaluate @media rules!
  963. for (auto& style_sheet : style_sheets().sheets()) {
  964. style_sheet.evaluate_media_queries(window());
  965. }
  966. // FIXME: This invalidates too often!
  967. // We should only invalidate when one or more @media rules changes evaluation status.
  968. style_computer().invalidate_rule_cache();
  969. }
  970. NonnullRefPtr<DOMImplementation> Document::implementation() const
  971. {
  972. return *m_implementation;
  973. }
  974. bool Document::has_focus() const
  975. {
  976. // FIXME: Return whether we actually have focus.
  977. return true;
  978. }
  979. }