/* * Copyright (c) 2018-2022, Andreas Kling * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::HTML { class BrowsingContext final : public JS::Cell { GC_CELL(BrowsingContext, JS::Cell); GC_DECLARE_ALLOCATOR(BrowsingContext); public: struct BrowsingContextAndDocument { GC::Ref browsing_context; GC::Ref document; }; static WebIDL::ExceptionOr create_a_new_browsing_context_and_document(GC::Ref page, GC::Ptr creator, GC::Ptr embedder, GC::Ref group); static WebIDL::ExceptionOr create_a_new_auxiliary_browsing_context_and_document(GC::Ref page, GC::Ref opener); virtual ~BrowsingContext() override; GC::Ref top_level_traversable() const; GC::Ptr first_child() const; GC::Ptr next_sibling() const; bool is_ancestor_of(BrowsingContext const&) const; bool is_familiar_with(BrowsingContext const&) const; template TraversalDecision for_each_in_inclusive_subtree(Callback callback) const { if (callback(*this) == TraversalDecision::Break) return TraversalDecision::Break; for (auto child = first_child(); child; child = child->next_sibling()) { if (child->for_each_in_inclusive_subtree(callback) == TraversalDecision::Break) return TraversalDecision::Break; } return TraversalDecision::Continue; } template TraversalDecision for_each_in_inclusive_subtree(Callback callback) { if (callback(*this) == TraversalDecision::Break) return TraversalDecision::Break; for (auto child = first_child(); child; child = child->next_sibling()) { if (child->for_each_in_inclusive_subtree(callback) == TraversalDecision::Break) return TraversalDecision::Break; } return TraversalDecision::Continue; } template TraversalDecision for_each_in_subtree(Callback callback) const { for (auto child = first_child(); child; child = child->next_sibling()) { if (child->for_each_in_inclusive_subtree(callback) == TraversalDecision::Break) return TraversalDecision::Break; } return TraversalDecision::Continue; } template TraversalDecision for_each_in_subtree(Callback callback) { for (auto child = first_child(); child; child = child->next_sibling()) { if (child->for_each_in_inclusive_subtree(callback) == TraversalDecision::Break) return TraversalDecision::Break; } return TraversalDecision::Continue; } bool is_top_level() const; bool is_auxiliary() const { return m_is_auxiliary; } DOM::Document const* active_document() const; DOM::Document* active_document(); HTML::WindowProxy* window_proxy(); HTML::WindowProxy const* window_proxy() const; void set_window_proxy(GC::Ptr); HTML::Window* active_window(); HTML::Window const* active_window() const; Page& page() { return m_page; } Page const& page() const { return m_page; } u64 virtual_browsing_context_group_id() const { return m_virtual_browsing_context_group_id; } GC::Ptr top_level_browsing_context() const; BrowsingContextGroup* group(); BrowsingContextGroup const* group() const; void set_group(BrowsingContextGroup*); // https://html.spec.whatwg.org/multipage/browsers.html#bcg-remove void remove(); // https://html.spec.whatwg.org/multipage/origin.html#one-permitted-sandboxed-navigator BrowsingContext const* the_one_permitted_sandboxed_navigator() const; bool has_navigable_been_destroyed() const; GC::Ptr opener_browsing_context() const { return m_opener_browsing_context; } void set_opener_browsing_context(GC::Ptr browsing_context) { m_opener_browsing_context = browsing_context; } void set_is_popup(TokenizedFeature::Popup is_popup) { m_is_popup = is_popup; } private: explicit BrowsingContext(GC::Ref); virtual void visit_edges(Cell::Visitor&) override; GC::Ref m_page; // https://html.spec.whatwg.org/multipage/document-sequences.html#browsing-context GC::Ptr m_window_proxy; // https://html.spec.whatwg.org/multipage/browsers.html#opener-browsing-context GC::Ptr m_opener_browsing_context; // https://html.spec.whatwg.org/multipage/document-sequences.html#opener-origin-at-creation Optional m_opener_origin_at_creation; // https://html.spec.whatwg.org/multipage/browsers.html#is-popup TokenizedFeature::Popup m_is_popup { TokenizedFeature::Popup::No }; // https://html.spec.whatwg.org/multipage/document-sequences.html#is-auxiliary bool m_is_auxiliary { false }; // https://html.spec.whatwg.org/multipage/document-sequences.html#browsing-context-initial-url Optional m_initial_url; // https://html.spec.whatwg.org/multipage/document-sequences.html#virtual-browsing-context-group-id u64 m_virtual_browsing_context_group_id = { 0 }; // https://html.spec.whatwg.org/multipage/browsers.html#tlbc-group GC::Ptr m_group; GC::Ptr m_first_child; GC::Ptr m_last_child; GC::Ptr m_next_sibling; GC::Ptr m_previous_sibling; }; URL::Origin determine_the_origin(Optional, SandboxingFlagSet, Optional source_origin); SandboxingFlagSet determine_the_creation_sandboxing_flags(BrowsingContext const&, GC::Ptr embedder); // FIXME: Find a better home for these bool url_matches_about_blank(URL::URL const& url); bool url_matches_about_srcdoc(URL::URL const& url); }