Skip to main content

script/dom/html/document_metadata/
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::context::JSContext;
8use js::rust::HandleObject;
9use script_bindings::cell::DomRefCell;
10use servo_url::ServoUrl;
11
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::attributes::storage::AttrRef;
18use crate::dom::element::{AttributeMutation, Element};
19use crate::dom::globalscope::GlobalScope;
20use crate::dom::html::htmlelement::HTMLElement;
21use crate::dom::node::virtualmethods::VirtualMethods;
22use crate::dom::node::{BindContext, Node, NodeTraits, UnbindContext};
23use crate::dom::security::csp::CspReporting;
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        cx: &mut js::context::JSContext,
48        local_name: LocalName,
49        prefix: Option<Prefix>,
50        document: &Document,
51        proto: Option<HandleObject>,
52    ) -> DomRoot<HTMLBaseElement> {
53        Node::reflect_node_with_proto(
54            cx,
55            Box::new(HTMLBaseElement::new_inherited(local_name, prefix, document)),
56            document,
57            proto,
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, cx: &mut JSContext) {
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 href_value = self
72            .upcast::<Element>()
73            .get_attribute_string_ref(&local_name!("href"))
74            .expect("Must always have a href set when setting frozen base URL");
75        let href_value = href_value.as_attr_ref().value();
76        let document_fallback_url = document.fallback_base_url();
77        let url_record = document_fallback_url.join(&href_value).ok();
78        // Step 3. If any of the following are true:
79        if
80        // urlRecord is failure;
81        url_record.as_ref().is_none_or(|url_record|
82            // urlRecord's scheme is "data" or "javascript"; or
83            url_record.scheme() == "data" || url_record.scheme() == "javascript"
84            // running Is base allowed for Document? on urlRecord and document returns "Blocked",
85            || !document
86                .get_csp_list()
87                .is_base_allowed_for_document(
88                    cx,
89                    document.window().upcast::<GlobalScope>(),
90                    &url_record.clone().into_url(),
91                    &document.origin().immutable().clone().into_url_origin(),
92                ))
93        {
94            // then set element's frozen base URL to document's fallback base URL and return.
95            *self.frozen_base_url.borrow_mut() = Some(document_fallback_url);
96            return;
97        }
98        // Step 4. Set element's frozen base URL to urlRecord.
99        *self.frozen_base_url.borrow_mut() = url_record;
100        // Step 5. Respond to base URL changes given document.
101        // TODO
102    }
103
104    /// <https://html.spec.whatwg.org/multipage/#frozen-base-url>
105    pub(crate) fn frozen_base_url(&self) -> ServoUrl {
106        self.frozen_base_url
107            .borrow()
108            .clone()
109            .expect("Must only retrieve frozen base URL for valid base elements")
110    }
111}
112
113impl HTMLBaseElementMethods<crate::DomTypeHolder> for HTMLBaseElement {
114    /// <https://html.spec.whatwg.org/multipage/#dom-base-href>
115    fn Href(&self) -> DOMString {
116        // Step 1. Let document be element's node document.
117        let document = self.owner_document();
118
119        // Step 2. Let url be the value of the href attribute of this element, if it has one, and the empty string otherwise.
120        let url = self
121            .upcast::<Element>()
122            .get_attribute_string_value(&local_name!("href"))
123            .unwrap_or_default();
124
125        // Step 3. Let urlRecord be the result of parsing url with document's fallback base URL,
126        // and document's character encoding. (Thus, the base element isn't affected by other base elements or itself.)
127        let url_record = document.fallback_base_url().join(&url);
128
129        match url_record {
130            Err(_) => {
131                // Step 4. If urlRecord is failure, return url.
132                url.into()
133            },
134            Ok(url_record) => {
135                // Step 5. Return the serialization of urlRecord.
136                url_record.into_string().into()
137            },
138        }
139    }
140
141    // https://html.spec.whatwg.org/multipage/#dom-base-href
142    make_setter!(SetHref, "href");
143}
144
145impl VirtualMethods for HTMLBaseElement {
146    fn super_type(&self) -> Option<&dyn VirtualMethods> {
147        Some(self.upcast::<HTMLElement>() as &dyn VirtualMethods)
148    }
149
150    fn attribute_mutated(
151        &self,
152        cx: &mut js::context::JSContext,
153        attr: AttrRef<'_>,
154        mutation: AttributeMutation,
155    ) {
156        self.super_type()
157            .unwrap()
158            .attribute_mutated(cx, attr, mutation);
159
160        // https://html.spec.whatwg.org/multipage/#frozen-base-url
161        if *attr.local_name() == local_name!("href") {
162            // > The base element is the first base element in tree order with an href content attribute in its Document,
163            // > and its href content attribute is changed.
164            if self.frozen_base_url.borrow().is_some() && !mutation.is_removal() {
165                self.set_frozen_base_url(cx);
166            } else {
167                // > The base element becomes the first base element in tree order with an href content attribute in its Document.
168                let document = self.owner_document();
169                document.refresh_base_element(cx);
170            }
171        }
172    }
173
174    fn bind_to_tree(&self, cx: &mut JSContext, context: &BindContext) {
175        self.super_type().unwrap().bind_to_tree(cx, context);
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(cx);
180    }
181
182    fn unbind_from_tree(&self, cx: &mut JSContext, context: &UnbindContext) {
183        self.super_type().unwrap().unbind_from_tree(cx, context);
184        // https://html.spec.whatwg.org/multipage/#frozen-base-url
185        // > The base element becomes the first base element in tree order with an href content attribute in its Document.
186        let document = self.owner_document();
187        document.refresh_base_element(cx);
188    }
189}