Share code to determine a forbidden method
[WebKit-https.git] / Source / WebCore / xml / XMLHttpRequest.cpp
1 /*
2  *  Copyright (C) 2004-2016 Apple Inc. All rights reserved.
3  *  Copyright (C) 2005-2007 Alexey Proskuryakov <ap@webkit.org>
4  *  Copyright (C) 2007, 2008 Julien Chaffraix <jchaffraix@webkit.org>
5  *  Copyright (C) 2008, 2011 Google Inc. All rights reserved.
6  *  Copyright (C) 2012 Intel Corporation
7  *
8  *  This library is free software; you can redistribute it and/or
9  *  modify it under the terms of the GNU Lesser General Public
10  *  License as published by the Free Software Foundation; either
11  *  version 2 of the License, or (at your option) any later version.
12  *
13  *  This library is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  *  Lesser General Public License for more details.
17  *
18  *  You should have received a copy of the GNU Lesser General Public
19  *  License along with this library; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #include "config.h"
24 #include "XMLHttpRequest.h"
25
26 #include "Blob.h"
27 #include "CachedResourceRequestInitiators.h"
28 #include "ContentSecurityPolicy.h"
29 #include "CrossOriginAccessControl.h"
30 #include "DOMFormData.h"
31 #include "Event.h"
32 #include "EventNames.h"
33 #include "File.h"
34 #include "HTMLDocument.h"
35 #include "HTTPHeaderNames.h"
36 #include "HTTPHeaderValues.h"
37 #include "HTTPParsers.h"
38 #include "InspectorInstrumentation.h"
39 #include "JSDOMBinding.h"
40 #include "JSDOMWindow.h"
41 #include "MIMETypeRegistry.h"
42 #include "MemoryCache.h"
43 #include "ParsedContentType.h"
44 #include "ResourceError.h"
45 #include "ResourceRequest.h"
46 #include "ScriptController.h"
47 #include "SecurityOriginPolicy.h"
48 #include "Settings.h"
49 #include "SharedBuffer.h"
50 #include "StringAdaptors.h"
51 #include "TextResourceDecoder.h"
52 #include "ThreadableLoader.h"
53 #include "XMLDocument.h"
54 #include "XMLHttpRequestProgressEvent.h"
55 #include "XMLHttpRequestUpload.h"
56 #include "markup.h"
57 #include <interpreter/StackVisitor.h>
58 #include <mutex>
59 #include <runtime/ArrayBuffer.h>
60 #include <runtime/ArrayBufferView.h>
61 #include <runtime/JSCInlines.h>
62 #include <runtime/JSLock.h>
63 #include <wtf/RefCountedLeakCounter.h>
64 #include <wtf/StdLibExtras.h>
65 #include <wtf/text/CString.h>
66
67 namespace WebCore {
68
69 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, xmlHttpRequestCounter, ("XMLHttpRequest"));
70
71 // Histogram enum to see when we can deprecate xhr.send(ArrayBuffer).
72 enum XMLHttpRequestSendArrayBufferOrView {
73     XMLHttpRequestSendArrayBuffer,
74     XMLHttpRequestSendArrayBufferView,
75     XMLHttpRequestSendArrayBufferOrViewMax,
76 };
77
78 static void replaceCharsetInMediaType(String& mediaType, const String& charsetValue)
79 {
80     unsigned pos = 0, len = 0;
81
82     findCharsetInMediaType(mediaType, pos, len);
83
84     if (!len) {
85         // When no charset found, do nothing.
86         return;
87     }
88
89     // Found at least one existing charset, replace all occurrences with new charset.
90     while (len) {
91         mediaType.replace(pos, len, charsetValue);
92         unsigned start = pos + charsetValue.length();
93         findCharsetInMediaType(mediaType, pos, len, start);
94     }
95 }
96
97 static void logConsoleError(ScriptExecutionContext* context, const String& message)
98 {
99     if (!context)
100         return;
101     // FIXME: It's not good to report the bad usage without indicating what source line it came from.
102     // We should pass additional parameters so we can tell the console where the mistake occurred.
103     context->addConsoleMessage(MessageSource::JS, MessageLevel::Error, message);
104 }
105
106 Ref<XMLHttpRequest> XMLHttpRequest::create(ScriptExecutionContext& context)
107 {
108     auto xmlHttpRequest = adoptRef(*new XMLHttpRequest(context));
109     xmlHttpRequest->suspendIfNeeded();
110     return xmlHttpRequest;
111 }
112
113 XMLHttpRequest::XMLHttpRequest(ScriptExecutionContext& context)
114     : ActiveDOMObject(&context)
115     , m_progressEventThrottle(this)
116     , m_resumeTimer(*this, &XMLHttpRequest::resumeTimerFired)
117     , m_networkErrorTimer(*this, &XMLHttpRequest::networkErrorTimerFired)
118     , m_timeoutTimer(*this, &XMLHttpRequest::didReachTimeout)
119 {
120 #ifndef NDEBUG
121     xmlHttpRequestCounter.increment();
122 #endif
123 }
124
125 XMLHttpRequest::~XMLHttpRequest()
126 {
127 #ifndef NDEBUG
128     xmlHttpRequestCounter.decrement();
129 #endif
130 }
131
132 Document* XMLHttpRequest::document() const
133 {
134     ASSERT(scriptExecutionContext());
135     return downcast<Document>(scriptExecutionContext());
136 }
137
138 SecurityOrigin* XMLHttpRequest::securityOrigin() const
139 {
140     return scriptExecutionContext()->securityOrigin();
141 }
142
143 #if ENABLE(DASHBOARD_SUPPORT)
144
145 bool XMLHttpRequest::usesDashboardBackwardCompatibilityMode() const
146 {
147     if (scriptExecutionContext()->isWorkerGlobalScope())
148         return false;
149     return document()->settings().usesDashboardBackwardCompatibilityMode();
150 }
151
152 #endif
153
154 XMLHttpRequest::State XMLHttpRequest::readyState() const
155 {
156     return m_state;
157 }
158
159 ExceptionOr<OwnedString> XMLHttpRequest::responseText()
160 {
161     if (m_responseType != ResponseType::EmptyString && m_responseType != ResponseType::Text)
162         return Exception { InvalidStateError };
163     return OwnedString { responseTextIgnoringResponseType() };
164 }
165
166 void XMLHttpRequest::didCacheResponse()
167 {
168     ASSERT(doneWithoutErrors());
169     m_responseCacheIsValid = true;
170     m_responseBuilder.clear();
171 }
172
173 ExceptionOr<Document*> XMLHttpRequest::responseXML()
174 {
175     ASSERT(scriptExecutionContext()->isDocument());
176     
177     if (m_responseType != ResponseType::EmptyString && m_responseType != ResponseType::Document)
178         return Exception { InvalidStateError };
179
180     if (!doneWithoutErrors())
181         return nullptr;
182
183     if (!m_createdDocument) {
184         String mimeType = responseMIMEType();
185         bool isHTML = equalLettersIgnoringASCIICase(mimeType, "text/html");
186
187         // The W3C spec requires the final MIME type to be some valid XML type, or text/html.
188         // If it is text/html, then the responseType of "document" must have been supplied explicitly.
189         if ((m_response.isHTTP() && !responseIsXML() && !isHTML)
190             || (isHTML && m_responseType == ResponseType::EmptyString)) {
191             m_responseDocument = nullptr;
192         } else {
193             if (isHTML)
194                 m_responseDocument = HTMLDocument::create(0, m_url);
195             else
196                 m_responseDocument = XMLDocument::create(0, m_url);
197             // FIXME: Set Last-Modified.
198             m_responseDocument->setContent(m_responseBuilder.toStringPreserveCapacity());
199             m_responseDocument->setContextDocument(downcast<Document>(*scriptExecutionContext()));
200             m_responseDocument->setSecurityOriginPolicy(scriptExecutionContext()->securityOriginPolicy());
201             m_responseDocument->overrideMIMEType(mimeType);
202
203             if (!m_responseDocument->wellFormed())
204                 m_responseDocument = nullptr;
205         }
206         m_createdDocument = true;
207     }
208
209     return m_responseDocument.get();
210 }
211
212 Ref<Blob> XMLHttpRequest::createResponseBlob()
213 {
214     ASSERT(m_responseType == ResponseType::Blob);
215     ASSERT(doneWithoutErrors());
216
217     if (!m_binaryResponseBuilder)
218         return Blob::create();
219
220     // FIXME: We just received the data from NetworkProcess, and are sending it back. This is inefficient.
221     Vector<uint8_t> data;
222     data.append(m_binaryResponseBuilder->data(), m_binaryResponseBuilder->size());
223     m_binaryResponseBuilder = nullptr;
224     String normalizedContentType = Blob::normalizedContentType(responseMIMEType()); // responseMIMEType defaults to text/xml which may be incorrect.
225     return Blob::create(WTFMove(data), normalizedContentType);
226 }
227
228 RefPtr<ArrayBuffer> XMLHttpRequest::createResponseArrayBuffer()
229 {
230     ASSERT(m_responseType == ResponseType::Arraybuffer);
231     ASSERT(doneWithoutErrors());
232
233     auto result = m_binaryResponseBuilder ? m_binaryResponseBuilder->tryCreateArrayBuffer() : ArrayBuffer::create(nullptr, 0);
234     m_binaryResponseBuilder = nullptr;
235     return result;
236 }
237
238 ExceptionOr<void> XMLHttpRequest::setTimeout(unsigned timeout)
239 {
240     if (scriptExecutionContext()->isDocument() && !m_async) {
241         logConsoleError(scriptExecutionContext(), "XMLHttpRequest.timeout cannot be set for synchronous HTTP(S) requests made from the window context.");
242         return Exception { InvalidAccessError };
243     }
244     m_timeoutMilliseconds = timeout;
245     if (!m_timeoutTimer.isActive())
246         return { };
247
248     // If timeout is zero, we should use the default network timeout. But we disabled it so let's mimic it with a 60 seconds timeout value.
249     Seconds interval = Seconds { m_timeoutMilliseconds ? m_timeoutMilliseconds / 1000. : 60. } - (MonotonicTime::now() - m_sendingTime);
250     m_timeoutTimer.startOneShot(std::max(interval, 0_s));
251     return { };
252 }
253
254 ExceptionOr<void> XMLHttpRequest::setResponseType(ResponseType type)
255 {
256     if (!scriptExecutionContext()->isDocument() && type == ResponseType::Document)
257         return { };
258
259     if (m_state >= LOADING)
260         return Exception { InvalidStateError };
261
262     // Newer functionality is not available to synchronous requests in window contexts, as a spec-mandated
263     // attempt to discourage synchronous XHR use. responseType is one such piece of functionality.
264     // We'll only disable this functionality for HTTP(S) requests since sync requests for local protocols
265     // such as file: and data: still make sense to allow.
266     if (!m_async && scriptExecutionContext()->isDocument() && m_url.protocolIsInHTTPFamily()) {
267         logConsoleError(scriptExecutionContext(), "XMLHttpRequest.responseType cannot be changed for synchronous HTTP(S) requests made from the window context.");
268         return Exception { InvalidAccessError };
269     }
270
271     m_responseType = type;
272     return { };
273 }
274
275 String XMLHttpRequest::responseURL() const
276 {
277     URL responseURL(m_response.url());
278     responseURL.removeFragmentIdentifier();
279
280     return responseURL.string();
281 }
282
283 void XMLHttpRequest::setLastSendLineAndColumnNumber(unsigned lineNumber, unsigned columnNumber)
284 {
285     m_lastSendLineNumber = lineNumber;
286     m_lastSendColumnNumber = columnNumber;
287 }
288
289 XMLHttpRequestUpload* XMLHttpRequest::upload()
290 {
291     if (!m_upload)
292         m_upload = std::make_unique<XMLHttpRequestUpload>(this);
293     return m_upload.get();
294 }
295
296 void XMLHttpRequest::changeState(State newState)
297 {
298     if (m_state != newState) {
299         m_state = newState;
300         callReadyStateChangeListener();
301     }
302 }
303
304 void XMLHttpRequest::callReadyStateChangeListener()
305 {
306     if (!scriptExecutionContext())
307         return;
308
309     // Check whether sending load and loadend events before sending readystatechange event, as it may change m_error/m_state values.
310     bool shouldSendLoadEvent = (m_state == DONE && !m_error);
311
312     if (m_async || (m_state <= OPENED || m_state == DONE))
313         m_progressEventThrottle.dispatchReadyStateChangeEvent(Event::create(eventNames().readystatechangeEvent, false, false), m_state == DONE ? FlushProgressEvent : DoNotFlushProgressEvent);
314
315     if (shouldSendLoadEvent) {
316         m_progressEventThrottle.dispatchProgressEvent(eventNames().loadEvent);
317         m_progressEventThrottle.dispatchProgressEvent(eventNames().loadendEvent);
318     }
319 }
320
321 ExceptionOr<void> XMLHttpRequest::setWithCredentials(bool value)
322 {
323     if (m_state > OPENED || m_sendFlag)
324         return Exception { InvalidStateError };
325
326     m_includeCredentials = value;
327     return { };
328 }
329
330 String XMLHttpRequest::uppercaseKnownHTTPMethod(const String& method)
331 {
332     const char* const methods[] = { "DELETE", "GET", "HEAD", "OPTIONS", "POST", "PUT" };
333     for (auto* value : methods) {
334         if (equalIgnoringASCIICase(method, value)) {
335             // Don't bother allocating a new string if it's already all uppercase.
336             if (method == value)
337                 break;
338             return ASCIILiteral(value);
339         }
340     }
341     return method;
342 }
343
344 ExceptionOr<void> XMLHttpRequest::open(const String& method, const String& url)
345 {
346     // If the async argument is omitted, set async to true.
347     return open(method, scriptExecutionContext()->completeURL(url), true);
348 }
349
350 ExceptionOr<void> XMLHttpRequest::open(const String& method, const URL& url, bool async)
351 {
352     if (!internalAbort())
353         return { };
354
355     State previousState = m_state;
356     m_state = UNSENT;
357     m_error = false;
358     m_sendFlag = false;
359     m_uploadComplete = false;
360     m_wasAbortedByClient = false;
361
362     // clear stuff from possible previous load
363     clearResponse();
364     clearRequest();
365
366     ASSERT(m_state == UNSENT);
367
368     if (!isValidHTTPToken(method))
369         return Exception { SyntaxError };
370
371     if (isForbiddenMethod(method))
372         return Exception { SecurityError };
373
374     if (!async && scriptExecutionContext()->isDocument()) {
375         // Newer functionality is not available to synchronous requests in window contexts, as a spec-mandated
376         // attempt to discourage synchronous XHR use. responseType is one such piece of functionality.
377         // We'll only disable this functionality for HTTP(S) requests since sync requests for local protocols
378         // such as file: and data: still make sense to allow.
379         if (url.protocolIsInHTTPFamily() && m_responseType != ResponseType::EmptyString) {
380             logConsoleError(scriptExecutionContext(), "Synchronous HTTP(S) requests made from the window context cannot have XMLHttpRequest.responseType set.");
381             return Exception { InvalidAccessError };
382         }
383
384         // Similarly, timeouts are disabled for synchronous requests as well.
385         if (m_timeoutMilliseconds > 0) {
386             logConsoleError(scriptExecutionContext(), "Synchronous XMLHttpRequests must not have a timeout value set.");
387             return Exception { InvalidAccessError };
388         }
389     }
390
391     m_method = uppercaseKnownHTTPMethod(method);
392
393     m_url = url;
394     scriptExecutionContext()->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(m_url, ContentSecurityPolicy::InsecureRequestType::Load);
395
396     m_async = async;
397
398     ASSERT(!m_loader);
399
400     // Check previous state to avoid dispatching readyState event
401     // when calling open several times in a row.
402     if (previousState != OPENED)
403         changeState(OPENED);
404     else
405         m_state = OPENED;
406
407     return { };
408 }
409
410 ExceptionOr<void> XMLHttpRequest::open(const String& method, const String& url, bool async, const String& user, const String& password)
411 {
412     URL urlWithCredentials = scriptExecutionContext()->completeURL(url);
413     if (!user.isNull()) {
414         urlWithCredentials.setUser(user);
415         if (!password.isNull())
416             urlWithCredentials.setPass(password);
417     }
418
419     return open(method, urlWithCredentials, async);
420 }
421
422 std::optional<ExceptionOr<void>> XMLHttpRequest::prepareToSend()
423 {
424     // A return value other than std::nullopt means we should not try to send, and we should return that value to the caller.
425     // std::nullopt means we are ready to send and should continue with the send algorithm.
426
427     if (!scriptExecutionContext())
428         return ExceptionOr<void> { };
429
430     auto& context = *scriptExecutionContext();
431
432     if (m_state != OPENED || m_sendFlag)
433         return ExceptionOr<void> { Exception { InvalidStateError } };
434     ASSERT(!m_loader);
435
436     // FIXME: Convert this to check the isolated world's Content Security Policy once webkit.org/b/104520 is solved.
437     if (!context.shouldBypassMainWorldContentSecurityPolicy() && !context.contentSecurityPolicy()->allowConnectToSource(m_url)) {
438         if (!m_async)
439             return ExceptionOr<void> { Exception { NetworkError } };
440         setPendingActivity(this);
441         m_timeoutTimer.stop();
442         m_networkErrorTimer.startOneShot(0_s);
443         return ExceptionOr<void> { };
444     }
445
446     m_error = false;
447     return std::nullopt;
448 }
449
450 namespace {
451
452 // FIXME: This should be abstracted out, so that any IDL function can be passed the line/column/url tuple.
453
454 // FIXME: This should probably use ShadowChicken so that we get the right frame even when it did a tail call.
455 // https://bugs.webkit.org/show_bug.cgi?id=155688
456
457 class SendFunctor {
458 public:
459     SendFunctor() = default;
460
461     unsigned line() const { return m_line; }
462     unsigned column() const { return m_column; }
463     String url() const { return m_url; }
464
465     JSC::StackVisitor::Status operator()(JSC::StackVisitor& visitor) const
466     {
467         if (!m_hasSkippedFirstFrame) {
468             m_hasSkippedFirstFrame = true;
469             return JSC::StackVisitor::Continue;
470         }
471
472         unsigned line = 0;
473         unsigned column = 0;
474         visitor->computeLineAndColumn(line, column);
475         m_line = line;
476         m_column = column;
477         m_url = visitor->sourceURL();
478         return JSC::StackVisitor::Done;
479     }
480
481 private:
482     mutable bool m_hasSkippedFirstFrame { false };
483     mutable unsigned m_line { 0 };
484     mutable unsigned m_column { 0 };
485     mutable String m_url;
486 };
487
488 }
489
490 ExceptionOr<void> XMLHttpRequest::send(JSC::ExecState& state, std::optional<SendTypes>&& sendType)
491 {
492     InspectorInstrumentation::willSendXMLHttpRequest(scriptExecutionContext(), url());
493
494     ExceptionOr<void> result;
495     if (!sendType)
496         result = send();
497     else {
498         result = WTF::switchOn(sendType.value(),
499             [this] (const RefPtr<Document>& document) -> ExceptionOr<void> { return send(*document); },
500             [this] (const RefPtr<Blob>& blob) -> ExceptionOr<void> { return send(*blob); },
501             [this] (const RefPtr<JSC::ArrayBufferView>& arrayBufferView) -> ExceptionOr<void> { return send(*arrayBufferView); },
502             [this] (const RefPtr<JSC::ArrayBuffer>& arrayBuffer) -> ExceptionOr<void> { return send(*arrayBuffer); },
503             [this] (const RefPtr<DOMFormData>& formData) -> ExceptionOr<void> { return send(*formData); },
504             [this] (const String& string) -> ExceptionOr<void> { return send(string); }
505         );
506     }
507
508     SendFunctor functor;
509     state.iterate(functor);
510     setLastSendLineAndColumnNumber(functor.line(), functor.column());
511     setLastSendURL(functor.url());
512
513     return result;
514 }
515
516 ExceptionOr<void> XMLHttpRequest::send(Document& document)
517 {
518     if (auto result = prepareToSend())
519         return WTFMove(result.value());
520
521     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
522         if (!m_requestHeaders.contains(HTTPHeaderName::ContentType)) {
523 #if ENABLE(DASHBOARD_SUPPORT)
524             if (usesDashboardBackwardCompatibilityMode())
525                 m_requestHeaders.set(HTTPHeaderName::ContentType, ASCIILiteral("application/x-www-form-urlencoded"));
526             else
527 #endif
528                 // FIXME: this should include the charset used for encoding.
529                 m_requestHeaders.set(HTTPHeaderName::ContentType, document.isHTMLDocument() ? ASCIILiteral("text/html;charset=UTF-8") : ASCIILiteral("application/xml;charset=UTF-8"));
530         }
531
532         // FIXME: According to XMLHttpRequest Level 2, this should use the Document.innerHTML algorithm
533         // from the HTML5 specification to serialize the document.
534         m_requestEntityBody = FormData::create(UTF8Encoding().encode(createMarkup(document), EntitiesForUnencodables));
535         if (m_upload)
536             m_requestEntityBody->setAlwaysStream(true);
537     }
538
539     return createRequest();
540 }
541
542 ExceptionOr<void> XMLHttpRequest::send(const String& body)
543 {
544     if (auto result = prepareToSend())
545         return WTFMove(result.value());
546
547     if (!body.isNull() && m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
548         String contentType = m_requestHeaders.get(HTTPHeaderName::ContentType);
549         if (contentType.isNull()) {
550 #if ENABLE(DASHBOARD_SUPPORT)
551             if (usesDashboardBackwardCompatibilityMode())
552                 m_requestHeaders.set(HTTPHeaderName::ContentType, ASCIILiteral("application/x-www-form-urlencoded"));
553             else
554 #endif
555                 m_requestHeaders.set(HTTPHeaderName::ContentType, HTTPHeaderValues::textPlainContentType());
556         } else {
557             replaceCharsetInMediaType(contentType, "UTF-8");
558             m_requestHeaders.set(HTTPHeaderName::ContentType, contentType);
559         }
560
561         m_requestEntityBody = FormData::create(UTF8Encoding().encode(body, EntitiesForUnencodables));
562         if (m_upload)
563             m_requestEntityBody->setAlwaysStream(true);
564     }
565
566     return createRequest();
567 }
568
569 ExceptionOr<void> XMLHttpRequest::send(Blob& body)
570 {
571     if (auto result = prepareToSend())
572         return WTFMove(result.value());
573
574     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
575         if (!m_requestHeaders.contains(HTTPHeaderName::ContentType)) {
576             const String& blobType = body.type();
577             if (!blobType.isEmpty() && isValidContentType(blobType))
578                 m_requestHeaders.set(HTTPHeaderName::ContentType, blobType);
579             else {
580                 // From FileAPI spec, whenever media type cannot be determined, empty string must be returned.
581                 m_requestHeaders.set(HTTPHeaderName::ContentType, emptyString());
582             }
583         }
584
585         m_requestEntityBody = FormData::create();
586         m_requestEntityBody->appendBlob(body.url());
587     }
588
589     return createRequest();
590 }
591
592 ExceptionOr<void> XMLHttpRequest::send(DOMFormData& body)
593 {
594     if (auto result = prepareToSend())
595         return WTFMove(result.value());
596
597     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
598         m_requestEntityBody = FormData::createMultiPart(body, document());
599         m_requestEntityBody->generateFiles(document());
600         if (!m_requestHeaders.contains(HTTPHeaderName::ContentType))
601             m_requestHeaders.set(HTTPHeaderName::ContentType, makeString("multipart/form-data; boundary=", m_requestEntityBody->boundary().data()));
602     }
603
604     return createRequest();
605 }
606
607 ExceptionOr<void> XMLHttpRequest::send(ArrayBuffer& body)
608 {
609     ASCIILiteral consoleMessage("ArrayBuffer is deprecated in XMLHttpRequest.send(). Use ArrayBufferView instead.");
610     scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Warning, consoleMessage);
611     return sendBytesData(body.data(), body.byteLength());
612 }
613
614 ExceptionOr<void> XMLHttpRequest::send(ArrayBufferView& body)
615 {
616     return sendBytesData(body.baseAddress(), body.byteLength());
617 }
618
619 ExceptionOr<void> XMLHttpRequest::sendBytesData(const void* data, size_t length)
620 {
621     if (auto result = prepareToSend())
622         return WTFMove(result.value());
623
624     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
625         m_requestEntityBody = FormData::create(data, length);
626         if (m_upload)
627             m_requestEntityBody->setAlwaysStream(true);
628     }
629
630     return createRequest();
631 }
632
633 ExceptionOr<void> XMLHttpRequest::createRequest()
634 {
635     // Only GET request is supported for blob URL.
636     if (!m_async && m_url.protocolIsBlob() && m_method != "GET")
637         return Exception { NetworkError };
638
639     m_sendFlag = true;
640
641     // The presence of upload event listeners forces us to use preflighting because POSTing to an URL that does not
642     // permit cross origin requests should look exactly like POSTing to an URL that does not respond at all.
643     // Also, only async requests support upload progress events.
644     bool uploadEvents = false;
645     if (m_async) {
646         m_progressEventThrottle.dispatchProgressEvent(eventNames().loadstartEvent);
647         if (m_requestEntityBody && m_upload) {
648             uploadEvents = m_upload->hasEventListeners();
649             m_upload->dispatchProgressEvent(eventNames().loadstartEvent);
650         }
651     }
652
653     m_sameOriginRequest = securityOrigin()->canRequest(m_url);
654
655     // We also remember whether upload events should be allowed for this request in case the upload listeners are
656     // added after the request is started.
657     m_uploadEventsAllowed = m_sameOriginRequest || uploadEvents || !isSimpleCrossOriginAccessRequest(m_method, m_requestHeaders);
658
659     ResourceRequest request(m_url);
660     request.setRequester(ResourceRequest::Requester::XHR);
661     request.setInitiatorIdentifier(scriptExecutionContext()->resourceRequestIdentifier());
662     request.setHTTPMethod(m_method);
663
664     if (m_requestEntityBody) {
665         ASSERT(m_method != "GET");
666         ASSERT(m_method != "HEAD");
667         request.setHTTPBody(WTFMove(m_requestEntityBody));
668     }
669
670     if (!m_requestHeaders.isEmpty())
671         request.setHTTPHeaderFields(m_requestHeaders);
672
673     ThreadableLoaderOptions options;
674     options.sendLoadCallbacks = SendCallbacks;
675     options.preflightPolicy = uploadEvents ? ForcePreflight : ConsiderPreflight;
676     options.credentials = m_includeCredentials ? FetchOptions::Credentials::Include : FetchOptions::Credentials::SameOrigin;
677     options.mode = FetchOptions::Mode::Cors;
678     options.contentSecurityPolicyEnforcement = scriptExecutionContext()->shouldBypassMainWorldContentSecurityPolicy() ? ContentSecurityPolicyEnforcement::DoNotEnforce : ContentSecurityPolicyEnforcement::EnforceConnectSrcDirective;
679     options.initiator = cachedResourceRequestInitiators().xmlhttprequest;
680     options.sameOriginDataURLFlag = SameOriginDataURLFlag::Set;
681     options.filteringPolicy = ResponseFilteringPolicy::Enable;
682
683     if (m_timeoutMilliseconds) {
684         if (!m_async)
685             request.setTimeoutInterval(m_timeoutMilliseconds / 1000.0);
686         else {
687             request.setTimeoutInterval(std::numeric_limits<double>::infinity());
688             m_sendingTime = MonotonicTime::now();
689             m_timeoutTimer.startOneShot(1_ms * m_timeoutMilliseconds);
690         }
691     }
692
693     m_exceptionCode = std::nullopt;
694     m_error = false;
695
696     if (m_async) {
697         // ThreadableLoader::create can return null here, for example if we're no longer attached to a page or if a content blocker blocks the load.
698         // This is true while running onunload handlers.
699         // FIXME: Maybe we need to be able to send XMLHttpRequests from onunload, <http://bugs.webkit.org/show_bug.cgi?id=10904>.
700         m_loader = ThreadableLoader::create(*scriptExecutionContext(), *this, WTFMove(request), options);
701
702         // Either loader is null or some error was synchronously sent to us.
703         ASSERT(m_loader || !m_sendFlag);
704
705         // Neither this object nor the JavaScript wrapper should be deleted while
706         // a request is in progress because we need to keep the listeners alive,
707         // and they are referenced by the JavaScript wrapper.
708         if (m_loader)
709             setPendingActivity(this);
710     } else {
711         request.setDomainForCachePartition(scriptExecutionContext()->topOrigin().domainForCachePartition());
712         InspectorInstrumentation::willLoadXHRSynchronously(scriptExecutionContext());
713         ThreadableLoader::loadResourceSynchronously(*scriptExecutionContext(), WTFMove(request), *this, options);
714         InspectorInstrumentation::didLoadXHRSynchronously(scriptExecutionContext());
715     }
716
717     if (m_exceptionCode)
718         return Exception { m_exceptionCode.value() };
719     if (m_error)
720         return Exception { NetworkError };
721     return { };
722 }
723
724 void XMLHttpRequest::abort()
725 {
726     // internalAbort() calls dropProtection(), which may release the last reference.
727     Ref<XMLHttpRequest> protectedThis(*this);
728
729     m_wasAbortedByClient = true;
730     if (!internalAbort())
731         return;
732
733     clearResponseBuffers();
734
735     // Clear headers as required by the spec
736     m_requestHeaders.clear();
737     if ((m_state == OPENED && m_sendFlag) || m_state == HEADERS_RECEIVED || m_state == LOADING) {
738         ASSERT(!m_loader);
739         m_sendFlag = false;
740         changeState(DONE);
741         dispatchErrorEvents(eventNames().abortEvent);
742     }
743     m_state = UNSENT;
744 }
745
746 bool XMLHttpRequest::internalAbort()
747 {
748     m_error = true;
749
750     // FIXME: when we add the support for multi-part XHR, we will have to think be careful with this initialization.
751     m_receivedLength = 0;
752
753     m_decoder = nullptr;
754
755     m_timeoutTimer.stop();
756
757     if (!m_loader)
758         return true;
759
760     // Cancelling m_loader may trigger a window.onload callback which can call open() on the same xhr.
761     // This would create internalAbort reentrant call.
762     // m_loader is set to null before being cancelled to exit early in any reentrant internalAbort() call.
763     auto loader = WTFMove(m_loader);
764     loader->cancel();
765
766     // If window.onload callback calls open() and send() on the same xhr, m_loader is now set to a new value.
767     // The function calling internalAbort() should abort to let the open() and send() calls continue properly.
768     // We ask the function calling internalAbort() to exit by returning false.
769     // Save this information to a local variable since we are going to drop protection.
770     bool newLoadStarted = m_loader;
771
772     dropProtection();
773
774     return !newLoadStarted;
775 }
776
777 void XMLHttpRequest::clearResponse()
778 {
779     m_response = ResourceResponse();
780     clearResponseBuffers();
781 }
782
783 void XMLHttpRequest::clearResponseBuffers()
784 {
785     m_responseBuilder.clear();
786     m_responseEncoding = String();
787     m_createdDocument = false;
788     m_responseDocument = nullptr;
789     m_binaryResponseBuilder = nullptr;
790     m_responseCacheIsValid = false;
791 }
792
793 void XMLHttpRequest::clearRequest()
794 {
795     m_requestHeaders.clear();
796     m_requestEntityBody = nullptr;
797 }
798
799 void XMLHttpRequest::genericError()
800 {
801     clearResponse();
802     clearRequest();
803     m_sendFlag = false;
804     m_error = true;
805
806     changeState(DONE);
807 }
808
809 void XMLHttpRequest::networkError()
810 {
811     genericError();
812     dispatchErrorEvents(eventNames().errorEvent);
813     internalAbort();
814 }
815
816 void XMLHttpRequest::networkErrorTimerFired()
817 {
818     networkError();
819     dropProtection();
820 }
821     
822 void XMLHttpRequest::abortError()
823 {
824     ASSERT(m_wasAbortedByClient);
825     genericError();
826     dispatchErrorEvents(eventNames().abortEvent);
827 }
828
829 void XMLHttpRequest::dropProtection()
830 {
831     // The XHR object itself holds on to the responseText, and
832     // thus has extra cost even independent of any
833     // responseText or responseXML objects it has handed
834     // out. But it is protected from GC while loading, so this
835     // can't be recouped until the load is done, so only
836     // report the extra cost at that point.
837     JSC::VM& vm = scriptExecutionContext()->vm();
838     JSC::JSLockHolder lock(vm);
839     // FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
840     // https://bugs.webkit.org/show_bug.cgi?id=142595
841     vm.heap.deprecatedReportExtraMemory(m_responseBuilder.length() * 2);
842
843     unsetPendingActivity(this);
844 }
845
846 ExceptionOr<void> XMLHttpRequest::overrideMimeType(const String& override)
847 {
848     if (m_state == LOADING || m_state == DONE)
849         return Exception { InvalidStateError };
850
851     m_mimeTypeOverride = override;
852     return { };
853 }
854
855 ExceptionOr<void> XMLHttpRequest::setRequestHeader(const String& name, const String& value)
856 {
857     if (m_state != OPENED || m_sendFlag) {
858 #if ENABLE(DASHBOARD_SUPPORT)
859         if (usesDashboardBackwardCompatibilityMode())
860             return { };
861 #endif
862         return Exception { InvalidStateError };
863     }
864
865     String normalizedValue = stripLeadingAndTrailingHTTPSpaces(value);
866     if (!isValidHTTPToken(name) || !isValidHTTPHeaderValue(normalizedValue))
867         return Exception { SyntaxError };
868
869     bool allowUnsafeHeaderField = false;
870 #if ENABLE(DASHBOARD_SUPPORT)
871     allowUnsafeHeaderField = usesDashboardBackwardCompatibilityMode();
872 #endif
873     if (!allowUnsafeHeaderField && isForbiddenHeaderName(name)) {
874         logConsoleError(scriptExecutionContext(), "Refused to set unsafe header \"" + name + "\"");
875         return { };
876     }
877
878     m_requestHeaders.add(name, normalizedValue);
879     return { };
880 }
881
882 String XMLHttpRequest::getAllResponseHeaders() const
883 {
884     if (m_state < HEADERS_RECEIVED || m_error)
885         return emptyString();
886
887     if (!m_allResponseHeaders) {
888         Vector<String> headers;
889         headers.reserveInitialCapacity(m_response.httpHeaderFields().size());
890
891         for (auto& header : m_response.httpHeaderFields()) {
892             StringBuilder stringBuilder;
893             stringBuilder.append(header.key.convertToASCIILowercase());
894             stringBuilder.appendLiteral(": ");
895             stringBuilder.append(header.value);
896             stringBuilder.appendLiteral("\r\n");
897             headers.uncheckedAppend(stringBuilder.toString());
898         }
899         std::sort(headers.begin(), headers.end(), WTF::codePointCompareLessThan);
900
901         StringBuilder stringBuilder;
902         for (auto& header : headers)
903             stringBuilder.append(header);
904         m_allResponseHeaders = stringBuilder.toString();
905     }
906
907     return m_allResponseHeaders;
908 }
909
910 String XMLHttpRequest::getResponseHeader(const String& name) const
911 {
912     if (m_state < HEADERS_RECEIVED || m_error)
913         return String();
914
915     return m_response.httpHeaderField(name);
916 }
917
918 String XMLHttpRequest::responseMIMEType() const
919 {
920     String mimeType = extractMIMETypeFromMediaType(m_mimeTypeOverride);
921     if (mimeType.isEmpty()) {
922         if (m_response.isHTTP())
923             mimeType = extractMIMETypeFromMediaType(m_response.httpHeaderField(HTTPHeaderName::ContentType));
924         else
925             mimeType = m_response.mimeType();
926         if (mimeType.isEmpty())
927             mimeType = ASCIILiteral("text/xml");
928     }
929     return mimeType;
930 }
931
932 bool XMLHttpRequest::responseIsXML() const
933 {
934     return MIMETypeRegistry::isXMLMIMEType(responseMIMEType());
935 }
936
937 int XMLHttpRequest::status() const
938 {
939     if (m_state == UNSENT || m_state == OPENED || m_error)
940         return 0;
941
942     return m_response.httpStatusCode();
943 }
944
945 String XMLHttpRequest::statusText() const
946 {
947     if (m_state == UNSENT || m_state == OPENED || m_error)
948         return String();
949
950     return m_response.httpStatusText();
951 }
952
953 void XMLHttpRequest::didFail(const ResourceError& error)
954 {
955     // If we are already in an error state, for instance we called abort(), bail out early.
956     if (m_error)
957         return;
958
959     // The XHR specification says we should only fire an abort event if the cancelation was requested by the client.
960     if (m_wasAbortedByClient && error.isCancellation()) {
961         m_exceptionCode = AbortError;
962         abortError();
963         return;
964     }
965
966     // In case of worker sync timeouts.
967     if (error.isTimeout()) {
968         didReachTimeout();
969         return;
970     }
971
972     // Network failures are already reported to Web Inspector by ResourceLoader.
973     if (error.domain() == errorDomainWebKitInternal) {
974         String message = makeString("XMLHttpRequest cannot load ", error.failingURL().string(), ". ", error.localizedDescription());
975         logConsoleError(scriptExecutionContext(), message);
976     } else if (error.isAccessControl()) {
977         String message = makeString("XMLHttpRequest cannot load ", error.failingURL().string(), " due to access control checks.");
978         logConsoleError(scriptExecutionContext(), message);
979     }
980
981     // In case didFail is called synchronously on an asynchronous XHR call, let's dispatch network error asynchronously
982     if (m_async && m_sendFlag && !m_loader) {
983         m_sendFlag = false;
984         setPendingActivity(this);
985         m_timeoutTimer.stop();
986         m_networkErrorTimer.startOneShot(0_s);
987         return;
988     }
989     m_exceptionCode = NetworkError;
990     networkError();
991 }
992
993 void XMLHttpRequest::didFinishLoading(unsigned long identifier)
994 {
995     if (m_error)
996         return;
997
998     if (m_state < HEADERS_RECEIVED)
999         changeState(HEADERS_RECEIVED);
1000
1001     if (m_decoder)
1002         m_responseBuilder.append(m_decoder->flush());
1003
1004     m_responseBuilder.shrinkToFit();
1005
1006     std::optional<String> decodedText;
1007     if (!m_binaryResponseBuilder)
1008         decodedText = m_responseBuilder.toStringPreserveCapacity();
1009     InspectorInstrumentation::didFinishXHRLoading(scriptExecutionContext(), identifier, decodedText, m_url, m_lastSendURL, m_lastSendLineNumber, m_lastSendColumnNumber);
1010
1011     bool hadLoader = m_loader;
1012     m_loader = nullptr;
1013
1014     m_sendFlag = false;
1015     changeState(DONE);
1016     m_responseEncoding = String();
1017     m_decoder = nullptr;
1018
1019     m_timeoutTimer.stop();
1020
1021     if (hadLoader)
1022         dropProtection();
1023 }
1024
1025 void XMLHttpRequest::didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
1026 {
1027     if (!m_upload)
1028         return;
1029
1030     if (m_uploadEventsAllowed)
1031         m_upload->dispatchThrottledProgressEvent(true, bytesSent, totalBytesToBeSent);
1032     if (bytesSent == totalBytesToBeSent && !m_uploadComplete) {
1033         m_uploadComplete = true;
1034         if (m_uploadEventsAllowed) {
1035             m_upload->dispatchProgressEvent(eventNames().loadEvent);
1036             m_upload->dispatchProgressEvent(eventNames().loadendEvent);
1037         }
1038     }
1039 }
1040
1041 void XMLHttpRequest::didReceiveResponse(unsigned long, const ResourceResponse& response)
1042 {
1043     m_response = response;
1044     if (!m_mimeTypeOverride.isEmpty())
1045         m_response.setHTTPHeaderField(HTTPHeaderName::ContentType, m_mimeTypeOverride);
1046 }
1047
1048 static inline bool shouldDecodeResponse(XMLHttpRequest::ResponseType type)
1049 {
1050     switch (type) {
1051     case XMLHttpRequest::ResponseType::EmptyString:
1052     case XMLHttpRequest::ResponseType::Document:
1053     case XMLHttpRequest::ResponseType::Json:
1054     case XMLHttpRequest::ResponseType::Text:
1055         return true;
1056     case XMLHttpRequest::ResponseType::Arraybuffer:
1057     case XMLHttpRequest::ResponseType::Blob:
1058         return false;
1059     }
1060     ASSERT_NOT_REACHED();
1061     return true;
1062 }
1063
1064 void XMLHttpRequest::didReceiveData(const char* data, int len)
1065 {
1066     if (m_error)
1067         return;
1068
1069     if (m_state < HEADERS_RECEIVED)
1070         changeState(HEADERS_RECEIVED);
1071
1072     // FIXME: Should we update "Content-Type" header field with m_mimeTypeOverride value in case it has changed since didReceiveResponse?
1073     if (!m_mimeTypeOverride.isEmpty())
1074         m_responseEncoding = extractCharsetFromMediaType(m_mimeTypeOverride);
1075     if (m_responseEncoding.isEmpty())
1076         m_responseEncoding = m_response.textEncodingName();
1077
1078     bool useDecoder = shouldDecodeResponse(m_responseType);
1079
1080     if (useDecoder && !m_decoder) {
1081         if (!m_responseEncoding.isEmpty())
1082             m_decoder = TextResourceDecoder::create("text/plain", m_responseEncoding);
1083         // allow TextResourceDecoder to look inside the m_response if it's XML or HTML
1084         else if (responseIsXML()) {
1085             m_decoder = TextResourceDecoder::create("application/xml");
1086             // Don't stop on encoding errors, unlike it is done for other kinds of XML resources. This matches the behavior of previous WebKit versions, Firefox and Opera.
1087             m_decoder->useLenientXMLDecoding();
1088         } else if (equalLettersIgnoringASCIICase(responseMIMEType(), "text/html"))
1089             m_decoder = TextResourceDecoder::create("text/html", "UTF-8");
1090         else
1091             m_decoder = TextResourceDecoder::create("text/plain", "UTF-8");
1092     }
1093
1094     if (!len)
1095         return;
1096
1097     if (len == -1)
1098         len = strlen(data);
1099
1100     if (useDecoder)
1101         m_responseBuilder.append(m_decoder->decode(data, len));
1102     else {
1103         // Buffer binary data.
1104         if (!m_binaryResponseBuilder)
1105             m_binaryResponseBuilder = SharedBuffer::create();
1106         m_binaryResponseBuilder->append(data, len);
1107     }
1108
1109     if (!m_error) {
1110         m_receivedLength += len;
1111
1112         if (m_async) {
1113             long long expectedLength = m_response.expectedContentLength();
1114             bool lengthComputable = expectedLength > 0 && m_receivedLength <= expectedLength;
1115             unsigned long long total = lengthComputable ? expectedLength : 0;
1116             m_progressEventThrottle.dispatchThrottledProgressEvent(lengthComputable, m_receivedLength, total);
1117         }
1118
1119         if (m_state != LOADING)
1120             changeState(LOADING);
1121         else
1122             // Firefox calls readyStateChanged every time it receives data, 4449442
1123             callReadyStateChangeListener();
1124     }
1125 }
1126
1127 void XMLHttpRequest::dispatchErrorEvents(const AtomicString& type)
1128 {
1129     if (!m_uploadComplete) {
1130         m_uploadComplete = true;
1131         if (m_upload && m_uploadEventsAllowed) {
1132             m_upload->dispatchProgressEvent(eventNames().progressEvent);
1133             m_upload->dispatchProgressEvent(type);
1134             m_upload->dispatchProgressEvent(eventNames().loadendEvent);
1135         }
1136     }
1137     m_progressEventThrottle.dispatchProgressEvent(eventNames().progressEvent);
1138     m_progressEventThrottle.dispatchProgressEvent(type);
1139     m_progressEventThrottle.dispatchProgressEvent(eventNames().loadendEvent);
1140 }
1141
1142 void XMLHttpRequest::didReachTimeout()
1143 {
1144     // internalAbort() calls dropProtection(), which may release the last reference.
1145     Ref<XMLHttpRequest> protectedThis(*this);
1146     if (!internalAbort())
1147         return;
1148
1149     clearResponse();
1150     clearRequest();
1151
1152     m_sendFlag = false;
1153     m_error = true;
1154     m_exceptionCode = TimeoutError;
1155
1156     if (!m_async) {
1157         m_state = DONE;
1158         m_exceptionCode = TimeoutError;
1159         return;
1160     }
1161
1162     changeState(DONE);
1163
1164     dispatchErrorEvents(eventNames().timeoutEvent);
1165 }
1166
1167 bool XMLHttpRequest::canSuspendForDocumentSuspension() const
1168 {
1169     // If the load event has not fired yet, cancelling the load in suspend() may cause
1170     // the load event to be fired and arbitrary JS execution, which would be unsafe.
1171     // Therefore, we prevent suspending in this case.
1172     return document()->loadEventFinished();
1173 }
1174
1175 const char* XMLHttpRequest::activeDOMObjectName() const
1176 {
1177     return "XMLHttpRequest";
1178 }
1179
1180 void XMLHttpRequest::suspend(ReasonForSuspension reason)
1181 {
1182     m_progressEventThrottle.suspend();
1183
1184     if (m_resumeTimer.isActive()) {
1185         m_resumeTimer.stop();
1186         m_dispatchErrorOnResuming = true;
1187     }
1188
1189     if (reason == ActiveDOMObject::PageCache && m_loader) {
1190         // Going into PageCache, abort the request and dispatch a network error on resuming.
1191         genericError();
1192         m_dispatchErrorOnResuming = true;
1193         bool aborted = internalAbort();
1194         // It should not be possible to restart the load when aborting in suspend() because
1195         // we are not allowed to execute in JS in suspend().
1196         ASSERT_UNUSED(aborted, aborted);
1197     }
1198 }
1199
1200 void XMLHttpRequest::resume()
1201 {
1202     m_progressEventThrottle.resume();
1203
1204     // We are not allowed to execute arbitrary JS in resume() so dispatch
1205     // the error event in a timer.
1206     if (m_dispatchErrorOnResuming && !m_resumeTimer.isActive())
1207         m_resumeTimer.startOneShot(0_s);
1208 }
1209
1210 void XMLHttpRequest::resumeTimerFired()
1211 {
1212     ASSERT(m_dispatchErrorOnResuming);
1213     m_dispatchErrorOnResuming = false;
1214     dispatchErrorEvents(eventNames().errorEvent);
1215 }
1216
1217 void XMLHttpRequest::stop()
1218 {
1219     internalAbort();
1220 }
1221
1222 void XMLHttpRequest::contextDestroyed()
1223 {
1224     ASSERT(!m_loader);
1225     ActiveDOMObject::contextDestroyed();
1226 }
1227
1228 } // namespace WebCore