script/dom/
xmlhttprequest.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::borrow::ToOwned;
6use std::cell::Cell;
7use std::cmp;
8use std::default::Default;
9use std::str::{self, FromStr};
10use std::sync::Arc;
11use std::time::{Duration, Instant};
12
13use atomic_refcell::AtomicRefCell;
14use constellation_traits::BlobImpl;
15use data_url::mime::Mime;
16use dom_struct::dom_struct;
17use encoding_rs::{Encoding, UTF_8};
18use headers::{ContentLength, ContentType, HeaderMapExt};
19use html5ever::serialize;
20use html5ever::serialize::SerializeOpts;
21use http::Method;
22use http::header::{self, HeaderMap, HeaderName, HeaderValue};
23use hyper_serde::Serde;
24use js::jsapi::{Heap, JS_ClearPendingException};
25use js::jsval::{JSVal, NullValue};
26use js::rust::wrappers::JS_ParseJSON;
27use js::rust::{HandleObject, MutableHandleValue};
28use js::typedarray::{ArrayBufferU8, HeapArrayBuffer};
29use net_traits::fetch::headers::extract_mime_type_as_dataurl_mime;
30use net_traits::http_status::HttpStatus;
31use net_traits::request::{CredentialsMode, Referrer, RequestBuilder, RequestId, RequestMode};
32use net_traits::{
33    FetchMetadata, FilteredMetadata, NetworkError, ReferrerPolicy, ResourceFetchTiming,
34    trim_http_whitespace,
35};
36use script_bindings::conversions::SafeToJSValConvertible;
37use script_bindings::num::Finite;
38use script_bindings::trace::RootedTraceableBox;
39use script_traits::DocumentActivity;
40use servo_url::ServoUrl;
41use stylo_atoms::Atom;
42use url::Position;
43
44use crate::body::{BodySource, Extractable, ExtractedBody, decode_to_utf16_with_bom_removal};
45use crate::document_loader::DocumentLoader;
46use crate::dom::bindings::buffer_source::HeapBufferSource;
47use crate::dom::bindings::cell::DomRefCell;
48use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods;
49use crate::dom::bindings::codegen::Bindings::XMLHttpRequestBinding::{
50    XMLHttpRequestMethods, XMLHttpRequestResponseType,
51};
52use crate::dom::bindings::codegen::UnionTypes::DocumentOrBlobOrArrayBufferViewOrArrayBufferOrFormDataOrStringOrURLSearchParams as DocumentOrXMLHttpRequestBodyInit;
53use crate::dom::bindings::error::{Error, ErrorResult, Fallible};
54use crate::dom::bindings::inheritance::Castable;
55use crate::dom::bindings::refcounted::Trusted;
56use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object_with_proto};
57use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom};
58use crate::dom::bindings::str::{ByteString, DOMString, USVString, is_token};
59use crate::dom::blob::{Blob, normalize_type_string};
60use crate::dom::csp::{GlobalCspReporting, Violation};
61use crate::dom::document::{Document, DocumentSource, HasBrowsingContext, IsHTMLDocument};
62use crate::dom::event::{Event, EventBubbles, EventCancelable};
63use crate::dom::eventtarget::EventTarget;
64use crate::dom::globalscope::GlobalScope;
65use crate::dom::headers::is_forbidden_request_header;
66use crate::dom::node::Node;
67use crate::dom::performance::performanceresourcetiming::InitiatorType;
68use crate::dom::progressevent::ProgressEvent;
69use crate::dom::servoparser::ServoParser;
70use crate::dom::servoparser::html::HtmlSerialize;
71use crate::dom::stream::readablestream::ReadableStream;
72use crate::dom::window::Window;
73use crate::dom::workerglobalscope::WorkerGlobalScope;
74use crate::dom::xmlhttprequesteventtarget::XMLHttpRequestEventTarget;
75use crate::dom::xmlhttprequestupload::XMLHttpRequestUpload;
76use crate::fetch::{FetchCanceller, RequestWithGlobalScope};
77use crate::mime::{APPLICATION, CHARSET, HTML, MimeExt, TEXT, XML};
78use crate::network_listener::{self, FetchResponseListener, ResourceTimingListener};
79use crate::script_runtime::{CanGc, JSContext};
80use crate::task_source::{SendableTaskSource, TaskSourceName};
81use crate::timers::{OneshotTimerCallback, OneshotTimerHandle};
82
83#[derive(Clone, Copy, Debug, JSTraceable, MallocSizeOf, PartialEq)]
84enum XMLHttpRequestState {
85    Unsent = 0,
86    Opened = 1,
87    HeadersReceived = 2,
88    Loading = 3,
89    Done = 4,
90}
91
92#[derive(Clone, Copy, JSTraceable, MallocSizeOf, PartialEq)]
93pub(crate) struct GenerationId(u32);
94
95/// Closure of required data for each async network event that comprises the
96/// XHR's response.
97struct XHRContext {
98    xhr: TrustedXHRAddress,
99    gen_id: GenerationId,
100    sync_status: Arc<AtomicRefCell<Option<ErrorResult>>>,
101    url: ServoUrl,
102}
103
104impl FetchResponseListener for XHRContext {
105    fn process_request_body(&mut self, _: RequestId) {
106        // todo
107    }
108
109    fn process_request_eof(&mut self, _: RequestId) {
110        // todo
111    }
112
113    fn process_response(&mut self, _: RequestId, metadata: Result<FetchMetadata, NetworkError>) {
114        let xhr = self.xhr.root();
115        let rv = xhr.process_headers_available(self.gen_id, metadata, CanGc::note());
116        if rv.is_err() {
117            *self.sync_status.borrow_mut() = Some(rv);
118        }
119    }
120
121    fn process_response_chunk(&mut self, _: RequestId, chunk: Vec<u8>) {
122        self.xhr
123            .root()
124            .process_data_available(self.gen_id, chunk, CanGc::note());
125    }
126
127    fn process_response_eof(
128        self,
129        cx: &mut js::context::JSContext,
130        _: RequestId,
131        response: Result<(), NetworkError>,
132        timing: ResourceFetchTiming,
133    ) {
134        network_listener::submit_timing(&self, &response, &timing, CanGc::from_cx(cx));
135
136        let rv = self.xhr.root().process_response_complete(
137            self.gen_id,
138            response.map(|_| ()),
139            CanGc::from_cx(cx),
140        );
141        *self.sync_status.borrow_mut() = Some(rv);
142    }
143
144    fn process_csp_violations(&mut self, _request_id: RequestId, violations: Vec<Violation>) {
145        let global = &self.resource_timing_global();
146        global.report_csp_violations(violations, None, None);
147    }
148
149    fn should_invoke(&self) -> bool {
150        self.xhr.root().generation_id.get() == self.gen_id
151    }
152}
153
154impl ResourceTimingListener for XHRContext {
155    fn resource_timing_information(&self) -> (InitiatorType, ServoUrl) {
156        (InitiatorType::XMLHttpRequest, self.url.clone())
157    }
158
159    fn resource_timing_global(&self) -> DomRoot<GlobalScope> {
160        self.xhr.root().global()
161    }
162}
163
164#[derive(Clone)]
165pub(crate) enum XHRProgress {
166    /// Notify that headers have been received
167    HeadersReceived(GenerationId, Option<HeaderMap>, HttpStatus),
168    /// Partial progress (after receiving headers), containing portion of the response
169    Loading(GenerationId, Vec<u8>),
170    /// Loading is done
171    Done(GenerationId),
172    /// There was an error (only Error::Abort(None), Error::Timeout(None) or Error::Network(None) is used)
173    Errored(GenerationId, Error),
174}
175
176impl XHRProgress {
177    fn generation_id(&self) -> GenerationId {
178        match *self {
179            XHRProgress::HeadersReceived(id, _, _) |
180            XHRProgress::Loading(id, _) |
181            XHRProgress::Done(id) |
182            XHRProgress::Errored(id, _) => id,
183        }
184    }
185}
186
187#[dom_struct]
188pub(crate) struct XMLHttpRequest {
189    eventtarget: XMLHttpRequestEventTarget,
190    ready_state: Cell<XMLHttpRequestState>,
191    timeout: Cell<Duration>,
192    with_credentials: Cell<bool>,
193    upload: Dom<XMLHttpRequestUpload>,
194    response_url: DomRefCell<String>,
195    #[no_trace]
196    status: DomRefCell<HttpStatus>,
197    response: DomRefCell<Vec<u8>>,
198    response_type: Cell<XMLHttpRequestResponseType>,
199    response_xml: MutNullableDom<Document>,
200    response_blob: MutNullableDom<Blob>,
201    #[ignore_malloc_size_of = "mozjs"]
202    response_arraybuffer: HeapBufferSource<ArrayBufferU8>,
203    #[ignore_malloc_size_of = "Defined in rust-mozjs"]
204    response_json: Heap<JSVal>,
205    #[ignore_malloc_size_of = "Defined in hyper"]
206    #[no_trace]
207    response_headers: DomRefCell<HeaderMap>,
208    #[ignore_malloc_size_of = "Defined in hyper"]
209    #[no_trace]
210    override_mime_type: DomRefCell<Option<Mime>>,
211
212    // Associated concepts
213    #[ignore_malloc_size_of = "Defined in hyper"]
214    #[no_trace]
215    request_method: DomRefCell<Method>,
216    #[no_trace]
217    request_url: DomRefCell<Option<ServoUrl>>,
218    #[ignore_malloc_size_of = "Defined in hyper"]
219    #[no_trace]
220    request_headers: DomRefCell<HeaderMap>,
221    request_body_len: Cell<usize>,
222    sync: Cell<bool>,
223    upload_complete: Cell<bool>,
224    upload_listener: Cell<bool>,
225    send_flag: Cell<bool>,
226
227    timeout_cancel: DomRefCell<Option<OneshotTimerHandle>>,
228    fetch_time: Cell<Instant>,
229    generation_id: Cell<GenerationId>,
230    response_status: Cell<Result<(), ()>>,
231    #[no_trace]
232    referrer: Referrer,
233    #[no_trace]
234    referrer_policy: ReferrerPolicy,
235    canceller: DomRefCell<FetchCanceller>,
236}
237
238impl XMLHttpRequest {
239    fn new_inherited(global: &GlobalScope, can_gc: CanGc) -> XMLHttpRequest {
240        XMLHttpRequest {
241            eventtarget: XMLHttpRequestEventTarget::new_inherited(),
242            ready_state: Cell::new(XMLHttpRequestState::Unsent),
243            timeout: Cell::new(Duration::ZERO),
244            with_credentials: Cell::new(false),
245            upload: Dom::from_ref(&*XMLHttpRequestUpload::new(global, can_gc)),
246            response_url: DomRefCell::new(String::new()),
247            status: DomRefCell::new(HttpStatus::new_error()),
248            response: DomRefCell::new(vec![]),
249            response_type: Cell::new(XMLHttpRequestResponseType::_empty),
250            response_xml: Default::default(),
251            response_blob: Default::default(),
252            response_arraybuffer: HeapBufferSource::default(),
253            response_json: Heap::default(),
254            response_headers: DomRefCell::new(HeaderMap::new()),
255            override_mime_type: DomRefCell::new(None),
256
257            request_method: DomRefCell::new(Method::GET),
258            request_url: DomRefCell::new(None),
259            request_headers: DomRefCell::new(HeaderMap::new()),
260            request_body_len: Cell::new(0),
261            sync: Cell::new(false),
262            upload_complete: Cell::new(false),
263            upload_listener: Cell::new(false),
264            send_flag: Cell::new(false),
265
266            timeout_cancel: DomRefCell::new(None),
267            fetch_time: Cell::new(Instant::now()),
268            generation_id: Cell::new(GenerationId(0)),
269            response_status: Cell::new(Ok(())),
270            referrer: global.get_referrer(),
271            referrer_policy: global.get_referrer_policy(),
272            canceller: DomRefCell::new(Default::default()),
273        }
274    }
275
276    fn new(
277        global: &GlobalScope,
278        proto: Option<HandleObject>,
279        can_gc: CanGc,
280    ) -> DomRoot<XMLHttpRequest> {
281        reflect_dom_object_with_proto(
282            Box::new(XMLHttpRequest::new_inherited(global, can_gc)),
283            global,
284            proto,
285            can_gc,
286        )
287    }
288
289    fn sync_in_window(&self) -> bool {
290        self.sync.get() && self.global().is::<Window>()
291    }
292}
293
294impl XMLHttpRequestMethods<crate::DomTypeHolder> for XMLHttpRequest {
295    /// <https://xhr.spec.whatwg.org/#constructors>
296    fn Constructor(
297        global: &GlobalScope,
298        proto: Option<HandleObject>,
299        can_gc: CanGc,
300    ) -> Fallible<DomRoot<XMLHttpRequest>> {
301        Ok(XMLHttpRequest::new(global, proto, can_gc))
302    }
303
304    // https://xhr.spec.whatwg.org/#handler-xhr-onreadystatechange
305    event_handler!(
306        readystatechange,
307        GetOnreadystatechange,
308        SetOnreadystatechange
309    );
310
311    /// <https://xhr.spec.whatwg.org/#dom-xmlhttprequest-readystate>
312    fn ReadyState(&self) -> u16 {
313        self.ready_state.get() as u16
314    }
315
316    /// <https://xhr.spec.whatwg.org/#the-open()-method>
317    fn Open(&self, method: ByteString, url: USVString) -> ErrorResult {
318        // Step 8
319        self.Open_(method, url, true, None, None)
320    }
321
322    /// <https://xhr.spec.whatwg.org/#the-open()-method>
323    fn Open_(
324        &self,
325        method: ByteString,
326        url: USVString,
327        asynch: bool,
328        username: Option<USVString>,
329        password: Option<USVString>,
330    ) -> ErrorResult {
331        // Step 1
332        if let Some(window) = DomRoot::downcast::<Window>(self.global()) {
333            if !window.Document().is_fully_active() {
334                return Err(Error::InvalidState(None));
335            }
336        }
337
338        // Step 5
339        // FIXME(seanmonstar): use a Trie instead?
340        let maybe_method = method.as_str().and_then(|s| {
341            // Note: hyper tests against the uppercase versions
342            // Since we want to pass methods not belonging to the short list above
343            // without changing capitalization, this will actually sidestep rust-http's type system
344            // since methods like "patch" or "PaTcH" will be considered extension methods
345            // despite the there being a rust-http method variant for them
346            let upper = s.to_ascii_uppercase();
347            match &*upper {
348                "DELETE" | "GET" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "CONNECT" | "TRACE" |
349                "TRACK" => upper.parse().ok(),
350                _ => s.parse().ok(),
351            }
352        });
353
354        match maybe_method {
355            // Step 4
356            Some(Method::CONNECT) | Some(Method::TRACE) => Err(Error::Security(None)),
357            Some(ref t) if t.as_str() == "TRACK" => Err(Error::Security(None)),
358            Some(parsed_method) => {
359                // Step 3
360                if !is_token(&method) {
361                    return Err(Error::Syntax(None));
362                }
363
364                // Step 2
365                let base = self.global().api_base_url();
366                // Step 6
367                let mut parsed_url = match base.join(&url.0) {
368                    Ok(parsed) => parsed,
369                    // Step 7
370                    Err(_) => return Err(Error::Syntax(None)),
371                };
372
373                // Step 9
374                if parsed_url.host().is_some() {
375                    if let Some(user_str) = username {
376                        parsed_url.set_username(&user_str.0).unwrap();
377                    }
378                    if let Some(pass_str) = password {
379                        parsed_url.set_password(Some(&pass_str.0)).unwrap();
380                    }
381                }
382
383                // Step 10
384                if !asynch {
385                    // FIXME: This should only happen if the global environment is a document environment
386                    if !self.timeout.get().is_zero() ||
387                        self.response_type.get() != XMLHttpRequestResponseType::_empty
388                    {
389                        return Err(Error::InvalidAccess(None));
390                    }
391                }
392                // Step 11 - abort existing requests
393                self.terminate_ongoing_fetch();
394
395                // FIXME(#13767): In the WPT test: FileAPI/blob/Blob-XHR-revoke.html,
396                // the xhr.open(url) is expected to hold a reference to the URL,
397                // thus renders following revocations invalid. Though we won't
398                // implement this for now, if ever needed, we should check blob
399                // scheme and trigger corresponding actions here.
400
401                // Step 12
402                *self.request_method.borrow_mut() = parsed_method;
403                *self.request_url.borrow_mut() = Some(parsed_url);
404                self.sync.set(!asynch);
405                *self.request_headers.borrow_mut() = HeaderMap::new();
406                self.send_flag.set(false);
407                self.upload_listener.set(false);
408                *self.status.borrow_mut() = HttpStatus::new_error();
409
410                // Step 13
411                if self.ready_state.get() != XMLHttpRequestState::Opened {
412                    self.change_ready_state(XMLHttpRequestState::Opened, CanGc::note());
413                }
414                Ok(())
415            },
416            // Step 3
417            // This includes cases where as_str() returns None, and when is_token() returns false,
418            // both of which indicate invalid extension method names
419            _ => Err(Error::Syntax(None)),
420        }
421    }
422
423    /// <https://xhr.spec.whatwg.org/#the-setrequestheader()-method>
424    fn SetRequestHeader(&self, name: ByteString, value: ByteString) -> ErrorResult {
425        // Step 1: If this’s state is not opened, then throw an "InvalidStateError" DOMException.
426        // Step 2: If this’s send() flag is set, then throw an "InvalidStateError" DOMException.
427        if self.ready_state.get() != XMLHttpRequestState::Opened || self.send_flag.get() {
428            return Err(Error::InvalidState(None));
429        }
430
431        // Step 3: Normalize value.
432        let value = trim_http_whitespace(&value);
433
434        // Step 4: If name is not a header name or value is not a header value, then throw a
435        // "SyntaxError" DOMException.
436        if !is_token(&name) || !is_field_value(value) {
437            return Err(Error::Syntax(None));
438        }
439
440        let name_str = name.as_str().ok_or(Error::Syntax(None))?;
441
442        // Step 5: If (name, value) is a forbidden request-header, then return.
443        if is_forbidden_request_header(name_str, value) {
444            return Ok(());
445        }
446
447        debug!(
448            "SetRequestHeader: name={:?}, value={:?}",
449            name_str,
450            str::from_utf8(value).ok()
451        );
452        let mut headers = self.request_headers.borrow_mut();
453
454        // Step 6: Combine (name, value) in this’s author request headers.
455        // https://fetch.spec.whatwg.org/#concept-header-list-combine
456        let value = match headers.get(name_str).map(HeaderValue::as_bytes) {
457            Some(raw) => {
458                let mut buf = raw.to_vec();
459                buf.extend_from_slice(b", ");
460                buf.extend_from_slice(value);
461                buf
462            },
463            None => value.into(),
464        };
465
466        headers.insert(
467            HeaderName::from_str(name_str).unwrap(),
468            HeaderValue::from_bytes(&value).unwrap(),
469        );
470        Ok(())
471    }
472
473    /// <https://xhr.spec.whatwg.org/#the-timeout-attribute>
474    fn Timeout(&self) -> u32 {
475        self.timeout.get().as_millis() as u32
476    }
477
478    /// <https://xhr.spec.whatwg.org/#the-timeout-attribute>
479    fn SetTimeout(&self, timeout: u32) -> ErrorResult {
480        // Step 1
481        if self.sync_in_window() {
482            return Err(Error::InvalidAccess(None));
483        }
484
485        // Step 2
486        let timeout = Duration::from_millis(timeout as u64);
487        self.timeout.set(timeout);
488
489        if self.send_flag.get() {
490            if timeout.is_zero() {
491                self.cancel_timeout();
492                return Ok(());
493            }
494            let progress = Instant::now() - self.fetch_time.get();
495            if timeout > progress {
496                self.set_timeout(timeout - progress);
497            } else {
498                // Immediately execute the timeout steps
499                self.set_timeout(Duration::ZERO);
500            }
501        }
502        Ok(())
503    }
504
505    /// <https://xhr.spec.whatwg.org/#the-withcredentials-attribute>
506    fn WithCredentials(&self) -> bool {
507        self.with_credentials.get()
508    }
509
510    /// <https://xhr.spec.whatwg.org/#dom-xmlhttprequest-withcredentials>
511    fn SetWithCredentials(&self, with_credentials: bool) -> ErrorResult {
512        match self.ready_state.get() {
513            // Step 1
514            XMLHttpRequestState::HeadersReceived |
515            XMLHttpRequestState::Loading |
516            XMLHttpRequestState::Done => Err(Error::InvalidState(None)),
517            // Step 2
518            _ if self.send_flag.get() => Err(Error::InvalidState(None)),
519            // Step 3
520            _ => {
521                self.with_credentials.set(with_credentials);
522                Ok(())
523            },
524        }
525    }
526
527    /// <https://xhr.spec.whatwg.org/#the-upload-attribute>
528    fn Upload(&self) -> DomRoot<XMLHttpRequestUpload> {
529        DomRoot::from_ref(&*self.upload)
530    }
531
532    /// <https://xhr.spec.whatwg.org/#dom-xmlhttprequest-send>
533    fn Send(
534        &self,
535        cx: &mut js::context::JSContext,
536        data: Option<DocumentOrXMLHttpRequestBodyInit>,
537    ) -> ErrorResult {
538        let can_gc = CanGc::from_cx(cx);
539        // Step 1, 2
540        if self.ready_state.get() != XMLHttpRequestState::Opened || self.send_flag.get() {
541            return Err(Error::InvalidState(None));
542        }
543
544        // Step 3
545        let data = match *self.request_method.borrow() {
546            Method::GET | Method::HEAD => None,
547            _ => data,
548        };
549        // Step 4 (first half)
550        let mut extracted_or_serialized = match data {
551            Some(DocumentOrXMLHttpRequestBodyInit::Document(ref doc)) => {
552                let bytes = Vec::from(&*serialize_document(doc)?.as_bytes());
553                let content_type = if doc.is_html_document() {
554                    "text/html;charset=UTF-8"
555                } else {
556                    "application/xml;charset=UTF-8"
557                };
558                let total_bytes = bytes.len();
559                let global = self.global();
560                let stream = ReadableStream::new_from_bytes(&global, bytes, can_gc)?;
561                Some(ExtractedBody {
562                    stream,
563                    total_bytes: Some(total_bytes),
564                    content_type: Some(DOMString::from(content_type)),
565                    source: BodySource::Object,
566                })
567            },
568            Some(DocumentOrXMLHttpRequestBodyInit::Blob(ref b)) => {
569                let extracted_body = b
570                    .extract(&self.global(), false, can_gc)
571                    .expect("Couldn't extract body.");
572                if !extracted_body.in_memory() && self.sync.get() {
573                    warn!("Sync XHR with not in-memory Blob as body not supported");
574                    None
575                } else {
576                    Some(extracted_body)
577                }
578            },
579            Some(DocumentOrXMLHttpRequestBodyInit::FormData(ref formdata)) => Some(
580                formdata
581                    .extract(&self.global(), false, can_gc)
582                    .expect("Couldn't extract body."),
583            ),
584            Some(DocumentOrXMLHttpRequestBodyInit::String(ref str)) => Some(
585                str.extract(&self.global(), false, can_gc)
586                    .expect("Couldn't extract body."),
587            ),
588            Some(DocumentOrXMLHttpRequestBodyInit::URLSearchParams(ref urlsp)) => Some(
589                urlsp
590                    .extract(&self.global(), false, can_gc)
591                    .expect("Couldn't extract body."),
592            ),
593            Some(DocumentOrXMLHttpRequestBodyInit::ArrayBuffer(ref typedarray)) => {
594                let bytes = typedarray.to_vec();
595                let total_bytes = bytes.len();
596                let global = self.global();
597                let stream = ReadableStream::new_from_bytes(&global, bytes, can_gc)?;
598                Some(ExtractedBody {
599                    stream,
600                    total_bytes: Some(total_bytes),
601                    content_type: None,
602                    source: BodySource::Object,
603                })
604            },
605            Some(DocumentOrXMLHttpRequestBodyInit::ArrayBufferView(ref typedarray)) => {
606                let bytes = typedarray.to_vec();
607                let total_bytes = bytes.len();
608                let global = self.global();
609                let stream = ReadableStream::new_from_bytes(&global, bytes, can_gc)?;
610                Some(ExtractedBody {
611                    stream,
612                    total_bytes: Some(total_bytes),
613                    content_type: None,
614                    source: BodySource::Object,
615                })
616            },
617            None => None,
618        };
619
620        self.request_body_len.set(
621            extracted_or_serialized
622                .as_ref()
623                .map_or(0, |e| e.total_bytes.unwrap_or(0)),
624        );
625
626        // Step 5
627        // If we dont have data to upload, we dont want to emit events
628        let has_handlers = self.upload.upcast::<EventTarget>().has_handlers();
629        self.upload_listener.set(has_handlers && data.is_some());
630
631        // todo preserved headers?
632
633        // Step 7
634        self.upload_complete.set(false);
635        // Step 8
636        // FIXME handle the 'timed out flag'
637        // Step 9
638        self.upload_complete.set(extracted_or_serialized.is_none());
639        // Step 10
640        self.send_flag.set(true);
641
642        // Step 11
643        if !self.sync.get() {
644            // If one of the event handlers below aborts the fetch by calling
645            // abort or open we will need the current generation id to detect it.
646            // Substep 1
647            let gen_id = self.generation_id.get();
648            self.dispatch_response_progress_event(atom!("loadstart"), can_gc);
649            if self.generation_id.get() != gen_id {
650                return Ok(());
651            }
652            // Substep 2
653            if !self.upload_complete.get() && self.upload_listener.get() {
654                self.dispatch_upload_progress_event(atom!("loadstart"), Ok(Some(0)), can_gc);
655                if self.generation_id.get() != gen_id {
656                    return Ok(());
657                }
658            }
659        }
660
661        // Step 6
662        // TODO - set referrer_policy/referrer_url in request
663        let credentials_mode = if self.with_credentials.get() {
664            CredentialsMode::Include
665        } else {
666            CredentialsMode::CredentialsSameOrigin
667        };
668        let use_url_credentials = if let Some(ref url) = *self.request_url.borrow() {
669            !url.username().is_empty() || url.password().is_some()
670        } else {
671            unreachable!()
672        };
673
674        let content_type = match extracted_or_serialized.as_mut() {
675            Some(body) => body.content_type.take(),
676            None => None,
677        };
678
679        let global = self.global();
680        let mut request = RequestBuilder::new(
681            global.webview_id(),
682            self.request_url.borrow().clone().unwrap(),
683            self.referrer.clone(),
684        )
685        .method(self.request_method.borrow().clone())
686        .headers((*self.request_headers.borrow()).clone())
687        .unsafe_request(true)
688        // XXXManishearth figure out how to avoid this clone
689        .body(extracted_or_serialized.map(|e| e.into_net_request_body().0))
690        .synchronous(self.sync.get())
691        .mode(RequestMode::CorsMode)
692        .use_cors_preflight(self.upload_listener.get())
693        .credentials_mode(credentials_mode)
694        .use_url_credentials(use_url_credentials)
695        .with_global_scope(&global)
696        .referrer_policy(self.referrer_policy);
697
698        // step 4 (second half)
699        if let Some(content_type) = content_type {
700            let encoding = match data {
701                Some(DocumentOrXMLHttpRequestBodyInit::String(_)) |
702                Some(DocumentOrXMLHttpRequestBodyInit::Document(_)) =>
703                // XHR spec differs from http, and says UTF-8 should be in capitals,
704                // instead of "utf-8", which is what Hyper defaults to. So not
705                // using content types provided by Hyper.
706                {
707                    Some("UTF-8")
708                },
709                _ => None,
710            };
711
712            let mut content_type_set = false;
713            if !request.headers.contains_key(header::CONTENT_TYPE) {
714                request.headers.insert(
715                    header::CONTENT_TYPE,
716                    HeaderValue::from_str(&content_type.str()).unwrap(),
717                );
718                content_type_set = true;
719            }
720
721            if !content_type_set {
722                let ct = request.headers.typed_get::<ContentType>();
723                if let Some(ct) = ct {
724                    if let Some(encoding) = encoding {
725                        let mime: Mime = ct.to_string().parse().unwrap();
726                        for param in mime.parameters.iter() {
727                            if param.0 == CHARSET && !param.1.eq_ignore_ascii_case(encoding) {
728                                let params_iter = mime.parameters.iter();
729                                let new_params: Vec<(String, String)> = params_iter
730                                    .filter(|p| p.0 != CHARSET)
731                                    .map(|p| (p.0.clone(), p.1.clone()))
732                                    .collect();
733
734                                let new_mime = format!(
735                                    "{}/{};charset={}{}{}",
736                                    mime.type_,
737                                    mime.subtype,
738                                    encoding,
739                                    if new_params.is_empty() { "" } else { "; " },
740                                    new_params
741                                        .iter()
742                                        .map(|p| format!("{}={}", p.0, p.1))
743                                        .collect::<Vec<String>>()
744                                        .join("; ")
745                                );
746
747                                request.headers.insert(
748                                    header::CONTENT_TYPE,
749                                    HeaderValue::from_str(&new_mime).unwrap(),
750                                );
751                            }
752                        }
753                    }
754                }
755            }
756        }
757
758        self.fetch_time.set(Instant::now());
759
760        let rv = self.fetch(cx, request, &self.global());
761        // Step 10
762        if self.sync.get() {
763            return rv;
764        }
765
766        let timeout = self.timeout.get();
767        if timeout > Duration::ZERO {
768            self.set_timeout(timeout);
769        }
770        Ok(())
771    }
772
773    /// <https://xhr.spec.whatwg.org/#the-abort()-method>
774    fn Abort(&self, can_gc: CanGc) {
775        // Step 1
776        self.terminate_ongoing_fetch();
777        // Step 2
778        let state = self.ready_state.get();
779        if (state == XMLHttpRequestState::Opened && self.send_flag.get()) ||
780            state == XMLHttpRequestState::HeadersReceived ||
781            state == XMLHttpRequestState::Loading
782        {
783            let gen_id = self.generation_id.get();
784            self.process_partial_response(XHRProgress::Errored(gen_id, Error::Abort(None)), can_gc);
785            // If open was called in one of the handlers invoked by the
786            // above call then we should terminate the abort sequence
787            if self.generation_id.get() != gen_id {
788                return;
789            }
790        }
791        // Step 3
792        if self.ready_state.get() == XMLHttpRequestState::Done {
793            self.change_ready_state(XMLHttpRequestState::Unsent, can_gc);
794            self.response_status.set(Err(()));
795            *self.status.borrow_mut() = HttpStatus::new_error();
796            self.response.borrow_mut().clear();
797            self.response_headers.borrow_mut().clear();
798        }
799    }
800
801    /// <https://xhr.spec.whatwg.org/#the-responseurl-attribute>
802    fn ResponseURL(&self) -> USVString {
803        USVString(self.response_url.borrow().clone())
804    }
805
806    /// <https://xhr.spec.whatwg.org/#the-status-attribute>
807    fn Status(&self) -> u16 {
808        self.status.borrow().raw_code()
809    }
810
811    /// <https://xhr.spec.whatwg.org/#the-statustext-attribute>
812    fn StatusText(&self) -> ByteString {
813        ByteString::new(self.status.borrow().message().to_vec())
814    }
815
816    /// <https://xhr.spec.whatwg.org/#the-getresponseheader()-method>
817    fn GetResponseHeader(&self, name: ByteString) -> Option<ByteString> {
818        let headers = self.filter_response_headers();
819        let headers = headers.get_all(HeaderName::from_str(&name.as_str()?.to_lowercase()).ok()?);
820        let mut first = true;
821        let s = headers.iter().fold(Vec::new(), |mut vec, value| {
822            if !first {
823                vec.extend(", ".as_bytes());
824            }
825            if let Ok(v) = str::from_utf8(value.as_bytes()).map(|s| s.trim().as_bytes()) {
826                vec.extend(v);
827                first = false;
828            }
829            vec
830        });
831
832        // There was no header with that name so we never got to change that value
833        if first {
834            None
835        } else {
836            Some(ByteString::new(s))
837        }
838    }
839
840    /// <https://xhr.spec.whatwg.org/#the-getallresponseheaders()-method>
841    fn GetAllResponseHeaders(&self) -> ByteString {
842        let headers = self.filter_response_headers();
843        let keys = headers.keys();
844        let v = keys.fold(Vec::new(), |mut vec, k| {
845            let values = headers.get_all(k);
846            vec.extend(k.as_str().as_bytes());
847            vec.extend(": ".as_bytes());
848            let mut first = true;
849            for value in values {
850                if !first {
851                    vec.extend(", ".as_bytes());
852                    first = false;
853                }
854                vec.extend(value.as_bytes());
855            }
856            vec.extend("\r\n".as_bytes());
857            vec
858        });
859
860        ByteString::new(v)
861    }
862
863    /// <https://xhr.spec.whatwg.org/#the-overridemimetype()-method>
864    fn OverrideMimeType(&self, mime: DOMString) -> ErrorResult {
865        // 1. If this’s state is loading or done, then throw an "InvalidStateError"
866        //   DOMException.
867        match self.ready_state.get() {
868            XMLHttpRequestState::Loading | XMLHttpRequestState::Done => {
869                return Err(Error::InvalidState(None));
870            },
871            _ => {},
872        }
873
874        // 2. Set this’s override MIME type to the result of parsing mime.
875        // 3. If this’s override MIME type is failure, then set this’s override MIME type
876        //    to application/octet-stream.
877        let override_mime = match mime.parse::<Mime>() {
878            Ok(mime) => mime,
879            Err(_) => "application/octet-stream"
880                .parse::<Mime>()
881                .map_err(|_| Error::Syntax(None))?,
882        };
883
884        *self.override_mime_type.borrow_mut() = Some(override_mime);
885        Ok(())
886    }
887
888    /// <https://xhr.spec.whatwg.org/#the-responsetype-attribute>
889    fn ResponseType(&self) -> XMLHttpRequestResponseType {
890        self.response_type.get()
891    }
892
893    /// <https://xhr.spec.whatwg.org/#the-responsetype-attribute>
894    fn SetResponseType(&self, response_type: XMLHttpRequestResponseType) -> ErrorResult {
895        // Step 1
896        if self.global().is::<WorkerGlobalScope>() &&
897            response_type == XMLHttpRequestResponseType::Document
898        {
899            return Ok(());
900        }
901        match self.ready_state.get() {
902            // Step 2
903            XMLHttpRequestState::Loading | XMLHttpRequestState::Done => {
904                Err(Error::InvalidState(None))
905            },
906            _ => {
907                if self.sync_in_window() {
908                    // Step 3
909                    Err(Error::InvalidAccess(None))
910                } else {
911                    // Step 4
912                    self.response_type.set(response_type);
913                    Ok(())
914                }
915            },
916        }
917    }
918
919    /// <https://xhr.spec.whatwg.org/#the-response-attribute>
920    fn Response(&self, cx: JSContext, can_gc: CanGc, mut rval: MutableHandleValue) {
921        match self.response_type.get() {
922            XMLHttpRequestResponseType::_empty | XMLHttpRequestResponseType::Text => {
923                let ready_state = self.ready_state.get();
924                // Step 2
925                if ready_state == XMLHttpRequestState::Done ||
926                    ready_state == XMLHttpRequestState::Loading
927                {
928                    self.text_response().safe_to_jsval(cx, rval, can_gc);
929                } else {
930                    // Step 1
931                    "".safe_to_jsval(cx, rval, can_gc);
932                }
933            },
934            // Step 1
935            _ if self.ready_state.get() != XMLHttpRequestState::Done => {
936                rval.set(NullValue());
937            },
938            // Step 2
939            XMLHttpRequestResponseType::Document => self
940                .document_response(can_gc)
941                .safe_to_jsval(cx, rval, can_gc),
942            XMLHttpRequestResponseType::Json => self.json_response(cx, rval),
943            XMLHttpRequestResponseType::Blob => {
944                self.blob_response(can_gc).safe_to_jsval(cx, rval, can_gc)
945            },
946            XMLHttpRequestResponseType::Arraybuffer => {
947                match self.arraybuffer_response(cx, can_gc) {
948                    Some(array_buffer) => array_buffer.safe_to_jsval(cx, rval, can_gc),
949                    None => rval.set(NullValue()),
950                }
951            },
952        }
953    }
954
955    /// <https://xhr.spec.whatwg.org/#the-responsetext-attribute>
956    fn GetResponseText(&self) -> Fallible<USVString> {
957        match self.response_type.get() {
958            XMLHttpRequestResponseType::_empty | XMLHttpRequestResponseType::Text => {
959                Ok(USVString(match self.ready_state.get() {
960                    // Step 3
961                    XMLHttpRequestState::Loading | XMLHttpRequestState::Done => {
962                        self.text_response()
963                    },
964                    // Step 2
965                    _ => "".to_owned(),
966                }))
967            },
968            // Step 1
969            _ => Err(Error::InvalidState(None)),
970        }
971    }
972
973    /// <https://xhr.spec.whatwg.org/#the-responsexml-attribute>
974    fn GetResponseXML(&self, can_gc: CanGc) -> Fallible<Option<DomRoot<Document>>> {
975        match self.response_type.get() {
976            XMLHttpRequestResponseType::_empty | XMLHttpRequestResponseType::Document => {
977                // Step 3
978                if let XMLHttpRequestState::Done = self.ready_state.get() {
979                    Ok(self.document_response(can_gc))
980                } else {
981                    // Step 2
982                    Ok(None)
983                }
984            },
985            // Step 1
986            _ => Err(Error::InvalidState(None)),
987        }
988    }
989}
990
991pub(crate) type TrustedXHRAddress = Trusted<XMLHttpRequest>;
992
993impl XMLHttpRequest {
994    fn change_ready_state(&self, rs: XMLHttpRequestState, can_gc: CanGc) {
995        assert_ne!(self.ready_state.get(), rs);
996        self.ready_state.set(rs);
997        if rs != XMLHttpRequestState::Unsent {
998            let event = Event::new(
999                &self.global(),
1000                atom!("readystatechange"),
1001                EventBubbles::DoesNotBubble,
1002                EventCancelable::Cancelable,
1003                can_gc,
1004            );
1005            event.fire(self.upcast(), can_gc);
1006        }
1007    }
1008
1009    fn process_headers_available(
1010        &self,
1011        gen_id: GenerationId,
1012        metadata: Result<FetchMetadata, NetworkError>,
1013        can_gc: CanGc,
1014    ) -> Result<(), Error> {
1015        let metadata = match metadata {
1016            Ok(meta) => match meta {
1017                FetchMetadata::Unfiltered(m) => m,
1018                FetchMetadata::Filtered { filtered, .. } => match filtered {
1019                    FilteredMetadata::Basic(m) => m,
1020                    FilteredMetadata::Cors(m) => m,
1021                    FilteredMetadata::Opaque => return Err(Error::Network(None)),
1022                    FilteredMetadata::OpaqueRedirect(_) => return Err(Error::Network(None)),
1023                },
1024            },
1025            Err(_) => {
1026                self.process_partial_response(
1027                    XHRProgress::Errored(gen_id, Error::Network(None)),
1028                    can_gc,
1029                );
1030                return Err(Error::Network(None));
1031            },
1032        };
1033
1034        metadata.final_url[..Position::AfterQuery].clone_into(&mut self.response_url.borrow_mut());
1035
1036        // XXXManishearth Clear cache entries in case of a network error
1037        self.process_partial_response(
1038            XHRProgress::HeadersReceived(
1039                gen_id,
1040                metadata.headers.map(Serde::into_inner),
1041                metadata.status,
1042            ),
1043            can_gc,
1044        );
1045        Ok(())
1046    }
1047
1048    fn process_data_available(&self, gen_id: GenerationId, payload: Vec<u8>, can_gc: CanGc) {
1049        self.process_partial_response(XHRProgress::Loading(gen_id, payload), can_gc);
1050    }
1051
1052    fn process_response_complete(
1053        &self,
1054        gen_id: GenerationId,
1055        status: Result<(), NetworkError>,
1056        can_gc: CanGc,
1057    ) -> ErrorResult {
1058        match status {
1059            Ok(()) => {
1060                self.process_partial_response(XHRProgress::Done(gen_id), can_gc);
1061                Ok(())
1062            },
1063            Err(_) => {
1064                self.process_partial_response(
1065                    XHRProgress::Errored(gen_id, Error::Network(None)),
1066                    can_gc,
1067                );
1068                Err(Error::Network(None))
1069            },
1070        }
1071    }
1072
1073    fn process_partial_response(&self, progress: XHRProgress, can_gc: CanGc) {
1074        let msg_id = progress.generation_id();
1075
1076        // Aborts processing if abort() or open() was called
1077        // (including from one of the event handlers called below)
1078        macro_rules! return_if_fetch_was_terminated(
1079            () => (
1080                if msg_id != self.generation_id.get() {
1081                    return
1082                }
1083            );
1084        );
1085
1086        // Ignore message if it belongs to a terminated fetch
1087        return_if_fetch_was_terminated!();
1088
1089        // Ignore messages coming from previously-errored responses or requests that have timed out
1090        if self.response_status.get().is_err() {
1091            return;
1092        }
1093
1094        match progress {
1095            XHRProgress::HeadersReceived(_, headers, status) => {
1096                assert!(self.ready_state.get() == XMLHttpRequestState::Opened);
1097                // For synchronous requests, this should not fire any events, and just store data
1098                // XXXManishearth Find a way to track partial progress of the send (onprogresss for XHRUpload)
1099
1100                // Part of step 13, send() (processing request end of file)
1101                // Substep 1
1102                self.upload_complete.set(true);
1103                // Substeps 2-4
1104                if !self.sync.get() && self.upload_listener.get() {
1105                    self.dispatch_upload_progress_event(atom!("progress"), Ok(None), can_gc);
1106                    return_if_fetch_was_terminated!();
1107                    self.dispatch_upload_progress_event(atom!("load"), Ok(None), can_gc);
1108                    return_if_fetch_was_terminated!();
1109                    self.dispatch_upload_progress_event(atom!("loadend"), Ok(None), can_gc);
1110                    return_if_fetch_was_terminated!();
1111                }
1112                // Part of step 13, send() (processing response)
1113                // XXXManishearth handle errors, if any (substep 1)
1114                // Substep 2
1115                if !status.is_error() {
1116                    *self.status.borrow_mut() = status.clone();
1117                }
1118                if let Some(h) = headers.as_ref() {
1119                    *self.response_headers.borrow_mut() = h.clone();
1120                }
1121                {
1122                    let len = headers.and_then(|h| h.typed_get::<ContentLength>());
1123                    let mut response = self.response.borrow_mut();
1124                    response.clear();
1125                    if let Some(len) = len {
1126                        // don't attempt to prereserve more than 4 MB of memory,
1127                        // to avoid giving servers the ability to DOS the client by
1128                        // providing arbitrarily large content-lengths.
1129                        //
1130                        // this number is arbitrary, it's basically big enough that most
1131                        // XHR requests won't hit it, but not so big that it allows for DOS
1132                        let size = cmp::min(0b100_0000000000_0000000000, len.0 as usize);
1133
1134                        // preallocate the buffer
1135                        response.reserve(size);
1136                    }
1137                }
1138                // Substep 3
1139                if !self.sync.get() {
1140                    self.change_ready_state(XMLHttpRequestState::HeadersReceived, can_gc);
1141                }
1142            },
1143            XHRProgress::Loading(_, mut partial_response) => {
1144                // For synchronous requests, this should not fire any events, and just store data
1145                // Part of step 11, send() (processing response body)
1146                // XXXManishearth handle errors, if any (substep 2)
1147
1148                self.response.borrow_mut().append(&mut partial_response);
1149                if !self.sync.get() {
1150                    if self.ready_state.get() == XMLHttpRequestState::HeadersReceived {
1151                        self.ready_state.set(XMLHttpRequestState::Loading);
1152                    }
1153                    let event = Event::new(
1154                        &self.global(),
1155                        atom!("readystatechange"),
1156                        EventBubbles::DoesNotBubble,
1157                        EventCancelable::Cancelable,
1158                        can_gc,
1159                    );
1160                    event.fire(self.upcast(), can_gc);
1161                    return_if_fetch_was_terminated!();
1162                    self.dispatch_response_progress_event(atom!("progress"), can_gc);
1163                }
1164            },
1165            XHRProgress::Done(_) => {
1166                assert!(
1167                    self.ready_state.get() == XMLHttpRequestState::HeadersReceived ||
1168                        self.ready_state.get() == XMLHttpRequestState::Loading ||
1169                        self.sync.get()
1170                );
1171
1172                self.cancel_timeout();
1173                self.canceller.borrow_mut().ignore();
1174
1175                // Part of step 11, send() (processing response end of file)
1176                // XXXManishearth handle errors, if any (substep 2)
1177
1178                // Subsubsteps 6-8
1179                self.send_flag.set(false);
1180
1181                self.change_ready_state(XMLHttpRequestState::Done, can_gc);
1182                return_if_fetch_was_terminated!();
1183                // Subsubsteps 11-12
1184                self.dispatch_response_progress_event(atom!("load"), can_gc);
1185                return_if_fetch_was_terminated!();
1186                self.dispatch_response_progress_event(atom!("loadend"), can_gc);
1187            },
1188            XHRProgress::Errored(_, e) => {
1189                self.cancel_timeout();
1190                self.canceller.borrow_mut().ignore();
1191
1192                self.discard_subsequent_responses();
1193                self.send_flag.set(false);
1194                *self.status.borrow_mut() = HttpStatus::new_error();
1195                self.response_headers.borrow_mut().clear();
1196                // XXXManishearth set response to NetworkError
1197                self.change_ready_state(XMLHttpRequestState::Done, can_gc);
1198                return_if_fetch_was_terminated!();
1199
1200                let errormsg = match e {
1201                    Error::Abort(None) => "abort",
1202                    Error::Timeout(None) => "timeout",
1203                    _ => "error",
1204                };
1205
1206                let upload_complete = &self.upload_complete;
1207                if !upload_complete.get() {
1208                    upload_complete.set(true);
1209                    if self.upload_listener.get() {
1210                        self.dispatch_upload_progress_event(Atom::from(errormsg), Err(()), can_gc);
1211                        return_if_fetch_was_terminated!();
1212                        self.dispatch_upload_progress_event(atom!("loadend"), Err(()), can_gc);
1213                        return_if_fetch_was_terminated!();
1214                    }
1215                }
1216                self.dispatch_response_progress_event(Atom::from(errormsg), can_gc);
1217                return_if_fetch_was_terminated!();
1218                self.dispatch_response_progress_event(atom!("loadend"), can_gc);
1219            },
1220        }
1221    }
1222
1223    fn terminate_ongoing_fetch(&self) {
1224        self.canceller.borrow_mut().abort();
1225        let GenerationId(prev_id) = self.generation_id.get();
1226        self.generation_id.set(GenerationId(prev_id + 1));
1227        self.response_status.set(Ok(()));
1228    }
1229
1230    fn dispatch_progress_event(
1231        &self,
1232        upload: bool,
1233        type_: Atom,
1234        loaded: u64,
1235        total: Option<u64>,
1236        can_gc: CanGc,
1237    ) {
1238        let (total_length, length_computable) = if self
1239            .response_headers
1240            .borrow()
1241            .contains_key(header::CONTENT_ENCODING)
1242        {
1243            (0, false)
1244        } else {
1245            (total.unwrap_or(0), total.is_some())
1246        };
1247        let progressevent = ProgressEvent::new(
1248            &self.global(),
1249            type_,
1250            EventBubbles::DoesNotBubble,
1251            EventCancelable::NotCancelable,
1252            length_computable,
1253            Finite::wrap(loaded as f64),
1254            Finite::wrap(total_length as f64),
1255            can_gc,
1256        );
1257        let target = if upload {
1258            self.upload.upcast()
1259        } else {
1260            self.upcast()
1261        };
1262        progressevent.upcast::<Event>().fire(target, can_gc);
1263    }
1264
1265    fn dispatch_upload_progress_event(
1266        &self,
1267        type_: Atom,
1268        partial_load: Result<Option<u64>, ()>,
1269        can_gc: CanGc,
1270    ) {
1271        // If partial_load is Ok(None), loading has completed and we can just use the value from the request body
1272        // If an error occurred, we pass 0 for both loaded and total
1273
1274        let request_body_len = self.request_body_len.get() as u64;
1275        let (loaded, total) = match partial_load {
1276            Ok(l) => match l {
1277                Some(loaded) => (loaded, Some(request_body_len)),
1278                None => (request_body_len, Some(request_body_len)),
1279            },
1280            Err(()) => (0, None),
1281        };
1282        self.dispatch_progress_event(true, type_, loaded, total, can_gc);
1283    }
1284
1285    fn dispatch_response_progress_event(&self, type_: Atom, can_gc: CanGc) {
1286        let len = self.response.borrow().len() as u64;
1287        let total = self
1288            .response_headers
1289            .borrow()
1290            .typed_get::<ContentLength>()
1291            .map(|v| v.0);
1292        self.dispatch_progress_event(false, type_, len, total, can_gc);
1293    }
1294
1295    fn set_timeout(&self, duration: Duration) {
1296        // Sets up the object to timeout in a given number of milliseconds
1297        // This will cancel all previous timeouts
1298        let callback = OneshotTimerCallback::XhrTimeout(XHRTimeoutCallback {
1299            xhr: Trusted::new(self),
1300            generation_id: self.generation_id.get(),
1301        });
1302        *self.timeout_cancel.borrow_mut() =
1303            Some(self.global().schedule_callback(callback, duration));
1304    }
1305
1306    fn cancel_timeout(&self) {
1307        if let Some(handle) = self.timeout_cancel.borrow_mut().take() {
1308            self.global().unschedule_callback(handle);
1309        }
1310    }
1311
1312    /// <https://xhr.spec.whatwg.org/#text-response>
1313    fn text_response(&self) -> String {
1314        // Step 3, 5
1315        let charset = self.final_charset().unwrap_or(UTF_8);
1316        // TODO: Step 4 - add support for XML encoding guess stuff using XML spec
1317
1318        // According to Simon, decode() should never return an error, so unwrap()ing
1319        // the result should be fine. XXXManishearth have a closer look at this later
1320        // Step 1, 2, 6
1321        let response = self.response.borrow();
1322        let (text, _, _) = charset.decode(&response);
1323        text.into_owned()
1324    }
1325
1326    /// <https://xhr.spec.whatwg.org/#blob-response>
1327    fn blob_response(&self, can_gc: CanGc) -> DomRoot<Blob> {
1328        // Step 1
1329        if let Some(response) = self.response_blob.get() {
1330            return response;
1331        }
1332        // Step 2
1333        let mime = normalize_type_string(&self.final_mime_type().to_string());
1334
1335        // Step 3, 4
1336        let bytes = self.response.borrow().to_vec();
1337        let blob = Blob::new(
1338            &self.global(),
1339            BlobImpl::new_from_bytes(bytes, mime),
1340            can_gc,
1341        );
1342        self.response_blob.set(Some(&blob));
1343        blob
1344    }
1345
1346    /// <https://xhr.spec.whatwg.org/#arraybuffer-response>
1347    fn arraybuffer_response(
1348        &self,
1349        cx: JSContext,
1350        can_gc: CanGc,
1351    ) -> Option<RootedTraceableBox<HeapArrayBuffer>> {
1352        // Step 5: Set the response object to a new ArrayBuffer with the received bytes
1353        // For caching purposes, skip this step if the response is already created
1354        if !self.response_arraybuffer.is_initialized() {
1355            let bytes = self.response.borrow();
1356
1357            // If this is not successful, the response won't be set and the function will return None
1358            self.response_arraybuffer
1359                .set_data(cx, &bytes, can_gc)
1360                .ok()?;
1361        }
1362
1363        // Return the correct ArrayBuffer
1364        self.response_arraybuffer.get_typed_array().ok()
1365    }
1366
1367    /// <https://xhr.spec.whatwg.org/#document-response>
1368    fn document_response(&self, can_gc: CanGc) -> Option<DomRoot<Document>> {
1369        // Caching: if we have existing response xml, redirect it directly
1370        let response = self.response_xml.get();
1371        if response.is_some() {
1372            return response;
1373        }
1374
1375        // Step 1: If xhr’s response’s body is null, then return.
1376        if self.response_status.get().is_err() {
1377            return None;
1378        }
1379
1380        // Step 2: Let finalMIME be the result of get a final MIME type for xhr.
1381        let final_mime = self.final_mime_type();
1382
1383        // Step 3: If finalMIME is not an HTML MIME type or an XML MIME type, then return.
1384        let is_xml_mime_type = final_mime.matches(TEXT, XML) ||
1385            final_mime.matches(APPLICATION, XML) ||
1386            final_mime.has_suffix(XML);
1387        if !final_mime.matches(TEXT, HTML) && !is_xml_mime_type {
1388            return None;
1389        }
1390
1391        // Step 4: If xhr’s response type is the empty string and finalMIME is an HTML MIME
1392        //         type, then return.
1393        let charset;
1394        let temp_doc;
1395        if final_mime.matches(TEXT, HTML) {
1396            if self.response_type.get() == XMLHttpRequestResponseType::_empty {
1397                return None;
1398            }
1399
1400            // Step 5: If finalMIME is an HTML MIME type, then:
1401            // Step 5.1: Let charset be the result of get a final encoding for xhr.
1402            // Step 5.2: If charset is null, prescan the first 1024 bytes of xhr’s received bytes
1403            // and if that does not terminate unsuccessfully then let charset be the return value.
1404            // TODO: This isn't happening right now.
1405            // Step 5.3. If charset is null, then set charset to UTF-8.
1406            charset = Some(self.final_charset().unwrap_or(UTF_8));
1407
1408            // Step 5.4: Let document be a document that represents the result parsing xhr’s
1409            // received bytes following the rules set forth in the HTML Standard for an HTML parser
1410            // with scripting disabled and a known definite encoding charset. [HTML]
1411            temp_doc = self.document_text_html(can_gc);
1412        } else {
1413            assert!(is_xml_mime_type);
1414
1415            // Step 6: Otherwise, let document be a document that represents the result of running
1416            // the XML parser with XML scripting support disabled on xhr’s received bytes. If that
1417            // fails (unsupported character encoding, namespace well-formedness error, etc.), then
1418            // return null. [HTML]
1419            //
1420            // TODO: The spec seems to suggest the charset should come from the XML parser here.
1421            temp_doc = self.handle_xml(can_gc);
1422            charset = self.final_charset();
1423
1424            // Not sure it the parser should throw an error for this case
1425            // The specification does not indicates this test,
1426            // but for now we check the document has no child nodes
1427            let has_no_child_nodes = temp_doc.upcast::<Node>().children().next().is_none();
1428            if has_no_child_nodes {
1429                return None;
1430            }
1431        }
1432
1433        // Step 7: If charset is null, then set charset to UTF-8.
1434        let charset = charset.unwrap_or(UTF_8);
1435
1436        // Step 8: Set document’s encoding to charset.
1437        temp_doc.set_encoding(charset);
1438
1439        // Step 9: Set document’s content type to finalMIME.
1440        // Step 10: Set document’s URL to xhr’s response’s URL.
1441        // Step 11: Set document’s origin to xhr’s relevant settings object’s origin.
1442        //
1443        // Done by `handle_text_html()` and `handle_xml()`.
1444
1445        // Step 12: Set xhr’s response object to document.
1446        self.response_xml.set(Some(&temp_doc));
1447        self.response_xml.get()
1448    }
1449
1450    #[expect(unsafe_code)]
1451    /// <https://xhr.spec.whatwg.org/#json-response>
1452    fn json_response(&self, cx: JSContext, mut rval: MutableHandleValue) {
1453        // Step 1
1454        let response_json = self.response_json.get();
1455        if !response_json.is_null_or_undefined() {
1456            return rval.set(response_json);
1457        }
1458        // Step 2
1459        let bytes = self.response.borrow();
1460        // Step 3
1461        if bytes.is_empty() {
1462            return rval.set(NullValue());
1463        }
1464        // Step 4
1465        // https://xhr.spec.whatwg.org/#json-response refers to
1466        // https://infra.spec.whatwg.org/#parse-json-from-bytes which refers to
1467        // https://encoding.spec.whatwg.org/#utf-8-decode which means
1468        // that the encoding is always UTF-8 and the UTF-8 BOM is removed,
1469        // if present, but UTF-16BE/LE BOM must not be honored.
1470        let json_text = decode_to_utf16_with_bom_removal(&bytes, UTF_8);
1471        // Step 5
1472        unsafe {
1473            if !JS_ParseJSON(
1474                *cx,
1475                json_text.as_ptr(),
1476                json_text.len() as u32,
1477                rval.reborrow(),
1478            ) {
1479                JS_ClearPendingException(*cx);
1480                return rval.set(NullValue());
1481            }
1482        }
1483        // Step 6
1484        self.response_json.set(rval.get());
1485    }
1486
1487    fn document_text_html(&self, can_gc: CanGc) -> DomRoot<Document> {
1488        let charset = self.final_charset().unwrap_or(UTF_8);
1489        let wr = self.global();
1490        let response = self.response.borrow();
1491        let (decoded, _, _) = charset.decode(&response);
1492        let document = self.new_doc(IsHTMLDocument::HTMLDocument, can_gc);
1493        // TODO: Disable scripting while parsing
1494        ServoParser::parse_html_document(
1495            &document,
1496            Some(DOMString::from(decoded)),
1497            wr.get_url(),
1498            None,
1499            None,
1500            can_gc,
1501        );
1502        document
1503    }
1504
1505    fn handle_xml(&self, can_gc: CanGc) -> DomRoot<Document> {
1506        let charset = self.final_charset().unwrap_or(UTF_8);
1507        let wr = self.global();
1508        let response = self.response.borrow();
1509        let (decoded, _, _) = charset.decode(&response);
1510        let document = self.new_doc(IsHTMLDocument::NonHTMLDocument, can_gc);
1511        // TODO: Disable scripting while parsing
1512        ServoParser::parse_xml_document(
1513            &document,
1514            Some(DOMString::from(decoded)),
1515            wr.get_url(),
1516            None,
1517            can_gc,
1518        );
1519        document
1520    }
1521
1522    fn new_doc(&self, is_html_document: IsHTMLDocument, can_gc: CanGc) -> DomRoot<Document> {
1523        let wr = self.global();
1524        let win = wr.as_window();
1525        let doc = win.Document();
1526        let docloader = DocumentLoader::new(&doc.loader());
1527        let base = wr.get_url();
1528        let parsed_url = base.join(&self.ResponseURL().0).ok();
1529        let content_type = Some(self.final_mime_type());
1530        Document::new(
1531            win,
1532            HasBrowsingContext::No,
1533            parsed_url,
1534            None,
1535            doc.origin().clone(),
1536            is_html_document,
1537            content_type,
1538            None,
1539            DocumentActivity::Inactive,
1540            DocumentSource::FromParser,
1541            docloader,
1542            None,
1543            None,
1544            Default::default(),
1545            false,
1546            false,
1547            Some(doc.insecure_requests_policy()),
1548            doc.has_trustworthy_ancestor_origin(),
1549            doc.custom_element_reaction_stack(),
1550            doc.creation_sandboxing_flag_set(),
1551            can_gc,
1552        )
1553    }
1554
1555    fn filter_response_headers(&self) -> HeaderMap {
1556        // https://fetch.spec.whatwg.org/#concept-response-header-list
1557        let mut headers = self.response_headers.borrow().clone();
1558        headers.remove(header::SET_COOKIE);
1559        headers.remove(HeaderName::from_static("set-cookie2"));
1560        // XXXManishearth additional CORS filtering goes here
1561        headers
1562    }
1563
1564    fn discard_subsequent_responses(&self) {
1565        self.response_status.set(Err(()));
1566    }
1567
1568    fn fetch(
1569        &self,
1570        cx: &mut js::context::JSContext,
1571        request_builder: RequestBuilder,
1572        global: &GlobalScope,
1573    ) -> ErrorResult {
1574        let xhr = Trusted::new(self);
1575
1576        let sync_status = Arc::new(AtomicRefCell::new(None));
1577        let context = XHRContext {
1578            xhr,
1579            gen_id: self.generation_id.get(),
1580            sync_status: sync_status.clone(),
1581            url: request_builder.url.clone(),
1582        };
1583
1584        let (task_source, script_port) = if self.sync.get() {
1585            let (sender, receiver) = global.new_script_pair();
1586            (
1587                SendableTaskSource {
1588                    sender,
1589                    pipeline_id: global.pipeline_id(),
1590                    name: TaskSourceName::Networking,
1591                    canceller: Default::default(),
1592                },
1593                Some(receiver),
1594            )
1595        } else {
1596            (
1597                global.task_manager().networking_task_source().to_sendable(),
1598                None,
1599            )
1600        };
1601
1602        *self.canceller.borrow_mut() =
1603            FetchCanceller::new(request_builder.id, false, global.core_resource_thread());
1604
1605        global.fetch(request_builder, context, task_source);
1606
1607        if let Some(script_port) = script_port {
1608            loop {
1609                if !global.process_event(script_port.recv().unwrap(), cx) {
1610                    // We're exiting.
1611                    return Err(Error::Abort(None));
1612                }
1613                if let Some(ref status) = *sync_status.borrow() {
1614                    return status.clone();
1615                }
1616            }
1617        }
1618        Ok(())
1619    }
1620
1621    /// <https://xhr.spec.whatwg.org/#final-charset>
1622    fn final_charset(&self) -> Option<&'static Encoding> {
1623        // 1. Let label be null.
1624        // 2. Let responseMIME be the result of get a response MIME type for xhr.
1625        // 3. If responseMIME’s parameters["charset"] exists, then set label to it.
1626        let response_charset = self
1627            .response_mime_type()
1628            .get_parameter(CHARSET)
1629            .map(ToString::to_string);
1630
1631        // 4. If xhr’s override MIME type’s parameters["charset"] exists, then set label to it.
1632        let override_charset = self
1633            .override_mime_type
1634            .borrow()
1635            .as_ref()
1636            .and_then(|mime| mime.get_parameter(CHARSET))
1637            .map(ToString::to_string);
1638
1639        // 5. If label is null, then return null.
1640        // 6. Let encoding be the result of getting an encoding from label.
1641        // 7. If encoding is failure, then return null.
1642        // 8. Return encoding.
1643        override_charset
1644            .or(response_charset)
1645            .and_then(|charset| Encoding::for_label(charset.as_bytes()))
1646    }
1647
1648    /// <https://xhr.spec.whatwg.org/#response-mime-type>
1649    fn response_mime_type(&self) -> Mime {
1650        // 1. Let mimeType be the result of extracting a MIME type from xhr’s response’s
1651        //    header list.
1652        // 2. If mimeType is failure, then set mimeType to text/xml.
1653        // 3. Return mimeType.
1654        extract_mime_type_as_dataurl_mime(&self.response_headers.borrow())
1655            .unwrap_or_else(|| Mime::new(TEXT, XML))
1656    }
1657
1658    /// <https://xhr.spec.whatwg.org/#final-mime-type>
1659    fn final_mime_type(&self) -> Mime {
1660        self.override_mime_type
1661            .borrow()
1662            .as_ref()
1663            .map(MimeExt::clone)
1664            .unwrap_or_else(|| self.response_mime_type())
1665    }
1666}
1667
1668#[derive(JSTraceable, MallocSizeOf)]
1669pub(crate) struct XHRTimeoutCallback {
1670    #[ignore_malloc_size_of = "Because it is non-owning"]
1671    xhr: Trusted<XMLHttpRequest>,
1672    generation_id: GenerationId,
1673}
1674
1675impl XHRTimeoutCallback {
1676    pub(crate) fn invoke(self, can_gc: CanGc) {
1677        let xhr = self.xhr.root();
1678        if xhr.ready_state.get() != XMLHttpRequestState::Done {
1679            xhr.process_partial_response(
1680                XHRProgress::Errored(self.generation_id, Error::Timeout(None)),
1681                can_gc,
1682            );
1683        }
1684    }
1685}
1686
1687fn serialize_document(doc: &Document) -> Fallible<DOMString> {
1688    let mut writer = vec![];
1689    match serialize(
1690        &mut writer,
1691        &HtmlSerialize::new(doc.upcast::<Node>()),
1692        SerializeOpts::default(),
1693    ) {
1694        Ok(_) => Ok(DOMString::from(String::from_utf8(writer).unwrap())),
1695        Err(_) => Err(Error::InvalidState(None)),
1696    }
1697}
1698
1699/// Returns whether `bs` is a `field-value`, as defined by
1700/// [RFC 2616](http://tools.ietf.org/html/rfc2616#page-32).
1701pub(crate) fn is_field_value(slice: &[u8]) -> bool {
1702    // Classifications of characters necessary for the [CRLF] (SP|HT) rule
1703    #[derive(PartialEq)]
1704    #[expect(clippy::upper_case_acronyms)]
1705    enum PreviousCharacter {
1706        Other,
1707        CR,
1708        LF,
1709        SPHT, // SP or HT
1710    }
1711    let mut prev = PreviousCharacter::Other; // The previous character
1712    slice.iter().all(|&x| {
1713        // http://tools.ietf.org/html/rfc2616#section-2.2
1714        match x {
1715            13 => {
1716                // CR
1717                if prev == PreviousCharacter::Other || prev == PreviousCharacter::SPHT {
1718                    prev = PreviousCharacter::CR;
1719                    true
1720                } else {
1721                    false
1722                }
1723            },
1724            10 => {
1725                // LF
1726                if prev == PreviousCharacter::CR {
1727                    prev = PreviousCharacter::LF;
1728                    true
1729                } else {
1730                    false
1731                }
1732            },
1733            32 => {
1734                // SP
1735                if prev == PreviousCharacter::LF || prev == PreviousCharacter::SPHT {
1736                    prev = PreviousCharacter::SPHT;
1737                    true
1738                } else if prev == PreviousCharacter::Other {
1739                    // Counts as an Other here, since it's not preceded by a CRLF
1740                    // SP is not a CTL, so it can be used anywhere
1741                    // though if used immediately after a CR the CR is invalid
1742                    // We don't change prev since it's already Other
1743                    true
1744                } else {
1745                    false
1746                }
1747            },
1748            9 => {
1749                // HT
1750                if prev == PreviousCharacter::LF || prev == PreviousCharacter::SPHT {
1751                    prev = PreviousCharacter::SPHT;
1752                    true
1753                } else {
1754                    false
1755                }
1756            },
1757            0..=31 | 127 => false, // CTLs
1758            x if x > 127 => false, // non ASCII
1759            _ if prev == PreviousCharacter::Other || prev == PreviousCharacter::SPHT => {
1760                prev = PreviousCharacter::Other;
1761                true
1762            },
1763            _ => false, // Previous character was a CR/LF but not part of the [CRLF] (SP|HT) rule
1764        }
1765    })
1766}