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