XMLHttpRequest.cpp 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265
  1. /*
  2. * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021-2023, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2022-2023, Luke Wilde <lukew@serenityos.org>
  5. * Copyright (c) 2022, Ali Mohammad Pur <mpfard@serenityos.org>
  6. * Copyright (c) 2022-2023, Kenneth Myhra <kennethmyhra@serenityos.org>
  7. *
  8. * SPDX-License-Identifier: BSD-2-Clause
  9. */
  10. #include <AK/ByteBuffer.h>
  11. #include <AK/GenericLexer.h>
  12. #include <AK/QuickSort.h>
  13. #include <LibJS/Runtime/ArrayBuffer.h>
  14. #include <LibJS/Runtime/Completion.h>
  15. #include <LibJS/Runtime/FunctionObject.h>
  16. #include <LibJS/Runtime/GlobalObject.h>
  17. #include <LibTextCodec/Decoder.h>
  18. #include <LibWeb/Bindings/XMLHttpRequestPrototype.h>
  19. #include <LibWeb/DOM/Document.h>
  20. #include <LibWeb/DOM/DocumentLoading.h>
  21. #include <LibWeb/DOM/Event.h>
  22. #include <LibWeb/DOM/EventDispatcher.h>
  23. #include <LibWeb/DOM/IDLEventListener.h>
  24. #include <LibWeb/Fetch/BodyInit.h>
  25. #include <LibWeb/Fetch/Fetching/Fetching.h>
  26. #include <LibWeb/Fetch/Infrastructure/FetchAlgorithms.h>
  27. #include <LibWeb/Fetch/Infrastructure/FetchController.h>
  28. #include <LibWeb/Fetch/Infrastructure/HTTP.h>
  29. #include <LibWeb/Fetch/Infrastructure/HTTP/Methods.h>
  30. #include <LibWeb/Fetch/Infrastructure/HTTP/Requests.h>
  31. #include <LibWeb/Fetch/Infrastructure/HTTP/Responses.h>
  32. #include <LibWeb/FileAPI/Blob.h>
  33. #include <LibWeb/HTML/EventHandler.h>
  34. #include <LibWeb/HTML/EventNames.h>
  35. #include <LibWeb/HTML/Origin.h>
  36. #include <LibWeb/HTML/Parser/HTMLEncodingDetection.h>
  37. #include <LibWeb/HTML/Parser/HTMLParser.h>
  38. #include <LibWeb/HTML/Window.h>
  39. #include <LibWeb/Infra/ByteSequences.h>
  40. #include <LibWeb/Infra/JSON.h>
  41. #include <LibWeb/Infra/Strings.h>
  42. #include <LibWeb/Loader/ResourceLoader.h>
  43. #include <LibWeb/Page/Page.h>
  44. #include <LibWeb/Platform/EventLoopPlugin.h>
  45. #include <LibWeb/WebIDL/DOMException.h>
  46. #include <LibWeb/WebIDL/ExceptionOr.h>
  47. #include <LibWeb/XHR/EventNames.h>
  48. #include <LibWeb/XHR/ProgressEvent.h>
  49. #include <LibWeb/XHR/XMLHttpRequest.h>
  50. #include <LibWeb/XHR/XMLHttpRequestUpload.h>
  51. namespace Web::XHR {
  52. WebIDL::ExceptionOr<JS::NonnullGCPtr<XMLHttpRequest>> XMLHttpRequest::construct_impl(JS::Realm& realm)
  53. {
  54. auto upload_object = realm.heap().allocate<XMLHttpRequestUpload>(realm, realm);
  55. auto author_request_headers = Fetch::Infrastructure::HeaderList::create(realm.vm());
  56. auto response = Fetch::Infrastructure::Response::network_error(realm.vm(), "Not sent yet"sv);
  57. auto fetch_controller = Fetch::Infrastructure::FetchController::create(realm.vm());
  58. return realm.heap().allocate<XMLHttpRequest>(realm, realm, *upload_object, *author_request_headers, *response, *fetch_controller);
  59. }
  60. XMLHttpRequest::XMLHttpRequest(JS::Realm& realm, XMLHttpRequestUpload& upload_object, Fetch::Infrastructure::HeaderList& author_request_headers, Fetch::Infrastructure::Response& response, Fetch::Infrastructure::FetchController& fetch_controller)
  61. : XMLHttpRequestEventTarget(realm)
  62. , m_upload_object(upload_object)
  63. , m_author_request_headers(author_request_headers)
  64. , m_response(response)
  65. , m_response_type(Bindings::XMLHttpRequestResponseType::Empty)
  66. , m_fetch_controller(fetch_controller)
  67. {
  68. set_overrides_must_survive_garbage_collection(true);
  69. }
  70. XMLHttpRequest::~XMLHttpRequest() = default;
  71. void XMLHttpRequest::initialize(JS::Realm& realm)
  72. {
  73. Base::initialize(realm);
  74. set_prototype(&Bindings::ensure_web_prototype<Bindings::XMLHttpRequestPrototype>(realm, "XMLHttpRequest"));
  75. }
  76. void XMLHttpRequest::visit_edges(Cell::Visitor& visitor)
  77. {
  78. Base::visit_edges(visitor);
  79. visitor.visit(m_upload_object);
  80. visitor.visit(m_author_request_headers);
  81. visitor.visit(m_request_body);
  82. visitor.visit(m_response);
  83. visitor.visit(m_fetch_controller);
  84. if (auto* value = m_response_object.get_pointer<JS::NonnullGCPtr<JS::Object>>())
  85. visitor.visit(*value);
  86. }
  87. // https://xhr.spec.whatwg.org/#concept-event-fire-progress
  88. static void fire_progress_event(XMLHttpRequestEventTarget& target, FlyString const& event_name, u64 transmitted, u64 length)
  89. {
  90. // To fire a progress event named e at target, given transmitted and length, means to fire an event named e at target, using ProgressEvent,
  91. // with the loaded attribute initialized to transmitted, and if length is not 0, with the lengthComputable attribute initialized to true
  92. // and the total attribute initialized to length.
  93. ProgressEventInit event_init {};
  94. event_init.length_computable = true;
  95. event_init.loaded = transmitted;
  96. event_init.total = length;
  97. // FIXME: If we're in an async context, this will propagate to a callback context which can't propagate it anywhere else and does not expect this to fail.
  98. target.dispatch_event(*ProgressEvent::create(target.realm(), event_name, event_init));
  99. }
  100. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-responsetext
  101. WebIDL::ExceptionOr<String> XMLHttpRequest::response_text() const
  102. {
  103. // 1. If this’s response type is not the empty string or "text", then throw an "InvalidStateError" DOMException.
  104. if (m_response_type != Bindings::XMLHttpRequestResponseType::Empty && m_response_type != Bindings::XMLHttpRequestResponseType::Text)
  105. return WebIDL::InvalidStateError::create(realm(), "XHR responseText can only be used for responseType \"\" or \"text\""_fly_string);
  106. // 2. If this’s state is not loading or done, then return the empty string.
  107. if (m_state != State::Loading && m_state != State::Done)
  108. return String {};
  109. // 3. Return the result of getting a text response for this.
  110. return get_text_response();
  111. }
  112. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-responsexml
  113. WebIDL::ExceptionOr<JS::GCPtr<DOM::Document>> XMLHttpRequest::response_xml()
  114. {
  115. // 1. If this’s response type is not the empty string or "document", then throw an "InvalidStateError" DOMException.
  116. if (m_response_type != Bindings::XMLHttpRequestResponseType::Empty && m_response_type != Bindings::XMLHttpRequestResponseType::Document)
  117. return WebIDL::InvalidStateError::create(realm(), "XHR responseXML can only be used for responseXML \"\" or \"document\""_fly_string);
  118. // 2. If this’s state is not done, then return null.
  119. if (m_state != State::Done)
  120. return nullptr;
  121. // 3. Assert: this’s response object is not failure.
  122. VERIFY(!m_response_object.has<Failure>());
  123. // 4. If this’s response object is non-null, then return it.
  124. if (!m_response_object.has<Empty>())
  125. return &verify_cast<DOM::Document>(*m_response_object.get<JS::NonnullGCPtr<JS::Object>>());
  126. // 5. Set a document response for this.
  127. set_document_response();
  128. // 6. Return this’s response object.
  129. if (m_response_object.has<Empty>())
  130. return nullptr;
  131. return &verify_cast<DOM::Document>(*m_response_object.get<JS::NonnullGCPtr<JS::Object>>());
  132. }
  133. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-responsetype
  134. WebIDL::ExceptionOr<void> XMLHttpRequest::set_response_type(Bindings::XMLHttpRequestResponseType response_type)
  135. {
  136. // 1. If the current global object is not a Window object and the given value is "document", then return.
  137. if (!is<HTML::Window>(HTML::current_global_object()) && response_type == Bindings::XMLHttpRequestResponseType::Document)
  138. return {};
  139. // 2. If this’s state is loading or done, then throw an "InvalidStateError" DOMException.
  140. if (m_state == State::Loading || m_state == State::Done)
  141. return WebIDL::InvalidStateError::create(realm(), "Can't readyState when XHR is loading or done"_fly_string);
  142. // 3. If the current global object is a Window object and this’s synchronous flag is set, then throw an "InvalidAccessError" DOMException.
  143. if (is<HTML::Window>(HTML::current_global_object()) && m_synchronous)
  144. return WebIDL::InvalidAccessError::create(realm(), "Can't set readyState on synchronous XHR in Window environment"_fly_string);
  145. // 4. Set this’s response type to the given value.
  146. m_response_type = response_type;
  147. return {};
  148. }
  149. // https://xhr.spec.whatwg.org/#response
  150. WebIDL::ExceptionOr<JS::Value> XMLHttpRequest::response()
  151. {
  152. auto& vm = this->vm();
  153. // 1. If this’s response type is the empty string or "text", then:
  154. if (m_response_type == Bindings::XMLHttpRequestResponseType::Empty || m_response_type == Bindings::XMLHttpRequestResponseType::Text) {
  155. // 1. If this’s state is not loading or done, then return the empty string.
  156. if (m_state != State::Loading && m_state != State::Done)
  157. return JS::PrimitiveString::create(vm, String {});
  158. // 2. Return the result of getting a text response for this.
  159. return JS::PrimitiveString::create(vm, get_text_response());
  160. }
  161. // 2. If this’s state is not done, then return null.
  162. if (m_state != State::Done)
  163. return JS::js_null();
  164. // 3. If this’s response object is failure, then return null.
  165. if (m_response_object.has<Failure>())
  166. return JS::js_null();
  167. // 4. If this’s response object is non-null, then return it.
  168. if (!m_response_object.has<Empty>())
  169. return m_response_object.get<JS::NonnullGCPtr<JS::Object>>();
  170. // 5. If this’s response type is "arraybuffer",
  171. if (m_response_type == Bindings::XMLHttpRequestResponseType::Arraybuffer) {
  172. // then set this’s response object to a new ArrayBuffer object representing this’s received bytes. If this throws an exception, then set this’s response object to failure and return null.
  173. auto buffer_result = JS::ArrayBuffer::create(realm(), m_received_bytes.size());
  174. if (buffer_result.is_error()) {
  175. m_response_object = Failure();
  176. return JS::js_null();
  177. }
  178. auto buffer = buffer_result.release_value();
  179. buffer->buffer().overwrite(0, m_received_bytes.data(), m_received_bytes.size());
  180. m_response_object = JS::NonnullGCPtr<JS::Object> { buffer };
  181. }
  182. // 6. Otherwise, if this’s response type is "blob", set this’s response object to a new Blob object representing this’s received bytes with type set to the result of get a final MIME type for this.
  183. else if (m_response_type == Bindings::XMLHttpRequestResponseType::Blob) {
  184. auto mime_type_as_string = TRY_OR_THROW_OOM(vm, TRY_OR_THROW_OOM(vm, get_final_mime_type()).serialized());
  185. auto blob_part = FileAPI::Blob::create(realm(), m_received_bytes, move(mime_type_as_string));
  186. auto blob = FileAPI::Blob::create(realm(), Vector<FileAPI::BlobPart> { JS::make_handle(*blob_part) });
  187. m_response_object = JS::NonnullGCPtr<JS::Object> { blob };
  188. }
  189. // 7. Otherwise, if this’s response type is "document", set a document response for this.
  190. else if (m_response_type == Bindings::XMLHttpRequestResponseType::Document) {
  191. set_document_response();
  192. if (m_response_object.has<Empty>())
  193. return JS::js_null();
  194. }
  195. // 8. Otherwise:
  196. else {
  197. // 1. Assert: this’s response type is "json".
  198. // Note: Automatically done by the layers above us.
  199. // 2. If this’s response’s body is null, then return null.
  200. if (!m_response->body())
  201. return JS::js_null();
  202. // 3. Let jsonObject be the result of running parse JSON from bytes on this’s received bytes. If that threw an exception, then return null.
  203. auto json_object_result = Infra::parse_json_bytes_to_javascript_value(realm(), m_received_bytes);
  204. if (json_object_result.is_error())
  205. return JS::js_null();
  206. // 4. Set this’s response object to jsonObject.
  207. m_response_object = JS::NonnullGCPtr<JS::Object> { json_object_result.release_value().as_object() };
  208. }
  209. // 9. Return this’s response object.
  210. return m_response_object.get<JS::NonnullGCPtr<JS::Object>>();
  211. }
  212. // https://xhr.spec.whatwg.org/#text-response
  213. String XMLHttpRequest::get_text_response() const
  214. {
  215. // 1. If xhr’s response’s body is null, then return the empty string.
  216. if (!m_response->body())
  217. return String {};
  218. // 2. Let charset be the result of get a final encoding for xhr.
  219. auto charset = get_final_encoding().release_value_but_fixme_should_propagate_errors();
  220. // 3. If xhr’s response type is the empty string, charset is null, and the result of get a final MIME type for xhr is an XML MIME type,
  221. if (m_response_type == Bindings::XMLHttpRequestResponseType::Empty && !charset.has_value() && get_final_mime_type().release_value_but_fixme_should_propagate_errors().is_xml()) {
  222. // FIXME: then use the rules set forth in the XML specifications to determine the encoding. Let charset be the determined encoding. [XML] [XML-NAMES]
  223. }
  224. // 4. If charset is null, then set charset to UTF-8.
  225. if (!charset.has_value())
  226. charset = "UTF-8"sv;
  227. // 5. Return the result of running decode on xhr’s received bytes using fallback encoding charset.
  228. auto decoder = TextCodec::decoder_for(charset.value());
  229. // If we don't support the decoder yet, let's crash instead of attempting to return something, as the result would be incorrect and create obscure bugs.
  230. VERIFY(decoder.has_value());
  231. return TextCodec::convert_input_to_utf8_using_given_decoder_unless_there_is_a_byte_order_mark(*decoder, m_received_bytes).release_value_but_fixme_should_propagate_errors();
  232. }
  233. // https://xhr.spec.whatwg.org/#document-response
  234. void XMLHttpRequest::set_document_response()
  235. {
  236. // 1. If xhr’s response’s body is null, then return.
  237. if (!m_response->body())
  238. return;
  239. // 2. Let finalMIME be the result of get a final MIME type for xhr.
  240. auto final_mine = MUST(get_final_mime_type());
  241. // 3. If finalMIME is not an HTML MIME type or an XML MIME type, then return.
  242. if (!final_mine.is_html() && !final_mine.is_xml())
  243. return;
  244. // 4. If xhr’s response type is the empty string and finalMIME is an HTML MIME type, then return.
  245. if (m_response_type == Bindings::XMLHttpRequestResponseType::Empty && final_mine.is_html())
  246. return;
  247. // 5. If finalMIME is an HTML MIME type, then:
  248. Optional<StringView> charset;
  249. JS::GCPtr<DOM::Document> document;
  250. if (final_mine.is_html()) {
  251. // 5.1. Let charset be the result of get a final encoding for xhr.
  252. charset = MUST(get_final_encoding());
  253. // 5.2. If charset is null, prescan the first 1024 bytes of xhr’s received bytes and if that does not terminate unsuccessfully then let charset be the return value.
  254. document = DOM::Document::create(realm());
  255. if (!charset.has_value())
  256. if (auto found_charset = HTML::run_prescan_byte_stream_algorithm(*document, m_received_bytes); found_charset.has_value())
  257. charset = MUST(String::from_deprecated_string(found_charset.value())).bytes_as_string_view();
  258. // 5.3. If charset is null, then set charset to UTF-8.
  259. if (!charset.has_value())
  260. charset = "UTF-8"sv;
  261. // 5.4. Let document be a document that represents the result parsing xhr’s received bytes following the rules set forth in the HTML Standard for an HTML parser with scripting disabled and a known definite encoding charset.
  262. auto parser = HTML::HTMLParser::create(*document, m_received_bytes, charset.value());
  263. parser->run(document->url());
  264. // 5.5. Flag document as an HTML document.
  265. document->set_document_type(DOM::Document::Type::HTML);
  266. }
  267. // 6. Otherwise, let document be a document that represents the result of running the XML parser with XML scripting support disabled on xhr’s received bytes. If that fails (unsupported character encoding, namespace well-formedness error, etc.), then return null.
  268. else {
  269. document = DOM::Document::create(realm());
  270. if (!Web::build_xml_document(*document, m_received_bytes)) {
  271. m_response_object = Empty {};
  272. return;
  273. }
  274. }
  275. // 7. If charset is null, then set charset to UTF-8.
  276. if (!charset.has_value())
  277. charset = "UTF-8"sv;
  278. // 8. Set document’s encoding to charset.
  279. document->set_encoding(MUST(String::from_utf8(charset.value())));
  280. // 9. Set document’s content type to finalMIME.
  281. document->set_content_type(MUST(final_mine.serialized()));
  282. // 10. Set document’s URL to xhr’s response’s URL.
  283. document->set_url(m_response->url().value_or({}));
  284. // 11. Set document’s origin to xhr’s relevant settings object’s origin.
  285. document->set_origin(HTML::relevant_settings_object(*this).origin());
  286. // 12. Set xhr’s response object to document.
  287. m_response_object = JS::NonnullGCPtr<JS::Object> { *document };
  288. }
  289. // https://xhr.spec.whatwg.org/#final-mime-type
  290. ErrorOr<MimeSniff::MimeType> XMLHttpRequest::get_final_mime_type() const
  291. {
  292. // 1. If xhr’s override MIME type is null, return the result of get a response MIME type for xhr.
  293. if (!m_override_mime_type.has_value())
  294. return get_response_mime_type();
  295. // 2. Return xhr’s override MIME type.
  296. return *m_override_mime_type;
  297. }
  298. // https://xhr.spec.whatwg.org/#response-mime-type
  299. ErrorOr<MimeSniff::MimeType> XMLHttpRequest::get_response_mime_type() const
  300. {
  301. // 1. Let mimeType be the result of extracting a MIME type from xhr’s response’s header list.
  302. auto mime_type = TRY(m_response->header_list()->extract_mime_type());
  303. // 2. If mimeType is failure, then set mimeType to text/xml.
  304. if (!mime_type.has_value())
  305. return MimeSniff::MimeType::create("text"_string, "xml"_string);
  306. // 3. Return mimeType.
  307. return mime_type.release_value();
  308. }
  309. // https://xhr.spec.whatwg.org/#final-charset
  310. ErrorOr<Optional<StringView>> XMLHttpRequest::get_final_encoding() const
  311. {
  312. // 1. Let label be null.
  313. Optional<String> label;
  314. // 2. Let responseMIME be the result of get a response MIME type for xhr.
  315. auto response_mime = TRY(get_response_mime_type());
  316. // 3. If responseMIME’s parameters["charset"] exists, then set label to it.
  317. auto response_mime_charset_it = response_mime.parameters().find("charset"sv);
  318. if (response_mime_charset_it != response_mime.parameters().end())
  319. label = response_mime_charset_it->value;
  320. // 4. If xhr’s override MIME type’s parameters["charset"] exists, then set label to it.
  321. if (m_override_mime_type.has_value()) {
  322. auto override_mime_charset_it = m_override_mime_type->parameters().find("charset"sv);
  323. if (override_mime_charset_it != m_override_mime_type->parameters().end())
  324. label = override_mime_charset_it->value;
  325. }
  326. // 5. If label is null, then return null.
  327. if (!label.has_value())
  328. return OptionalNone {};
  329. // 6. Let encoding be the result of getting an encoding from label.
  330. auto encoding = TextCodec::get_standardized_encoding(label.value());
  331. // 7. If encoding is failure, then return null.
  332. // 8. Return encoding.
  333. return encoding;
  334. }
  335. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-setrequestheader
  336. WebIDL::ExceptionOr<void> XMLHttpRequest::set_request_header(String const& name_string, String const& value_string)
  337. {
  338. auto& realm = this->realm();
  339. auto& vm = realm.vm();
  340. auto name = name_string.bytes();
  341. auto value = value_string.bytes();
  342. // 1. If this’s state is not opened, then throw an "InvalidStateError" DOMException.
  343. if (m_state != State::Opened)
  344. return WebIDL::InvalidStateError::create(realm, "XHR readyState is not OPENED"_fly_string);
  345. // 2. If this’s send() flag is set, then throw an "InvalidStateError" DOMException.
  346. if (m_send)
  347. return WebIDL::InvalidStateError::create(realm, "XHR send() flag is already set"_fly_string);
  348. // 3. Normalize value.
  349. auto normalized_value = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::normalize_header_value(value));
  350. // 4. If name is not a header name or value is not a header value, then throw a "SyntaxError" DOMException.
  351. if (!Fetch::Infrastructure::is_header_name(name))
  352. return WebIDL::SyntaxError::create(realm, "Header name contains invalid characters."_fly_string);
  353. if (!Fetch::Infrastructure::is_header_value(value))
  354. return WebIDL::SyntaxError::create(realm, "Header value contains invalid characters."_fly_string);
  355. auto header = Fetch::Infrastructure::Header {
  356. .name = TRY_OR_THROW_OOM(vm, ByteBuffer::copy(name)),
  357. .value = move(normalized_value),
  358. };
  359. // 5. If (name, value) is a forbidden request-header, then return.
  360. if (TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::is_forbidden_request_header(header)))
  361. return {};
  362. // 6. Combine (name, value) in this’s author request headers.
  363. TRY_OR_THROW_OOM(vm, m_author_request_headers->combine(move(header)));
  364. return {};
  365. }
  366. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-open
  367. WebIDL::ExceptionOr<void> XMLHttpRequest::open(String const& method_string, String const& url)
  368. {
  369. // 7. If the async argument is omitted, set async to true, and set username and password to null.
  370. return open(method_string, url, true, Optional<String> {}, Optional<String> {});
  371. }
  372. WebIDL::ExceptionOr<void> XMLHttpRequest::open(String const& method_string, String const& url, bool async, Optional<String> const& username, Optional<String> const& password)
  373. {
  374. auto method = method_string.bytes();
  375. // 1. If this’s relevant global object is a Window object and its associated Document is not fully active, then throw an "InvalidStateError" DOMException.
  376. if (is<HTML::Window>(HTML::relevant_global_object(*this))) {
  377. auto const& window = static_cast<HTML::Window const&>(HTML::relevant_global_object(*this));
  378. if (!window.associated_document().is_fully_active())
  379. return WebIDL::InvalidStateError::create(realm(), "Invalid state: Window's associated document is not fully active."_fly_string);
  380. }
  381. // 2. If method is not a method, then throw a "SyntaxError" DOMException.
  382. if (!Fetch::Infrastructure::is_method(method))
  383. return WebIDL::SyntaxError::create(realm(), "An invalid or illegal string was specified."_fly_string);
  384. // 3. If method is a forbidden method, then throw a "SecurityError" DOMException.
  385. if (Fetch::Infrastructure::is_forbidden_method(method))
  386. return WebIDL::SecurityError::create(realm(), "Forbidden method, must not be 'CONNECT', 'TRACE', or 'TRACK'"_fly_string);
  387. // 4. Normalize method.
  388. auto normalized_method = TRY_OR_THROW_OOM(vm(), Fetch::Infrastructure::normalize_method(method));
  389. // 5. Let parsedURL be the result of parsing url with this’s relevant settings object’s API base URL and this’s relevant settings object’s API URL character encoding.
  390. // FIXME: Pass in this’s relevant settings object’s API URL character encoding.
  391. auto parsed_url = HTML::relevant_settings_object(*this).api_base_url().complete_url(url);
  392. // 6. If parsedURL is failure, then throw a "SyntaxError" DOMException.
  393. if (!parsed_url.is_valid())
  394. return WebIDL::SyntaxError::create(realm(), "Invalid URL"_fly_string);
  395. // 7. If the async argument is omitted, set async to true, and set username and password to null.
  396. // NOTE: This is handled in the overload lacking the async argument.
  397. // 8. If parsedURL’s host is non-null, then:
  398. if (!parsed_url.host().has<Empty>()) {
  399. // 1. If the username argument is not null, set the username given parsedURL and username.
  400. if (username.has_value())
  401. MUST(parsed_url.set_username(username.value()));
  402. // 2. If the password argument is not null, set the password given parsedURL and password.
  403. if (password.has_value())
  404. MUST(parsed_url.set_password(password.value()));
  405. }
  406. // 9. If async is false, the current global object is a Window object, and either this’s timeout is
  407. // not 0 or this’s response type is not the empty string, then throw an "InvalidAccessError" DOMException.
  408. if (!async
  409. && is<HTML::Window>(HTML::current_global_object())
  410. && (m_timeout != 0 || m_response_type != Bindings::XMLHttpRequestResponseType::Empty)) {
  411. return WebIDL::InvalidAccessError::create(realm(), "Synchronous XMLHttpRequests in a Window context do not support timeout or a non-empty responseType"_fly_string);
  412. }
  413. // 10. Terminate this’s fetch controller.
  414. // Spec Note: A fetch can be ongoing at this point.
  415. m_fetch_controller->terminate();
  416. // 11. Set variables associated with the object as follows:
  417. // Unset this’s send() flag.
  418. m_send = false;
  419. // Unset this’s upload listener flag.
  420. m_upload_listener = false;
  421. // Set this’s request method to method.
  422. m_request_method = move(normalized_method);
  423. // Set this’s request URL to parsedURL.
  424. m_request_url = parsed_url;
  425. // Set this’s synchronous flag if async is false; otherwise unset this’s synchronous flag.
  426. m_synchronous = !async;
  427. // Empty this’s author request headers.
  428. m_author_request_headers->clear();
  429. // Set this’s response to a network error.
  430. m_response = Fetch::Infrastructure::Response::network_error(realm().vm(), "Not yet sent"sv);
  431. // Set this’s received bytes to the empty byte sequence.
  432. m_received_bytes = {};
  433. // Set this’s response object to null.
  434. m_response_object = {};
  435. // Spec Note: Override MIME type is not overridden here as the overrideMimeType() method can be invoked before the open() method.
  436. // 12. If this’s state is not opened, then:
  437. if (m_state != State::Opened) {
  438. // 1. Set this’s state to opened.
  439. m_state = State::Opened;
  440. // 2. Fire an event named readystatechange at this.
  441. dispatch_event(DOM::Event::create(realm(), EventNames::readystatechange));
  442. }
  443. return {};
  444. }
  445. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-send
  446. WebIDL::ExceptionOr<void> XMLHttpRequest::send(Optional<DocumentOrXMLHttpRequestBodyInit> body)
  447. {
  448. auto& vm = this->vm();
  449. auto& realm = *vm.current_realm();
  450. // 1. If this’s state is not opened, then throw an "InvalidStateError" DOMException.
  451. if (m_state != State::Opened)
  452. return WebIDL::InvalidStateError::create(realm, "XHR readyState is not OPENED"_fly_string);
  453. // 2. If this’s send() flag is set, then throw an "InvalidStateError" DOMException.
  454. if (m_send)
  455. return WebIDL::InvalidStateError::create(realm, "XHR send() flag is already set"_fly_string);
  456. // 3. If this’s request method is `GET` or `HEAD`, then set body to null.
  457. if (m_request_method.is_one_of("GET"sv, "HEAD"sv))
  458. body = {};
  459. // 4. If body is not null, then:
  460. if (body.has_value()) {
  461. // 1. Let extractedContentType be null.
  462. Optional<ByteBuffer> extracted_content_type;
  463. // 2. If body is a Document, then set this’s request body to body, serialized, converted, and UTF-8 encoded.
  464. if (body->has<JS::Handle<DOM::Document>>()) {
  465. // FIXME: Perform USVString conversion and UTF-8 encoding.
  466. auto string_serialized_document = TRY(body->get<JS::Handle<DOM::Document>>().cell()->serialize_fragment(DOMParsing::RequireWellFormed::No));
  467. m_request_body = TRY(Fetch::Infrastructure::byte_sequence_as_body(realm, string_serialized_document.bytes()));
  468. }
  469. // 3. Otherwise:
  470. else {
  471. // 1. Let bodyWithType be the result of safely extracting body.
  472. auto body_with_type = TRY(Fetch::safely_extract_body(realm, body->downcast<Fetch::BodyInitOrReadableBytes>()));
  473. // 2. Set this’s request body to bodyWithType’s body.
  474. m_request_body = move(body_with_type.body);
  475. // 3. Set extractedContentType to bodyWithType’s type.
  476. extracted_content_type = move(body_with_type.type);
  477. }
  478. // 4. Let originalAuthorContentType be the result of getting `Content-Type` from this’s author request headers.
  479. auto original_author_content_type = TRY_OR_THROW_OOM(vm, m_author_request_headers->get("Content-Type"sv.bytes()));
  480. // 5. If originalAuthorContentType is non-null, then:
  481. if (original_author_content_type.has_value()) {
  482. // 1. If body is a Document or a USVString, then:
  483. if (body->has<JS::Handle<DOM::Document>>() || body->has<String>()) {
  484. // 1. Let contentTypeRecord be the result of parsing originalAuthorContentType.
  485. auto content_type_record = TRY_OR_THROW_OOM(vm, MimeSniff::MimeType::parse(original_author_content_type.value()));
  486. // 2. If contentTypeRecord is not failure, contentTypeRecord’s parameters["charset"] exists, and parameters["charset"] is not an ASCII case-insensitive match for "UTF-8", then:
  487. if (content_type_record.has_value()) {
  488. auto charset_parameter_iterator = content_type_record->parameters().find("charset"sv);
  489. if (charset_parameter_iterator != content_type_record->parameters().end() && !Infra::is_ascii_case_insensitive_match(charset_parameter_iterator->value, "UTF-8"sv)) {
  490. // 1. Set contentTypeRecord’s parameters["charset"] to "UTF-8".
  491. TRY_OR_THROW_OOM(vm, content_type_record->set_parameter("charset"_string, "UTF-8"_string));
  492. // 2. Let newContentTypeSerialized be the result of serializing contentTypeRecord.
  493. auto new_content_type_serialized = TRY_OR_THROW_OOM(vm, content_type_record->serialized());
  494. // 3. Set (`Content-Type`, newContentTypeSerialized) in this’s author request headers.
  495. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, new_content_type_serialized));
  496. TRY_OR_THROW_OOM(vm, m_author_request_headers->set(move(header)));
  497. }
  498. }
  499. }
  500. }
  501. // 6. Otherwise:
  502. else {
  503. if (body->has<JS::Handle<DOM::Document>>()) {
  504. auto document = body->get<JS::Handle<DOM::Document>>();
  505. // NOTE: A document can only be an HTML document or XML document.
  506. // 1. If body is an HTML document, then set (`Content-Type`, `text/html;charset=UTF-8`) in this’s author request headers.
  507. if (document->is_html_document()) {
  508. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, "text/html;charset=UTF-8"sv));
  509. TRY_OR_THROW_OOM(vm, m_author_request_headers->set(move(header)));
  510. }
  511. // 2. Otherwise, if body is an XML document, set (`Content-Type`, `application/xml;charset=UTF-8`) in this’s author request headers.
  512. else if (document->is_xml_document()) {
  513. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, "application/xml;charset=UTF-8"sv));
  514. TRY_OR_THROW_OOM(vm, m_author_request_headers->set(move(header)));
  515. } else {
  516. VERIFY_NOT_REACHED();
  517. }
  518. }
  519. // 3. Otherwise, if extractedContentType is not null, set (`Content-Type`, extractedContentType) in this’s author request headers.
  520. else if (extracted_content_type.has_value()) {
  521. auto header = TRY_OR_THROW_OOM(vm, Fetch::Infrastructure::Header::from_string_pair("Content-Type"sv, extracted_content_type.value()));
  522. TRY_OR_THROW_OOM(vm, m_author_request_headers->set(move(header)));
  523. }
  524. }
  525. }
  526. // 5. If one or more event listeners are registered on this’s upload object, then set this’s upload listener flag.
  527. m_upload_listener = m_upload_object->has_event_listeners();
  528. // 6. Let req be a new request, initialized as follows:
  529. auto request = Fetch::Infrastructure::Request::create(vm);
  530. // method
  531. // This’s request method.
  532. request->set_method(TRY_OR_THROW_OOM(vm, ByteBuffer::copy(m_request_method.bytes())));
  533. // URL
  534. // This’s request URL.
  535. request->set_url(m_request_url);
  536. // header list
  537. // This’s author request headers.
  538. request->set_header_list(m_author_request_headers);
  539. // unsafe-request flag
  540. // Set.
  541. request->set_unsafe_request(true);
  542. // body
  543. // This’s request body.
  544. if (m_request_body)
  545. request->set_body(JS::NonnullGCPtr { *m_request_body });
  546. // client
  547. // This’s relevant settings object.
  548. request->set_client(&HTML::relevant_settings_object(*this));
  549. // mode
  550. // "cors".
  551. request->set_mode(Fetch::Infrastructure::Request::Mode::CORS);
  552. // use-CORS-preflight flag
  553. // Set if this’s upload listener flag is set.
  554. request->set_use_cors_preflight(m_upload_listener);
  555. // credentials mode
  556. // If this’s cross-origin credentials is true, then "include"; otherwise "same-origin".
  557. request->set_credentials_mode(m_cross_origin_credentials ? Fetch::Infrastructure::Request::CredentialsMode::Include : Fetch::Infrastructure::Request::CredentialsMode::SameOrigin);
  558. // use-URL-credentials flag
  559. // Set if this’s request URL includes credentials.
  560. request->set_use_url_credentials(m_request_url.includes_credentials());
  561. // initiator type
  562. // "xmlhttprequest".
  563. request->set_initiator_type(Fetch::Infrastructure::Request::InitiatorType::XMLHttpRequest);
  564. // 7. Unset this’s upload complete flag.
  565. m_upload_complete = false;
  566. // 8. Unset this’s timed out flag.
  567. m_timed_out = false;
  568. // 9. If req’s body is null, then set this’s upload complete flag.
  569. // NOTE: req's body is always m_request_body here, see step 6.
  570. if (!m_request_body)
  571. m_upload_complete = true;
  572. // 10. Set this’s send() flag.
  573. m_send = true;
  574. dbgln("{}XHR send from {} to {}", m_synchronous ? "\033[33;1mSynchronous\033[0m " : "", HTML::relevant_settings_object(*this).creation_url, m_request_url);
  575. // 11. If this’s synchronous flag is unset, then:
  576. if (!m_synchronous) {
  577. // 1. Fire a progress event named loadstart at this with 0 and 0.
  578. fire_progress_event(*this, EventNames::loadstart, 0, 0);
  579. // 2. Let requestBodyTransmitted be 0.
  580. // NOTE: This is kept on the XHR object itself instead of the stack, as we cannot capture references to stack variables in an async context.
  581. m_request_body_transmitted = 0;
  582. // 3. Let requestBodyLength be req’s body’s length, if req’s body is non-null; otherwise 0.
  583. // NOTE: req's body is always m_request_body here, see step 6.
  584. // 4. Assert: requestBodyLength is an integer.
  585. // NOTE: This is done to provide a better assertion failure message, whereas below the message would be "m_has_value"
  586. if (m_request_body)
  587. VERIFY(m_request_body->length().has_value());
  588. // NOTE: This is const to allow the callback functions to take a copy of it and know it won't change.
  589. auto const request_body_length = m_request_body ? m_request_body->length().value() : 0;
  590. // 5. If this’s upload complete flag is unset and this’s upload listener flag is set, then fire a progress event named loadstart at this’s upload object with requestBodyTransmitted and requestBodyLength.
  591. if (!m_upload_complete && m_upload_listener)
  592. fire_progress_event(m_upload_object, EventNames::loadstart, m_request_body_transmitted, request_body_length);
  593. // 6. If this’s state is not opened or this’s send() flag is unset, then return.
  594. if (m_state != State::Opened || !m_send)
  595. return {};
  596. // 7. Let processRequestBodyChunkLength, given a bytesLength, be these steps:
  597. // NOTE: request_body_length is captured by copy as to not UAF it when we leave `send()` and the callback gets called.
  598. // NOTE: `this` is kept alive by FetchAlgorithms using JS::SafeFunction.
  599. auto process_request_body_chunk_length = [this, request_body_length](u64 bytes_length) {
  600. // 1. Increase requestBodyTransmitted by bytesLength.
  601. m_request_body_transmitted += bytes_length;
  602. // FIXME: 2. If not roughly 50ms have passed since these steps were last invoked, then return.
  603. // 3. If this’s upload listener flag is set, then fire a progress event named progress at this’s upload object with requestBodyTransmitted and requestBodyLength.
  604. if (m_upload_listener)
  605. fire_progress_event(m_upload_object, EventNames::progress, m_request_body_transmitted, request_body_length);
  606. };
  607. // 8. Let processRequestEndOfBody be these steps:
  608. // NOTE: request_body_length is captured by copy as to not UAF it when we leave `send()` and the callback gets called.
  609. // NOTE: `this` is kept alive by FetchAlgorithms using JS::SafeFunction.
  610. auto process_request_end_of_body = [this, request_body_length]() {
  611. // 1. Set this’s upload complete flag.
  612. m_upload_complete = true;
  613. // 2. If this’s upload listener flag is unset, then return.
  614. if (!m_upload_listener)
  615. return;
  616. // 3. Fire a progress event named progress at this’s upload object with requestBodyTransmitted and requestBodyLength.
  617. fire_progress_event(m_upload_object, EventNames::progress, m_request_body_transmitted, request_body_length);
  618. // 4. Fire a progress event named load at this’s upload object with requestBodyTransmitted and requestBodyLength.
  619. fire_progress_event(m_upload_object, EventNames::load, m_request_body_transmitted, request_body_length);
  620. // 5. Fire a progress event named loadend at this’s upload object with requestBodyTransmitted and requestBodyLength.
  621. fire_progress_event(m_upload_object, EventNames::loadend, m_request_body_transmitted, request_body_length);
  622. };
  623. // 9. Let processResponse, given a response, be these steps:
  624. // NOTE: `this` is kept alive by FetchAlgorithms using JS::SafeFunction.
  625. auto process_response = [this](JS::NonnullGCPtr<Fetch::Infrastructure::Response> response) {
  626. // 1. Set this’s response to response.
  627. m_response = response;
  628. // 2. Handle errors for this.
  629. // NOTE: This cannot throw, as `handle_errors` only throws in a synchronous context.
  630. // FIXME: However, we can receive allocation failures, but we can't propagate them anywhere currently.
  631. handle_errors().release_value_but_fixme_should_propagate_errors();
  632. // 3. If this’s response is a network error, then return.
  633. if (m_response->is_network_error())
  634. return;
  635. // 4. Set this’s state to headers received.
  636. m_state = State::HeadersReceived;
  637. // 5. Fire an event named readystatechange at this.
  638. // FIXME: We're in an async context, so we can't propagate the error anywhere.
  639. dispatch_event(*DOM::Event::create(this->realm(), EventNames::readystatechange));
  640. // 6. If this’s state is not headers received, then return.
  641. if (m_state != State::HeadersReceived)
  642. return;
  643. // 7. If this’s response’s body is null, then run handle response end-of-body for this and return.
  644. if (!m_response->body()) {
  645. // NOTE: This cannot throw, as `handle_response_end_of_body` only throws in a synchronous context.
  646. // FIXME: However, we can receive allocation failures, but we can't propagate them anywhere currently.
  647. handle_response_end_of_body().release_value_but_fixme_should_propagate_errors();
  648. return;
  649. }
  650. // 8. Let length be the result of extracting a length from this’s response’s header list.
  651. // FIXME: We're in an async context, so we can't propagate the error anywhere.
  652. auto length = m_response->header_list()->extract_length().release_value_but_fixme_should_propagate_errors();
  653. // 9. If length is not an integer, then set it to 0.
  654. if (!length.has<u64>())
  655. length = 0;
  656. // FIXME: We can't implement these steps yet, as we don't fully implement the Streams standard.
  657. // 10. Let processBodyChunk given bytes be these steps:
  658. // 1. Append bytes to this’s received bytes.
  659. // 2. If not roughly 50ms have passed since these steps were last invoked, then return.
  660. // 3. If this’s state is headers received, then set this’s state to loading.
  661. // 4. Fire an event named readystatechange at this.
  662. // Spec Note: Web compatibility is the reason readystatechange fires more often than this’s state changes.
  663. // 5. Fire a progress event named progress at this with this’s received bytes’s length and length.
  664. // 11. Let processEndOfBody be this step: run handle response end-of-body for this.
  665. // 12. Let processBodyError be these steps:
  666. // 1. Set this’s response to a network error.
  667. // 2. Run handle errors for this.
  668. // 13. Incrementally read this’s response’s body, given processBodyChunk, processEndOfBody, processBodyError, and this’s relevant global object.
  669. };
  670. // FIXME: Remove this once we implement the Streams standard. See above.
  671. // NOTE: `this` is kept alive by FetchAlgorithms using JS::SafeFunction.
  672. auto process_response_consume_body = [this](JS::NonnullGCPtr<Fetch::Infrastructure::Response>, Variant<Empty, Fetch::Infrastructure::FetchAlgorithms::ConsumeBodyFailureTag, ByteBuffer> null_or_failure_or_bytes) {
  673. // NOTE: `response` is not used here as `process_response` is called before `process_response_consume_body` and thus `m_response` is already set up.
  674. if (null_or_failure_or_bytes.has<ByteBuffer>()) {
  675. // NOTE: We are not in a context where we can throw if this fails due to OOM.
  676. m_received_bytes.append(null_or_failure_or_bytes.get<ByteBuffer>());
  677. }
  678. // NOTE: This cannot throw, as `handle_response_end_of_body` only throws in a synchronous context.
  679. // FIXME: However, we can receive allocation failures, but we can't propagate them anywhere currently.
  680. handle_response_end_of_body().release_value_but_fixme_should_propagate_errors();
  681. };
  682. // 10. Set this’s fetch controller to the result of fetching req with processRequestBodyChunkLength set to processRequestBodyChunkLength, processRequestEndOfBody set to processRequestEndOfBody, and processResponse set to processResponse.
  683. m_fetch_controller = TRY(Fetch::Fetching::fetch(
  684. realm,
  685. request,
  686. Fetch::Infrastructure::FetchAlgorithms::create(vm,
  687. {
  688. .process_request_body_chunk_length = move(process_request_body_chunk_length),
  689. .process_request_end_of_body = move(process_request_end_of_body),
  690. .process_early_hints_response = {},
  691. .process_response = move(process_response),
  692. .process_response_end_of_body = {},
  693. .process_response_consume_body = move(process_response_consume_body), // FIXME: Set this to null once we implement the Streams standard. See above.
  694. })));
  695. // 11. Let now be the present time.
  696. // 12. Run these steps in parallel:
  697. // 1. Wait until either req’s done flag is set or this’s timeout is not 0 and this’s timeout milliseconds have passed since now.
  698. // 2. If req’s done flag is unset, then set this’s timed out flag and terminate this’s fetch controller.
  699. if (m_timeout != 0) {
  700. auto timer = Platform::Timer::create_single_shot(m_timeout, nullptr);
  701. // NOTE: `timer` is kept alive by copying the NNRP into the lambda, incrementing its ref-count.
  702. // NOTE: `this` and `request` is kept alive by Platform::Timer using JS::SafeFunction.
  703. timer->on_timeout = [this, request, timer]() {
  704. if (!request->done()) {
  705. m_timed_out = true;
  706. m_fetch_controller->terminate();
  707. }
  708. };
  709. timer->start();
  710. }
  711. } else {
  712. // 1. Let processedResponse be false.
  713. bool processed_response = false;
  714. // 2. Let processResponseConsumeBody, given a response and nullOrFailureOrBytes, be these steps:
  715. auto process_response_consume_body = [this, &processed_response](JS::NonnullGCPtr<Fetch::Infrastructure::Response> response, Variant<Empty, Fetch::Infrastructure::FetchAlgorithms::ConsumeBodyFailureTag, ByteBuffer> null_or_failure_or_bytes) {
  716. // 1. If nullOrFailureOrBytes is not failure, then set this’s response to response.
  717. if (!null_or_failure_or_bytes.has<Fetch::Infrastructure::FetchAlgorithms::ConsumeBodyFailureTag>())
  718. m_response = response;
  719. // 2. If nullOrFailureOrBytes is a byte sequence, then append nullOrFailureOrBytes to this’s received bytes.
  720. if (null_or_failure_or_bytes.has<ByteBuffer>()) {
  721. // NOTE: We are not in a context where we can throw if this fails due to OOM.
  722. m_received_bytes.append(null_or_failure_or_bytes.get<ByteBuffer>());
  723. }
  724. // 3. Set processedResponse to true.
  725. processed_response = true;
  726. };
  727. // 3. Set this’s fetch controller to the result of fetching req with processResponseConsumeBody set to processResponseConsumeBody and useParallelQueue set to true.
  728. m_fetch_controller = TRY(Fetch::Fetching::fetch(
  729. realm,
  730. request,
  731. Fetch::Infrastructure::FetchAlgorithms::create(vm,
  732. {
  733. .process_request_body_chunk_length = {},
  734. .process_request_end_of_body = {},
  735. .process_early_hints_response = {},
  736. .process_response = {},
  737. .process_response_end_of_body = {},
  738. .process_response_consume_body = move(process_response_consume_body),
  739. }),
  740. Fetch::Fetching::UseParallelQueue::Yes));
  741. // 4. Let now be the present time.
  742. // 5. Pause until either processedResponse is true or this’s timeout is not 0 and this’s timeout milliseconds have passed since now.
  743. bool did_time_out = false;
  744. if (m_timeout != 0) {
  745. auto timer = Platform::Timer::create_single_shot(m_timeout, nullptr);
  746. // NOTE: `timer` is kept alive by copying the NNRP into the lambda, incrementing its ref-count.
  747. timer->on_timeout = [timer, &did_time_out]() {
  748. did_time_out = true;
  749. };
  750. timer->start();
  751. }
  752. // FIXME: This is not exactly correct, as it allows the HTML event loop to continue executing tasks.
  753. Platform::EventLoopPlugin::the().spin_until([&]() {
  754. return processed_response || did_time_out;
  755. });
  756. // 6. If processedResponse is false, then set this’s timed out flag and terminate this’s fetch controller.
  757. if (!processed_response) {
  758. m_timed_out = true;
  759. m_fetch_controller->terminate();
  760. }
  761. // FIXME: 7. Report timing for this’s fetch controller given the current global object.
  762. // We cannot do this for responses that have a body yet, as we do not setup the stream that then calls processResponseEndOfBody in `fetch_response_handover`.
  763. // 8. Run handle response end-of-body for this.
  764. TRY(handle_response_end_of_body());
  765. }
  766. return {};
  767. }
  768. WebIDL::CallbackType* XMLHttpRequest::onreadystatechange()
  769. {
  770. return event_handler_attribute(Web::XHR::EventNames::readystatechange);
  771. }
  772. void XMLHttpRequest::set_onreadystatechange(WebIDL::CallbackType* value)
  773. {
  774. set_event_handler_attribute(Web::XHR::EventNames::readystatechange, value);
  775. }
  776. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-getresponseheader
  777. WebIDL::ExceptionOr<Optional<String>> XMLHttpRequest::get_response_header(String const& name) const
  778. {
  779. auto& vm = this->vm();
  780. // The getResponseHeader(name) method steps are to return the result of getting name from this’s response’s header list.
  781. auto header_bytes = TRY_OR_THROW_OOM(vm, m_response->header_list()->get(name.bytes()));
  782. return header_bytes.has_value() ? TRY_OR_THROW_OOM(vm, String::from_utf8(*header_bytes)) : Optional<String> {};
  783. }
  784. // https://xhr.spec.whatwg.org/#legacy-uppercased-byte-less-than
  785. static ErrorOr<bool> is_legacy_uppercased_byte_less_than(ReadonlyBytes a, ReadonlyBytes b)
  786. {
  787. // 1. Let A be a, byte-uppercased.
  788. auto uppercased_a = TRY(ByteBuffer::copy(a));
  789. Infra::byte_uppercase(uppercased_a);
  790. // 2. Let B be b, byte-uppercased.
  791. auto uppercased_b = TRY(ByteBuffer::copy(b));
  792. Infra::byte_uppercase(uppercased_b);
  793. // 3. Return A is byte less than B.
  794. return Infra::is_byte_less_than(uppercased_a, uppercased_b);
  795. }
  796. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-getallresponseheaders
  797. WebIDL::ExceptionOr<String> XMLHttpRequest::get_all_response_headers() const
  798. {
  799. auto& vm = this->vm();
  800. // 1. Let output be an empty byte sequence.
  801. ByteBuffer output;
  802. // 2. Let initialHeaders be the result of running sort and combine with this’s response’s header list.
  803. auto initial_headers = TRY_OR_THROW_OOM(vm, m_response->header_list()->sort_and_combine());
  804. // 3. Let headers be the result of sorting initialHeaders in ascending order, with a being less than b if a’s name is legacy-uppercased-byte less than b’s name.
  805. // Spec Note: Unfortunately, this is needed for compatibility with deployed content.
  806. // NOTE: quick_sort mutates the collection instead of returning a sorted copy.
  807. quick_sort(initial_headers, [](Fetch::Infrastructure::Header const& a, Fetch::Infrastructure::Header const& b) {
  808. // FIXME: We are not in a context where we can throw from OOM.
  809. return is_legacy_uppercased_byte_less_than(a.name, b.name).release_value_but_fixme_should_propagate_errors();
  810. });
  811. // 4. For each header in headers, append header’s name, followed by a 0x3A 0x20 byte pair, followed by header’s value, followed by a 0x0D 0x0A byte pair, to output.
  812. for (auto const& header : initial_headers) {
  813. TRY_OR_THROW_OOM(vm, output.try_append(header.name));
  814. TRY_OR_THROW_OOM(vm, output.try_append(0x3A)); // ':'
  815. TRY_OR_THROW_OOM(vm, output.try_append(0x20)); // ' '
  816. TRY_OR_THROW_OOM(vm, output.try_append(header.value));
  817. TRY_OR_THROW_OOM(vm, output.try_append(0x0D)); // '\r'
  818. TRY_OR_THROW_OOM(vm, output.try_append(0x0A)); // '\n'
  819. }
  820. // 5. Return output.
  821. return TRY_OR_THROW_OOM(vm, String::from_utf8(output));
  822. }
  823. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-overridemimetype
  824. WebIDL::ExceptionOr<void> XMLHttpRequest::override_mime_type(String const& mime)
  825. {
  826. auto& vm = this->vm();
  827. // 1. If this’s state is loading or done, then throw an "InvalidStateError" DOMException.
  828. if (m_state == State::Loading || m_state == State::Done)
  829. return WebIDL::InvalidStateError::create(realm(), "Cannot override MIME type when state is Loading or Done."_fly_string);
  830. // 2. Set this’s override MIME type to the result of parsing mime.
  831. m_override_mime_type = TRY_OR_THROW_OOM(vm, MimeSniff::MimeType::parse(mime));
  832. // 3. If this’s override MIME type is failure, then set this’s override MIME type to application/octet-stream.
  833. if (!m_override_mime_type.has_value())
  834. m_override_mime_type = TRY_OR_THROW_OOM(vm, MimeSniff::MimeType::create("application"_string, "octet-stream"_string));
  835. return {};
  836. }
  837. // https://xhr.spec.whatwg.org/#ref-for-dom-xmlhttprequest-timeout%E2%91%A2
  838. WebIDL::ExceptionOr<void> XMLHttpRequest::set_timeout(u32 timeout)
  839. {
  840. // 1. If the current global object is a Window object and this’s synchronous flag is set,
  841. // then throw an "InvalidAccessError" DOMException.
  842. if (is<HTML::Window>(HTML::current_global_object()) && m_synchronous)
  843. return WebIDL::InvalidAccessError::create(realm(), "Use of XMLHttpRequest's timeout attribute is not supported in the synchronous mode in window context."_fly_string);
  844. // 2. Set this’s timeout to the given value.
  845. m_timeout = timeout;
  846. return {};
  847. }
  848. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-timeout
  849. u32 XMLHttpRequest::timeout() const { return m_timeout; }
  850. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-withcredentials
  851. bool XMLHttpRequest::with_credentials() const
  852. {
  853. // The withCredentials getter steps are to return this’s cross-origin credentials.
  854. return m_cross_origin_credentials;
  855. }
  856. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-withcredentials
  857. WebIDL::ExceptionOr<void> XMLHttpRequest::set_with_credentials(bool with_credentials)
  858. {
  859. auto& realm = this->realm();
  860. // 1. If this’s state is not unsent or opened, then throw an "InvalidStateError" DOMException.
  861. if (m_state != State::Unsent && m_state != State::Opened)
  862. return WebIDL::InvalidStateError::create(realm, "XHR readyState is not UNSENT or OPENED"_fly_string);
  863. // 2. If this’s send() flag is set, then throw an "InvalidStateError" DOMException.
  864. if (m_send)
  865. return WebIDL::InvalidStateError::create(realm, "XHR send() flag is already set"_fly_string);
  866. // 3. Set this’s cross-origin credentials to the given value.
  867. m_cross_origin_credentials = with_credentials;
  868. return {};
  869. }
  870. // https://xhr.spec.whatwg.org/#garbage-collection
  871. bool XMLHttpRequest::must_survive_garbage_collection() const
  872. {
  873. // An XMLHttpRequest object must not be garbage collected
  874. // if its state is either opened with the send() flag set, headers received, or loading,
  875. // and it has one or more event listeners registered whose type is one of
  876. // readystatechange, progress, abort, error, load, timeout, and loadend.
  877. if ((m_state == State::Opened && m_send)
  878. || m_state == State::HeadersReceived
  879. || m_state == State::Loading) {
  880. if (has_event_listener(EventNames::readystatechange))
  881. return true;
  882. if (has_event_listener(EventNames::progress))
  883. return true;
  884. if (has_event_listener(EventNames::abort))
  885. return true;
  886. if (has_event_listener(EventNames::error))
  887. return true;
  888. if (has_event_listener(EventNames::load))
  889. return true;
  890. if (has_event_listener(EventNames::timeout))
  891. return true;
  892. if (has_event_listener(EventNames::loadend))
  893. return true;
  894. }
  895. // FIXME: If an XMLHttpRequest object is garbage collected while its connection is still open,
  896. // the user agent must terminate the XMLHttpRequest object’s fetch controller.
  897. // NOTE: This would go in XMLHttpRequest::finalize().
  898. return false;
  899. }
  900. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-abort
  901. void XMLHttpRequest::abort()
  902. {
  903. // 1. Abort this’s fetch controller.
  904. m_fetch_controller->abort(realm(), {});
  905. // 2. If this’s state is opened with this’s send() flag set, headers received, or loading, then run the request error steps for this and abort.
  906. if ((m_state == State::Opened || m_state == State::HeadersReceived || m_state == State::Loading) && m_send) {
  907. // NOTE: This cannot throw as we don't pass in an exception. XHR::abort cannot be reached in a synchronous context where the state matches above.
  908. // This is because it pauses inside XHR::send until the request is done or times out and then immediately calls `handle_response_end_of_body`
  909. // which will always set `m_state` to `Done`.
  910. MUST(request_error_steps(EventNames::abort));
  911. }
  912. // 3. If this’s state is done, then set this’s state to unsent and this’s response to a network error.
  913. // Spec Note: No readystatechange event is dispatched.
  914. if (m_state == State::Done) {
  915. m_state = State::Unsent;
  916. m_response = Fetch::Infrastructure::Response::network_error(vm(), "Not yet sent"sv);
  917. }
  918. }
  919. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-upload
  920. JS::NonnullGCPtr<XMLHttpRequestUpload> XMLHttpRequest::upload() const
  921. {
  922. // The upload getter steps are to return this’s upload object.
  923. return m_upload_object;
  924. }
  925. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-status
  926. Fetch::Infrastructure::Status XMLHttpRequest::status() const
  927. {
  928. // The status getter steps are to return this’s response’s status.
  929. return m_response->status();
  930. }
  931. // https://xhr.spec.whatwg.org/#dom-xmlhttprequest-statustext
  932. WebIDL::ExceptionOr<String> XMLHttpRequest::status_text() const
  933. {
  934. auto& vm = this->vm();
  935. // The statusText getter steps are to return this’s response’s status message.
  936. return TRY_OR_THROW_OOM(vm, String::from_utf8(m_response->status_message()));
  937. }
  938. // https://xhr.spec.whatwg.org/#handle-response-end-of-body
  939. WebIDL::ExceptionOr<void> XMLHttpRequest::handle_response_end_of_body()
  940. {
  941. auto& vm = this->vm();
  942. auto& realm = this->realm();
  943. // 1. Handle errors for xhr.
  944. TRY(handle_errors());
  945. // 2. If xhr’s response is a network error, then return.
  946. if (m_response->is_network_error())
  947. return {};
  948. // 3. Let transmitted be xhr’s received bytes’s length.
  949. auto transmitted = m_received_bytes.size();
  950. // 4. Let length be the result of extracting a length from this’s response’s header list.
  951. auto maybe_length = TRY_OR_THROW_OOM(vm, m_response->header_list()->extract_length());
  952. // 5. If length is not an integer, then set it to 0.
  953. if (!maybe_length.has<u64>())
  954. maybe_length = 0;
  955. auto length = maybe_length.get<u64>();
  956. // 6. If xhr’s synchronous flag is unset, then fire a progress event named progress at xhr with transmitted and length.
  957. if (!m_synchronous)
  958. fire_progress_event(*this, EventNames::progress, transmitted, length);
  959. // 7. Set xhr’s state to done.
  960. m_state = State::Done;
  961. // 8. Unset xhr’s send() flag.
  962. m_send = false;
  963. // 9. Fire an event named readystatechange at xhr.
  964. // FIXME: If we're in an async context, this will propagate to a callback context which can't propagate it anywhere else and does not expect this to fail.
  965. dispatch_event(*DOM::Event::create(realm, EventNames::readystatechange));
  966. // 10. Fire a progress event named load at xhr with transmitted and length.
  967. fire_progress_event(*this, EventNames::load, transmitted, length);
  968. // 11. Fire a progress event named loadend at xhr with transmitted and length.
  969. fire_progress_event(*this, EventNames::loadend, transmitted, length);
  970. return {};
  971. }
  972. // https://xhr.spec.whatwg.org/#handle-errors
  973. WebIDL::ExceptionOr<void> XMLHttpRequest::handle_errors()
  974. {
  975. // 1. If xhr’s send() flag is unset, then return.
  976. if (!m_send)
  977. return {};
  978. // 2. If xhr’s timed out flag is set, then run the request error steps for xhr, timeout, and "TimeoutError" DOMException.
  979. if (m_timed_out)
  980. return TRY(request_error_steps(EventNames::timeout, WebIDL::TimeoutError::create(realm(), "Timed out"_fly_string)));
  981. // 3. Otherwise, if xhr’s response’s aborted flag is set, run the request error steps for xhr, abort, and "AbortError" DOMException.
  982. if (m_response->aborted())
  983. return TRY(request_error_steps(EventNames::abort, WebIDL::AbortError::create(realm(), "Aborted"_fly_string)));
  984. // 4. Otherwise, if xhr’s response is a network error, then run the request error steps for xhr, error, and "NetworkError" DOMException.
  985. if (m_response->is_network_error())
  986. return TRY(request_error_steps(EventNames::error, WebIDL::NetworkError::create(realm(), "Network error"_fly_string)));
  987. return {};
  988. }
  989. JS::ThrowCompletionOr<void> XMLHttpRequest::request_error_steps(FlyString const& event_name, JS::GCPtr<WebIDL::DOMException> exception)
  990. {
  991. // 1. Set xhr’s state to done.
  992. m_state = State::Done;
  993. // 2. Unset xhr’s send() flag.
  994. m_send = false;
  995. // 3. Set xhr’s response to a network error.
  996. m_response = Fetch::Infrastructure::Response::network_error(realm().vm(), "Failed to load"sv);
  997. // 4. If xhr’s synchronous flag is set, then throw exception.
  998. if (m_synchronous) {
  999. VERIFY(exception);
  1000. return JS::throw_completion(exception.ptr());
  1001. }
  1002. // 5. Fire an event named readystatechange at xhr.
  1003. // FIXME: Since we're in an async context, this will propagate to a callback context which can't propagate it anywhere else and does not expect this to fail.
  1004. dispatch_event(*DOM::Event::create(realm(), EventNames::readystatechange));
  1005. // 6. If xhr’s upload complete flag is unset, then:
  1006. if (!m_upload_complete) {
  1007. // 1. Set xhr’s upload complete flag.
  1008. m_upload_complete = true;
  1009. // 2. If xhr’s upload listener flag is set, then:
  1010. if (m_upload_listener) {
  1011. // 1. Fire a progress event named event at xhr’s upload object with 0 and 0.
  1012. fire_progress_event(m_upload_object, event_name, 0, 0);
  1013. // 2. Fire a progress event named loadend at xhr’s upload object with 0 and 0.
  1014. fire_progress_event(m_upload_object, EventNames::loadend, 0, 0);
  1015. }
  1016. }
  1017. // 7. Fire a progress event named event at xhr with 0 and 0.
  1018. fire_progress_event(*this, event_name, 0, 0);
  1019. // 8. Fire a progress event named loadend at xhr with 0 and 0.
  1020. fire_progress_event(*this, EventNames::loadend, 0, 0);
  1021. return {};
  1022. }
  1023. }