net_traits/
response.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
5//! The [Response](https://fetch.spec.whatwg.org/#responses) object
6//! resulting from a [fetch operation](https://fetch.spec.whatwg.org/#concept-fetch)
7use std::sync::atomic::AtomicBool;
8
9use http::HeaderMap;
10use hyper_serde::Serde;
11use malloc_size_of_derive::MallocSizeOf;
12use parking_lot::Mutex;
13use serde::{Deserialize, Serialize};
14use servo_arc::Arc;
15use servo_url::ServoUrl;
16
17use crate::fetch::headers::extract_mime_type_as_mime;
18use crate::http_status::HttpStatus;
19use crate::{
20    FetchMetadata, FilteredMetadata, Metadata, NetworkError, ReferrerPolicy, ResourceFetchTiming,
21    ResourceTimingType, TlsSecurityInfo,
22};
23
24/// [Response type](https://fetch.spec.whatwg.org/#concept-response-type)
25#[derive(Clone, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
26pub enum ResponseType {
27    Basic,
28    Cors,
29    Default,
30    Error(NetworkError),
31    Opaque,
32    OpaqueRedirect,
33}
34
35/// [Response termination reason](https://fetch.spec.whatwg.org/#concept-response-termination-reason)
36#[derive(Clone, Copy, Debug, Deserialize, MallocSizeOf, Serialize)]
37pub enum TerminationReason {
38    EndUserAbort,
39    Fatal,
40    Timeout,
41}
42
43/// The response body can still be pushed to after fetch
44/// This provides a way to store unfinished response bodies
45#[derive(Clone, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
46pub enum ResponseBody {
47    Empty, // XXXManishearth is this necessary, or is Done(vec![]) enough?
48    Receiving(Vec<u8>),
49    Done(Vec<u8>),
50}
51
52impl ResponseBody {
53    pub fn is_done(&self) -> bool {
54        match *self {
55            ResponseBody::Done(..) => true,
56            ResponseBody::Empty | ResponseBody::Receiving(..) => false,
57        }
58    }
59}
60
61/// <https://fetch.spec.whatwg.org/#response-redirect-taint>
62#[derive(Clone, Copy, Debug, Default, Deserialize, MallocSizeOf, PartialEq, Serialize)]
63pub enum RedirectTaint {
64    #[default]
65    SameOrigin,
66    SameSite,
67    CrossSite,
68}
69
70/// [Cache state](https://fetch.spec.whatwg.org/#concept-response-cache-state)
71#[derive(Clone, Copy, Debug, Deserialize, MallocSizeOf, Serialize)]
72pub enum CacheState {
73    None,
74    Local,
75    Validated,
76    Partial,
77}
78
79/// [Https state](https://fetch.spec.whatwg.org/#concept-response-https-state)
80#[derive(Clone, Copy, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
81pub enum HttpsState {
82    None,
83    Deprecated,
84    Modern,
85}
86
87#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
88pub struct ResponseInit {
89    pub url: ServoUrl,
90    #[serde(
91        deserialize_with = "::hyper_serde::deserialize",
92        serialize_with = "::hyper_serde::serialize"
93    )]
94    pub headers: HeaderMap,
95    pub status_code: u16,
96    pub referrer: Option<ServoUrl>,
97    pub location_url: Option<Result<ServoUrl, String>>,
98}
99
100/// A [Response](https://fetch.spec.whatwg.org/#concept-response) as defined by the Fetch spec
101#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
102pub struct Response {
103    pub response_type: ResponseType,
104    pub termination_reason: Option<TerminationReason>,
105    url: Option<ServoUrl>,
106    pub url_list: Vec<ServoUrl>,
107    pub status: HttpStatus,
108    #[serde(
109        deserialize_with = "::hyper_serde::deserialize",
110        serialize_with = "::hyper_serde::serialize"
111    )]
112    pub headers: HeaderMap,
113    #[conditional_malloc_size_of]
114    pub body: Arc<Mutex<ResponseBody>>,
115    pub cache_state: CacheState,
116    pub https_state: HttpsState,
117    pub tls_security_info: Option<TlsSecurityInfo>,
118    pub referrer: Option<ServoUrl>,
119    /// <https://fetch.spec.whatwg.org/#response-redirect-taint>
120    pub redirect_taint: RedirectTaint,
121    pub referrer_policy: ReferrerPolicy,
122    /// [CORS-exposed header-name list](https://fetch.spec.whatwg.org/#concept-response-cors-exposed-header-name-list)
123    pub cors_exposed_header_name_list: Vec<String>,
124    /// [Location URL](https://fetch.spec.whatwg.org/#concept-response-location-url)
125    pub location_url: Option<Result<ServoUrl, String>>,
126    /// [Internal response](https://fetch.spec.whatwg.org/#concept-internal-response), only used if the Response
127    /// is a filtered response
128    pub internal_response: Option<Box<Response>>,
129    /// whether or not to try to return the internal_response when asked for actual_response
130    pub return_internal: bool,
131    /// <https://fetch.spec.whatwg.org/#concept-response-aborted>
132    #[conditional_malloc_size_of]
133    pub aborted: Arc<AtomicBool>,
134    /// track network metrics
135    #[conditional_malloc_size_of]
136    pub resource_timing: Arc<Mutex<ResourceFetchTiming>>,
137
138    /// <https://fetch.spec.whatwg.org/#concept-response-range-requested-flag>
139    pub range_requested: bool,
140}
141
142impl Response {
143    pub fn new(url: ServoUrl, resource_timing: ResourceFetchTiming) -> Response {
144        Response {
145            response_type: ResponseType::Default,
146            termination_reason: None,
147            url: Some(url),
148            url_list: vec![],
149            status: HttpStatus::default(),
150            headers: HeaderMap::new(),
151            body: Arc::new(Mutex::new(ResponseBody::Empty)),
152            cache_state: CacheState::None,
153            https_state: HttpsState::None,
154            tls_security_info: None,
155            referrer: None,
156            referrer_policy: ReferrerPolicy::EmptyString,
157            cors_exposed_header_name_list: vec![],
158            location_url: None,
159            internal_response: None,
160            return_internal: true,
161            aborted: Arc::new(AtomicBool::new(false)),
162            resource_timing: Arc::new(Mutex::new(resource_timing)),
163            range_requested: false,
164            redirect_taint: Default::default(),
165        }
166    }
167
168    pub fn from_init(init: ResponseInit, resource_timing_type: ResourceTimingType) -> Response {
169        let mut res = Response::new(init.url, ResourceFetchTiming::new(resource_timing_type));
170        res.location_url = init.location_url;
171        res.headers = init.headers;
172        res.referrer = init.referrer;
173        res.status = HttpStatus::new_raw(init.status_code, vec![]);
174        res
175    }
176
177    pub fn network_error(e: NetworkError) -> Response {
178        Response {
179            response_type: ResponseType::Error(e),
180            termination_reason: None,
181            url: None,
182            url_list: vec![],
183            status: HttpStatus::new_error(),
184            headers: HeaderMap::new(),
185            body: Arc::new(Mutex::new(ResponseBody::Empty)),
186            cache_state: CacheState::None,
187            https_state: HttpsState::None,
188            tls_security_info: None,
189            referrer: None,
190            referrer_policy: ReferrerPolicy::EmptyString,
191            cors_exposed_header_name_list: vec![],
192            location_url: None,
193            internal_response: None,
194            return_internal: true,
195            aborted: Arc::new(AtomicBool::new(false)),
196            resource_timing: Arc::new(Mutex::new(ResourceFetchTiming::new(
197                ResourceTimingType::Error,
198            ))),
199            range_requested: false,
200            redirect_taint: Default::default(),
201        }
202    }
203
204    pub fn url(&self) -> Option<&ServoUrl> {
205        self.url.as_ref()
206    }
207
208    pub fn is_network_error(&self) -> bool {
209        matches!(self.response_type, ResponseType::Error(..))
210    }
211
212    pub fn get_network_error(&self) -> Option<&NetworkError> {
213        match self.response_type {
214            ResponseType::Error(ref e) => Some(e),
215            _ => None,
216        }
217    }
218
219    pub fn set_network_error(&mut self, network_error: NetworkError) {
220        self.response_type = ResponseType::Error(network_error);
221    }
222
223    pub fn actual_response(&self) -> &Response {
224        if self.return_internal && self.internal_response.is_some() {
225            self.internal_response.as_ref().unwrap()
226        } else {
227            self
228        }
229    }
230
231    pub fn actual_response_mut(&mut self) -> &mut Response {
232        if self.return_internal && self.internal_response.is_some() {
233            self.internal_response.as_mut().unwrap()
234        } else {
235            self
236        }
237    }
238
239    pub fn to_actual(self) -> Response {
240        if self.return_internal && self.internal_response.is_some() {
241            *self.internal_response.unwrap()
242        } else {
243            self
244        }
245    }
246
247    pub fn get_resource_timing(&self) -> Arc<Mutex<ResourceFetchTiming>> {
248        Arc::clone(&self.resource_timing)
249    }
250
251    /// Convert to a filtered response, of type `filter_type`.
252    /// Do not use with type Error or Default
253    #[rustfmt::skip]
254    pub fn to_filtered(self, filter_type: ResponseType) -> Response {
255        match filter_type {
256            ResponseType::Default |
257            ResponseType::Error(..) => panic!(),
258            _ => (),
259        }
260
261        let old_response = self.to_actual();
262
263        if let ResponseType::Error(e) = old_response.response_type {
264            return Response::network_error(e);
265        }
266
267        let old_headers = old_response.headers.clone();
268        let exposed_headers = old_response.cors_exposed_header_name_list.clone();
269        let mut response = old_response.clone();
270        response.internal_response = Some(Box::new(old_response));
271        response.response_type = filter_type;
272
273        match response.response_type {
274            ResponseType::Default |
275            ResponseType::Error(..) => unreachable!(),
276
277            ResponseType::Basic => {
278                let headers = old_headers.iter().filter(|(name, _)| {
279                    !matches!(&*name.as_str().to_ascii_lowercase(), "set-cookie" | "set-cookie2")
280                }).map(|(n, v)| (n.clone(), v.clone())).collect();
281                response.headers = headers;
282            },
283
284            ResponseType::Cors => {
285                let headers = old_headers.iter().filter(|(name, _)| {
286                    match &*name.as_str().to_ascii_lowercase() {
287                        "cache-control" | "content-language" | "content-length" | "content-type" |
288                        "expires" | "last-modified" | "pragma" => true,
289                        "set-cookie" | "set-cookie2" => false,
290                        header => {
291                            exposed_headers.iter().any(|h| *header == h.as_str().to_ascii_lowercase())
292                        }
293                    }
294                }).map(|(n, v)| (n.clone(), v.clone())).collect();
295                response.headers = headers;
296            },
297
298            ResponseType::Opaque => {
299                response.url_list = vec![];
300                response.url = None;
301                response.headers = HeaderMap::new();
302                response.status = HttpStatus::new_error();
303                response.body = Arc::new(Mutex::new(ResponseBody::Empty));
304                response.cache_state = CacheState::None;
305            },
306
307            ResponseType::OpaqueRedirect => {
308                response.headers = HeaderMap::new();
309                response.status = HttpStatus::new_error();
310                response.body = Arc::new(Mutex::new(ResponseBody::Empty));
311                response.cache_state = CacheState::None;
312            },
313        }
314
315        response
316    }
317
318    pub fn metadata(&self) -> Result<FetchMetadata, NetworkError> {
319        fn init_metadata(response: &Response, url: &ServoUrl) -> Metadata {
320            let mut metadata = Metadata::default(url.clone());
321            metadata.set_content_type(extract_mime_type_as_mime(&response.headers).as_ref());
322            metadata.location_url.clone_from(&response.location_url);
323            metadata.headers = Some(Serde(response.headers.clone()));
324            metadata.status.clone_from(&response.status);
325            metadata.https_state = response.https_state;
326            metadata.referrer.clone_from(&response.referrer);
327            metadata.referrer_policy = response.referrer_policy;
328            metadata.redirected = response.actual_response().url_list.len() > 1;
329            metadata
330                .tls_security_info
331                .clone_from(&response.tls_security_info);
332            metadata
333        }
334
335        if let Some(error) = self.get_network_error() {
336            return Err(error.clone());
337        }
338
339        let metadata = self.url.as_ref().map(|url| init_metadata(self, url));
340
341        if let Some(ref response) = self.internal_response {
342            match response.url {
343                Some(ref url) => {
344                    let unsafe_metadata = init_metadata(response, url);
345
346                    match self.response_type {
347                        ResponseType::Basic => Ok(FetchMetadata::Filtered {
348                            filtered: FilteredMetadata::Basic(metadata.unwrap()),
349                            unsafe_: unsafe_metadata,
350                        }),
351                        ResponseType::Cors => Ok(FetchMetadata::Filtered {
352                            filtered: FilteredMetadata::Cors(metadata.unwrap()),
353                            unsafe_: unsafe_metadata,
354                        }),
355                        ResponseType::Default => unreachable!(),
356                        ResponseType::Error(ref network_err) => Err(network_err.clone()),
357                        ResponseType::Opaque => Ok(FetchMetadata::Filtered {
358                            filtered: FilteredMetadata::Opaque,
359                            unsafe_: unsafe_metadata,
360                        }),
361                        ResponseType::OpaqueRedirect => Ok(FetchMetadata::Filtered {
362                            filtered: FilteredMetadata::OpaqueRedirect(url.clone()),
363                            unsafe_: unsafe_metadata,
364                        }),
365                    }
366                },
367                None => Err(NetworkError::ResourceLoadError(
368                    "No url found in unsafe response".to_owned(),
369                )),
370            }
371        } else {
372            assert_eq!(self.response_type, ResponseType::Default);
373            Ok(FetchMetadata::Unfiltered(metadata.unwrap()))
374        }
375    }
376}
net_traits/response.rs

net_traits/
response.rs
