2011-01-24 Chris Marrin <cmarrin@apple.com>
[WebKit-https.git] / Source / WebCore / xml / XMLHttpRequest.h
1 /*
2  *  Copyright (C) 2003, 2006, 2008 Apple Inc. All rights reserved.
3  *  Copyright (C) 2005, 2006 Alexey Proskuryakov <ap@nypop.com>
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Lesser General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Lesser General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Lesser General Public
16  *  License along with this library; if not, write to the Free Software
17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  */
19
20 #ifndef XMLHttpRequest_h
21 #define XMLHttpRequest_h
22
23 #include "ActiveDOMObject.h"
24 #include "EventListener.h"
25 #include "EventNames.h"
26 #include "EventTarget.h"
27 #include "FormData.h"
28 #include "ResourceResponse.h"
29 #include "ThreadableLoaderClient.h"
30 #include "XMLHttpRequestProgressEventThrottle.h"
31 #include <wtf/OwnPtr.h>
32 #include <wtf/text/AtomicStringHash.h>
33 #include <wtf/text/StringBuilder.h>
34
35 namespace WebCore {
36
37 class ArrayBuffer;
38 class Blob;
39 class Document;
40 class DOMFormData;
41 class ResourceRequest;
42 class SharedBuffer;
43 class TextResourceDecoder;
44 class ThreadableLoader;
45
46 class XMLHttpRequest : public RefCounted<XMLHttpRequest>, public EventTarget, private ThreadableLoaderClient, public ActiveDOMObject {
47     WTF_MAKE_FAST_ALLOCATED;
48 public:
49     static PassRefPtr<XMLHttpRequest> create(ScriptExecutionContext* context) { return adoptRef(new XMLHttpRequest(context)); }
50     ~XMLHttpRequest();
51
52     // These exact numeric values are important because JS expects them.
53     enum State {
54         UNSENT = 0,
55         OPENED = 1,
56         HEADERS_RECEIVED = 2,
57         LOADING = 3,
58         DONE = 4
59     };
60     
61     enum ResponseTypeCode {
62         ResponseTypeDefault,
63         ResponseTypeText, 
64         ResponseTypeDocument,
65         ResponseTypeBlob,
66         ResponseTypeArrayBuffer
67     };
68
69     virtual XMLHttpRequest* toXMLHttpRequest() { return this; }
70
71     virtual void contextDestroyed();
72     virtual bool canSuspend() const;
73     virtual void suspend(ReasonForSuspension);
74     virtual void resume();
75     virtual void stop();
76
77     virtual ScriptExecutionContext* scriptExecutionContext() const;
78
79     const KURL& url() const { return m_url; }
80     String statusText(ExceptionCode&) const;
81     int status(ExceptionCode&) const;
82     State readyState() const;
83     bool withCredentials() const { return m_includeCredentials; }
84     void setWithCredentials(bool, ExceptionCode&);
85 #if ENABLE(XHR_RESPONSE_BLOB)
86     bool asBlob() const { return responseTypeCode() == ResponseTypeBlob; }
87     void setAsBlob(bool, ExceptionCode&);
88 #endif
89     void open(const String& method, const KURL&, ExceptionCode&);
90     void open(const String& method, const KURL&, bool async, ExceptionCode&);
91     void open(const String& method, const KURL&, bool async, const String& user, ExceptionCode&);
92     void open(const String& method, const KURL&, bool async, const String& user, const String& password, ExceptionCode&);
93     void send(ExceptionCode&);
94     void send(Document*, ExceptionCode&);
95     void send(const String&, ExceptionCode&);
96     void send(Blob*, ExceptionCode&);
97     void send(DOMFormData*, ExceptionCode&);
98 #if ENABLE(WEBGL) || ENABLE(BLOB)
99     void send(ArrayBuffer*, ExceptionCode&);
100 #endif
101     void abort();
102     void setRequestHeader(const AtomicString& name, const String& value, ExceptionCode&);
103     void overrideMimeType(const String& override);
104     String getAllResponseHeaders(ExceptionCode&) const;
105     String getResponseHeader(const AtomicString& name, ExceptionCode&) const;
106     String responseText(ExceptionCode&);
107     Document* responseXML(ExceptionCode&);
108     Document* optionalResponseXML() const { return m_responseXML.get(); }
109 #if ENABLE(XHR_RESPONSE_BLOB)
110     Blob* responseBlob(ExceptionCode&) const;
111     Blob* optionalResponseBlob() const { return m_responseBlob.get(); }
112 #endif
113
114     void setResponseType(const String&, ExceptionCode&);
115     String responseType();
116     ResponseTypeCode responseTypeCode() const { return m_responseTypeCode; }
117     
118 #if ENABLE(WEBGL) || ENABLE(BLOB)
119     // response attribute has custom getter.
120     ArrayBuffer* responseArrayBuffer(ExceptionCode&);
121     ArrayBuffer* optionalResponseArrayBuffer() const { return m_responseArrayBuffer.get(); }
122 #endif
123
124     void setLastSendLineNumber(unsigned lineNumber) { m_lastSendLineNumber = lineNumber; }
125     void setLastSendURL(const String& url) { m_lastSendURL = url; }
126
127     XMLHttpRequestUpload* upload();
128     XMLHttpRequestUpload* optionalUpload() const { return m_upload.get(); }
129
130     DEFINE_ATTRIBUTE_EVENT_LISTENER(readystatechange);
131     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
132     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
133     DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
134     DEFINE_ATTRIBUTE_EVENT_LISTENER(loadstart);
135     DEFINE_ATTRIBUTE_EVENT_LISTENER(progress);
136
137     using RefCounted<XMLHttpRequest>::ref;
138     using RefCounted<XMLHttpRequest>::deref;
139
140 private:
141     XMLHttpRequest(ScriptExecutionContext*);
142
143     virtual void refEventTarget() { ref(); }
144     virtual void derefEventTarget() { deref(); }
145     virtual EventTargetData* eventTargetData();
146     virtual EventTargetData* ensureEventTargetData();
147
148     Document* document() const;
149
150 #if ENABLE(DASHBOARD_SUPPORT)
151     bool usesDashboardBackwardCompatibilityMode() const;
152 #endif
153
154     virtual void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent);
155     virtual void didReceiveResponse(const ResourceResponse&);
156     virtual void didReceiveData(const char* data, int lengthReceived);
157     virtual void didFinishLoading(unsigned long identifier);
158     virtual void didFail(const ResourceError&);
159     virtual void didFailRedirectCheck();
160     virtual void didReceiveAuthenticationCancellation(const ResourceResponse&);
161
162     String responseMIMEType() const;
163     bool responseIsXML() const;
164
165     bool initSend(ExceptionCode&);
166
167     String getRequestHeader(const AtomicString& name) const;
168     void setRequestHeaderInternal(const AtomicString& name, const String& value);
169     bool isSafeRequestHeader(const String&) const;
170
171     void changeState(State newState);
172     void callReadyStateChangeListener();
173     void dropProtection();
174     void internalAbort();
175     void clearResponse();
176     void clearRequest();
177
178     void createRequest(ExceptionCode&);
179
180     void genericError();
181     void networkError();
182     void abortError();
183
184     RefPtr<XMLHttpRequestUpload> m_upload;
185
186     KURL m_url;
187     String m_method;
188     HTTPHeaderMap m_requestHeaders;
189     RefPtr<FormData> m_requestEntityBody;
190     String m_mimeTypeOverride;
191     bool m_async;
192     bool m_includeCredentials;
193 #if ENABLE(XHR_RESPONSE_BLOB)
194     RefPtr<Blob> m_responseBlob;
195 #endif
196
197     RefPtr<ThreadableLoader> m_loader;
198     State m_state;
199
200     ResourceResponse m_response;
201     String m_responseEncoding;
202
203     RefPtr<TextResourceDecoder> m_decoder;
204
205     StringBuilder m_responseBuilder;
206     mutable bool m_createdDocument;
207     mutable RefPtr<Document> m_responseXML;
208     
209 #if ENABLE(WEBGL) || ENABLE(BLOB)
210     RefPtr<SharedBuffer> m_binaryResponseBuilder;
211     mutable RefPtr<ArrayBuffer> m_responseArrayBuffer;
212 #endif
213
214     bool m_error;
215
216     bool m_uploadEventsAllowed;
217     bool m_uploadComplete;
218
219     bool m_sameOriginRequest;
220
221     // Used for onprogress tracking
222     long long m_receivedLength;
223
224     unsigned m_lastSendLineNumber;
225     String m_lastSendURL;
226     ExceptionCode m_exceptionCode;
227
228     EventTargetData m_eventTargetData;
229
230     XMLHttpRequestProgressEventThrottle m_progressEventThrottle;
231
232     // An enum corresponding to the allowed string values for the responseType attribute.
233     ResponseTypeCode m_responseTypeCode;
234 };
235
236 } // namespace WebCore
237
238 #endif // XMLHttpRequest_h