script/dom/url/
url.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 std::default::Default;
6
7use dom_struct::dom_struct;
8use js::rust::HandleObject;
9use net_traits::CoreResourceMsg;
10use net_traits::blob_url_store::parse_blob_url;
11use net_traits::filemanager_thread::FileManagerThreadMsg;
12use profile_traits::generic_channel;
13use script_bindings::cell::DomRefCell;
14use script_bindings::cformat;
15use script_bindings::reflector::{Reflector, reflect_dom_object_with_proto};
16use servo_base::generic_channel::GenericSend;
17use servo_url::{ImmutableOrigin, ServoUrl};
18use url::Url;
19use uuid::Uuid;
20
21use crate::dom::bindings::codegen::Bindings::URLBinding::URLMethods;
22use crate::dom::bindings::error::{Error, ErrorResult, Fallible};
23use crate::dom::bindings::reflector::DomGlobal;
24use crate::dom::bindings::root::{DomRoot, MutNullableDom};
25use crate::dom::bindings::str::{DOMString, USVString};
26use crate::dom::blob::Blob;
27use crate::dom::globalscope::GlobalScope;
28use crate::dom::url::urlhelper::UrlHelper;
29use crate::dom::url::urlsearchparams::URLSearchParams;
30use crate::script_runtime::CanGc;
31
32/// <https://url.spec.whatwg.org/#url>
33#[dom_struct]
34#[expect(clippy::upper_case_acronyms)]
35pub(crate) struct URL {
36    reflector_: Reflector,
37
38    /// <https://url.spec.whatwg.org/#concept-url-url>
39    #[no_trace]
40    url: DomRefCell<ServoUrl>,
41
42    /// <https://url.spec.whatwg.org/#dom-url-searchparams>
43    search_params: MutNullableDom<URLSearchParams>,
44}
45
46impl URL {
47    fn new_inherited(url: ServoUrl) -> URL {
48        URL {
49            reflector_: Reflector::new(),
50            url: DomRefCell::new(url),
51            search_params: Default::default(),
52        }
53    }
54
55    fn new(
56        global: &GlobalScope,
57        proto: Option<HandleObject>,
58        url: ServoUrl,
59        can_gc: CanGc,
60    ) -> DomRoot<URL> {
61        reflect_dom_object_with_proto(Box::new(URL::new_inherited(url)), global, proto, can_gc)
62    }
63
64    pub(crate) fn query_pairs(&self) -> Vec<(String, String)> {
65        self.url
66            .borrow()
67            .as_url()
68            .query_pairs()
69            .into_owned()
70            .collect()
71    }
72
73    pub(crate) fn origin(&self) -> ImmutableOrigin {
74        self.url.borrow().origin()
75    }
76
77    pub(crate) fn set_query_pairs(&self, pairs: &[(String, String)]) {
78        let mut url = self.url.borrow_mut();
79
80        if pairs.is_empty() {
81            url.as_mut_url().set_query(None);
82        } else {
83            url.as_mut_url()
84                .query_pairs_mut()
85                .clear()
86                .extend_pairs(pairs);
87        }
88    }
89
90    /// <https://w3c.github.io/FileAPI/#unicodeBlobURL>
91    fn unicode_serialization_blob_url(origin: &ImmutableOrigin, id: &Uuid) -> String {
92        // Step 1. Let result be the empty string.
93        // Step 2. Append the string "blob:" to result.
94        let mut result = "blob:".to_string();
95
96        // Step 3. Let settings be the current settings object.
97        // Step 4. Let origin be settings’s origin.
98        // Step 5. Let serialized be the ASCII serialization of origin.
99        // Step 6. If serialized is "null", set it to an implementation-defined value.
100        // Step 7. Append serialized to result.
101        // N.B. We leave it as "null" right now.
102        result.push_str(&origin.ascii_serialization());
103
104        // Step 8. Append U+0024 SOLIDUS (/) to result.
105        result.push('/');
106
107        // Step 9. Generate a UUID [RFC4122] as a string and append it to result.
108        result.push_str(&id.to_string());
109
110        // Step 10. Return result.
111        result
112    }
113}
114
115impl URLMethods<crate::DomTypeHolder> for URL {
116    /// <https://url.spec.whatwg.org/#constructors>
117    fn Constructor(
118        global: &GlobalScope,
119        proto: Option<HandleObject>,
120        can_gc: CanGc,
121        url: USVString,
122        base: Option<USVString>,
123    ) -> Fallible<DomRoot<URL>> {
124        // Step 1. Parse url with base.
125        let parsed_base = match base {
126            None => None,
127            Some(base) => {
128                match ServoUrl::parse(&base.0) {
129                    Ok(base) => Some(base),
130                    Err(error) => {
131                        // Step 2. Throw a TypeError if URL parsing fails.
132                        return Err(Error::Type(cformat!("could not parse base: {}", error)));
133                    },
134                }
135            },
136        };
137        let parsed_url = match ServoUrl::parse_with_base(parsed_base.as_ref(), &url.0) {
138            Ok(url) => url,
139            Err(error) => {
140                // Step 2. Throw a TypeError if URL parsing fails.
141                return Err(Error::Type(cformat!("could not parse URL: {}", error)));
142            },
143        };
144
145        // Skip the steps below.
146        // Instead of constructing a new `URLSearchParams` object here, construct it
147        // on-demand inside `URL::SearchParams`.
148        //
149        // Step 3. Let query be parsedURL’s query.
150        // Step 5. Set this’s query object to a new URLSearchParams object.
151        // Step 6. Initialize this’s query object with query.
152        // Step 7. Set this’s query object’s URL object to this.
153
154        // Step 4. Set this’s URL to parsedURL.
155        Ok(URL::new(global, proto, parsed_url, can_gc))
156    }
157
158    /// <https://url.spec.whatwg.org/#dom-url-canparse>
159    fn CanParse(_global: &GlobalScope, url: USVString, base: Option<USVString>) -> bool {
160        // Step 1. Let parsedURL be the result of running the API URL parser on url with base, if given.
161        let parsed_url = run_api_url_parser(url, base);
162
163        // Step 2. If parsedURL is failure, then return false.
164        // Step 3. Return true.
165        parsed_url.is_ok()
166    }
167
168    /// <https://url.spec.whatwg.org/#dom-url-parse>
169    fn Parse(
170        global: &GlobalScope,
171        url: USVString,
172        base: Option<USVString>,
173        can_gc: CanGc,
174    ) -> Option<DomRoot<URL>> {
175        // Step 1: Let parsedURL be the result of running the API URL parser on url with base,
176        // if given.
177        // Step 2: If parsedURL is failure, then return null.
178        let parsed_url = run_api_url_parser(url, base).ok()?;
179
180        // Step 3: Let url be a new URL object.
181        // Step 4: Initialize url with parsedURL.
182        // Step 5: Return url.
183        // Regarding initialization, the same condition should apply here as stated in the comments
184        // in Self::Constructor above - construct it on-demand inside `URL::SearchParams`.
185        Some(URL::new(
186            global,
187            None,
188            ServoUrl::from_url(parsed_url),
189            can_gc,
190        ))
191    }
192
193    /// <https://w3c.github.io/FileAPI/#dfn-createObjectURL>
194    fn CreateObjectURL(global: &GlobalScope, blob: &Blob) -> DOMString {
195        // XXX: Second field is an unicode-serialized Origin, it is a temporary workaround
196        //      and should not be trusted. See issue https://github.com/servo/servo/issues/11722
197        let origin = global.origin().immutable();
198
199        let id = blob.get_blob_url_id();
200
201        DOMString::from(URL::unicode_serialization_blob_url(origin, &id))
202    }
203
204    /// <https://w3c.github.io/FileAPI/#dfn-revokeObjectURL>
205    fn RevokeObjectURL(global: &GlobalScope, url: DOMString) {
206        // If the value provided for the url argument is not a Blob URL OR
207        // if the value provided for the url argument does not have an entry in the Blob URL Store,
208        // this method call does nothing. User agents may display a message on the error console.
209        let origin = global.origin().immutable();
210
211        if let Ok(url) = ServoUrl::parse(&url.str()) &&
212            url.fragment().is_none() &&
213            *origin == url.origin() &&
214            let Ok((id, _)) = parse_blob_url(&url)
215        {
216            let resource_threads = global.resource_threads();
217            let (tx, rx) = generic_channel::channel(global.time_profiler_chan().clone()).unwrap();
218            let msg = FileManagerThreadMsg::RevokeBlobURL(id, origin.clone(), tx);
219            let _ = resource_threads.send(CoreResourceMsg::ToFileManager(msg));
220
221            let _ = rx.recv().unwrap();
222        }
223    }
224
225    /// <https://url.spec.whatwg.org/#dom-url-hash>
226    fn Hash(&self) -> USVString {
227        UrlHelper::Hash(&self.url.borrow())
228    }
229
230    /// <https://url.spec.whatwg.org/#dom-url-hash>
231    fn SetHash(&self, value: USVString) {
232        UrlHelper::SetHash(&mut self.url.borrow_mut(), value);
233    }
234
235    /// <https://url.spec.whatwg.org/#dom-url-host>
236    fn Host(&self) -> USVString {
237        UrlHelper::Host(&self.url.borrow())
238    }
239
240    /// <https://url.spec.whatwg.org/#dom-url-host>
241    fn SetHost(&self, value: USVString) {
242        UrlHelper::SetHost(&mut self.url.borrow_mut(), value);
243    }
244
245    /// <https://url.spec.whatwg.org/#dom-url-hostname>
246    fn Hostname(&self) -> USVString {
247        UrlHelper::Hostname(&self.url.borrow())
248    }
249
250    /// <https://url.spec.whatwg.org/#dom-url-hostname>
251    fn SetHostname(&self, value: USVString) {
252        UrlHelper::SetHostname(&mut self.url.borrow_mut(), value);
253    }
254
255    /// <https://url.spec.whatwg.org/#dom-url-href>
256    fn Href(&self) -> USVString {
257        UrlHelper::Href(&self.url.borrow())
258    }
259
260    /// <https://url.spec.whatwg.org/#dom-url-href>
261    fn SetHref(&self, value: USVString) -> ErrorResult {
262        match ServoUrl::parse(&value.0) {
263            Ok(url) => {
264                *self.url.borrow_mut() = url;
265                self.search_params.set(None); // To be re-initialized in the SearchParams getter.
266                Ok(())
267            },
268            Err(error) => Err(Error::Type(cformat!("could not parse URL: {}", error))),
269        }
270    }
271
272    /// <https://url.spec.whatwg.org/#dom-url-password>
273    fn Password(&self) -> USVString {
274        UrlHelper::Password(&self.url.borrow())
275    }
276
277    /// <https://url.spec.whatwg.org/#dom-url-password>
278    fn SetPassword(&self, value: USVString) {
279        UrlHelper::SetPassword(&mut self.url.borrow_mut(), value);
280    }
281
282    /// <https://url.spec.whatwg.org/#dom-url-pathname>
283    fn Pathname(&self) -> USVString {
284        UrlHelper::Pathname(&self.url.borrow())
285    }
286
287    /// <https://url.spec.whatwg.org/#dom-url-pathname>
288    fn SetPathname(&self, value: USVString) {
289        UrlHelper::SetPathname(&mut self.url.borrow_mut(), value);
290    }
291
292    /// <https://url.spec.whatwg.org/#dom-url-port>
293    fn Port(&self) -> USVString {
294        UrlHelper::Port(&self.url.borrow())
295    }
296
297    /// <https://url.spec.whatwg.org/#dom-url-port>
298    fn SetPort(&self, value: USVString) {
299        UrlHelper::SetPort(&mut self.url.borrow_mut(), value);
300    }
301
302    /// <https://url.spec.whatwg.org/#dom-url-protocol>
303    fn Protocol(&self) -> USVString {
304        UrlHelper::Protocol(&self.url.borrow())
305    }
306
307    /// <https://url.spec.whatwg.org/#dom-url-protocol>
308    fn SetProtocol(&self, value: USVString) {
309        UrlHelper::SetProtocol(&mut self.url.borrow_mut(), value);
310    }
311
312    /// <https://url.spec.whatwg.org/#dom-url-origin>
313    fn Origin(&self) -> USVString {
314        UrlHelper::Origin(&self.url.borrow())
315    }
316
317    /// <https://url.spec.whatwg.org/#dom-url-search>
318    fn Search(&self) -> USVString {
319        UrlHelper::Search(&self.url.borrow())
320    }
321
322    /// <https://url.spec.whatwg.org/#dom-url-search>
323    fn SetSearch(&self, value: USVString) {
324        UrlHelper::SetSearch(&mut self.url.borrow_mut(), value);
325        if let Some(search_params) = self.search_params.get() {
326            search_params.set_list(self.query_pairs());
327        }
328    }
329
330    /// <https://url.spec.whatwg.org/#dom-url-searchparams>
331    fn SearchParams(&self, can_gc: CanGc) -> DomRoot<URLSearchParams> {
332        self.search_params
333            .or_init(|| URLSearchParams::new(&self.global(), Some(self), can_gc))
334    }
335
336    /// <https://url.spec.whatwg.org/#dom-url-username>
337    fn Username(&self) -> USVString {
338        UrlHelper::Username(&self.url.borrow())
339    }
340
341    /// <https://url.spec.whatwg.org/#dom-url-username>
342    fn SetUsername(&self, value: USVString) {
343        UrlHelper::SetUsername(&mut self.url.borrow_mut(), value);
344    }
345
346    /// <https://url.spec.whatwg.org/#dom-url-tojson>
347    fn ToJSON(&self) -> USVString {
348        self.Href()
349    }
350}
351
352/// <https://url.spec.whatwg.org/#api-url-parser>
353fn run_api_url_parser(url: USVString, base: Option<USVString>) -> Result<Url, url::ParseError> {
354    // Step 1. Let parsedBase be null.
355    // Step 2. If base is non-null:
356    // Step 2.1 Set parsedBase to the result of running the basic URL parser on base.
357    // Step 2.2 If parsedBase is failure, then return failure.
358    let parsed_base = base.map(|base| Url::parse(&base.0)).transpose()?;
359
360    // Step 3. Return the result of running the basic URL parser on url with parsedBase.
361    Url::options().base_url(parsed_base.as_ref()).parse(&url.0)
362}
script/dom/url/url.rs

script/dom/url/
url.rs
