script/dom/html/
htmlbaseelement.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use dom_struct::dom_struct;
6use html5ever::{LocalName, Prefix, local_name};
7use js::rust::HandleObject;
8use servo_url::ServoUrl;
9
10use crate::dom::attr::Attr;
11use crate::dom::bindings::cell::DomRefCell;
12use crate::dom::bindings::codegen::Bindings::HTMLBaseElementBinding::HTMLBaseElementMethods;
13use crate::dom::bindings::inheritance::Castable;
14use crate::dom::bindings::root::DomRoot;
15use crate::dom::bindings::str::DOMString;
16use crate::dom::document::Document;
17use crate::dom::element::{AttributeMutation, Element};
18use crate::dom::globalscope::GlobalScope;
19use crate::dom::html::htmlelement::HTMLElement;
20use crate::dom::node::{BindContext, Node, NodeTraits, UnbindContext};
21use crate::dom::security::csp::CspReporting;
22use crate::dom::virtualmethods::VirtualMethods;
23use crate::script_runtime::CanGc;
24
25#[dom_struct]
26pub(crate) struct HTMLBaseElement {
27    htmlelement: HTMLElement,
28
29    /// <https://html.spec.whatwg.org/multipage/#frozen-base-url>
30    #[no_trace]
31    frozen_base_url: DomRefCell<Option<ServoUrl>>,
32}
33
34impl HTMLBaseElement {
35    fn new_inherited(
36        local_name: LocalName,
37        prefix: Option<Prefix>,
38        document: &Document,
39    ) -> HTMLBaseElement {
40        HTMLBaseElement {
41            htmlelement: HTMLElement::new_inherited(local_name, prefix, document),
42            frozen_base_url: Default::default(),
43        }
44    }
45
46    pub(crate) fn new(
47        local_name: LocalName,
48        prefix: Option<Prefix>,
49        document: &Document,
50        proto: Option<HandleObject>,
51        can_gc: CanGc,
52    ) -> DomRoot<HTMLBaseElement> {
53        Node::reflect_node_with_proto(
54            Box::new(HTMLBaseElement::new_inherited(local_name, prefix, document)),
55            document,
56            proto,
57            can_gc,
58        )
59    }
60
61    pub(crate) fn clear_frozen_base_url(&self) {
62        *self.frozen_base_url.borrow_mut() = None;
63    }
64
65    /// <https://html.spec.whatwg.org/multipage/#set-the-frozen-base-url>
66    pub(crate) fn set_frozen_base_url(&self) {
67        // Step 1. Let document be element's node document.
68        let document = self.owner_document();
69        // Step 2. Let urlRecord be the result of parsing the value of element's href content attribute
70        // with document's fallback base URL, and document's character encoding. (Thus, the base element isn't affected by itself.)
71        let attr = self.upcast::<Element>().get_attribute(&local_name!("href"));
72        let Some(href_value) = attr.as_ref().map(|attr| attr.value()) else {
73            unreachable!("Must always have a href set when setting frozen base URL");
74        };
75        let document_fallback_url = document.fallback_base_url();
76        let url_record = document_fallback_url.join(&href_value).ok();
77        // Step 3. If any of the following are true:
78        if
79        // urlRecord is failure;
80        url_record.as_ref().is_none_or(|url_record|
81            // urlRecord's scheme is "data" or "javascript"; or
82            url_record.scheme() == "data" || url_record.scheme() == "javascript"
83            // running Is base allowed for Document? on urlRecord and document returns "Blocked",
84            || !document
85                .get_csp_list()
86                .is_base_allowed_for_document(
87                    document.window().upcast::<GlobalScope>(),
88                    &url_record.clone().into_url(),
89                    &document.origin().immutable().clone().into_url_origin(),
90                ))
91        {
92            // then set element's frozen base URL to document's fallback base URL and return.
93            *self.frozen_base_url.borrow_mut() = Some(document_fallback_url);
94            return;
95        }
96        // Step 4. Set element's frozen base URL to urlRecord.
97        *self.frozen_base_url.borrow_mut() = url_record;
98        // Step 5. Respond to base URL changes given document.
99        // TODO
100    }
101
102    /// <https://html.spec.whatwg.org/multipage/#frozen-base-url>
103    pub(crate) fn frozen_base_url(&self) -> ServoUrl {
104        self.frozen_base_url
105            .borrow()
106            .clone()
107            .expect("Must only retrieve frozen base URL for valid base elements")
108    }
109}
110
111impl HTMLBaseElementMethods<crate::DomTypeHolder> for HTMLBaseElement {
112    /// <https://html.spec.whatwg.org/multipage/#dom-base-href>
113    fn Href(&self) -> DOMString {
114        // Step 1. Let document be element's node document.
115        let document = self.owner_document();
116
117        // Step 2. Let url be the value of the href attribute of this element, if it has one, and the empty string otherwise.
118        let attr = self.upcast::<Element>().get_attribute(&local_name!("href"));
119        let value = attr.as_ref().map(|attr| attr.value());
120        let url = value.as_ref().map_or("", |value| &**value);
121
122        // Step 3. Let urlRecord be the result of parsing url with document's fallback base URL,
123        // and document's character encoding. (Thus, the base element isn't affected by other base elements or itself.)
124        let url_record = document.fallback_base_url().join(url);
125
126        match url_record {
127            Err(_) => {
128                // Step 4. If urlRecord is failure, return url.
129                url.into()
130            },
131            Ok(url_record) => {
132                // Step 5. Return the serialization of urlRecord.
133                url_record.into_string().into()
134            },
135        }
136    }
137
138    // https://html.spec.whatwg.org/multipage/#dom-base-href
139    make_setter!(SetHref, "href");
140}
141
142impl VirtualMethods for HTMLBaseElement {
143    fn super_type(&self) -> Option<&dyn VirtualMethods> {
144        Some(self.upcast::<HTMLElement>() as &dyn VirtualMethods)
145    }
146
147    fn attribute_mutated(&self, attr: &Attr, mutation: AttributeMutation, can_gc: CanGc) {
148        self.super_type()
149            .unwrap()
150            .attribute_mutated(attr, mutation, can_gc);
151
152        // https://html.spec.whatwg.org/multipage/#frozen-base-url
153        if *attr.local_name() == local_name!("href") {
154            // > The base element is the first base element in tree order with an href content attribute in its Document,
155            // > and its href content attribute is changed.
156            if self.frozen_base_url.borrow().is_some() && !mutation.is_removal() {
157                self.set_frozen_base_url();
158            } else {
159                // > The base element becomes the first base element in tree order with an href content attribute in its Document.
160                let document = self.owner_document();
161                document.refresh_base_element();
162            }
163        }
164    }
165
166    fn bind_to_tree(&self, context: &BindContext, can_gc: CanGc) {
167        self.super_type().unwrap().bind_to_tree(context, can_gc);
168        // https://html.spec.whatwg.org/multipage/#frozen-base-url
169        // > The base element becomes the first base element in tree order with an href content attribute in its Document.
170        let document = self.owner_document();
171        document.refresh_base_element();
172    }
173
174    fn unbind_from_tree(&self, context: &UnbindContext, can_gc: CanGc) {
175        self.super_type().unwrap().unbind_from_tree(context, can_gc);
176        // https://html.spec.whatwg.org/multipage/#frozen-base-url
177        // > The base element becomes the first base element in tree order with an href content attribute in its Document.
178        let document = self.owner_document();
179        document.refresh_base_element();
180    }
181}