blob: 6405fcdaa8abd7807353332225d9a592514f7506 [file] [log] [blame]
/*
* Copyright (C) 2003, 2006, 2008 Apple Inc. All rights reserved.
* Copyright (C) 2005, 2006 Alexey Proskuryakov <ap@nypop.com>
* Copyright (C) 2011 Google Inc. All rights reserved.
* Copyright (C) 2012 Intel Corporation
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include "ActiveDOMObject.h"
#include "ExceptionOr.h"
#include "FormData.h"
#include "ResourceResponse.h"
#include "ThreadableLoaderClient.h"
#include "UserGestureIndicator.h"
#include <wtf/URL.h>
#include "XMLHttpRequestEventTarget.h"
#include "XMLHttpRequestProgressEventThrottle.h"
#include <wtf/Variant.h>
#include <wtf/text/StringBuilder.h>
namespace JSC {
class ArrayBuffer;
class ArrayBufferView;
}
namespace WebCore {
class Blob;
class Document;
class DOMFormData;
class SecurityOrigin;
class SharedBuffer;
class TextResourceDecoder;
class ThreadableLoader;
class XMLHttpRequestUpload;
struct OwnedString;
class XMLHttpRequest final : public ActiveDOMObject, public RefCounted<XMLHttpRequest>, private ThreadableLoaderClient, public XMLHttpRequestEventTarget {
WTF_MAKE_ISO_ALLOCATED(XMLHttpRequest);
public:
static Ref<XMLHttpRequest> create(ScriptExecutionContext&);
WEBCORE_EXPORT ~XMLHttpRequest();
// Keep it in 3bits.
enum State : uint8_t {
UNSENT = 0,
OPENED = 1,
HEADERS_RECEIVED = 2,
LOADING = 3,
DONE = 4
};
virtual void didReachTimeout();
EventTargetInterface eventTargetInterface() const override { return XMLHttpRequestEventTargetInterfaceType; }
ScriptExecutionContext* scriptExecutionContext() const override { return ActiveDOMObject::scriptExecutionContext(); }
using SendTypes = Variant<RefPtr<Document>, RefPtr<Blob>, RefPtr<JSC::ArrayBufferView>, RefPtr<JSC::ArrayBuffer>, RefPtr<DOMFormData>, String>;
const URL& url() const { return m_url; }
String statusText() const;
int status() const;
State readyState() const;
bool withCredentials() const { return m_includeCredentials; }
ExceptionOr<void> setWithCredentials(bool);
ExceptionOr<void> open(const String& method, const String& url);
ExceptionOr<void> open(const String& method, const URL&, bool async);
ExceptionOr<void> open(const String& method, const String&, bool async, const String& user, const String& password);
ExceptionOr<void> send(Optional<SendTypes>&&);
void abort();
ExceptionOr<void> setRequestHeader(const String& name, const String& value);
ExceptionOr<void> overrideMimeType(const String& override);
bool doneWithoutErrors() const { return !m_error && readyState() == DONE; }
String getAllResponseHeaders() const;
String getResponseHeader(const String& name) const;
ExceptionOr<OwnedString> responseText();
String responseTextIgnoringResponseType() const { return m_responseBuilder.toStringPreserveCapacity(); }
String responseMIMEType() const;
Document* optionalResponseXML() const { return m_responseDocument.get(); }
ExceptionOr<Document*> responseXML();
Ref<Blob> createResponseBlob();
RefPtr<JSC::ArrayBuffer> createResponseArrayBuffer();
unsigned timeout() const { return m_timeoutMilliseconds; }
ExceptionOr<void> setTimeout(unsigned);
bool responseCacheIsValid() const { return m_responseCacheIsValid; }
void didCacheResponse();
// Keep it in 3bits.
enum class ResponseType : uint8_t {
EmptyString = 0,
Arraybuffer = 1,
Blob = 2,
Document = 3,
Json = 4,
Text = 5,
};
ExceptionOr<void> setResponseType(ResponseType);
ResponseType responseType() const;
String responseURL() const;
XMLHttpRequestUpload& upload();
XMLHttpRequestUpload* optionalUpload() const { return m_upload.get(); }
const ResourceResponse& resourceResponse() const { return m_response; }
using RefCounted<XMLHttpRequest>::ref;
using RefCounted<XMLHttpRequest>::deref;
size_t memoryCost() const;
WEBCORE_EXPORT void setMaximumIntervalForUserGestureForwarding(double);
bool hasPendingActivity() const final;
using EventTarget::dispatchEvent;
void dispatchEvent(Event&) override;
private:
explicit XMLHttpRequest(ScriptExecutionContext&);
// EventTarget.
void eventListenersDidChange() final;
TextEncoding finalResponseCharset() const;
// ActiveDOMObject
void contextDestroyed() override;
void suspend(ReasonForSuspension) override;
void resume() override;
void stop() override;
const char* activeDOMObjectName() const override;
void refEventTarget() override { ref(); }
void derefEventTarget() override { deref(); }
Document* document() const;
SecurityOrigin* securityOrigin() const;
// ThreadableLoaderClient
void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent) override;
void didReceiveResponse(unsigned long identifier, const ResourceResponse&) override;
void didReceiveData(const char* data, int dataLength) override;
void didFinishLoading(unsigned long identifier) override;
void didFail(const ResourceError&) override;
bool responseIsXML() const;
Optional<ExceptionOr<void>> prepareToSend();
ExceptionOr<void> send(Document&);
ExceptionOr<void> send(const String& = { });
ExceptionOr<void> send(Blob&);
ExceptionOr<void> send(DOMFormData&);
ExceptionOr<void> send(JSC::ArrayBuffer&);
ExceptionOr<void> send(JSC::ArrayBufferView&);
ExceptionOr<void> sendBytesData(const void*, size_t);
void changeState(State);
void callReadyStateChangeListener();
// Returns false when cancelling the loader within internalAbort() triggers an event whose callback creates a new loader.
// In that case, the function calling internalAbort should exit.
bool internalAbort();
void clearResponse();
void clearResponseBuffers();
void clearRequest();
ExceptionOr<void> createRequest();
void genericError();
void networkError();
void abortError();
void dispatchErrorEvents(const AtomString&);
Ref<TextResourceDecoder> createDecoder() const;
unsigned m_async : 1;
unsigned m_includeCredentials : 1;
unsigned m_sendFlag : 1;
unsigned m_createdDocument : 1;
unsigned m_error : 1;
unsigned m_uploadListenerFlag : 1;
unsigned m_uploadComplete : 1;
unsigned m_wasAbortedByClient : 1;
unsigned m_responseCacheIsValid : 1;
unsigned m_readyState : 3; // State
unsigned m_responseType : 3; // ResponseType
unsigned m_timeoutMilliseconds { 0 };
std::unique_ptr<XMLHttpRequestUpload> m_upload;
URL m_url;
String m_method;
HTTPHeaderMap m_requestHeaders;
RefPtr<FormData> m_requestEntityBody;
String m_mimeTypeOverride;
struct LoadingActivity {
Ref<XMLHttpRequest> protectedThis; // Keep object alive while loading even if there is no longer a JS wrapper.
Ref<ThreadableLoader> loader;
};
Optional<LoadingActivity> m_loadingActivity;
String m_responseEncoding;
ResourceResponse m_response;
RefPtr<TextResourceDecoder> m_decoder;
RefPtr<Document> m_responseDocument;
RefPtr<SharedBuffer> m_binaryResponseBuilder;
StringBuilder m_responseBuilder;
// Used for progress event tracking.
long long m_receivedLength { 0 };
XMLHttpRequestProgressEventThrottle m_progressEventThrottle;
mutable String m_allResponseHeaders;
Timer m_timeoutTimer;
MonotonicTime m_sendingTime;
Optional<ExceptionCode> m_exceptionCode;
RefPtr<UserGestureToken> m_userGestureToken;
Seconds m_maximumIntervalForUserGestureForwarding;
bool m_hasRelevantEventListener { false };
};
inline auto XMLHttpRequest::responseType() const -> ResponseType
{
return static_cast<ResponseType>(m_responseType);
}
inline auto XMLHttpRequest::readyState() const -> State
{
return static_cast<State>(m_readyState);
}
} // namespace WebCore