Skip to main content

script/dom/
processingoptions.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::str::FromStr;
6
7use cssparser::match_ignore_ascii_case;
8use http::header::HeaderMap;
9use hyper_serde::Serde;
10use mime::Mime;
11use net_traits::fetch::headers::get_decode_and_split_header_name;
12use net_traits::mime_classifier::{MediaType, MimeClassifier};
13use net_traits::policy_container::PolicyContainer;
14use net_traits::request::{
15    CorsSettings, Destination, Initiator, PreloadId, PreloadKey, Referrer, RequestBuilder,
16    RequestClient, RequestId,
17};
18use net_traits::response::{Response, ResponseBody};
19use net_traits::{
20    CoreResourceMsg, FetchMetadata, NetworkError, ReferrerPolicy, ResourceFetchTiming,
21};
22pub use nom_rfc8288::complete::LinkDataOwned as LinkHeader;
23use nom_rfc8288::complete::link_lenient as parse_link_header;
24use servo_base::id::WebViewId;
25use servo_url::{ImmutableOrigin, ServoUrl};
26use strum::IntoStaticStr;
27
28use crate::dom::bindings::refcounted::Trusted;
29use crate::dom::bindings::reflector::DomGlobal;
30use crate::dom::bindings::root::DomRoot;
31use crate::dom::csp::{GlobalCspReporting, Violation};
32use crate::dom::document::Document;
33use crate::dom::globalscope::GlobalScope;
34use crate::dom::medialist::MediaList;
35use crate::dom::node::NodeTraits;
36use crate::dom::performance::performanceresourcetiming::InitiatorType;
37use crate::dom::types::HTMLLinkElement;
38use crate::fetch::create_a_potential_cors_request;
39use crate::network_listener::{FetchResponseListener, ResourceTimingListener, submit_timing};
40
41trait ValueForKeyInLinkHeader {
42    fn has_key_in_link_header(&self, key: &str) -> bool;
43    fn value_for_key_in_link_header(&self, key: &str) -> Option<&str>;
44}
45
46impl ValueForKeyInLinkHeader for LinkHeader {
47    fn has_key_in_link_header(&self, key: &str) -> bool {
48        self.params.iter().any(|p| p.key == key)
49    }
50    fn value_for_key_in_link_header(&self, key: &str) -> Option<&str> {
51        let param = self.params.iter().find(|p| p.key == key)?;
52        param.val.as_deref()
53    }
54}
55
56#[derive(PartialEq)]
57pub(crate) enum LinkProcessingPhase {
58    Media,
59    PreMedia,
60}
61
62/// <https://html.spec.whatwg.org/multipage/#link-processing-options>
63#[derive(Debug)]
64pub(crate) struct LinkProcessingOptions {
65    /// <https://html.spec.whatwg.org/multipage/#link-options-href>
66    pub(crate) href: String,
67    /// <https://html.spec.whatwg.org/multipage/#link-options-destination>
68    pub(crate) destination: Destination,
69    /// <https://html.spec.whatwg.org/multipage/#link-options-integrity>
70    pub(crate) integrity: String,
71    /// <https://html.spec.whatwg.org/multipage/#link-options-type>
72    pub(crate) link_type: String,
73    /// <https://html.spec.whatwg.org/multipage/#link-options-nonce>
74    pub(crate) cryptographic_nonce_metadata: String,
75    /// <https://html.spec.whatwg.org/multipage/#link-options-crossorigin>
76    pub(crate) cross_origin: Option<CorsSettings>,
77    /// <https://html.spec.whatwg.org/multipage/#link-options-referrer-policy>
78    pub(crate) referrer_policy: ReferrerPolicy,
79    /// <https://html.spec.whatwg.org/multipage/#link-options-policy-container>
80    pub(crate) policy_container: PolicyContainer,
81    /// <https://html.spec.whatwg.org/multipage/#link-options-source-set>
82    pub(crate) source_set: Option<()>,
83    /// <https://html.spec.whatwg.org/multipage/#link-options-base-url>
84    pub(crate) base_url: ServoUrl,
85    /// <https://html.spec.whatwg.org/multipage/#link-options-origin>
86    pub(crate) origin: ImmutableOrigin,
87    pub(crate) referrer: Referrer,
88    // https://html.spec.whatwg.org/multipage/#link-options-environment
89    pub(crate) request_client: RequestClient,
90    // https://html.spec.whatwg.org/multipage/#link-options-document
91    // TODO
92    // https://html.spec.whatwg.org/multipage/#link-options-on-document-ready
93    // TODO
94    // https://html.spec.whatwg.org/multipage/#link-options-fetch-priority
95    // TODO
96}
97
98impl LinkProcessingOptions {
99    /// <https://html.spec.whatwg.org/multipage/#apply-link-options-from-parsed-header-attributes>
100    fn apply_link_options_from_parsed_header(
101        &mut self,
102        link_object: &LinkHeader,
103        rel: &str,
104    ) -> bool {
105        // Step 1. If rel is "preload":
106        if rel == "preload" {
107            // Step 1.1. If attribs["as"] does not exist, then return false.
108            let Some(as_) = link_object.value_for_key_in_link_header("as") else {
109                return false;
110            };
111            // Step 1.2. Let destination be the result of translating attribs["as"].
112            let Some(destination) = Self::translate_a_preload_destination(as_) else {
113                // Step 1.3. If destination is null, then return false.
114                return false;
115            };
116            // Step 1.4. Set options's destination to destination.
117            self.destination = destination;
118        }
119        // Step 2. If attribs["crossorigin"] exists and is an ASCII case-insensitive match for one of the
120        // CORS settings attribute keywords, then set options's crossorigin to the CORS settings attribute
121        // state corresponding to that keyword.
122        if let Some(cross_origin) = link_object.value_for_key_in_link_header("crossorigin") {
123            self.cross_origin = determine_cors_settings_for_token(cross_origin);
124        }
125        // Step 3. If attribs["integrity"] exists, then set options's integrity to attribs["integrity"].
126        if let Some(integrity) = link_object.value_for_key_in_link_header("integrity") {
127            self.integrity = integrity.to_owned();
128        }
129        // Step 4. If attribs["referrerpolicy"] exists and is an ASCII case-insensitive match for
130        // some referrer policy, then set options's referrer policy to that referrer policy.
131        if let Some(referrer_policy) = link_object.value_for_key_in_link_header("referrerpolicy") {
132            self.referrer_policy = ReferrerPolicy::from(referrer_policy);
133        }
134        // Step 5. If attribs["nonce"] exists, then set options's nonce to attribs["nonce"].
135        if let Some(nonce) = link_object.value_for_key_in_link_header("nonce") {
136            self.cryptographic_nonce_metadata = nonce.to_owned();
137        }
138        // Step 6. If attribs["type"] exists, then set options's type to attribs["type"].
139        if let Some(link_type) = link_object.value_for_key_in_link_header("type") {
140            self.link_type = link_type.to_owned();
141        }
142        // Step 7. If attribs["fetchpriority"] exists and is an ASCII case-insensitive match
143        // for a fetch priority attribute keyword, then set options's fetch priority to that
144        // fetch priority attribute keyword.
145        // TODO
146        // Step 8. Return true.
147        true
148    }
149
150    /// <https://html.spec.whatwg.org/multipage/#process-a-link-header>
151    fn process_link_header(self, rel: &str, document: &Document) {
152        if rel == "preload" {
153            // https://html.spec.whatwg.org/multipage/#link-type-preload:process-a-link-header
154            // The process a link header step for this type of link given a link processing options options
155            // is to preload options.
156            if !self.type_matches_destination() {
157                return;
158            }
159            self.preload(document.window().webview_id(), None, document);
160        }
161    }
162
163    /// <https://html.spec.whatwg.org/multipage/#translate-a-preload-destination>
164    pub(crate) fn translate_a_preload_destination(
165        potential_destination: &str,
166    ) -> Option<Destination> {
167        // Step 2. Return the result of translating destination.
168        Some(match potential_destination {
169            "fetch" => Destination::None,
170            "font" => Destination::Font,
171            "image" => Destination::Image,
172            "script" => Destination::Script,
173            "style" => Destination::Style,
174            "track" => Destination::Track,
175            // Step 1. If destination is not "fetch", "font", "image",
176            // "script", "style", or "track", then return null.
177            _ => return None,
178        })
179    }
180
181    /// <https://html.spec.whatwg.org/multipage/#create-a-link-request>
182    pub(crate) fn create_link_request(self, webview_id: WebViewId) -> Option<RequestBuilder> {
183        // Step 1. Assert: options's href is not the empty string.
184        assert!(!self.href.is_empty());
185
186        // Step 3. Let url be the result of encoding-parsing a URL given options's href, relative to options's base URL.
187        let Ok(url) = ServoUrl::parse_with_base(Some(&self.base_url), &self.href) else {
188            // Step 4. If url is failure, then return null.
189            return None;
190        };
191
192        // Step 5. Let request be the result of creating a potential-CORS request given
193        //         url, options's destination, and options's crossorigin.
194        // Step 6. Set request's policy container to options's policy container.
195        // Step 7. Set request's integrity metadata to options's integrity.
196        // Step 8. Set request's cryptographic nonce metadata to options's cryptographic nonce metadata.
197        // Step 9. Set request's referrer policy to options's referrer policy.
198        // Step 10. Set request's client to options's environment.
199        // FIXME: Step 11. Set request's priority to options's fetch priority.
200        let builder = create_a_potential_cors_request(
201            Some(webview_id),
202            url,
203            self.destination,
204            self.cross_origin,
205            None,
206            self.referrer,
207        )
208        .policy_container(self.policy_container)
209        .client(self.request_client)
210        .initiator(Initiator::Link)
211        .origin(self.origin)
212        .integrity_metadata(self.integrity)
213        .cryptographic_nonce_metadata(self.cryptographic_nonce_metadata)
214        .referrer_policy(self.referrer_policy);
215
216        // Step 12. Return request.
217        Some(builder)
218    }
219
220    /// <https://html.spec.whatwg.org/multipage/#match-preload-type>
221    pub(crate) fn type_matches_destination(&self) -> bool {
222        // Step 1. If type is an empty string, then return true.
223        if self.link_type.is_empty() {
224            return true;
225        }
226        // Step 2. If destination is "fetch", then return true.
227        //
228        // Fetch is handled as an empty string destination in the spec:
229        // https://fetch.spec.whatwg.org/#concept-potential-destination-translate
230        let destination = self.destination;
231        if destination == Destination::None {
232            return true;
233        }
234        // Step 3. Let mimeTypeRecord be the result of parsing type.
235        let Ok(mime_type_record) = Mime::from_str(&self.link_type) else {
236            // Step 4. If mimeTypeRecord is failure, then return false.
237            return false;
238        };
239        // Step 5. If mimeTypeRecord is not supported by the user agent, then return false.
240        //
241        // We currently don't check if we actually support the mime type. Only if we can classify
242        // it according to the spec.
243        let Some(mime_type) = MimeClassifier::get_media_type(&mime_type_record) else {
244            return false;
245        };
246        // Step 6. If any of the following are true:
247        if
248        // destination is "audio" or "video", and mimeTypeRecord is an audio or video MIME type;
249        ((destination == Destination::Audio || destination == Destination::Video) &&
250            mime_type == MediaType::AudioVideo)
251            // destination is a script-like destination and mimeTypeRecord is a JavaScript MIME type;
252            || (destination.is_script_like() && mime_type == MediaType::JavaScript)
253            // destination is "image" and mimeTypeRecord is an image MIME type;
254            || (destination == Destination::Image && mime_type == MediaType::Image)
255            // destination is "font" and mimeTypeRecord is a font MIME type;
256            || (destination == Destination::Font && mime_type == MediaType::Font)
257            // destination is "json" and mimeTypeRecord is a JSON MIME type;
258            || (destination == Destination::Json && mime_type == MediaType::Json)
259            // destination is "style" and mimeTypeRecord's essence is text/css; or
260            || (destination == Destination::Style && mime_type_record == mime::TEXT_CSS)
261            // destination is "track" and mimeTypeRecord's essence is text/vtt,
262            || (destination == Destination::Track && mime_type_record.essence_str() == "text/vtt")
263        {
264            // then return true.
265            return true;
266        }
267        // Step 7. Return false.
268        false
269    }
270
271    /// <https://html.spec.whatwg.org/multipage/#preload>
272    pub(crate) fn preload(
273        self,
274        webview_id: WebViewId,
275        link: Option<Trusted<HTMLLinkElement>>,
276        document: &Document,
277    ) {
278        // Step 1. If options's type doesn't match options's destination, then return.
279        //
280        // Handled by callers, since we need to check the previous destination type
281        assert!(self.type_matches_destination());
282        // Step 2. If options's destination is "image" and options's source set is not null,
283        // then set options's href to the result of selecting an image source from options's source set.
284        // TODO
285        // Step 3. Let request be the result of creating a link request given options.
286        let Some(request) = self.create_link_request(webview_id) else {
287            // Step 4. If request is null, then return.
288            return;
289        };
290        let preload_id = PreloadId::default();
291        let request = request.preload_id(preload_id.clone());
292        // Step 5. Let unsafeEndTime be 0.
293        // TODO
294        // Step 6. Let entry be a new preload entry whose integrity metadata is options's integrity.
295        //
296        // This is performed in `CoreResourceManager::fetch`
297        // Step 7. Let key be the result of creating a preload key given request.
298        let key = PreloadKey::new(&request);
299        // Step 8. If options's document is "pending", then set request's initiator type to "early hint".
300        // TODO
301        // Step 9. Let controller be null.
302        // Step 10. Let reportTiming given a Document document be to report timing for controller
303        // given document's relevant global object.
304        let url = request.url.url();
305        let fetch_context = LinkFetchContext {
306            url,
307            link,
308            document: Trusted::new(document),
309            global: Trusted::new(&document.global()),
310            type_: LinkFetchContextType::Preload(key.clone()),
311            response_body: vec![],
312        };
313        document.insert_preloaded_resource(key, preload_id);
314        // Step 11. Set controller to the result of fetching request, with processResponseConsumeBody
315        // set to the following steps given a response response and null, failure, or a byte sequence bodyBytes:
316        document.fetch_background(request, fetch_context);
317    }
318}
319
320pub(crate) fn determine_cors_settings_for_token(token: &str) -> Option<CorsSettings> {
321    match_ignore_ascii_case! { token,
322        "anonymous" => Some(CorsSettings::Anonymous),
323        "use-credentials" => Some(CorsSettings::UseCredentials),
324        _ => None,
325    }
326}
327
328/// <https://html.spec.whatwg.org/multipage/#extract-links-from-headers>
329pub(crate) fn extract_links_from_headers(headers: &Option<Serde<HeaderMap>>) -> Vec<LinkHeader> {
330    // Step 1. Let links be a new list.
331    let mut links = Vec::new();
332    let Some(headers) = headers else {
333        return links;
334    };
335    // Step 2. Let rawLinkHeaders be the result of getting, decoding, and splitting `Link` from headers.
336    let Some(raw_link_headers) = get_decode_and_split_header_name("Link", headers) else {
337        return links;
338    };
339    // Step 3. For each linkHeader of rawLinkHeaders:
340    for link_header in raw_link_headers {
341        // Step 3.1. Let linkObject be the result of parsing linkHeader. [WEBLINK]
342        let Ok(parsed_link_header) = parse_link_header(&link_header) else {
343            continue;
344        };
345        for link_object in parsed_link_header {
346            let Some(link_object) = link_object else {
347                // Step 3.2. If linkObject["target_uri"] does not exist, then continue.
348                continue;
349            };
350            // Step 3.3. Append linkObject to links.
351            links.push(link_object.to_owned());
352        }
353    }
354    // Step 4. Return links.
355    links
356}
357
358/// <https://html.spec.whatwg.org/multipage/#process-link-headers>
359pub(crate) fn process_link_headers(
360    link_headers: &[LinkHeader],
361    document: &Document,
362    phase: LinkProcessingPhase,
363) {
364    let global = document.owner_global();
365    // Step 1. Let links be the result of extracting links from response's header list.
366    //
367    // Already performed once when parsing headers by caller
368    // Step 2. For each linkObject in links:
369    for link_object in link_headers {
370        // Step 2.1. Let rel be linkObject["relation_type"].
371        let Some(rel) = link_object.value_for_key_in_link_header("rel") else {
372            continue;
373        };
374        // Step 2.2. Let attribs be linkObject["target_attributes"].
375        //
376        // Not applicable, that's in `link_object.params`
377        // Step 2.3. Let expectedPhase be "media" if either "srcset", "imagesrcset",
378        // or "media" exist in attribs; otherwise "pre-media".
379        let expected_phase = if link_object.has_key_in_link_header("srcset") ||
380            link_object.has_key_in_link_header("imagesrcset") ||
381            link_object.has_key_in_link_header("media")
382        {
383            LinkProcessingPhase::Media
384        } else {
385            LinkProcessingPhase::PreMedia
386        };
387        // Step 2.4. If expectedPhase is not phase, then continue.
388        if expected_phase != phase {
389            continue;
390        }
391        // Step 2.5. If attribs["media"] exists and attribs["media"] does not match the environment, then continue.
392        if let Some(media) = link_object.value_for_key_in_link_header("media") &&
393            !MediaList::matches_environment(document, media)
394        {
395            continue;
396        }
397        // Step 2.6. Let options be a new link processing options with
398        let mut options = LinkProcessingOptions {
399            href: link_object.url.clone(),
400            destination: Destination::None,
401            integrity: String::new(),
402            link_type: String::new(),
403            cryptographic_nonce_metadata: String::new(),
404            cross_origin: None,
405            referrer_policy: ReferrerPolicy::EmptyString,
406            policy_container: document.policy_container().to_owned(),
407            source_set: None,
408            origin: document.origin().immutable().to_owned(),
409            base_url: document.base_url(),
410            request_client: global.request_client(None),
411            referrer: global.get_referrer(),
412        };
413        // Step 2.7. Apply link options from parsed header attributes to options given attribs and rel.
414        // If that returned false, then return.
415        if !options.apply_link_options_from_parsed_header(link_object, rel) {
416            return;
417        }
418        // Step 2.8. If attribs["imagesrcset"] exists and attribs["imagesizes"] exists,
419        // then set options's source set to the result of creating a source set given
420        // linkObject["target_uri"], attribs["imagesrcset"], attribs["imagesizes"], and null.
421        // TODO
422        // Step 2.9. Run the process a link header steps for rel given options.
423        options.process_link_header(rel, document);
424    }
425}
426
427#[derive(Clone, IntoStaticStr)]
428#[strum(serialize_all = "lowercase")]
429pub(crate) enum LinkFetchContextType {
430    Prefetch,
431    Preload(PreloadKey),
432}
433
434impl From<LinkFetchContextType> for InitiatorType {
435    fn from(other: LinkFetchContextType) -> Self {
436        let name: &'static str = other.into();
437        InitiatorType::LocalName(name.to_owned())
438    }
439}
440
441pub(crate) struct LinkFetchContext {
442    /// The `<link>` element (if any) that caused this fetch
443    pub(crate) link: Option<Trusted<HTMLLinkElement>>,
444
445    pub(crate) global: Trusted<GlobalScope>,
446    pub(crate) document: Trusted<Document>,
447
448    /// The url being prefetched
449    pub(crate) url: ServoUrl,
450
451    /// The type of fetching we perform, used when report timings.
452    pub(crate) type_: LinkFetchContextType,
453
454    pub(crate) response_body: Vec<u8>,
455}
456
457impl FetchResponseListener for LinkFetchContext {
458    fn process_request_body(&mut self, _: RequestId) {}
459
460    fn process_response(
461        &mut self,
462        _: &mut js::context::JSContext,
463        _: RequestId,
464        fetch_metadata: Result<FetchMetadata, NetworkError>,
465    ) {
466        _ = fetch_metadata;
467    }
468
469    fn process_response_chunk(
470        &mut self,
471        _: &mut js::context::JSContext,
472        _: RequestId,
473        mut chunk: Vec<u8>,
474    ) {
475        if matches!(self.type_, LinkFetchContextType::Preload(..)) {
476            self.response_body.append(&mut chunk);
477        }
478    }
479
480    /// Step 7 of <https://html.spec.whatwg.org/multipage/#link-type-prefetch:fetch-and-process-the-linked-resource-2>
481    /// and step 3.1 of <https://html.spec.whatwg.org/multipage/#link-type-preload:fetch-and-process-the-linked-resource-2>
482    fn process_response_eof(
483        mut self,
484        cx: &mut js::context::JSContext,
485        _: RequestId,
486        response_result: Result<(), NetworkError>,
487        timing: ResourceFetchTiming,
488    ) {
489        // Steps for https://html.spec.whatwg.org/multipage/#preload
490        if let LinkFetchContextType::Preload(key) = &self.type_ {
491            let response = if response_result.is_ok() {
492                // Step 11.1. If bodyBytes is a byte sequence, then set response's body to bodyBytes as a body.
493                let response = Response::new(self.url.clone(), timing.clone());
494                *response.body.lock() = ResponseBody::Done(std::mem::take(&mut self.response_body));
495                response
496            } else {
497                // Step 11.2. Otherwise, set response to a network error.
498                Response::network_error(NetworkError::ResourceLoadError("Failed to preload".into()))
499            };
500            // Step 11.5. If entry's on response available is null, then set entry's response to response;
501            // otherwise call entry's on response available given response.
502            // Step 12. Let commit be the following steps given a Document document:
503            // Step 12.1. If entry's response is not null, then call reportTiming given document.
504            // Step 12.2. Set document's map of preloaded resources[key] to entry.
505            // Step 13. If options's document is null, then set options's on document ready to commit. Otherwise, call commit with options's document.
506            let document = self.document.root();
507            let document_preloaded_resources = document.preloaded_resources();
508            let Some(preload_id) = document_preloaded_resources.get(key) else {
509                unreachable!(
510                    "Must only be able to lookup preloaded resources if they already exist in document"
511                );
512            };
513            let _ = self.global.root().core_resource_thread().send(
514                CoreResourceMsg::StorePreloadedResponse(preload_id.clone(), response),
515            );
516        }
517
518        submit_timing(cx, &self, &response_result, &timing);
519
520        // Step 11.6. If processResponse is given, then call processResponse with response.
521        //
522        // Part of Preload
523        //
524        // Step 6. Let processPrefetchResponse be the following steps given a response response and null, failure, or a byte sequence bytesOrNull:
525        //
526        // Part of Prefetch
527        if let Some(link) = self.link.as_ref() {
528            link.root().fire_event_after_response(cx, response_result);
529        }
530    }
531
532    fn process_csp_violations(
533        &mut self,
534        cx: &mut js::context::JSContext,
535        _request_id: RequestId,
536        violations: Vec<Violation>,
537    ) {
538        let global = &self.resource_timing_global();
539        global.report_csp_violations(cx, violations, None, None);
540    }
541}
542
543impl ResourceTimingListener for LinkFetchContext {
544    fn resource_timing_information(&self) -> (InitiatorType, ServoUrl) {
545        (self.type_.clone().into(), self.url.clone())
546    }
547
548    fn resource_timing_global(&self) -> DomRoot<GlobalScope> {
549        self.global.root()
550    }
551}