Reduce the number of ResourceRequest copies in DocumentThreadableLoader
[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 "DOMImplementation.h"
32 #include "Event.h"
33 #include "EventNames.h"
34 #include "ExceptionCode.h"
35 #include "File.h"
36 #include "HTMLDocument.h"
37 #include "HTTPHeaderNames.h"
38 #include "HTTPParsers.h"
39 #include "InspectorInstrumentation.h"
40 #include "JSDOMBinding.h"
41 #include "JSDOMWindow.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 "TextResourceDecoder.h"
51 #include "ThreadableLoader.h"
52 #include "XMLHttpRequestProgressEvent.h"
53 #include "XMLHttpRequestUpload.h"
54 #include "markup.h"
55 #include <heap/Strong.h>
56 #include <mutex>
57 #include <runtime/ArrayBuffer.h>
58 #include <runtime/ArrayBufferView.h>
59 #include <runtime/JSCInlines.h>
60 #include <runtime/JSLock.h>
61 #include <wtf/NeverDestroyed.h>
62 #include <wtf/Ref.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     Settings* settings = document()->settings();
150     return settings && settings->usesDashboardBackwardCompatibilityMode();
151 }
152
153 #endif
154
155 XMLHttpRequest::State XMLHttpRequest::readyState() const
156 {
157     return m_state;
158 }
159
160 String XMLHttpRequest::responseText(ExceptionCode& ec)
161 {
162     if (m_responseType != ResponseType::EmptyString && m_responseType != ResponseType::Text) {
163         ec = INVALID_STATE_ERR;
164         return { };
165     }
166     return responseTextIgnoringResponseType();
167 }
168
169 void XMLHttpRequest::didCacheResponse()
170 {
171     ASSERT(doneWithoutErrors());
172     m_responseCacheIsValid = true;
173     m_responseBuilder.clear();
174 }
175
176 Document* XMLHttpRequest::responseXML(ExceptionCode& ec)
177 {
178     if (m_responseType != ResponseType::EmptyString && m_responseType != ResponseType::Document) {
179         ec = INVALID_STATE_ERR;
180         return nullptr;
181     }
182
183     if (!doneWithoutErrors())
184         return nullptr;
185
186     if (!m_createdDocument) {
187         String mimeType = responseMIMEType();
188         bool isHTML = equalLettersIgnoringASCIICase(mimeType, "text/html");
189
190         // The W3C spec requires the final MIME type to be some valid XML type, or text/html.
191         // If it is text/html, then the responseType of "document" must have been supplied explicitly.
192         if ((m_response.isHTTP() && !responseIsXML() && !isHTML)
193             || (isHTML && m_responseType == ResponseType::EmptyString)
194             || scriptExecutionContext()->isWorkerGlobalScope()) {
195             m_responseDocument = nullptr;
196         } else {
197             if (isHTML)
198                 m_responseDocument = HTMLDocument::create(0, m_url);
199             else
200                 m_responseDocument = XMLDocument::create(0, m_url);
201             // FIXME: Set Last-Modified.
202             m_responseDocument->setContent(m_responseBuilder.toStringPreserveCapacity());
203             m_responseDocument->setSecurityOriginPolicy(scriptExecutionContext()->securityOriginPolicy());
204             m_responseDocument->overrideMIMEType(mimeType);
205
206             if (!m_responseDocument->wellFormed())
207                 m_responseDocument = nullptr;
208         }
209         m_createdDocument = true;
210     }
211
212     return m_responseDocument.get();
213 }
214
215 Ref<Blob> XMLHttpRequest::createResponseBlob()
216 {
217     ASSERT(m_responseType == ResponseType::Blob);
218     ASSERT(doneWithoutErrors());
219
220     if (!m_binaryResponseBuilder)
221         return Blob::create();
222
223     // FIXME: We just received the data from NetworkProcess, and are sending it back. This is inefficient.
224     Vector<uint8_t> data;
225     data.append(m_binaryResponseBuilder->data(), m_binaryResponseBuilder->size());
226     m_binaryResponseBuilder = nullptr;
227     String normalizedContentType = Blob::normalizedContentType(responseMIMEType()); // responseMIMEType defaults to text/xml which may be incorrect.
228     return Blob::create(WTFMove(data), normalizedContentType);
229 }
230
231 RefPtr<ArrayBuffer> XMLHttpRequest::createResponseArrayBuffer()
232 {
233     ASSERT(m_responseType == ResponseType::Arraybuffer);
234     ASSERT(doneWithoutErrors());
235
236     auto result = m_binaryResponseBuilder ? m_binaryResponseBuilder->createArrayBuffer() : ArrayBuffer::create(nullptr, 0);
237     m_binaryResponseBuilder = nullptr;
238     return result;
239 }
240
241 void XMLHttpRequest::setTimeout(unsigned timeout, ExceptionCode& ec)
242 {
243     if (scriptExecutionContext()->isDocument() && !m_async) {
244         logConsoleError(scriptExecutionContext(), "XMLHttpRequest.timeout cannot be set for synchronous HTTP(S) requests made from the window context.");
245         ec = INVALID_ACCESS_ERR;
246         return;
247     }
248     m_timeoutMilliseconds = timeout;
249     if (!m_timeoutTimer.isActive())
250         return;
251     if (!m_timeoutMilliseconds) {
252         m_timeoutTimer.stop();
253         return;
254     }
255     std::chrono::duration<double> interval = std::chrono::milliseconds { m_timeoutMilliseconds } - (std::chrono::steady_clock::now() - m_sendingTime);
256     m_timeoutTimer.startOneShot(std::max(0.0, interval.count()));
257 }
258
259 void XMLHttpRequest::setResponseType(ResponseType type, ExceptionCode& ec)
260 {
261     if (m_state >= LOADING) {
262         ec = INVALID_STATE_ERR;
263         return;
264     }
265
266     // Newer functionality is not available to synchronous requests in window contexts, as a spec-mandated
267     // attempt to discourage synchronous XHR use. responseType is one such piece of functionality.
268     // We'll only disable this functionality for HTTP(S) requests since sync requests for local protocols
269     // such as file: and data: still make sense to allow.
270     if (!m_async && scriptExecutionContext()->isDocument() && m_url.protocolIsInHTTPFamily()) {
271         logConsoleError(scriptExecutionContext(), "XMLHttpRequest.responseType cannot be changed for synchronous HTTP(S) requests made from the window context.");
272         ec = INVALID_ACCESS_ERR;
273         return;
274     }
275
276     m_responseType = type;
277 }
278
279 String XMLHttpRequest::responseURL() const
280 {
281     URL responseURL(m_response.url());
282     responseURL.removeFragmentIdentifier();
283
284     return responseURL.string();
285 }
286
287 void XMLHttpRequest::setLastSendLineAndColumnNumber(unsigned lineNumber, unsigned columnNumber)
288 {
289     m_lastSendLineNumber = lineNumber;
290     m_lastSendColumnNumber = columnNumber;
291 }
292
293 XMLHttpRequestUpload* XMLHttpRequest::upload()
294 {
295     if (!m_upload)
296         m_upload = std::make_unique<XMLHttpRequestUpload>(this);
297     return m_upload.get();
298 }
299
300 void XMLHttpRequest::changeState(State newState)
301 {
302     if (m_state != newState) {
303         m_state = newState;
304         callReadyStateChangeListener();
305     }
306 }
307
308 void XMLHttpRequest::callReadyStateChangeListener()
309 {
310     if (!scriptExecutionContext())
311         return;
312
313     // Check whether sending load and loadend events before sending readystatechange event, as it may change m_error/m_state values.
314     bool shouldSendLoadEvent = (m_state == DONE && !m_error);
315
316     if (m_async || (m_state <= OPENED || m_state == DONE))
317         m_progressEventThrottle.dispatchReadyStateChangeEvent(Event::create(eventNames().readystatechangeEvent, false, false), m_state == DONE ? FlushProgressEvent : DoNotFlushProgressEvent);
318
319     if (shouldSendLoadEvent) {
320         m_progressEventThrottle.dispatchProgressEvent(eventNames().loadEvent);
321         m_progressEventThrottle.dispatchProgressEvent(eventNames().loadendEvent);
322     }
323 }
324
325 void XMLHttpRequest::setWithCredentials(bool value, ExceptionCode& ec)
326 {
327     if (m_state > OPENED || m_sendFlag) {
328         ec = INVALID_STATE_ERR;
329         return;
330     }
331
332     m_includeCredentials = value;
333 }
334
335 bool XMLHttpRequest::isAllowedHTTPMethod(const String& method)
336 {
337     return !equalLettersIgnoringASCIICase(method, "trace")
338         && !equalLettersIgnoringASCIICase(method, "track")
339         && !equalLettersIgnoringASCIICase(method, "connect");
340 }
341
342 String XMLHttpRequest::uppercaseKnownHTTPMethod(const String& method)
343 {
344     const char* const methods[] = { "DELETE", "GET", "HEAD", "OPTIONS", "POST", "PUT" };
345     for (auto* value : methods) {
346         if (equalIgnoringASCIICase(method, value)) {
347             // Don't bother allocating a new string if it's already all uppercase.
348             if (method == value)
349                 break;
350             return ASCIILiteral(value);
351         }
352     }
353     return method;
354 }
355
356 static bool isForbiddenRequestHeader(const String& name)
357 {
358     HTTPHeaderName headerName;
359     if (!findHTTPHeaderName(name, headerName))
360         return false;
361
362     switch (headerName) {
363     case HTTPHeaderName::AcceptCharset:
364     case HTTPHeaderName::AcceptEncoding:
365     case HTTPHeaderName::AccessControlRequestHeaders:
366     case HTTPHeaderName::AccessControlRequestMethod:
367     case HTTPHeaderName::Connection:
368     case HTTPHeaderName::ContentLength:
369     case HTTPHeaderName::ContentTransferEncoding:
370     case HTTPHeaderName::Cookie:
371     case HTTPHeaderName::Cookie2:
372     case HTTPHeaderName::Date:
373     case HTTPHeaderName::DNT:
374     case HTTPHeaderName::Expect:
375     case HTTPHeaderName::Host:
376     case HTTPHeaderName::KeepAlive:
377     case HTTPHeaderName::Origin:
378     case HTTPHeaderName::Referer:
379     case HTTPHeaderName::TE:
380     case HTTPHeaderName::Trailer:
381     case HTTPHeaderName::TransferEncoding:
382     case HTTPHeaderName::Upgrade:
383     case HTTPHeaderName::UserAgent:
384     case HTTPHeaderName::Via:
385         return true;
386
387     default:
388         return false;
389     }
390 }
391
392 bool XMLHttpRequest::isAllowedHTTPHeader(const String& name)
393 {
394     if (isForbiddenRequestHeader(name))
395         return false;
396
397     if (name.startsWith("proxy-", false))
398         return false;
399
400     if (name.startsWith("sec-", false))
401         return false;
402
403     return true;
404 }
405
406 void XMLHttpRequest::open(const String& method, const String& url, ExceptionCode& ec)
407 {
408     // If the async argument is omitted, set async to true.
409     return open(method, scriptExecutionContext()->completeURL(url), true, ec);
410 }
411
412 void XMLHttpRequest::open(const String& method, const URL& url, bool async, ExceptionCode& ec)
413 {
414     if (!internalAbort())
415         return;
416
417     State previousState = m_state;
418     m_state = UNSENT;
419     m_error = false;
420     m_sendFlag = false;
421     m_uploadComplete = false;
422
423     // clear stuff from possible previous load
424     clearResponse();
425     clearRequest();
426
427     ASSERT(m_state == UNSENT);
428
429     if (!isValidHTTPToken(method)) {
430         ec = SYNTAX_ERR;
431         return;
432     }
433
434     if (!isAllowedHTTPMethod(method)) {
435         ec = SECURITY_ERR;
436         return;
437     }
438
439     if (!async && scriptExecutionContext()->isDocument()) {
440         if (document()->settings() && !document()->settings()->syncXHRInDocumentsEnabled()) {
441             logConsoleError(scriptExecutionContext(), "Synchronous XMLHttpRequests are disabled for this page.");
442             ec = INVALID_ACCESS_ERR;
443             return;
444         }
445
446         // Newer functionality is not available to synchronous requests in window contexts, as a spec-mandated
447         // attempt to discourage synchronous XHR use. responseType is one such piece of functionality.
448         // We'll only disable this functionality for HTTP(S) requests since sync requests for local protocols
449         // such as file: and data: still make sense to allow.
450         if (url.protocolIsInHTTPFamily() && m_responseType != ResponseType::EmptyString) {
451             logConsoleError(scriptExecutionContext(), "Synchronous HTTP(S) requests made from the window context cannot have XMLHttpRequest.responseType set.");
452             ec = INVALID_ACCESS_ERR;
453             return;
454         }
455
456         // Similarly, timeouts are disabled for synchronous requests as well.
457         if (m_timeoutMilliseconds > 0) {
458             logConsoleError(scriptExecutionContext(), "Synchronous XMLHttpRequests must not have a timeout value set.");
459             ec = INVALID_ACCESS_ERR;
460             return;
461         }
462     }
463
464     m_method = uppercaseKnownHTTPMethod(method);
465
466     m_url = url;
467     scriptExecutionContext()->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(m_url, ContentSecurityPolicy::InsecureRequestType::Load);
468
469     m_async = async;
470
471     ASSERT(!m_loader);
472
473     // Check previous state to avoid dispatching readyState event
474     // when calling open several times in a row.
475     if (previousState != OPENED)
476         changeState(OPENED);
477     else
478         m_state = OPENED;
479 }
480
481 void XMLHttpRequest::open(const String& method, const String& url, bool async, const String& user, const String& password, ExceptionCode& ec)
482 {
483     URL urlWithCredentials = scriptExecutionContext()->completeURL(url);
484     if (!user.isNull()) {
485         urlWithCredentials.setUser(user);
486         if (!password.isNull())
487             urlWithCredentials.setPass(password);
488     }
489
490     open(method, urlWithCredentials, async, ec);
491 }
492
493 bool XMLHttpRequest::initSend(ExceptionCode& ec)
494 {
495     if (!scriptExecutionContext())
496         return false;
497
498     if (m_state != OPENED || m_sendFlag) {
499         ec = INVALID_STATE_ERR;
500         return false;
501     }
502     ASSERT(!m_loader);
503
504     // FIXME: Convert this to check the isolated world's Content Security Policy once webkit.org/b/104520 is solved.
505     if (!scriptExecutionContext()->contentSecurityPolicy()->allowConnectToSource(m_url, scriptExecutionContext()->shouldBypassMainWorldContentSecurityPolicy())) {
506         if (m_async) {
507             setPendingActivity(this);
508             m_timeoutTimer.stop();
509             m_networkErrorTimer.startOneShot(0);
510         } else
511             ec = NETWORK_ERR;
512         return false;
513     }
514
515     m_error = false;
516     return true;
517 }
518
519 void XMLHttpRequest::send(ExceptionCode& ec)
520 {
521     send(String(), ec);
522 }
523
524 void XMLHttpRequest::send(Document* document, ExceptionCode& ec)
525 {
526     ASSERT(document);
527
528     if (!initSend(ec))
529         return;
530
531     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
532         if (!m_requestHeaders.contains(HTTPHeaderName::ContentType)) {
533 #if ENABLE(DASHBOARD_SUPPORT)
534             if (usesDashboardBackwardCompatibilityMode())
535                 m_requestHeaders.set(HTTPHeaderName::ContentType, ASCIILiteral("application/x-www-form-urlencoded"));
536             else
537 #endif
538                 // FIXME: this should include the charset used for encoding.
539                 m_requestHeaders.set(HTTPHeaderName::ContentType, document->isHTMLDocument() ? ASCIILiteral("text/html;charset=UTF-8") : ASCIILiteral("application/xml;charset=UTF-8"));
540         }
541
542         // FIXME: According to XMLHttpRequest Level 2, this should use the Document.innerHTML algorithm
543         // from the HTML5 specification to serialize the document.
544         String body = createMarkup(*document);
545
546         m_requestEntityBody = FormData::create(UTF8Encoding().encode(body, EntitiesForUnencodables));
547         if (m_upload)
548             m_requestEntityBody->setAlwaysStream(true);
549     }
550
551     createRequest(ec);
552 }
553
554 void XMLHttpRequest::send(const String& body, ExceptionCode& ec)
555 {
556     if (!initSend(ec))
557         return;
558
559     if (!body.isNull() && m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
560         String contentType = m_requestHeaders.get(HTTPHeaderName::ContentType);
561         if (contentType.isNull()) {
562 #if ENABLE(DASHBOARD_SUPPORT)
563             if (usesDashboardBackwardCompatibilityMode())
564                 m_requestHeaders.set(HTTPHeaderName::ContentType, ASCIILiteral("application/x-www-form-urlencoded"));
565             else
566 #endif
567                 m_requestHeaders.set(HTTPHeaderName::ContentType, ASCIILiteral("text/plain;charset=UTF-8"));
568         } else {
569             replaceCharsetInMediaType(contentType, "UTF-8");
570             m_requestHeaders.set(HTTPHeaderName::ContentType, contentType);
571         }
572
573         m_requestEntityBody = FormData::create(UTF8Encoding().encode(body, EntitiesForUnencodables));
574         if (m_upload)
575             m_requestEntityBody->setAlwaysStream(true);
576     }
577
578     createRequest(ec);
579 }
580
581 void XMLHttpRequest::send(Blob* body, ExceptionCode& ec)
582 {
583     if (!initSend(ec))
584         return;
585
586     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
587         if (!m_requestHeaders.contains(HTTPHeaderName::ContentType)) {
588             const String& blobType = body->type();
589             if (!blobType.isEmpty() && isValidContentType(blobType))
590                 m_requestHeaders.set(HTTPHeaderName::ContentType, blobType);
591             else {
592                 // From FileAPI spec, whenever media type cannot be determined, empty string must be returned.
593                 m_requestHeaders.set(HTTPHeaderName::ContentType, emptyString());
594             }
595         }
596
597         m_requestEntityBody = FormData::create();
598         m_requestEntityBody->appendBlob(body->url());
599     }
600
601     createRequest(ec);
602 }
603
604 void XMLHttpRequest::send(DOMFormData* body, ExceptionCode& ec)
605 {
606     if (!initSend(ec))
607         return;
608
609     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
610         m_requestEntityBody = FormData::createMultiPart(*(static_cast<FormDataList*>(body)), body->encoding(), document());
611
612         m_requestEntityBody->generateFiles(document());
613
614         if (!m_requestHeaders.contains(HTTPHeaderName::ContentType))
615             m_requestHeaders.set(HTTPHeaderName::ContentType, makeString("multipart/form-data; boundary=", m_requestEntityBody->boundary().data()));
616     }
617
618     createRequest(ec);
619 }
620
621 void XMLHttpRequest::send(ArrayBuffer* body, ExceptionCode& ec)
622 {
623     String consoleMessage("ArrayBuffer is deprecated in XMLHttpRequest.send(). Use ArrayBufferView instead.");
624     scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Warning, consoleMessage);
625
626     sendBytesData(body->data(), body->byteLength(), ec);
627 }
628
629 void XMLHttpRequest::send(ArrayBufferView* body, ExceptionCode& ec)
630 {
631     sendBytesData(body->baseAddress(), body->byteLength(), ec);
632 }
633
634 void XMLHttpRequest::sendBytesData(const void* data, size_t length, ExceptionCode& ec)
635 {
636     if (!initSend(ec))
637         return;
638
639     if (m_method != "GET" && m_method != "HEAD" && m_url.protocolIsInHTTPFamily()) {
640         m_requestEntityBody = FormData::create(data, length);
641         if (m_upload)
642             m_requestEntityBody->setAlwaysStream(true);
643     }
644
645     createRequest(ec);
646 }
647
648 void XMLHttpRequest::createRequest(ExceptionCode& ec)
649 {
650     // Only GET request is supported for blob URL.
651     if (!m_async && m_url.protocolIsBlob() && m_method != "GET") {
652         ec = NETWORK_ERR;
653         return;
654     }
655
656     m_sendFlag = true;
657
658     // The presence of upload event listeners forces us to use preflighting because POSTing to an URL that does not
659     // permit cross origin requests should look exactly like POSTing to an URL that does not respond at all.
660     // Also, only async requests support upload progress events.
661     bool uploadEvents = false;
662     if (m_async) {
663         m_progressEventThrottle.dispatchProgressEvent(eventNames().loadstartEvent);
664         if (m_requestEntityBody && m_upload) {
665             uploadEvents = m_upload->hasEventListeners();
666             m_upload->dispatchProgressEvent(eventNames().loadstartEvent);
667         }
668     }
669
670     m_sameOriginRequest = securityOrigin()->canRequest(m_url);
671
672     // We also remember whether upload events should be allowed for this request in case the upload listeners are
673     // added after the request is started.
674     m_uploadEventsAllowed = m_sameOriginRequest || uploadEvents || !isSimpleCrossOriginAccessRequest(m_method, m_requestHeaders);
675
676     ResourceRequest request(m_url);
677     request.setRequester(ResourceRequest::Requester::XHR);
678     request.setHTTPMethod(m_method);
679
680     if (m_requestEntityBody) {
681         ASSERT(m_method != "GET");
682         ASSERT(m_method != "HEAD");
683         request.setHTTPBody(WTFMove(m_requestEntityBody));
684     }
685
686     if (!m_requestHeaders.isEmpty())
687         request.setHTTPHeaderFields(m_requestHeaders);
688
689     ThreadableLoaderOptions options;
690     options.setSendLoadCallbacks(SendCallbacks);
691     options.setSniffContent(DoNotSniffContent);
692     options.preflightPolicy = uploadEvents ? ForcePreflight : ConsiderPreflight;
693     options.credentials = m_includeCredentials ? FetchOptions::Credentials::Include : FetchOptions::Credentials::SameOrigin;
694     options.mode = FetchOptions::Mode::Cors;
695     options.contentSecurityPolicyEnforcement = scriptExecutionContext()->shouldBypassMainWorldContentSecurityPolicy() ? ContentSecurityPolicyEnforcement::DoNotEnforce : ContentSecurityPolicyEnforcement::EnforceConnectSrcDirective;
696     options.initiator = cachedResourceRequestInitiators().xmlhttprequest;
697
698     if (m_timeoutMilliseconds) {
699         if (!m_async)
700             request.setTimeoutInterval(m_timeoutMilliseconds / 1000.0);
701         else {
702             m_sendingTime = std::chrono::steady_clock::now();
703             m_timeoutTimer.startOneShot(std::chrono::milliseconds { m_timeoutMilliseconds });
704         }
705     }
706
707     m_exceptionCode = 0;
708     m_error = false;
709
710     if (m_async) {
711         if (m_upload)
712             request.setReportUploadProgress(true);
713
714         // 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.
715         // This is true while running onunload handlers.
716         // FIXME: Maybe we need to be able to send XMLHttpRequests from onunload, <http://bugs.webkit.org/show_bug.cgi?id=10904>.
717         m_loader = ThreadableLoader::create(scriptExecutionContext(), this, WTFMove(request), options);
718
719         // Neither this object nor the JavaScript wrapper should be deleted while
720         // a request is in progress because we need to keep the listeners alive,
721         // and they are referenced by the JavaScript wrapper.
722         setPendingActivity(this);
723         if (!m_loader) {
724             m_sendFlag = false;
725             m_timeoutTimer.stop();
726             m_networkErrorTimer.startOneShot(0);
727         }
728     } else {
729         InspectorInstrumentation::willLoadXHRSynchronously(scriptExecutionContext());
730         ThreadableLoader::loadResourceSynchronously(scriptExecutionContext(), WTFMove(request), *this, options);
731         InspectorInstrumentation::didLoadXHRSynchronously(scriptExecutionContext());
732     }
733
734     if (!m_exceptionCode && m_error)
735         m_exceptionCode = NETWORK_ERR;
736     ec = m_exceptionCode;
737 }
738
739 void XMLHttpRequest::abort()
740 {
741     // internalAbort() calls dropProtection(), which may release the last reference.
742     Ref<XMLHttpRequest> protectedThis(*this);
743
744     if (!internalAbort())
745         return;
746
747     clearResponseBuffers();
748
749     // Clear headers as required by the spec
750     m_requestHeaders.clear();
751     if ((m_state == OPENED && m_sendFlag) || m_state == HEADERS_RECEIVED || m_state == LOADING) {
752         ASSERT(!m_loader);
753         m_sendFlag = false;
754         changeState(DONE);
755         dispatchErrorEvents(eventNames().abortEvent);
756     }
757     m_state = UNSENT;
758 }
759
760 bool XMLHttpRequest::internalAbort()
761 {
762     m_error = true;
763
764     // FIXME: when we add the support for multi-part XHR, we will have to think be careful with this initialization.
765     m_receivedLength = 0;
766
767     m_decoder = nullptr;
768
769     m_timeoutTimer.stop();
770
771     if (!m_loader)
772         return true;
773
774     // Cancelling m_loader may trigger a window.onload callback which can call open() on the same xhr.
775     // This would create internalAbort reentrant call.
776     // m_loader is set to null before being cancelled to exit early in any reentrant internalAbort() call.
777     auto loader = WTFMove(m_loader);
778     loader->cancel();
779
780     // If window.onload callback calls open() and send() on the same xhr, m_loader is now set to a new value.
781     // The function calling internalAbort() should abort to let the open() and send() calls continue properly.
782     // We ask the function calling internalAbort() to exit by returning false.
783     // Save this information to a local variable since we are going to drop protection.
784     bool newLoadStarted = m_loader;
785
786     dropProtection();
787
788     return !newLoadStarted;
789 }
790
791 void XMLHttpRequest::clearResponse()
792 {
793     m_response = ResourceResponse();
794     clearResponseBuffers();
795 }
796
797 void XMLHttpRequest::clearResponseBuffers()
798 {
799     m_responseBuilder.clear();
800     m_responseEncoding = String();
801     m_createdDocument = false;
802     m_responseDocument = nullptr;
803     m_binaryResponseBuilder = nullptr;
804     m_responseCacheIsValid = false;
805 }
806
807 void XMLHttpRequest::clearRequest()
808 {
809     m_requestHeaders.clear();
810     m_requestEntityBody = nullptr;
811 }
812
813 void XMLHttpRequest::genericError()
814 {
815     clearResponse();
816     clearRequest();
817     m_sendFlag = false;
818     m_error = true;
819
820     changeState(DONE);
821 }
822
823 void XMLHttpRequest::networkError()
824 {
825     genericError();
826     dispatchErrorEvents(eventNames().errorEvent);
827     internalAbort();
828 }
829
830 void XMLHttpRequest::networkErrorTimerFired()
831 {
832     networkError();
833     dropProtection();
834 }
835     
836 void XMLHttpRequest::abortError()
837 {
838     genericError();
839     dispatchErrorEvents(eventNames().abortEvent);
840 }
841
842 void XMLHttpRequest::dropProtection()
843 {
844     // The XHR object itself holds on to the responseText, and
845     // thus has extra cost even independent of any
846     // responseText or responseXML objects it has handed
847     // out. But it is protected from GC while loading, so this
848     // can't be recouped until the load is done, so only
849     // report the extra cost at that point.
850     JSC::VM& vm = scriptExecutionContext()->vm();
851     JSC::JSLockHolder lock(vm);
852     // FIXME: Adopt reportExtraMemoryVisited, and switch to reportExtraMemoryAllocated.
853     // https://bugs.webkit.org/show_bug.cgi?id=142595
854     vm.heap.deprecatedReportExtraMemory(m_responseBuilder.length() * 2);
855
856     unsetPendingActivity(this);
857 }
858
859 void XMLHttpRequest::overrideMimeType(const String& override, ExceptionCode& ec)
860 {
861     if (m_state == LOADING || m_state == DONE) {
862         ec = INVALID_STATE_ERR;
863         return;
864     }
865
866     m_mimeTypeOverride = override;
867 }
868
869 void XMLHttpRequest::setRequestHeader(const String& name, const String& value, ExceptionCode& ec)
870 {
871     if (m_state != OPENED || m_sendFlag) {
872 #if ENABLE(DASHBOARD_SUPPORT)
873         if (usesDashboardBackwardCompatibilityMode())
874             return;
875 #endif
876
877         ec = INVALID_STATE_ERR;
878         return;
879     }
880
881     String normalizedValue = stripLeadingAndTrailingHTTPSpaces(value);
882     if (!isValidHTTPToken(name) || !isValidHTTPHeaderValue(normalizedValue)) {
883         ec = SYNTAX_ERR;
884         return;
885     }
886
887     // A privileged script (e.g. a Dashboard widget) can set any headers.
888     if (!securityOrigin()->canLoadLocalResources() && !isAllowedHTTPHeader(name)) {
889         logConsoleError(scriptExecutionContext(), "Refused to set unsafe header \"" + name + "\"");
890         return;
891     }
892
893     m_requestHeaders.add(name, normalizedValue);
894 }
895
896 String XMLHttpRequest::getAllResponseHeaders() const
897 {
898     if (m_state < HEADERS_RECEIVED || m_error)
899         return emptyString();
900
901     StringBuilder stringBuilder;
902
903     for (const auto& header : m_response.httpHeaderFields()) {
904         stringBuilder.append(header.key);
905         stringBuilder.append(':');
906         stringBuilder.append(' ');
907         stringBuilder.append(header.value);
908         stringBuilder.append('\r');
909         stringBuilder.append('\n');
910     }
911
912     return stringBuilder.toString();
913 }
914
915 String XMLHttpRequest::getResponseHeader(const String& name) const
916 {
917     if (m_state < HEADERS_RECEIVED || m_error)
918         return String();
919
920     return m_response.httpHeaderField(name);
921 }
922
923 String XMLHttpRequest::responseMIMEType() const
924 {
925     String mimeType = extractMIMETypeFromMediaType(m_mimeTypeOverride);
926     if (mimeType.isEmpty()) {
927         if (m_response.isHTTP())
928             mimeType = extractMIMETypeFromMediaType(m_response.httpHeaderField(HTTPHeaderName::ContentType));
929         else
930             mimeType = m_response.mimeType();
931         if (mimeType.isEmpty())
932             mimeType = ASCIILiteral("text/xml");
933     }
934     return mimeType;
935 }
936
937 bool XMLHttpRequest::responseIsXML() const
938 {
939     return DOMImplementation::isXMLMIMEType(responseMIMEType());
940 }
941
942 int XMLHttpRequest::status() const
943 {
944     if (m_state == UNSENT || m_state == OPENED || m_error)
945         return 0;
946
947     return m_response.httpStatusCode();
948 }
949
950 String XMLHttpRequest::statusText() const
951 {
952     if (m_state == UNSENT || m_state == OPENED || m_error)
953         return String();
954
955     return m_response.httpStatusText();
956 }
957
958 void XMLHttpRequest::didFail(const ResourceError& error)
959 {
960
961     // If we are already in an error state, for instance we called abort(), bail out early.
962     if (m_error)
963         return;
964
965     if (error.isCancellation()) {
966         m_exceptionCode = ABORT_ERR;
967         abortError();
968         return;
969     }
970
971     // In case of worker sync timeouts.
972     if (error.isTimeout()) {
973         didReachTimeout();
974         return;
975     }
976
977     // Network failures are already reported to Web Inspector by ResourceLoader.
978     if (error.domain() == errorDomainWebKitInternal) {
979         String message = makeString("XMLHttpRequest cannot load ", error.failingURL().string(), ". ", error.localizedDescription());
980         logConsoleError(scriptExecutionContext(), message);
981     }
982
983     m_exceptionCode = NETWORK_ERR;
984     networkError();
985 }
986
987 void XMLHttpRequest::didFinishLoading(unsigned long identifier, double)
988 {
989     if (m_error)
990         return;
991
992     if (m_state < HEADERS_RECEIVED)
993         changeState(HEADERS_RECEIVED);
994
995     if (m_decoder)
996         m_responseBuilder.append(m_decoder->flush());
997
998     m_responseBuilder.shrinkToFit();
999
1000     InspectorInstrumentation::didFinishXHRLoading(scriptExecutionContext(), this, identifier, m_responseBuilder.toStringPreserveCapacity(), m_url, m_lastSendURL, m_lastSendLineNumber, m_lastSendColumnNumber);
1001
1002     bool hadLoader = m_loader;
1003     m_loader = nullptr;
1004
1005     m_sendFlag = false;
1006     changeState(DONE);
1007     m_responseEncoding = String();
1008     m_decoder = nullptr;
1009
1010     m_timeoutTimer.stop();
1011
1012     if (hadLoader)
1013         dropProtection();
1014 }
1015
1016 void XMLHttpRequest::didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
1017 {
1018     if (!m_upload)
1019         return;
1020
1021     if (m_uploadEventsAllowed)
1022         m_upload->dispatchThrottledProgressEvent(true, bytesSent, totalBytesToBeSent);
1023     if (bytesSent == totalBytesToBeSent && !m_uploadComplete) {
1024         m_uploadComplete = true;
1025         if (m_uploadEventsAllowed) {
1026             m_upload->dispatchProgressEvent(eventNames().loadEvent);
1027             m_upload->dispatchProgressEvent(eventNames().loadendEvent);
1028         }
1029     }
1030 }
1031
1032 void XMLHttpRequest::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
1033 {
1034     InspectorInstrumentation::didReceiveXHRResponse(scriptExecutionContext(), identifier);
1035
1036     m_response = response;
1037     if (!m_mimeTypeOverride.isEmpty())
1038         m_response.setHTTPHeaderField(HTTPHeaderName::ContentType, m_mimeTypeOverride);
1039 }
1040
1041 static inline bool shouldDecodeResponse(XMLHttpRequest::ResponseType type)
1042 {
1043     switch (type) {
1044     case XMLHttpRequest::ResponseType::EmptyString:
1045     case XMLHttpRequest::ResponseType::Document:
1046     case XMLHttpRequest::ResponseType::Json:
1047     case XMLHttpRequest::ResponseType::Text:
1048         return true;
1049     case XMLHttpRequest::ResponseType::Arraybuffer:
1050     case XMLHttpRequest::ResponseType::Blob:
1051         return false;
1052     }
1053     ASSERT_NOT_REACHED();
1054     return true;
1055 }
1056
1057 void XMLHttpRequest::didReceiveData(const char* data, int len)
1058 {
1059     if (m_error)
1060         return;
1061
1062     if (m_state < HEADERS_RECEIVED)
1063         changeState(HEADERS_RECEIVED);
1064
1065     // FIXME: Should we update "Content-Type" header field with m_mimeTypeOverride value in case it has changed since didReceiveResponse?
1066     if (!m_mimeTypeOverride.isEmpty())
1067         m_responseEncoding = extractCharsetFromMediaType(m_mimeTypeOverride);
1068     if (m_responseEncoding.isEmpty())
1069         m_responseEncoding = m_response.textEncodingName();
1070
1071     bool useDecoder = shouldDecodeResponse(m_responseType);
1072
1073     if (useDecoder && !m_decoder) {
1074         if (!m_responseEncoding.isEmpty())
1075             m_decoder = TextResourceDecoder::create("text/plain", m_responseEncoding);
1076         // allow TextResourceDecoder to look inside the m_response if it's XML or HTML
1077         else if (responseIsXML()) {
1078             m_decoder = TextResourceDecoder::create("application/xml");
1079             // 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.
1080             m_decoder->useLenientXMLDecoding();
1081         } else if (equalLettersIgnoringASCIICase(responseMIMEType(), "text/html"))
1082             m_decoder = TextResourceDecoder::create("text/html", "UTF-8");
1083         else
1084             m_decoder = TextResourceDecoder::create("text/plain", "UTF-8");
1085     }
1086
1087     if (!len)
1088         return;
1089
1090     if (len == -1)
1091         len = strlen(data);
1092
1093     if (useDecoder)
1094         m_responseBuilder.append(m_decoder->decode(data, len));
1095     else {
1096         // Buffer binary data.
1097         if (!m_binaryResponseBuilder)
1098             m_binaryResponseBuilder = SharedBuffer::create();
1099         m_binaryResponseBuilder->append(data, len);
1100     }
1101
1102     if (!m_error) {
1103         m_receivedLength += len;
1104
1105         if (m_async) {
1106             long long expectedLength = m_response.expectedContentLength();
1107             bool lengthComputable = expectedLength > 0 && m_receivedLength <= expectedLength;
1108             unsigned long long total = lengthComputable ? expectedLength : 0;
1109             m_progressEventThrottle.dispatchThrottledProgressEvent(lengthComputable, m_receivedLength, total);
1110         }
1111
1112         if (m_state != LOADING)
1113             changeState(LOADING);
1114         else
1115             // Firefox calls readyStateChanged every time it receives data, 4449442
1116             callReadyStateChangeListener();
1117     }
1118 }
1119
1120 void XMLHttpRequest::dispatchErrorEvents(const AtomicString& type)
1121 {
1122     if (!m_uploadComplete) {
1123         m_uploadComplete = true;
1124         if (m_upload && m_uploadEventsAllowed) {
1125             m_upload->dispatchProgressEvent(eventNames().progressEvent);
1126             m_upload->dispatchProgressEvent(type);
1127             m_upload->dispatchProgressEvent(eventNames().loadendEvent);
1128         }
1129     }
1130     m_progressEventThrottle.dispatchProgressEvent(eventNames().progressEvent);
1131     m_progressEventThrottle.dispatchProgressEvent(type);
1132     m_progressEventThrottle.dispatchProgressEvent(eventNames().loadendEvent);
1133 }
1134
1135 void XMLHttpRequest::didReachTimeout()
1136 {
1137     // internalAbort() calls dropProtection(), which may release the last reference.
1138     Ref<XMLHttpRequest> protectedThis(*this);
1139     if (!internalAbort())
1140         return;
1141
1142     clearResponse();
1143     clearRequest();
1144
1145     m_sendFlag = false;
1146     m_error = true;
1147     m_exceptionCode = TIMEOUT_ERR;
1148
1149     if (!m_async) {
1150         m_state = DONE;
1151         m_exceptionCode = TIMEOUT_ERR;
1152         return;
1153     }
1154
1155     changeState(DONE);
1156
1157     dispatchErrorEvents(eventNames().timeoutEvent);
1158 }
1159
1160 bool XMLHttpRequest::canSuspendForDocumentSuspension() const
1161 {
1162     // If the load event has not fired yet, cancelling the load in suspend() may cause
1163     // the load event to be fired and arbitrary JS execution, which would be unsafe.
1164     // Therefore, we prevent suspending in this case.
1165     return document()->loadEventFinished();
1166 }
1167
1168 const char* XMLHttpRequest::activeDOMObjectName() const
1169 {
1170     return "XMLHttpRequest";
1171 }
1172
1173 void XMLHttpRequest::suspend(ReasonForSuspension reason)
1174 {
1175     m_progressEventThrottle.suspend();
1176
1177     if (m_resumeTimer.isActive()) {
1178         m_resumeTimer.stop();
1179         m_dispatchErrorOnResuming = true;
1180     }
1181
1182     if (reason == ActiveDOMObject::PageCache && m_loader) {
1183         // Going into PageCache, abort the request and dispatch a network error on resuming.
1184         genericError();
1185         m_dispatchErrorOnResuming = true;
1186         bool aborted = internalAbort();
1187         // It should not be possible to restart the load when aborting in suspend() because
1188         // we are not allowed to execute in JS in suspend().
1189         ASSERT_UNUSED(aborted, aborted);
1190     }
1191 }
1192
1193 void XMLHttpRequest::resume()
1194 {
1195     m_progressEventThrottle.resume();
1196
1197     // We are not allowed to execute arbitrary JS in resume() so dispatch
1198     // the error event in a timer.
1199     if (m_dispatchErrorOnResuming && !m_resumeTimer.isActive())
1200         m_resumeTimer.startOneShot(0);
1201 }
1202
1203 void XMLHttpRequest::resumeTimerFired()
1204 {
1205     ASSERT(m_dispatchErrorOnResuming);
1206     m_dispatchErrorOnResuming = false;
1207     dispatchErrorEvents(eventNames().errorEvent);
1208 }
1209
1210 void XMLHttpRequest::stop()
1211 {
1212     internalAbort();
1213 }
1214
1215 void XMLHttpRequest::contextDestroyed()
1216 {
1217     ASSERT(!m_loader);
1218     ActiveDOMObject::contextDestroyed();
1219 }
1220
1221 } // namespace WebCore