ladybird/Libraries/LibWeb/HTML/NavigationParams.h

/*
 * Copyright (c) 2022, Andreas Kling <andreas@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/Optional.h>
#include <LibGC/CellAllocator.h>
#include <LibGC/Ptr.h>
#include <LibURL/Origin.h>
#include <LibWeb/Fetch/Infrastructure/HTTP/Requests.h>
#include <LibWeb/Fetch/Infrastructure/HTTP/Responses.h>
#include <LibWeb/Forward.h>
#include <LibWeb/HTML/CrossOrigin/OpenerPolicy.h>
#include <LibWeb/HTML/CrossOrigin/OpenerPolicyEnforcementResult.h>
#include <LibWeb/HTML/PolicyContainers.h>
#include <LibWeb/HTML/SandboxingFlagSet.h>

namespace Web::HTML {

// https://html.spec.whatwg.org/multipage/browsing-the-web.html#user-navigation-involvement
enum class UserNavigationInvolvement {
    BrowserUI,
    Activation,
    None,
};

// https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigation-params
struct NavigationParams : GC::Cell {
    GC_CELL(NavigationParams, GC::Cell);
    GC_DECLARE_ALLOCATOR(NavigationParams);

    // null or a navigation ID
    Optional<String> id;

    // the navigable to be navigated
    GC::Ptr<Navigable> navigable;

    // null or a request that started the navigation
    GC::Ptr<Fetch::Infrastructure::Request> request;

    // a response that ultimately was navigated to (potentially a network error)
    GC::Ptr<Fetch::Infrastructure::Response> response;

    // null or a fetch controller
    GC::Ptr<Fetch::Infrastructure::FetchController> fetch_controller { nullptr };

    // null or an algorithm accepting a Document, once it has been created
    Function<void(DOM::Document&)> commit_early_hints { nullptr };

    // an opener policy enforcement result, used for reporting and potentially for causing a browsing context group switch
    OpenerPolicyEnforcementResult coop_enforcement_result;

    // null or an environment reserved for the new Document
    Fetch::Infrastructure::Request::ReservedClientType reserved_environment;

    // an origin to use for the new Document
    URL::Origin origin;

    // a policy container to use for the new Document
    GC::Ptr<PolicyContainer> policy_container;

    // a sandboxing flag set to impose on the new Document
    SandboxingFlagSet final_sandboxing_flag_set = {};

    // an opener policy to use for the new Document
    OpenerPolicy opener_policy;

    // FIXME: a NavigationTimingType used for creating the navigation timing entry for the new Document

    // a URL or null used to populate the new Document's about base URL
    Optional<URL::URL> about_base_url;

    // a user navigation involvement used when obtaining a browsing context for the new Document
    UserNavigationInvolvement user_involvement;

protected:
    void visit_edges(Visitor& visitor) override;

    NavigationParams(
        Optional<String> id,
        GC::Ptr<Navigable> navigable,
        GC::Ptr<Fetch::Infrastructure::Request> request,
        GC::Ptr<Fetch::Infrastructure::Response> response,
        GC::Ptr<Fetch::Infrastructure::FetchController> fetch_controller,
        Function<void(DOM::Document&)> commit_early_hints,
        OpenerPolicyEnforcementResult coop_enforcement_result,
        Fetch::Infrastructure::Request::ReservedClientType reserved_environment,
        URL::Origin origin,
        GC::Ptr<PolicyContainer> policy_container,
        SandboxingFlagSet final_sandboxing_flag_set,
        OpenerPolicy opener_policy,
        Optional<URL::URL> about_base_url,
        UserNavigationInvolvement user_involvement)
        : id(move(id))
        , navigable(navigable)
        , request(request)
        , response(response)
        , fetch_controller(fetch_controller)
        , commit_early_hints(move(commit_early_hints))
        , coop_enforcement_result(move(coop_enforcement_result))
        , reserved_environment(reserved_environment)
        , origin(move(origin))
        , policy_container(policy_container)
        , final_sandboxing_flag_set(final_sandboxing_flag_set)
        , opener_policy(opener_policy)
        , about_base_url(move(about_base_url))
        , user_involvement(user_involvement)
    {
    }
};

// https://html.spec.whatwg.org/multipage/browsing-the-web.html#non-fetch-scheme-navigation-params
struct NonFetchSchemeNavigationParams : JS::Cell {
    GC_CELL(NonFetchSchemeNavigationParams, JS::Cell);
    GC_DECLARE_ALLOCATOR(NonFetchSchemeNavigationParams);

    // null or a navigation ID
    Optional<String> id;

    // the navigable to be navigated
    GC::Ptr<Navigable> navigable;

    // a URL
    URL::URL url;

    // the target snapshot params's sandboxing flags present during navigation
    SandboxingFlagSet target_snapshot_sandboxing_flags = {};

    // a copy of the source snapshot params's has transient activation boolean present during activation
    bool source_snapshot_has_transient_activation = { false };

    // an origin possibly for use in a user-facing prompt to confirm the invocation of an external software package
    URL::Origin initiator_origin;

    // FIXME: a NavigationTimingType used for creating the navigation timing entry for the new Document

    // a user navigation involvement used when obtaining a browsing context for the new Document (if one is created)
    UserNavigationInvolvement user_involvement;

protected:
    NonFetchSchemeNavigationParams(
        Optional<String> id,
        GC::Ptr<Navigable> navigable,
        URL::URL url,
        SandboxingFlagSet target_snapshot_sandboxing_flags,
        bool source_snapshot_has_transient_activation,
        URL::Origin initiator_origin,
        UserNavigationInvolvement user_involvement)
        : id(move(id))
        , navigable(navigable)
        , url(move(url))
        , target_snapshot_sandboxing_flags(target_snapshot_sandboxing_flags)
        , source_snapshot_has_transient_activation(source_snapshot_has_transient_activation)
        , initiator_origin(move(initiator_origin))
        , user_involvement(user_involvement)
    {
    }

    void visit_edges(Visitor& visitor) override;
};

bool check_a_navigation_responses_adherence_to_x_frame_options(GC::Ptr<Fetch::Infrastructure::Response> response, Navigable* navigable, GC::Ref<ContentSecurityPolicy::PolicyList const> csp_list, URL::Origin destination_origin);

}