LibWeb: Start fleshing out Navigable::navigate()

Start implementation of https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate

Co-authored-by: Andreas Kling <kling@serenityos.org>

2 files changed, 185 insertions, 0 deletions

diff --git a/Userland/Libraries/LibWeb/HTML/Navigable.cpp b/Userland/Libraries/LibWeb/HTML/Navigable.cpp
index 215e7d6d25..7fada325e1 100644
--- a/Userland/Libraries/LibWeb/HTML/Navigable.cpp
+++ b/Userland/Libraries/LibWeb/HTML/Navigable.cpp
@@ -1,15 +1,18 @@
 /*
  * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
+ * Copyright (c) 2023, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
 
+#include <LibWeb/Crypto/Crypto.h>
 #include <LibWeb/DOM/Document.h>
 #include <LibWeb/HTML/BrowsingContext.h>
 #include <LibWeb/HTML/DocumentState.h>
 #include <LibWeb/HTML/Navigable.h>
 #include <LibWeb/HTML/SessionHistoryEntry.h>
 #include <LibWeb/HTML/TraversableNavigable.h>
+#include <LibWeb/Platform/EventLoopPlugin.h>
 
 namespace Web::HTML {
 
@@ -130,4 +133,169 @@ JS::GCPtr<TraversableNavigable> Navigable::top_level_traversable()
     return verify_cast<TraversableNavigable>(navigable);
 }
 
+// To navigate a navigable navigable to a URL url using a Document sourceDocument,
+// with an optional POST resource, string, or null documentResource (default null),
+// an optional response-or-null response (default null), an optional boolean exceptionsEnabled (default false),
+// an optional history handling behavior historyHandling (default "push"),
+// an optional string cspNavigationType (default "other"),
+// and an optional referrer policy referrerPolicy (default the empty string):
+
+// https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate
+WebIDL::ExceptionOr<void> Navigable::navigate(
+    AK::URL const& url,
+    JS::NonnullGCPtr<DOM::Document> source_document,
+    Variant<Empty, String, POSTResource> document_resource,
+    JS::GCPtr<Fetch::Infrastructure::Response> response,
+    bool exceptions_enabled,
+    HistoryHandlingBehavior history_handling,
+    String csp_navigation_type,
+    ReferrerPolicy::ReferrerPolicy referrer_policy)
+{
+    // FIXME: 1. Let sourceSnapshotParams be the result of snapshotting source snapshot params given sourceDocument.
+
+    // 2. Let initiatorOriginSnapshot be sourceDocument's origin.
+    auto initiator_origin_snapshot = source_document->origin();
+
+    // FIXME: 3. If sourceDocument's node navigable is not allowed by sandboxing to navigate navigable given and sourceSnapshotParams, then:
+    if constexpr (false) {
+        // 1. If exceptionsEnabled is true, then throw a "SecurityError" DOMException.
+        if (exceptions_enabled) {
+            return WebIDL::SecurityError::create(*vm().current_realm(), "Source document's node navigable is not allowed to navigate"sv);
+        }
+
+        // 2 Return.
+        return {};
+    }
+
+    // 4. Let navigationId be the result of generating a random UUID.
+    String navigation_id = TRY_OR_THROW_OOM(vm(), Crypto::generate_random_uuid());
+
+    // FIXME: 5. If the surrounding agent is equal to navigable's active document's relevant agent, then continue these steps.
+    //           Otherwise, queue a global task on the navigation and traversal task source given navigable's active window to continue these steps.
+
+    // FIXME: 6. If navigable's active document's unload counter is greater than 0,
+    //           then invoke WebDriver BiDi navigation failed with a WebDriver BiDi navigation status whose id is navigationId,
+    //           status is "canceled", and url is url, and return.
+
+    // 7. If any of the following are true:
+    //    - url equals navigable's active document's URL;
+    //    - url's scheme is "javascript"; or
+    //    - navigable's active document's is initial about:blank is true
+    if (url.equals(active_document()->url())
+        || url.scheme() == "javascript"sv
+        || active_document()->is_initial_about_blank()) {
+        // then set historyHandling to "replace".
+        history_handling = HistoryHandlingBehavior::Replace;
+    }
+
+    // 8. If all of the following are true:
+    //    - documentResource is null;
+    //    - response is null;
+    //    - url equals navigable's active session history entry's URL with exclude fragments set to true; and
+    //    - url's fragment is non-null
+    if (document_resource.has<Empty>()
+        && !response
+        && url.equals(active_session_history_entry()->url, AK::URL::ExcludeFragment::Yes)
+        && !url.fragment().is_null()) {
+        // 1. Navigate to a fragment given navigable, url, historyHandling, and navigationId.
+        TRY(navigate_to_a_fragment(url, history_handling, navigation_id));
+
+        // 2. Return.
+        return {};
+    }
+
+    // 9. If navigable's parent is non-null, then set navigable's is delaying load events to true.
+    if (parent() != nullptr) {
+        set_delaying_load_events(true);
+    }
+
+    // 10. Let targetBrowsingContext be navigable's active browsing context.
+    [[maybe_unused]] auto target_browsing_context = active_browsing_context();
+
+    // FIXME: 11. Let targetSnapshotParams be the result of snapshotting target snapshot params given navigable.
+
+    // FIXME: 12. Invoke WebDriver BiDi navigation started with targetBrowsingContext, and a new WebDriver BiDi navigation status whose id is navigationId, url is url, and status is "pending".
+
+    // 13. If navigable's ongoing navigation is "traversal", then:
+    if (ongoing_navigation().has<Traversal>()) {
+        // FIXME: 1. Invoke WebDriver BiDi navigation failed with targetBrowsingContext and a new WebDriver BiDi navigation status whose id is navigationId, status is "canceled", and url is url.
+
+        // 2. Return.
+        return {};
+    }
+
+    // 14. Set navigable's ongoing navigation to navigationId.
+    m_ongoing_navigation = navigation_id;
+
+    // 15. If url's scheme is "javascript", then:
+    if (url.scheme() == "javascript"sv) {
+        // 1. Queue a global task on the navigation and traversal task source given navigable's active window to navigate to a javascript: URL given navigable, url, historyHandling, initiatorOriginSnapshot, and cspNavigationType.
+        queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this, url, history_handling, initiator_origin_snapshot, csp_navigation_type] {
+            (void)navigate_to_a_javascript_url(url, history_handling, initiator_origin_snapshot, csp_navigation_type);
+        });
+
+        // 2. Return.
+        return {};
+    }
+
+    // 16. In parallel, run these steps:
+    Platform::EventLoopPlugin::the().deferred_invoke([this, document_resource, url, navigation_id, referrer_policy, initiator_origin_snapshot, response] {
+        // FIXME: 1. Let unloadPromptCanceled be the result of checking if unloading is user-canceled for navigable's active document's inclusive descendant navigables.
+
+        // FIXME: 2. If unloadPromptCanceled is true, or navigable's ongoing navigation is no longer navigationId, then:
+
+        // 3. Queue a global task on the navigation and traversal task source given navigable's active window to abort navigable's active document.
+        queue_global_task(Task::Source::NavigationAndTraversal, *active_window(), [this] {
+            VERIFY(active_document());
+            active_document()->abort();
+        });
+
+        // 4. Let documentState be a new document state with
+        //    request referrer policy: referrerPolicy
+        //    initiator origin: initiatorOriginSnapshot
+        //    FIXME: resource: documentResource
+        //    navigable target name: navigable's target name
+        JS::NonnullGCPtr<DocumentState> document_state = *heap().allocate_without_realm<DocumentState>();
+        document_state->set_request_referrer_policy(referrer_policy);
+        document_state->set_initiator_origin(initiator_origin_snapshot);
+        document_state->set_navigable_target_name(target_name());
+
+        // 5. If url is about:blank, then set documentState's origin to documentState's initiator origin.
+        if (url == "about:blank"sv) {
+            document_state->set_origin(document_state->initiator_origin());
+        }
+
+        // 6. Otherwise, if url is about:srcdoc, then set documentState's origin to navigable's parent's active document's origin.
+        else if (url == "about:srcdoc"sv) {
+            document_state->set_origin(parent()->active_document()->origin());
+        }
+
+        // 7. Let historyEntry be a new session history entry, with its URL set to url and its document state set to documentState.
+        JS::NonnullGCPtr<SessionHistoryEntry> history_entry = *heap().allocate_without_realm<SessionHistoryEntry>();
+        history_entry->url = url;
+        history_entry->document_state = document_state;
+
+        // FIXME: 8. Let navigationParams be null.
+
+        // FIXME: 9. If response is non-null:
+        if (response) {
+        }
+    });
+
+    return {};
+}
+
+WebIDL::ExceptionOr<void> Navigable::navigate_to_a_fragment(AK::URL const&, HistoryHandlingBehavior, String navigation_id)
+{
+    (void)navigation_id;
+    TODO();
+}
+
+WebIDL::ExceptionOr<void> Navigable::navigate_to_a_javascript_url(AK::URL const&, HistoryHandlingBehavior, Origin const& initiator_origin, String csp_navigation_type)
+{
+    (void)initiator_origin;
+    (void)csp_navigation_type;
+    TODO();
+}
+
 }
diff --git a/Userland/Libraries/LibWeb/HTML/Navigable.h b/Userland/Libraries/LibWeb/HTML/Navigable.h
index 4036e842b3..14570ef331 100644
--- a/Userland/Libraries/LibWeb/HTML/Navigable.h
+++ b/Userland/Libraries/LibWeb/HTML/Navigable.h
@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
+ * Copyright (c) 2023, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
@@ -8,6 +9,8 @@
 
 #include <LibJS/Heap/Cell.h>
 #include <LibWeb/Forward.h>
+#include <LibWeb/HTML/HistoryHandlingBehavior.h>
+#include <LibWeb/HTML/POSTResource.h>
 
 namespace Web::HTML {
 
@@ -51,6 +54,20 @@ public:
 
     Variant<Empty, Traversal, String> ongoing_navigation() const { return m_ongoing_navigation; }
 
+    WebIDL::ExceptionOr<void> navigate(
+        AK::URL const&,
+        JS::NonnullGCPtr<DOM::Document> source_document,
+        Variant<Empty, String, POSTResource> document_resource = Empty {},
+        JS::GCPtr<Fetch::Infrastructure::Response> = nullptr,
+        bool exceptions_enabled = false,
+        HistoryHandlingBehavior = HistoryHandlingBehavior::Push,
+        String csp_navigation_type = String::from_utf8_short_string("other"sv),
+        ReferrerPolicy::ReferrerPolicy = ReferrerPolicy::ReferrerPolicy::EmptyString);
+
+    WebIDL::ExceptionOr<void> navigate_to_a_fragment(AK::URL const&, HistoryHandlingBehavior, String navigation_id);
+
+    WebIDL::ExceptionOr<void> navigate_to_a_javascript_url(AK::URL const&, HistoryHandlingBehavior, Origin const& initiator_origin, String csp_navigation_type);
+
 protected:
     Navigable();