script/dom/html/document_metadata/

htmllinkelement.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use std::borrow::{Borrow, ToOwned};
use std::cell::Cell;
use std::default::Default;
use std::str::FromStr;

use bytes::{Bytes, BytesMut};
use dom_struct::dom_struct;
use html5ever::{LocalName, Prefix, local_name};
use js::context::{JSContext, NoGC};
use js::rust::HandleObject;
use net_traits::image_cache::{
    Image, ImageCache, ImageCacheResponseCallback, ImageCacheResult, ImageLoadListener,
    ImageOrMetadataAvailable, ImageResponse, PendingImageId,
};
use net_traits::request::{Destination, Initiator, ParserMetadata, RequestBuilder, RequestId};
use net_traits::{
    FetchMetadata, FetchResponseMsg, NetworkError, ReferrerPolicy, ResourceFetchTiming,
};
use pixels::PixelFormat;
use script_bindings::cell::DomRefCell;
use script_bindings::root::Dom;
use servo_arc::Arc;
use servo_base::generic_channel::GenericSharedMemory;
use servo_url::ServoUrl;
use style::attr::AttrValue;
use style::media_queries::MediaList as StyleMediaList;
use style::stylesheets::Stylesheet;
use stylo_atoms::Atom;
use webrender_api::units::DeviceIntSize;

use crate::css::stylesheet_loader::{
    ElementStylesheetLoader, StylesheetContextSource, StylesheetOwner,
};
use crate::dom::bindings::codegen::Bindings::DOMTokenListBinding::DOMTokenList_Binding::DOMTokenListMethods;
use crate::dom::bindings::codegen::Bindings::HTMLLinkElementBinding::HTMLLinkElementMethods;
use crate::dom::bindings::inheritance::Castable;
use crate::dom::bindings::refcounted::Trusted;
use crate::dom::bindings::reflector::DomGlobal;
use crate::dom::bindings::root::{DomRoot, MutNullableDom};
use crate::dom::bindings::str::{DOMString, USVString};
use crate::dom::csp::{GlobalCspReporting, Violation};
use crate::dom::css::cssstylesheet::CSSStyleSheet;
use crate::dom::css::stylesheet::StyleSheet as DOMStyleSheet;
use crate::dom::document::Document;
use crate::dom::documentorshadowroot::StylesheetSource;
use crate::dom::domtokenlist::DOMTokenList;
use crate::dom::element::attributes::storage::AttrRef;
use crate::dom::element::{
    AttributeMutation, Element, ElementCreator, cors_setting_for_element,
    cors_settings_attribute_credential_mode, referrer_policy_for_element,
    reflect_cross_origin_attribute, reflect_referrer_policy_attribute, set_cross_origin_attribute,
};
use crate::dom::html::document_metadata::processingoptions::{
    LinkFetchContext, LinkFetchContextType, LinkProcessingOptions,
};
use crate::dom::html::htmlelement::HTMLElement;
use crate::dom::html::links::relations::LinkRelations;
use crate::dom::medialist::MediaList;
use crate::dom::node::virtualmethods::VirtualMethods;
use crate::dom::node::{BindContext, Node, NodeTraits, UnbindContext};
use crate::dom::performance::performanceresourcetiming::InitiatorType;
use crate::dom::srcset::SourceSet;
use crate::dom::types::{EventTarget, GlobalScope};
use crate::fetch::network_listener::{
    FetchResponseListener, ResourceTimingListener, submit_timing,
};
use crate::modules::script_module::{ScriptFetchOptions, fetch_a_modulepreload_module};
use crate::url::ensure_blob_referenced_by_url_is_kept_alive;

#[derive(Clone, Copy, JSTraceable, MallocSizeOf, PartialEq)]
pub(crate) struct RequestGenerationId(u32);

impl RequestGenerationId {
    fn increment(self) -> RequestGenerationId {
        RequestGenerationId(self.0 + 1)
    }
}

#[dom_struct]
pub(crate) struct HTMLLinkElement {
    htmlelement: HTMLElement,
    /// The relations as specified by the "rel" attribute
    rel_list: MutNullableDom<DOMTokenList>,

    /// The link relations as they are used in practice.
    ///
    /// The reason this is separate from [HTMLLinkElement::rel_list] is that
    /// a literal list is a bit unwieldy and that there are corner cases to consider
    /// (Like `rev="made"` implying an author relationship that is not represented in rel_list)
    #[no_trace]
    relations: Cell<LinkRelations>,

    #[conditional_malloc_size_of]
    #[no_trace]
    stylesheet: DomRefCell<Option<Arc<Stylesheet>>>,
    cssom_stylesheet: MutNullableDom<CSSStyleSheet>,

    /// <https://html.spec.whatwg.org/multipage/#a-style-sheet-that-is-blocking-scripts>
    parser_inserted: Cell<bool>,
    /// Whether any of the loads have failed.
    any_failed_load: Cell<bool>,
    /// <https://html.spec.whatwg.org/multipage/#explicitly-enabled>
    is_explicitly_enabled: Cell<bool>,
    /// Whether the previous type matched with the destination
    previous_type_matched: Cell<bool>,
    /// The number of loads that this link element has triggered (could be more
    /// than one because of imports) and have not yet finished.
    pending_loads: Cell<u32>,
    /// A monotonically increasing counter that keeps track of which stylesheet to apply.
    request_generation_id: Cell<RequestGenerationId>,

    /// Whether the previous media environment matched with the media query
    previous_media_environment_matched: Cell<bool>,
    /// Line number this element was created on
    line_number: u64,
    /// <https://html.spec.whatwg.org/multipage/#source-set>
    source_set: DomRefCell<SourceSet>,
    /// <https://html.spec.whatwg.org/multipage/#dom-link-blocking>
    blocking: MutNullableDom<DOMTokenList>,
}

impl HTMLLinkElement {
    fn new_inherited(
        local_name: LocalName,
        prefix: Option<Prefix>,
        document: &Document,
        creator: ElementCreator,
    ) -> HTMLLinkElement {
        HTMLLinkElement {
            htmlelement: HTMLElement::new_inherited(local_name, prefix, document),
            rel_list: Default::default(),
            relations: Cell::new(LinkRelations::empty()),
            parser_inserted: Cell::new(creator.is_parser_created()),
            stylesheet: DomRefCell::new(None),
            cssom_stylesheet: MutNullableDom::new(None),
            pending_loads: Cell::new(0),
            any_failed_load: Cell::new(false),
            request_generation_id: Cell::new(RequestGenerationId(0)),
            is_explicitly_enabled: Cell::new(false),
            previous_type_matched: Cell::new(true),
            previous_media_environment_matched: Cell::new(true),
            line_number: creator.return_line_number(),
            source_set: DomRefCell::new(SourceSet::new()),
            blocking: Default::default(),
        }
    }

    pub(crate) fn new(
        cx: &mut js::context::JSContext,
        local_name: LocalName,
        prefix: Option<Prefix>,
        document: &Document,
        proto: Option<HandleObject>,
        creator: ElementCreator,
    ) -> DomRoot<HTMLLinkElement> {
        Node::reflect_node_with_proto(
            cx,
            Box::new(HTMLLinkElement::new_inherited(
                local_name, prefix, document, creator,
            )),
            document,
            proto,
        )
    }

    pub(crate) fn get_request_generation_id(&self) -> RequestGenerationId {
        self.request_generation_id.get()
    }

    #[cfg_attr(crown, expect(crown::unrooted_must_root))]
    fn remove_stylesheet(&self, no_gc: &NoGC) {
        if let Some(stylesheet) = self.stylesheet.borrow_mut().take() {
            let owner = self.stylesheet_list_owner();
            owner.remove_stylesheet(
                StylesheetSource::Element(Dom::from_ref(self.upcast())),
                &stylesheet,
            );
            self.clean_stylesheet_ownership();
            owner.invalidate_stylesheets(no_gc);
        }
    }

    // FIXME(emilio): These methods are duplicated with
    // HTMLStyleElement::set_stylesheet.
    #[cfg_attr(crown, expect(crown::unrooted_must_root))]
    pub(crate) fn set_stylesheet(&self, no_gc: &NoGC, new_stylesheet: Arc<Stylesheet>) {
        let owner = self.stylesheet_list_owner();
        if let Some(old_stylesheet) = self.stylesheet.borrow_mut().replace(new_stylesheet.clone()) {
            owner.remove_stylesheet(
                StylesheetSource::Element(Dom::from_ref(self.upcast())),
                &old_stylesheet,
            );
        }
        owner.add_owned_stylesheet(no_gc, self.upcast(), new_stylesheet);
    }

    pub(crate) fn get_stylesheet(&self) -> Option<Arc<Stylesheet>> {
        self.stylesheet.borrow().clone()
    }

    pub(crate) fn get_cssom_stylesheet(
        &self,
        cx: &mut JSContext,
    ) -> Option<DomRoot<CSSStyleSheet>> {
        self.get_stylesheet().map(|sheet| {
            self.cssom_stylesheet.or_init(|| {
                CSSStyleSheet::new(
                    cx,
                    &self.owner_window(),
                    Some(self.upcast::<Element>()),
                    DOMString::from_static("text/css"),
                    Some(self.Href().into()),
                    None, // todo handle title
                    sheet,
                    None, // constructor_document
                )
            })
        })
    }

    pub(crate) fn is_alternate(&self) -> bool {
        self.relations.get().contains(LinkRelations::ALTERNATE) &&
            !self
                .upcast::<Element>()
                .get_string_attribute(&local_name!("title"))
                .is_empty()
    }

    pub(crate) fn is_effectively_disabled(&self) -> bool {
        (self.is_alternate() && !self.is_explicitly_enabled.get()) ||
            self.upcast::<Element>()
                .has_attribute(&local_name!("disabled"))
    }

    fn clean_stylesheet_ownership(&self) {
        if let Some(cssom_stylesheet) = self.cssom_stylesheet.get() {
            cssom_stylesheet.set_owner_node(None);
        }
        self.cssom_stylesheet.set(None);
    }
}

impl VirtualMethods for HTMLLinkElement {
    fn super_type(&self) -> Option<&dyn VirtualMethods> {
        Some(self.upcast::<HTMLElement>() as &dyn VirtualMethods)
    }

    fn attribute_mutated(
        &self,
        cx: &mut js::context::JSContext,
        attr: AttrRef<'_>,
        mutation: AttributeMutation,
    ) {
        self.super_type()
            .unwrap()
            .attribute_mutated(cx, attr, mutation);

        let local_name = attr.local_name();
        let is_removal = mutation.is_removal();
        match *local_name {
            local_name!("disabled") => {
                self.handle_disabled_attribute_change(cx.no_gc(), is_removal);
                return;
            },
            local_name!("rel") | local_name!("rev") => {
                let previous_relations = self.relations.get();
                self.relations
                    .set(LinkRelations::for_element(self.upcast()));

                // If relations haven't changed, we shouldn't do anything
                if previous_relations == self.relations.get() {
                    return;
                }
            },
            _ => {},
        }

        let node = self.upcast::<Node>();
        if !node.is_connected() {
            return;
        }

        // For stylesheets, we should only refetch when the actual attribute value
        // has been changed.
        if self.relations.get().contains(LinkRelations::STYLESHEET) &&
            let AttributeMutation::Set(Some(previous_value), _) = mutation &&
            **previous_value == **attr.value()
        {
            return;
        }

        match *local_name {
            local_name!("rel") | local_name!("rev") => {
                // https://html.spec.whatwg.org/multipage/#link-type-stylesheet:fetch-and-process-the-linked-resource
                // > When the external resource link is created on a link element that is already browsing-context connected.
                if self.relations.get().contains(LinkRelations::STYLESHEET) {
                    self.handle_stylesheet_url(cx);
                } else {
                    self.remove_stylesheet(cx.no_gc());
                }

                if self.relations.get().contains(LinkRelations::MODULE_PRELOAD) {
                    self.fetch_and_process_modulepreload(cx);
                }
            },
            local_name!("href") => {
                // https://html.spec.whatwg.org/multipage/#attr-link-href
                // > If both the href and imagesrcset attributes are absent, then the element does not define a link.
                if is_removal {
                    if self.relations.get().contains(LinkRelations::STYLESHEET) {
                        self.remove_stylesheet(cx.no_gc());
                    }
                    return;
                }
                // https://html.spec.whatwg.org/multipage/#link-type-stylesheet:fetch-and-process-the-linked-resource
                // > When the href attribute of the link element of an external resource link
                // > that is already browsing-context connected is changed.
                if self.relations.get().contains(LinkRelations::STYLESHEET) {
                    self.handle_stylesheet_url(cx);
                }

                if self.relations.get().contains(LinkRelations::ICON) {
                    self.handle_favicon_url(&attr.value());
                }

                // https://html.spec.whatwg.org/multipage/#link-type-prefetch
                // When the href attribute of the link element of an external resource link
                // that is already browsing-context connected is changed.
                if self.relations.get().contains(LinkRelations::PREFETCH) {
                    self.fetch_and_process_prefetch_link(&attr.value());
                }

                // https://html.spec.whatwg.org/multipage/#link-type-preload
                // When the href attribute of the link element of an external resource link
                // that is already browsing-context connected is changed.
                if self.relations.get().contains(LinkRelations::PRELOAD) {
                    self.handle_preload_url();
                }

                // https://html.spec.whatwg.org/multipage/#link-type-modulepreload
                if self.relations.get().contains(LinkRelations::MODULE_PRELOAD) {
                    self.fetch_and_process_modulepreload(cx);
                }
            },
            local_name!("imagesrcset") => {
                self.source_set
                    .borrow_mut()
                    .update_source_set(self.upcast::<Element>());
            },
            local_name!("imagesizes") => {
                if self
                    .upcast::<Element>()
                    .has_attribute(&local_name!("imagesrcset"))
                {
                    self.source_set
                        .borrow_mut()
                        .update_source_set(self.upcast::<Element>());
                }
            },
            local_name!("sizes") if self.relations.get().contains(LinkRelations::ICON) => {
                self.handle_favicon_url(&attr.value());
            },
            local_name!("crossorigin") => {
                // https://html.spec.whatwg.org/multipage/#link-type-prefetch
                // When the crossorigin attribute of the link element of an external resource link
                // that is already browsing-context connected is set, changed, or removed.
                if self.relations.get().contains(LinkRelations::PREFETCH) {
                    self.fetch_and_process_prefetch_link(&attr.value());
                }

                // https://html.spec.whatwg.org/multipage/#link-type-stylesheet
                // When the crossorigin attribute of the link element of an external resource link
                // that is already browsing-context connected is set, changed, or removed.
                if self.relations.get().contains(LinkRelations::STYLESHEET) {
                    self.handle_stylesheet_url(cx);
                }
            },
            local_name!("as") => {
                // https://html.spec.whatwg.org/multipage/#link-type-preload
                // When the as attribute of the link element of an external resource link
                // that is already browsing-context connected is changed.
                if self.relations.get().contains(LinkRelations::PRELOAD) &&
                    let AttributeMutation::Set(Some(_), _) = mutation
                {
                    self.handle_preload_url();
                }
            },
            local_name!("type") => {
                // https://html.spec.whatwg.org/multipage/#link-type-stylesheet:fetch-and-process-the-linked-resource
                // When the type attribute of the link element of an external resource link that
                // is already browsing-context connected is set or changed to a value that does
                // not or no longer matches the Content-Type metadata of the previous obtained
                // external resource, if any.
                //
                // TODO: Match Content-Type metadata to check if it needs to be updated
                if self.relations.get().contains(LinkRelations::STYLESHEET) {
                    self.handle_stylesheet_url(cx);
                }

                // https://html.spec.whatwg.org/multipage/#link-type-preload
                // When the type attribute of the link element of an external resource link that
                // is already browsing-context connected, but was previously not obtained due to
                // the type attribute specifying an unsupported type for the request destination,
                // is set, removed, or changed.
                if self.relations.get().contains(LinkRelations::PRELOAD) &&
                    !self.previous_type_matched.get()
                {
                    self.handle_preload_url();
                }
            },
            local_name!("media") => {
                // https://html.spec.whatwg.org/multipage/#link-type-preload
                // When the media attribute of the link element of an external resource link that
                // is already browsing-context connected, but was previously not obtained due to
                // the media attribute not matching the environment, is changed or removed.
                if self.relations.get().contains(LinkRelations::PRELOAD) &&
                    !self.previous_media_environment_matched.get()
                {
                    match mutation {
                        AttributeMutation::Removed | AttributeMutation::Set(Some(_), _) => {
                            self.handle_preload_url()
                        },
                        _ => {},
                    };
                } else if self.relations.get().contains(LinkRelations::STYLESHEET) &&
                    let Some(ref stylesheet) = *self.stylesheet.borrow_mut()
                {
                    let document = self.owner_document();
                    let shared_lock = document.style_shared_author_lock().clone();
                    let mut guard = shared_lock.write();
                    let media = stylesheet.media.write_with(&mut guard);
                    match mutation {
                        AttributeMutation::Set(..) => {
                            *media = MediaList::parse_media_list(&attr.value(), document.window())
                        },
                        AttributeMutation::Removed => *media = StyleMediaList::empty(),
                    };
                    self.owner_document().invalidate_stylesheets(cx.no_gc());
                }

                let matches_media_environment =
                    MediaList::matches_environment(&self.owner_document(), &attr.value());
                self.previous_media_environment_matched
                    .set(matches_media_environment);
            },
            _ => {},
        }
    }

    fn parse_plain_attribute(&self, name: &LocalName, value: DOMString) -> AttrValue {
        match name {
            &local_name!("rel") => AttrValue::from_serialized_tokenlist(value.into()),
            _ => self
                .super_type()
                .unwrap()
                .parse_plain_attribute(name, value),
        }
    }

    fn bind_to_tree(&self, cx: &mut JSContext, context: &BindContext) {
        if let Some(s) = self.super_type() {
            s.bind_to_tree(cx, context);
        }

        let element = self.upcast::<Element>();
        let href = element.get_attribute_string_value(&local_name!("href"));

        if context.tree_connected &&
            (href.as_ref().is_some_and(|x| !x.is_empty()) ||
                element.has_attribute(&local_name!("imagesrcset")))
        {
            let relations = self.relations.get();
            // https://html.spec.whatwg.org/multipage/#link-type-stylesheet:fetch-and-process-the-linked-resource
            // > When the external resource link's link element becomes browsing-context connected.
            if let Some(href) = href {
                if relations.contains(LinkRelations::STYLESHEET) {
                    self.handle_stylesheet_url(cx);
                }

                if relations.contains(LinkRelations::ICON) {
                    self.handle_favicon_url(&href);
                }

                if relations.contains(LinkRelations::PREFETCH) {
                    self.fetch_and_process_prefetch_link(&href);
                }

                // https://html.spec.whatwg.org/multipage/#link-type-modulepreload
                if relations.contains(LinkRelations::MODULE_PRELOAD) {
                    let link = DomRoot::from_ref(self);
                    self.owner_document().add_delayed_task(
                        task!(FetchModulePreload: |cx, link: DomRoot<HTMLLinkElement>| {
                            link.fetch_and_process_modulepreload(cx);
                        }),
                    );
                }
            }

            if relations.contains(LinkRelations::PRELOAD) {
                self.handle_preload_url();
            }
        }
    }

    fn unbind_from_tree(&self, cx: &mut js::context::JSContext, context: &UnbindContext) {
        if let Some(s) = self.super_type() {
            s.unbind_from_tree(cx, context);
        }

        self.remove_stylesheet(cx.no_gc());
    }
}

impl HTMLLinkElement {
    fn compute_destination_for_attribute(&self) -> Option<Destination> {
        // Let destination be the result of translating the keyword
        // representing the state of el's as attribute.
        let element = self.upcast::<Element>();
        element
            .get_attribute_string_value(&local_name!("as"))
            .and_then(|attr| LinkProcessingOptions::translate_a_preload_destination(&attr))
    }

    /// <https://html.spec.whatwg.org/multipage/#create-link-options-from-element>
    fn processing_options(&self) -> LinkProcessingOptions {
        let element = self.upcast::<Element>();

        // Step 1. Let document be el's node document.
        let document = self.upcast::<Node>().owner_doc();
        let global = document.owner_global();

        // Step 2. Let options be a new link processing options
        let mut options = LinkProcessingOptions {
            href: String::new(),
            destination: Destination::None,
            integrity: String::new(),
            link_type: String::new(),
            cryptographic_nonce_metadata: self.upcast::<Element>().nonce_value(),
            cross_origin: cors_setting_for_element(element),
            referrer_policy: referrer_policy_for_element(element),
            policy_container: document.policy_container().to_owned(),
            source_set: Some(self.source_set.borrow().clone()),
            origin: document.borrow().origin().immutable().to_owned(),
            base_url: document.borrow().base_url(),
            request_client: global.request_client(None),
            referrer: global.get_referrer(),
        };

        // Step 3. If el has an href attribute, then set options's href to the value of el's href attribute.
        if let Some(href_attribute) = element.get_attribute_string_value(&local_name!("href")) {
            options.href = href_attribute;
        }

        // Step 4. If el has an integrity attribute, then set options's integrity
        //         to the value of el's integrity content attribute.
        if let Some(integrity_attribute) =
            element.get_attribute_string_value(&local_name!("integrity"))
        {
            options.integrity = integrity_attribute;
        }

        // Step 5. If el has a type attribute, then set options's type to the value of el's type attribute.
        if let Some(type_attribute) = element.get_attribute_string_value(&local_name!("type")) {
            options.link_type = type_attribute;
        }

        // Step 6. Assert: options's href is not the empty string, or options's source set is not null.
        assert!(!options.href.is_empty() || options.source_set.is_some());

        // Step 7. Return options.
        options
    }

    /// <https://html.spec.whatwg.org/multipage/#default-fetch-and-process-the-linked-resource>
    ///
    /// This method does not implement Step 7 (fetching the request) and instead returns the [RequestBuilder],
    /// as the fetch context that should be used depends on the link type.
    fn default_fetch_and_process_the_linked_resource(&self) -> Option<RequestBuilder> {
        // Step 1. Let options be the result of creating link options from el.
        let options = self.processing_options();

        // Step 2. Let request be the result of creating a link request given options.
        let Some(request) = options.create_link_request(self.owner_window().webview_id()) else {
            // Step 3. If request is null, then return.
            return None;
        };
        // Step 4. Set request's synchronous flag.
        let mut request = request.synchronous(true);

        // Step 5. Run the linked resource fetch setup steps, given el and request. If the result is false, then return.
        if !self.linked_resource_fetch_setup(&mut request) {
            return None;
        }

        // TODO Step 6. Set request's initiator type to "css" if el's rel attribute
        // contains the keyword stylesheet; "link" otherwise.

        // Step 7. Fetch request with processResponseConsumeBody set to the following steps given response response and null,
        // failure, or a byte sequence bodyBytes: [..]
        Some(request)
    }

    /// <https://html.spec.whatwg.org/multipage/#linked-resource-fetch-setup-steps>
    fn linked_resource_fetch_setup(&self, request: &mut RequestBuilder) -> bool {
        // https://html.spec.whatwg.org/multipage/#rel-icon:linked-resource-fetch-setup-steps
        if self.relations.get().contains(LinkRelations::ICON) {
            // Step 1. Set request's destination to "image".
            request.destination = Destination::Image;

            // Step 2. Return true.
            //
            // Fall-through
        }

        // https://html.spec.whatwg.org/multipage/#link-type-stylesheet:linked-resource-fetch-setup-steps
        if self.relations.get().contains(LinkRelations::STYLESHEET) {
            // Step 1. If el's disabled attribute is set, then return false.
            if self
                .upcast::<Element>()
                .has_attribute(&local_name!("disabled"))
            {
                return false;
            }
            // Step 2. If el contributes a script-blocking style sheet, append el to its node document's script-blocking style sheet set.
            //
            // Implemented in `ElementStylesheetLoader::load_with_element`.

            // Step 3. If el's media attribute's value matches the environment and el is potentially render-blocking, then block rendering on el.
            //
            // Implemented in `ElementStylesheetLoader::load_with_element`.

            // Step 4. If el is currently render-blocking, then set request's render-blocking to true.
            // TODO

            // Step 5. Return true.
            //
            // Fall-through
        }

        true
    }

    /// The `fetch and process the linked resource` algorithm for [`rel="prefetch"`](https://html.spec.whatwg.org/multipage/#link-type-prefetch)
    fn fetch_and_process_prefetch_link(&self, href: &str) {
        // Step 1. If el's href attribute's value is the empty string, then return.
        if href.is_empty() {
            return;
        }

        // Step 2. Let options be the result of creating link options from el.
        let mut options = self.processing_options();

        // Step 3. Set options's destination to the empty string.
        options.destination = Destination::None;

        // Step 4. Let request be the result of creating a link request given options.
        let Some(request) = options.create_link_request(self.owner_window().webview_id()) else {
            // Step 5. If request is null, then return.
            return;
        };
        let url = request.url.url();

        // Step 6. Set request's initiator to "prefetch".
        let request = request.initiator(Initiator::Prefetch);

        // (Step 7, firing load/error events is handled in the FetchResponseListener impl for LinkFetchContext)

        // Step 8. The user agent should fetch request, with processResponseConsumeBody set to processPrefetchResponse.
        let document = self.upcast::<Node>().owner_doc();
        let fetch_context = LinkFetchContext {
            url,
            link: Some(Trusted::new(self)),
            global: Trusted::new(&document.global()),
            type_: LinkFetchContextType::Prefetch,
            response_body: BytesMut::new(),
        };

        document.fetch_background(request, fetch_context);
    }

    /// <https://html.spec.whatwg.org/multipage/#concept-link-obtain>
    fn handle_stylesheet_url(&self, cx: &mut js::context::JSContext) {
        let document = self.owner_document();
        if document.browsing_context().is_none() {
            return;
        }

        let element = self.upcast::<Element>();

        // https://html.spec.whatwg.org/multipage/#processing-the-type-attribute
        // > If the UA does not support the given MIME type for the given link relationship,
        // > then the UA should not fetch and process the linked resource
        //
        // https://html.spec.whatwg.org/multipage/#link-type-stylesheet
        // > The default type for resources given by the stylesheet keyword is text/css.
        let type_ = element.get_string_attribute(&local_name!("type"));
        if !type_.is_empty() && type_ != "text/css" {
            return;
        }

        // Step 1.
        let href = element.get_string_attribute(&local_name!("href"));
        if href.is_empty() {
            return;
        }

        // Step 2.
        let link_url = match document.base_url().join(&href.str()) {
            Ok(url) => url,
            Err(e) => {
                debug!("Parsing url {} failed: {}", href, e);
                return;
            },
        };

        // Step 3
        let cors_setting = cors_setting_for_element(element);

        let mq_str = element
            .get_attribute_string_value(&local_name!("media"))
            .unwrap_or_default();
        let media = MediaList::parse_media_list(&mq_str, document.window());
        let media = Arc::new(document.style_shared_author_lock().wrap(media));

        let integrity_metadata = element
            .get_attribute_string_value(&local_name!("integrity"))
            .unwrap_or_default();

        self.request_generation_id
            .set(self.request_generation_id.get().increment());
        self.pending_loads.set(0);

        ElementStylesheetLoader::load_with_element(
            cx,
            self.upcast(),
            StylesheetContextSource::LinkElement,
            media,
            link_url,
            cors_setting,
            integrity_metadata,
        );
    }

    /// <https://html.spec.whatwg.org/multipage/#attr-link-disabled>
    fn handle_disabled_attribute_change(&self, no_gc: &NoGC, is_removal: bool) {
        // > Whenever the disabled attribute is removed, set the link element's explicitly enabled attribute to true.
        if is_removal {
            self.is_explicitly_enabled.set(true);
        }
        if let Some(stylesheet) = self.get_stylesheet() &&
            stylesheet.set_disabled(!is_removal)
        {
            self.stylesheet_list_owner().invalidate_stylesheets(no_gc);
        }
    }

    fn handle_favicon_url(&self, href: &str) {
        // If el's href attribute's value is the empty string, then return.
        if href.is_empty() {
            return;
        }

        // The spec does not specify this, but we don't fetch favicons for iframes, as
        // they won't be displayed anyways.
        let window = self.owner_window();
        if !window.is_top_level() {
            return;
        }
        let Ok(href) = self.Href().parse() else {
            return;
        };

        // Ignore all previous fetch operations
        self.request_generation_id
            .set(self.request_generation_id.get().increment());

        let cache_result = window.image_cache().get_cached_image_status(
            href,
            window.origin().immutable().clone(),
            cors_setting_for_element(self.upcast()),
        );

        match cache_result {
            ImageCacheResult::Available(ImageOrMetadataAvailable::ImageAvailable {
                image, ..
            }) => {
                self.process_favicon_response(image);
            },
            ImageCacheResult::Available(ImageOrMetadataAvailable::MetadataAvailable(_, id)) |
            ImageCacheResult::Pending(id) => {
                let sender = self.register_image_cache_callback(id);
                window.image_cache().add_listener(ImageLoadListener::new(
                    sender,
                    window.pipeline_id(),
                    id,
                ));
            },
            ImageCacheResult::ReadyForRequest(id) => {
                let Some(request) = self.default_fetch_and_process_the_linked_resource() else {
                    return;
                };

                let sender = self.register_image_cache_callback(id);
                window.image_cache().add_listener(ImageLoadListener::new(
                    sender,
                    window.pipeline_id(),
                    id,
                ));

                let document = self.upcast::<Node>().owner_doc();
                let fetch_context = FaviconFetchContext {
                    url: self.owner_document().base_url(),
                    image_cache: window.image_cache(),
                    id,
                    link: Trusted::new(self),
                };
                document.fetch_background(request, fetch_context);
            },
            ImageCacheResult::FailedToLoadOrDecode => {},
        };
    }

    fn register_image_cache_callback(&self, id: PendingImageId) -> ImageCacheResponseCallback {
        let trusted_node = Trusted::new(self);
        let window = self.owner_window();
        let request_generation_id = self.get_request_generation_id();
        window.register_image_cache_listener(id, move |response, _| {
            let trusted_node = trusted_node.clone();
            let link_element = trusted_node.root();
            let window = link_element.owner_window();

            let ImageResponse::Loaded(image, _) = response.response else {
                // We don't care about metadata and such for favicons.
                return;
            };

            if request_generation_id != link_element.get_request_generation_id() {
                // This load is no longer relevant.
                return;
            };

            window
                .as_global_scope()
                .task_manager()
                .networking_task_source()
                .queue(task!(process_favicon_response: move || {
                    let element = trusted_node.root();

                    if request_generation_id != element.get_request_generation_id() {
                        // This load is no longer relevant.
                        return;
                    };

                    element.process_favicon_response(image);
                }));
        })
    }

    /// Rasterizes a loaded favicon file if necessary and notifies the embedder about it.
    fn process_favicon_response(&self, image: Image) {
        // TODO: Include the size attribute here
        let window = self.owner_window();
        let document = self.owner_document();

        let send_rasterized_favicon_to_embedder = |raster_image: &pixels::RasterImage| {
            // Let's not worry about animated favicons...
            let frame = raster_image.first_frame();

            let format = match raster_image.format {
                PixelFormat::K8 => embedder_traits::PixelFormat::K8,
                PixelFormat::KA8 => embedder_traits::PixelFormat::KA8,
                PixelFormat::RGB8 => embedder_traits::PixelFormat::RGB8,
                PixelFormat::RGBA8 => embedder_traits::PixelFormat::RGBA8,
                PixelFormat::BGRA8 => embedder_traits::PixelFormat::BGRA8,
            };

            let embedder_image = embedder_traits::Image::new(
                frame.width,
                frame.height,
                std::sync::Arc::new(GenericSharedMemory::from_arc_vec(
                    raster_image.bytes.clone(),
                )),
                raster_image.frames[0].byte_range.clone(),
                format,
            );
            document.set_favicon(embedder_image);
        };

        match image {
            Image::Raster(raster_image) => send_rasterized_favicon_to_embedder(&raster_image),
            Image::Vector(vector_image) => {
                // This size is completely arbitrary.
                let size = DeviceIntSize::new(250, 250);

                let image_cache = window.image_cache();
                if let Some(raster_image) =
                    image_cache.rasterize_vector_image(vector_image.id, size, None)
                {
                    send_rasterized_favicon_to_embedder(&raster_image);
                } else {
                    // The rasterization callback will end up calling "process_favicon_response" again,
                    // but this time with a raster image.
                    let image_cache_sender = self.register_image_cache_callback(vector_image.id);
                    image_cache.add_rasterization_complete_listener(
                        window.pipeline_id(),
                        vector_image.id,
                        size,
                        image_cache_sender,
                    );
                }
            },
        }
    }

    /// <https://html.spec.whatwg.org/multipage/#link-type-preload:fetch-and-process-the-linked-resource-2>
    /// and type matching destination steps of <https://html.spec.whatwg.org/multipage/#preload>
    fn handle_preload_url(&self) {
        // Step 1. Update the source set for el.
        self.source_set
            .borrow_mut()
            .update_source_set(self.upcast::<Element>());
        // Step 2. Let options be the result of creating link options from el.
        let mut options = self.processing_options();
        // Step 3. Let destination be the result of translating the keyword
        // representing the state of el's as attribute.
        let Some(destination) = self.compute_destination_for_attribute() else {
            // Step 4. If destination is null, then return.
            return;
        };
        // Step 5. Set options's destination to destination.
        options.destination = destination;
        // Steps for https://html.spec.whatwg.org/multipage/#preload
        {
            // Step 1. If options's type doesn't match options's destination, then return.
            let type_matches_destination = options.type_matches_destination();
            self.previous_type_matched.set(type_matches_destination);
            if !type_matches_destination {
                return;
            }
        }
        // Step 6. Preload options, with the following steps given a response response:
        let document = self.upcast::<Node>().owner_doc();
        options.preload(
            self.owner_window().webview_id(),
            Some(Trusted::new(self)),
            &document,
        );
    }

    /// <https://html.spec.whatwg.org/multipage/#link-type-preload:fetch-and-process-the-linked-resource-2>
    pub(crate) fn fire_event_after_response(
        &self,
        cx: &mut JSContext,
        response: Result<(), NetworkError>,
    ) {
        // Step 3.1 If response is a network error, fire an event named error at el.
        // Otherwise, fire an event named load at el.
        if response.is_err() {
            self.upcast::<EventTarget>().fire_event(cx, atom!("error"));
        } else {
            self.upcast::<EventTarget>().fire_event(cx, atom!("load"));
        }
    }

    /// <https://html.spec.whatwg.org/multipage/#link-type-modulepreload:fetch-and-process-the-linked-resource-2>
    fn fetch_and_process_modulepreload(&self, cx: &mut JSContext) {
        let el = self.upcast::<Element>();
        let href_attribute_value = el.get_string_attribute(&local_name!("href"));

        // Step 1. If el's href attribute's value is the empty string, then return.
        if href_attribute_value.is_empty() {
            return;
        }

        // Step 2. Let destination be the current state of el's as attribute (a destination), or "script" if it is in no state.
        let destination = el
            .get_attribute_string_value(&local_name!("as"))
            .map(|value| value.to_ascii_lowercase())
            .and_then(|value| match value.as_str() {
                // `Destination::from_str` will map an empty string to `Destination::None`
                "" => None,
                // "fetch" is a valid preload destination, but not for modules
                "fetch" => Some(Destination::None),
                _ => Destination::from_str(&value).ok(),
            })
            .unwrap_or(Destination::Script);

        let document = self.owner_document();
        let global = document.global();

        // A module preload destination is "json", "style", "text" or a script-like destination.
        let is_a_modulepreload_destination = match destination {
            Destination::Json | Destination::Style | Destination::Text => true,
            // https://fetch.spec.whatwg.org/#ref-for-request-destination-script-like
            // While "xslt" can cause script execution, it is not relevant here.
            Destination::Xslt => false,
            d => d.is_script_like(),
        };

        // Step 3. If destination is not a module preload destination, then queue an element task on the
        // networking task source given el to fire an event named error at el, and return.
        if !is_a_modulepreload_destination {
            return global
                .task_manager()
                .networking_task_source()
                .queue_simple_event(self.upcast(), atom!("error"));
        }

        // Step 4. Let url be the result of encoding-parsing a URL given el's href attribute's value, relative to el's node document.
        // Step 5. If url is failure, then return.
        let Ok(url) = document.encoding_parse_a_url(&href_attribute_value.str()) else {
            return;
        };
        let url = ensure_blob_referenced_by_url_is_kept_alive(&global, url);

        // Step 6. Let settings object be el's node document's relevant settings object.

        // Step 7. Let credentials mode be the CORS settings attribute credentials mode for el's crossorigin attribute.
        let credentials_mode = cors_settings_attribute_credential_mode(el);

        // Step 8. Let cryptographic nonce be el.[[CryptographicNonce]].
        let cryptographic_nonce = el.nonce_value();

        // Step 9. Let integrity metadata be the value of el's integrity attribute, if it is specified, or the empty string otherwise.
        // Step 10. If el does not have an integrity attribute, then set integrity metadata to
        // the result of resolving a module integrity metadata with url and settings object.
        let integrity_metadata = el
            .get_attribute_string_value(&local_name!("integrity"))
            .unwrap_or_else(|| {
                global
                    .import_map()
                    .resolve_a_module_integrity_metadata(&url.url())
            });

        // Step 11. Let referrer policy be the current state of el's referrerpolicy attribute.
        let referrer_policy = referrer_policy_for_element(el);

        // TODO Step 12. Let fetch priority be the current state of el's fetchpriority attribute.

        // Step 13. Let options be a script fetch options whose cryptographic nonce is cryptographic nonce,
        // integrity metadata is integrity metadata, parser metadata is "not-parser-inserted",
        // credentials mode is credentials mode, referrer policy is referrer policy, and fetch priority is fetch priority.
        let options = ScriptFetchOptions {
            cryptographic_nonce,
            integrity_metadata,
            parser_metadata: ParserMetadata::NotParserInserted,
            credentials_mode,
            referrer_policy,
            render_blocking: false,
        };

        let link = DomRoot::from_ref(self);

        // Step 14. Fetch a modulepreload module script graph given url, destination, settings object, options,
        // and with the following steps given result:
        fetch_a_modulepreload_module(
            cx,
            url,
            destination,
            &global,
            options,
            move |cx, fetch_failed| {
                // Step 1. If result is null, then fire an event named error at el, and return.
                // Step 2. Fire an event named load at el.
                let event = match fetch_failed {
                    true => atom!("error"),
                    false => atom!("load"),
                };

                link.upcast::<EventTarget>().fire_event(cx, event);
            },
        );
    }
}

impl StylesheetOwner for HTMLLinkElement {
    fn increment_pending_loads_count(&self) {
        self.pending_loads.set(self.pending_loads.get() + 1)
    }

    fn load_finished(&self, succeeded: bool) -> Option<bool> {
        assert!(self.pending_loads.get() > 0, "What finished?");
        if !succeeded {
            self.any_failed_load.set(true);
        }

        self.pending_loads.set(self.pending_loads.get() - 1);
        if self.pending_loads.get() != 0 {
            return None;
        }

        let any_failed = self.any_failed_load.get();
        self.any_failed_load.set(false);
        Some(any_failed)
    }

    fn parser_inserted(&self) -> bool {
        self.parser_inserted.get()
    }

    /// <https://html.spec.whatwg.org/multipage/#potentially-render-blocking>
    fn potentially_render_blocking(&self) -> bool {
        // An element is potentially render-blocking if its blocking tokens set contains "render",
        // or if it is implicitly potentially render-blocking, which will be defined at the individual elements.
        // By default, an element is not implicitly potentially render-blocking.
        //
        // https://html.spec.whatwg.org/multipage/#link-type-stylesheet:implicitly-potentially-render-blocking
        // > A link element of this type is implicitly potentially render-blocking if the element was created by its node document's parser.
        self.parser_inserted() ||
            self.blocking
                .get()
                .is_some_and(|list| list.Contains(DOMString::from_static("render")))
    }

    fn referrer_policy(&self, cx: &mut js::context::JSContext) -> ReferrerPolicy {
        if self
            .RelList(cx)
            .Contains(DOMString::from_static("noreferrer"))
        {
            return ReferrerPolicy::NoReferrer;
        }

        ReferrerPolicy::EmptyString
    }

    fn set_origin_clean(&self, cx: &mut js::context::JSContext, origin_clean: bool) {
        if let Some(stylesheet) = self.get_cssom_stylesheet(cx) {
            stylesheet.set_origin_clean(origin_clean);
        }
    }
}

impl HTMLLinkElementMethods<crate::DomTypeHolder> for HTMLLinkElement {
    // https://html.spec.whatwg.org/multipage/#dom-link-href
    make_url_getter!(Href, "href");

    // https://html.spec.whatwg.org/multipage/#dom-link-href
    make_url_setter!(SetHref, "href");

    // https://html.spec.whatwg.org/multipage/#dom-link-rel
    make_getter!(Rel, "rel");

    /// <https://html.spec.whatwg.org/multipage/#dom-link-rel>
    fn SetRel(&self, cx: &mut JSContext, rel: DOMString) {
        self.upcast::<Element>()
            .set_tokenlist_attribute(cx, &local_name!("rel"), rel);
    }

    // https://html.spec.whatwg.org/multipage/#dom-link-as
    make_enumerated_getter!(
        As,
        "as",
        "fetch" | "audio" | "audioworklet" | "document" | "embed" | "font" | "frame"
            | "iframe" | "image" | "json" | "manifest" | "object" | "paintworklet"
            | "report" | "script" | "serviceworker" | "sharedworker" | "style" | "track"
            | "video" | "webidentity" | "worker" | "xslt",
        missing => "",
        invalid => ""
    );

    // https://html.spec.whatwg.org/multipage/#dom-link-as
    make_setter!(SetAs, "as");

    // https://html.spec.whatwg.org/multipage/#dom-link-media
    make_getter!(Media, "media");

    // https://html.spec.whatwg.org/multipage/#dom-link-media
    make_setter!(SetMedia, "media");

    // https://html.spec.whatwg.org/multipage/#dom-link-integrity
    make_getter!(Integrity, "integrity");

    // https://html.spec.whatwg.org/multipage/#dom-link-integrity
    make_setter!(SetIntegrity, "integrity");

    // https://html.spec.whatwg.org/multipage/#dom-link-hreflang
    make_getter!(Hreflang, "hreflang");

    // https://html.spec.whatwg.org/multipage/#dom-link-hreflang
    make_setter!(SetHreflang, "hreflang");

    // https://html.spec.whatwg.org/multipage/#dom-link-type
    make_getter!(Type, "type");

    // https://html.spec.whatwg.org/multipage/#dom-link-type
    make_setter!(SetType, "type");

    // https://html.spec.whatwg.org/multipage/#dom-link-imagesrcset
    make_url_getter!(ImageSrcset, "imagesrcset");

    // https://html.spec.whatwg.org/multipage/#dom-link-imagesrcset
    make_url_setter!(SetImageSrcset, "imagesrcset");

    // https://html.spec.whatwg.org/multipage/#dom-link-imagesizes
    make_getter!(ImageSizes, "imagesizes");

    // https://html.spec.whatwg.org/multipage/#dom-link-imagesizes
    make_setter!(SetImageSizes, "imagesizes");

    // https://html.spec.whatwg.org/multipage/#dom-link-disabled
    make_bool_getter!(Disabled, "disabled");

    // https://html.spec.whatwg.org/multipage/#dom-link-disabled
    make_bool_setter!(SetDisabled, "disabled");

    /// <https://html.spec.whatwg.org/multipage/#dom-link-rellist>
    fn RelList(&self, cx: &mut js::context::JSContext) -> DomRoot<DOMTokenList> {
        self.rel_list.or_init(|| {
            DOMTokenList::new(
                cx,
                self.upcast(),
                &local_name!("rel"),
                Some(vec![
                    Atom::from("alternate"),
                    Atom::from("apple-touch-icon"),
                    Atom::from("apple-touch-icon-precomposed"),
                    Atom::from("canonical"),
                    Atom::from("dns-prefetch"),
                    Atom::from("icon"),
                    Atom::from("import"),
                    Atom::from("manifest"),
                    Atom::from("modulepreload"),
                    Atom::from("next"),
                    Atom::from("preconnect"),
                    Atom::from("prefetch"),
                    Atom::from("preload"),
                    Atom::from("prerender"),
                    Atom::from("stylesheet"),
                ]),
            )
        })
    }

    // https://html.spec.whatwg.org/multipage/#dom-link-charset
    make_getter!(Charset, "charset");

    // https://html.spec.whatwg.org/multipage/#dom-link-charset
    make_setter!(SetCharset, "charset");

    // https://html.spec.whatwg.org/multipage/#dom-link-rev
    make_getter!(Rev, "rev");

    // https://html.spec.whatwg.org/multipage/#dom-link-rev
    make_setter!(SetRev, "rev");

    // https://html.spec.whatwg.org/multipage/#dom-link-target
    make_getter!(Target, "target");

    // https://html.spec.whatwg.org/multipage/#dom-link-target
    make_setter!(SetTarget, "target");

    /// <https://html.spec.whatwg.org/multipage/#attr-link-blocking>
    fn Blocking(&self, cx: &mut js::context::JSContext) -> DomRoot<DOMTokenList> {
        self.blocking.or_init(|| {
            DOMTokenList::new(
                cx,
                self.upcast(),
                &local_name!("blocking"),
                Some(vec![Atom::from("render")]),
            )
        })
    }

    /// <https://html.spec.whatwg.org/multipage/#dom-link-crossorigin>
    fn GetCrossOrigin(&self) -> Option<DOMString> {
        reflect_cross_origin_attribute(self.upcast::<Element>())
    }

    /// <https://html.spec.whatwg.org/multipage/#dom-link-crossorigin>
    fn SetCrossOrigin(&self, cx: &mut JSContext, value: Option<DOMString>) {
        set_cross_origin_attribute(cx, self.upcast::<Element>(), value);
    }

    /// <https://html.spec.whatwg.org/multipage/#dom-link-referrerpolicy>
    fn ReferrerPolicy(&self) -> DOMString {
        reflect_referrer_policy_attribute(self.upcast::<Element>())
    }

    // https://html.spec.whatwg.org/multipage/#dom-link-referrerpolicy
    make_setter!(SetReferrerPolicy, "referrerpolicy");

    /// <https://drafts.csswg.org/cssom/#dom-linkstyle-sheet>
    fn GetSheet(&self, cx: &mut JSContext) -> Option<DomRoot<DOMStyleSheet>> {
        self.get_cssom_stylesheet(cx).map(DomRoot::upcast)
    }
}

struct FaviconFetchContext {
    /// The `<link>` element that caused this fetch operation
    link: Trusted<HTMLLinkElement>,
    image_cache: std::sync::Arc<dyn ImageCache>,
    id: PendingImageId,

    /// The base url of the document that the `<link>` element belongs to.
    url: ServoUrl,
}

impl FetchResponseListener for FaviconFetchContext {
    fn process_request_body(&mut self, _: RequestId) {}

    fn process_response(
        &mut self,
        _: &mut js::context::JSContext,
        request_id: RequestId,
        metadata: Result<FetchMetadata, NetworkError>,
    ) {
        self.image_cache.notify_pending_response(
            self.id,
            FetchResponseMsg::ProcessResponse(request_id, metadata),
        );
    }

    fn process_response_chunk(
        &mut self,
        _: &mut js::context::JSContext,
        request_id: RequestId,
        chunk: Bytes,
    ) {
        self.image_cache.notify_pending_response(
            self.id,
            FetchResponseMsg::ProcessResponseChunk(request_id, chunk),
        );
    }

    fn process_response_eof(
        self,
        cx: &mut js::context::JSContext,
        request_id: RequestId,
        response: Result<(), NetworkError>,
        timing: ResourceFetchTiming,
    ) {
        self.image_cache.notify_pending_response(
            self.id,
            FetchResponseMsg::ProcessResponseEOF(request_id, response.clone(), timing.clone()),
        );
        submit_timing(cx, &self, &response, &timing);
    }

    fn process_csp_violations(
        &mut self,
        cx: &mut js::context::JSContext,
        _request_id: RequestId,
        violations: Vec<Violation>,
    ) {
        let global = &self.resource_timing_global();
        global.report_csp_violations(cx, violations, None, None);
    }

    fn process_content_length(&mut self, request_id: RequestId, size: usize) {
        self.image_cache.notify_pending_response(
            self.id,
            FetchResponseMsg::ProcessContentLength(request_id, size),
        )
    }
}

impl ResourceTimingListener for FaviconFetchContext {
    fn resource_timing_information(&self) -> (InitiatorType, ServoUrl) {
        (
            InitiatorType::LocalName("link".to_string()),
            self.url.clone(),
        )
    }

    fn resource_timing_global(&self) -> DomRoot<GlobalScope> {
        self.link.root().upcast::<Node>().owner_doc().global()
    }
}