BrowsingContext.h 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. /*
  2. * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Function.h>
  8. #include <AK/Noncopyable.h>
  9. #include <AK/RefPtr.h>
  10. #include <AK/WeakPtr.h>
  11. #include <LibGfx/Bitmap.h>
  12. #include <LibGfx/Rect.h>
  13. #include <LibGfx/Size.h>
  14. #include <LibJS/Forward.h>
  15. #include <LibJS/Heap/Cell.h>
  16. #include <LibWeb/DOM/Position.h>
  17. #include <LibWeb/HTML/AbstractBrowsingContext.h>
  18. #include <LibWeb/HTML/ActivateTab.h>
  19. #include <LibWeb/HTML/HistoryHandlingBehavior.h>
  20. #include <LibWeb/HTML/NavigableContainer.h>
  21. #include <LibWeb/HTML/Origin.h>
  22. #include <LibWeb/HTML/SandboxingFlagSet.h>
  23. #include <LibWeb/HTML/SessionHistoryEntry.h>
  24. #include <LibWeb/HTML/TokenizedFeatures.h>
  25. #include <LibWeb/HTML/VisibilityState.h>
  26. #include <LibWeb/Page/EventHandler.h>
  27. #include <LibWeb/Platform/Timer.h>
  28. #include <LibWeb/TreeNode.h>
  29. namespace Web::HTML {
  30. class BrowsingContext final
  31. : public AbstractBrowsingContext
  32. , public Weakable<BrowsingContext> {
  33. JS_CELL(BrowsingContext, AbstractBrowsingContext);
  34. public:
  35. struct BrowsingContextAndDocument {
  36. JS::NonnullGCPtr<BrowsingContext> browsing_context;
  37. JS::NonnullGCPtr<DOM::Document> document;
  38. };
  39. static WebIDL::ExceptionOr<BrowsingContextAndDocument> create_a_new_browsing_context_and_document(Page& page, JS::GCPtr<DOM::Document> creator, JS::GCPtr<DOM::Element> embedder, JS::NonnullGCPtr<BrowsingContextGroup> group);
  40. static WebIDL::ExceptionOr<BrowsingContextAndDocument> create_a_new_auxiliary_browsing_context_and_document(Page& page, JS::NonnullGCPtr<HTML::BrowsingContext> opener);
  41. virtual ~BrowsingContext() override;
  42. JS::NonnullGCPtr<HTML::TraversableNavigable> top_level_traversable() const;
  43. JS::GCPtr<BrowsingContext> parent() const { return m_parent; }
  44. void append_child(JS::NonnullGCPtr<BrowsingContext>);
  45. void remove_child(JS::NonnullGCPtr<BrowsingContext>);
  46. JS::GCPtr<BrowsingContext> first_child() const;
  47. JS::GCPtr<BrowsingContext> next_sibling() const;
  48. bool is_ancestor_of(BrowsingContext const&) const;
  49. template<typename Callback>
  50. IterationDecision for_each_in_inclusive_subtree(Callback callback) const
  51. {
  52. if (callback(*this) == IterationDecision::Break)
  53. return IterationDecision::Break;
  54. for (auto child = first_child(); child; child = child->next_sibling()) {
  55. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  56. return IterationDecision::Break;
  57. }
  58. return IterationDecision::Continue;
  59. }
  60. template<typename Callback>
  61. IterationDecision for_each_in_inclusive_subtree(Callback callback)
  62. {
  63. if (callback(*this) == IterationDecision::Break)
  64. return IterationDecision::Break;
  65. for (auto child = first_child(); child; child = child->next_sibling()) {
  66. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  67. return IterationDecision::Break;
  68. }
  69. return IterationDecision::Continue;
  70. }
  71. template<typename Callback>
  72. IterationDecision for_each_in_subtree(Callback callback) const
  73. {
  74. for (auto child = first_child(); child; child = child->next_sibling()) {
  75. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  76. return IterationDecision::Break;
  77. }
  78. return IterationDecision::Continue;
  79. }
  80. template<typename Callback>
  81. IterationDecision for_each_in_subtree(Callback callback)
  82. {
  83. for (auto child = first_child(); child; child = child->next_sibling()) {
  84. if (child->for_each_in_inclusive_subtree(callback) == IterationDecision::Break)
  85. return IterationDecision::Break;
  86. }
  87. return IterationDecision::Continue;
  88. }
  89. bool is_top_level() const;
  90. bool is_focused_context() const;
  91. DOM::Document const* active_document() const;
  92. DOM::Document* active_document();
  93. virtual HTML::WindowProxy* window_proxy() override;
  94. virtual HTML::WindowProxy const* window_proxy() const override;
  95. void set_window_proxy(JS::GCPtr<WindowProxy>);
  96. HTML::Window* active_window();
  97. HTML::Window const* active_window() const;
  98. Page* page() { return m_page; }
  99. Page const* page() const { return m_page; }
  100. Web::EventHandler& event_handler() { return m_event_handler; }
  101. Web::EventHandler const& event_handler() const { return m_event_handler; }
  102. void scroll_to(CSSPixelPoint);
  103. JS::GCPtr<BrowsingContext> top_level_browsing_context() const;
  104. enum class WindowType {
  105. ExistingOrNone,
  106. NewAndUnrestricted,
  107. NewWithNoOpener,
  108. };
  109. struct ChosenBrowsingContext {
  110. JS::GCPtr<AbstractBrowsingContext> browsing_context;
  111. WindowType window_type;
  112. };
  113. ChosenBrowsingContext choose_a_browsing_context(StringView name, TokenizedFeature::NoOpener no_opener, ActivateTab = ActivateTab::Yes);
  114. HTML::NavigableContainer* container() { return m_container; }
  115. HTML::NavigableContainer const* container() const { return m_container; }
  116. CSSPixelPoint to_top_level_position(CSSPixelPoint);
  117. CSSPixelRect to_top_level_rect(CSSPixelRect const&);
  118. DOM::Position const& cursor_position() const { return m_cursor_position; }
  119. void set_cursor_position(DOM::Position);
  120. bool increment_cursor_position_offset();
  121. bool decrement_cursor_position_offset();
  122. bool cursor_blink_state() const { return m_cursor_blink_state; }
  123. DeprecatedString selected_text() const;
  124. void select_all();
  125. void did_edit(Badge<EditEventHandler>);
  126. JS::GCPtr<DOM::Node> currently_focused_area();
  127. Vector<JS::NonnullGCPtr<SessionHistoryEntry>>& session_history() { return m_session_history; }
  128. Vector<JS::NonnullGCPtr<SessionHistoryEntry>> const& session_history() const { return m_session_history; }
  129. size_t session_history_index() const { return *m_session_history_index; }
  130. // https://html.spec.whatwg.org/multipage/dom.html#still-on-its-initial-about:blank-document
  131. bool still_on_its_initial_about_blank_document() const;
  132. BrowsingContextGroup* group();
  133. void set_group(BrowsingContextGroup*);
  134. // https://html.spec.whatwg.org/multipage/browsers.html#bcg-remove
  135. void remove();
  136. // https://html.spec.whatwg.org/multipage/origin.html#one-permitted-sandboxed-navigator
  137. BrowsingContext const* the_one_permitted_sandboxed_navigator() const;
  138. bool has_been_discarded() const { return m_has_been_discarded; }
  139. Optional<AK::URL> const& creator_url() const { return m_creator_url; }
  140. virtual String const& window_handle() const override { return m_window_handle; }
  141. virtual void set_window_handle(String handle) override { m_window_handle = move(handle); }
  142. private:
  143. explicit BrowsingContext(Page&, HTML::NavigableContainer*);
  144. virtual void visit_edges(Cell::Visitor&) override;
  145. void reset_cursor_blink_cycle();
  146. WeakPtr<Page> m_page;
  147. Web::EventHandler m_event_handler;
  148. // https://html.spec.whatwg.org/multipage/history.html#current-entry
  149. SessionHistoryEntry& current_entry() { return m_session_history[*m_session_history_index]; }
  150. SessionHistoryEntry const& current_entry() const { return m_session_history[*m_session_history_index]; }
  151. Optional<size_t> m_session_history_index { 0 };
  152. // https://html.spec.whatwg.org/multipage/history.html#session-history
  153. Vector<JS::NonnullGCPtr<SessionHistoryEntry>> m_session_history;
  154. // https://html.spec.whatwg.org/multipage/browsers.html#creator-url
  155. Optional<AK::URL> m_creator_url;
  156. // https://html.spec.whatwg.org/multipage/browsers.html#creator-base-url
  157. Optional<AK::URL> m_creator_base_url;
  158. // https://html.spec.whatwg.org/multipage/browsers.html#creator-origin
  159. Optional<HTML::Origin> m_creator_origin;
  160. JS::GCPtr<HTML::NavigableContainer> m_container;
  161. // https://w3c.github.io/webdriver/#dfn-window-handles
  162. String m_window_handle;
  163. // https://html.spec.whatwg.org/multipage/browsers.html#browsing-context
  164. JS::GCPtr<HTML::WindowProxy> m_window_proxy;
  165. DOM::Position m_cursor_position;
  166. RefPtr<Core::Timer> m_cursor_blink_timer;
  167. bool m_cursor_blink_state { false };
  168. DeprecatedString m_name;
  169. // https://html.spec.whatwg.org/multipage/browsers.html#tlbc-group
  170. JS::GCPtr<BrowsingContextGroup> m_group;
  171. JS::GCPtr<BrowsingContext> m_parent;
  172. JS::GCPtr<BrowsingContext> m_first_child;
  173. JS::GCPtr<BrowsingContext> m_last_child;
  174. JS::GCPtr<BrowsingContext> m_next_sibling;
  175. JS::GCPtr<BrowsingContext> m_previous_sibling;
  176. bool m_has_been_discarded { false };
  177. };
  178. HTML::Origin determine_the_origin(AK::URL const& url, SandboxingFlagSet sandbox_flags, Optional<HTML::Origin> source_origin);
  179. SandboxingFlagSet determine_the_creation_sandboxing_flags(BrowsingContext const&, JS::GCPtr<DOM::Element> embedder);
  180. // FIXME: Find a better home for this
  181. bool url_matches_about_blank(AK::URL const& url);
  182. }