Move WebCore into Source
[WebKit-https.git] / Source / WebCore / loader / DocumentThreadableLoader.cpp
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "DocumentThreadableLoader.h"
33
34 #include "AuthenticationChallenge.h"
35 #include "CrossOriginAccessControl.h"
36 #include "CrossOriginPreflightResultCache.h"
37 #include "Document.h"
38 #include "Frame.h"
39 #include "FrameLoader.h"
40 #include "ResourceHandle.h"
41 #include "ResourceLoadScheduler.h"
42 #include "ResourceRequest.h"
43 #include "SecurityOrigin.h"
44 #include "SubresourceLoader.h"
45 #include "ThreadableLoaderClient.h"
46 #include <wtf/UnusedParam.h>
47
48 namespace WebCore {
49
50 void DocumentThreadableLoader::loadResourceSynchronously(Document* document, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
51 {
52     // The loader will be deleted as soon as this function exits.
53     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, &client, LoadSynchronously, request, options));
54     ASSERT(loader->hasOneRef());
55 }
56
57 PassRefPtr<DocumentThreadableLoader> DocumentThreadableLoader::create(Document* document, ThreadableLoaderClient* client, const ResourceRequest& request, const ThreadableLoaderOptions& options)
58 {
59     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadAsynchronously, request, options));
60     if (!loader->m_loader)
61         loader = 0;
62     return loader.release();
63 }
64
65 DocumentThreadableLoader::DocumentThreadableLoader(Document* document, ThreadableLoaderClient* client, BlockingBehavior blockingBehavior, const ResourceRequest& request, const ThreadableLoaderOptions& options)
66     : m_client(client)
67     , m_document(document)
68     , m_options(options)
69     , m_sameOriginRequest(document->securityOrigin()->canRequest(request.url()))
70     , m_async(blockingBehavior == LoadAsynchronously)
71 {
72     ASSERT(document);
73     ASSERT(client);
74
75     if (m_sameOriginRequest || m_options.crossOriginRequestPolicy == AllowCrossOriginRequests) {
76         loadRequest(request, DoSecurityCheck);
77         return;
78     }
79
80     if (m_options.crossOriginRequestPolicy == DenyCrossOriginRequests) {
81         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are not supported."));
82         return;
83     }
84     
85     ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
86
87     OwnPtr<ResourceRequest> crossOriginRequest = adoptPtr(new ResourceRequest(request));
88     crossOriginRequest->removeCredentials();
89     crossOriginRequest->setAllowCookies(m_options.allowCredentials);
90
91     if (!m_options.forcePreflight && isSimpleCrossOriginAccessRequest(crossOriginRequest->httpMethod(), crossOriginRequest->httpHeaderFields()))
92         makeSimpleCrossOriginAccessRequest(*crossOriginRequest);
93     else {
94         m_actualRequest = crossOriginRequest.release();
95
96         if (CrossOriginPreflightResultCache::shared().canSkipPreflight(document->securityOrigin()->toString(), m_actualRequest->url(), m_options.allowCredentials, m_actualRequest->httpMethod(), m_actualRequest->httpHeaderFields()))
97             preflightSuccess();
98         else
99             makeCrossOriginAccessRequestWithPreflight(*m_actualRequest);
100     }
101 }
102
103 void DocumentThreadableLoader::makeSimpleCrossOriginAccessRequest(const ResourceRequest& request)
104 {
105     ASSERT(isSimpleCrossOriginAccessRequest(request.httpMethod(), request.httpHeaderFields()));
106
107     // Cross-origin requests are only defined for HTTP. We would catch this when checking response headers later, but there is no reason to send a request that's guaranteed to be denied.
108     if (!request.url().protocolInHTTPFamily()) {
109         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are only supported for HTTP."));
110         return;
111     }
112
113     // Make a copy of the passed request so that we can modify some details.
114     ResourceRequest crossOriginRequest(request);
115     crossOriginRequest.setHTTPOrigin(m_document->securityOrigin()->toString());
116
117     loadRequest(crossOriginRequest, DoSecurityCheck);
118 }
119
120 void DocumentThreadableLoader::makeCrossOriginAccessRequestWithPreflight(const ResourceRequest& request)
121 {
122     ResourceRequest preflightRequest(request.url());
123     preflightRequest.removeCredentials();
124     preflightRequest.setHTTPOrigin(m_document->securityOrigin()->toString());
125     preflightRequest.setAllowCookies(m_options.allowCredentials);
126     preflightRequest.setHTTPMethod("OPTIONS");
127     preflightRequest.setHTTPHeaderField("Access-Control-Request-Method", request.httpMethod());
128
129     const HTTPHeaderMap& requestHeaderFields = request.httpHeaderFields();
130
131     if (requestHeaderFields.size() > 0) {
132         Vector<UChar> headerBuffer;
133         HTTPHeaderMap::const_iterator it = requestHeaderFields.begin();
134         append(headerBuffer, it->first);
135         ++it;
136
137         HTTPHeaderMap::const_iterator end = requestHeaderFields.end();
138         for (; it != end; ++it) {
139             headerBuffer.append(',');
140             headerBuffer.append(' ');
141             append(headerBuffer, it->first);
142         }
143
144         preflightRequest.setHTTPHeaderField("Access-Control-Request-Headers", String::adopt(headerBuffer));
145     }
146
147     loadRequest(preflightRequest, DoSecurityCheck);
148 }
149
150 DocumentThreadableLoader::~DocumentThreadableLoader()
151 {
152     if (m_loader)
153         m_loader->clearClient();
154 }
155
156 void DocumentThreadableLoader::cancel()
157 {
158     if (!m_loader)
159         return;
160
161     m_loader->cancel();
162     m_loader->clearClient();
163     m_loader = 0;
164     m_client = 0;
165 }
166
167 void DocumentThreadableLoader::willSendRequest(SubresourceLoader* loader, ResourceRequest& request, const ResourceResponse&)
168 {
169     ASSERT(m_client);
170     ASSERT_UNUSED(loader, loader == m_loader);
171
172     if (!isAllowedRedirect(request.url())) {
173         RefPtr<DocumentThreadableLoader> protect(this);
174         m_client->didFailRedirectCheck();
175         request = ResourceRequest();
176     }
177 }
178
179 void DocumentThreadableLoader::didSendData(SubresourceLoader* loader, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
180 {
181     ASSERT(m_client);
182     ASSERT_UNUSED(loader, loader == m_loader);
183
184     m_client->didSendData(bytesSent, totalBytesToBeSent);
185 }
186
187 void DocumentThreadableLoader::didReceiveResponse(SubresourceLoader* loader, const ResourceResponse& response)
188 {
189     ASSERT(m_client);
190     ASSERT_UNUSED(loader, loader == m_loader);
191
192     String accessControlErrorDescription;
193     if (m_actualRequest) {
194         if (!passesAccessControlCheck(response, m_options.allowCredentials, m_document->securityOrigin(), accessControlErrorDescription)) {
195             preflightFailure(response.url(), accessControlErrorDescription);
196             return;
197         }
198
199         OwnPtr<CrossOriginPreflightResultCacheItem> preflightResult = adoptPtr(new CrossOriginPreflightResultCacheItem(m_options.allowCredentials));
200         if (!preflightResult->parse(response, accessControlErrorDescription)
201             || !preflightResult->allowsCrossOriginMethod(m_actualRequest->httpMethod(), accessControlErrorDescription)
202             || !preflightResult->allowsCrossOriginHeaders(m_actualRequest->httpHeaderFields(), accessControlErrorDescription)) {
203             preflightFailure(response.url(), accessControlErrorDescription);
204             return;
205         }
206
207         CrossOriginPreflightResultCache::shared().appendEntry(m_document->securityOrigin()->toString(), m_actualRequest->url(), preflightResult.release());
208     } else {
209         if (!m_sameOriginRequest && m_options.crossOriginRequestPolicy == UseAccessControl) {
210             if (!passesAccessControlCheck(response, m_options.allowCredentials, m_document->securityOrigin(), accessControlErrorDescription)) {
211                 m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, response.url().string(), accessControlErrorDescription));
212                 return;
213             }
214         }
215
216         m_client->didReceiveResponse(response);
217     }
218 }
219
220 void DocumentThreadableLoader::didReceiveData(SubresourceLoader* loader, const char* data, int lengthReceived)
221 {
222     ASSERT(m_client);
223     ASSERT_UNUSED(loader, loader == m_loader);
224
225     // Ignore response body of preflight requests.
226     if (m_actualRequest)
227         return;
228
229     m_client->didReceiveData(data, lengthReceived);
230 }
231
232 void DocumentThreadableLoader::didFinishLoading(SubresourceLoader* loader)
233 {
234     ASSERT(loader == m_loader);
235     ASSERT(m_client);
236     didFinishLoading(loader->identifier());
237 }
238
239 void DocumentThreadableLoader::didFinishLoading(unsigned long identifier)
240 {
241     if (m_actualRequest) {
242         ASSERT(!m_sameOriginRequest);
243         ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
244         preflightSuccess();
245     } else
246         m_client->didFinishLoading(identifier);
247 }
248
249 void DocumentThreadableLoader::didFail(SubresourceLoader* loader, const ResourceError& error)
250 {
251     ASSERT(m_client);
252     // m_loader may be null if we arrive here via SubresourceLoader::create in the ctor
253     ASSERT_UNUSED(loader, loader == m_loader || !m_loader);
254
255     m_client->didFail(error);
256 }
257
258 bool DocumentThreadableLoader::getShouldUseCredentialStorage(SubresourceLoader* loader, bool& shouldUseCredentialStorage)
259 {
260     ASSERT_UNUSED(loader, loader == m_loader || !m_loader);
261
262     if (!m_options.allowCredentials) {
263         shouldUseCredentialStorage = false;
264         return true;
265     }
266
267     return false; // Only FrameLoaderClient can ultimately permit credential use.
268 }
269
270 void DocumentThreadableLoader::didReceiveAuthenticationChallenge(SubresourceLoader* loader, const AuthenticationChallenge& challenge)
271 {
272     ASSERT(loader == m_loader);
273     // Users are not prompted for credentials for cross-origin requests.
274     if (!m_sameOriginRequest) {
275 #if PLATFORM(MAC) || USE(CFNETWORK) || USE(CURL)
276         loader->handle()->receivedRequestToContinueWithoutCredential(challenge);
277 #else
278         // These platforms don't provide a way to continue without credentials, cancel the load altogether.
279         UNUSED_PARAM(challenge);
280         RefPtr<DocumentThreadableLoader> protect(this);
281         m_client->didFail(loader->blockedError());
282         cancel();
283 #endif
284     }
285 }
286
287 void DocumentThreadableLoader::receivedCancellation(SubresourceLoader* loader, const AuthenticationChallenge& challenge)
288 {
289     ASSERT(m_client);
290     ASSERT_UNUSED(loader, loader == m_loader);
291     m_client->didReceiveAuthenticationCancellation(challenge.failureResponse());
292 }
293
294 void DocumentThreadableLoader::preflightSuccess()
295 {
296     OwnPtr<ResourceRequest> actualRequest;
297     actualRequest.swap(m_actualRequest);
298
299     // It should be ok to skip the security check since we already asked about the preflight request.
300     loadRequest(*actualRequest, SkipSecurityCheck);
301 }
302
303 void DocumentThreadableLoader::preflightFailure(const String& url, const String& errorDescription)
304 {
305     m_actualRequest = 0; // Prevent didFinishLoading() from bypassing access check.
306     m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, url, errorDescription));
307 }
308
309 void DocumentThreadableLoader::loadRequest(const ResourceRequest& request, SecurityCheckPolicy securityCheck)
310 {
311     // Any credential should have been removed from the cross-site requests.
312     const KURL& requestURL = request.url();
313     ASSERT(m_sameOriginRequest || requestURL.user().isEmpty());
314     ASSERT(m_sameOriginRequest || requestURL.pass().isEmpty());
315
316     if (m_async) {
317         // Don't sniff content or send load callbacks for the preflight request.
318         bool sendLoadCallbacks = m_options.sendLoadCallbacks && !m_actualRequest;
319         bool sniffContent = m_options.sniffContent && !m_actualRequest;
320
321         // Clear the loader so that any callbacks from SubresourceLoader::create will not have the old loader.
322         m_loader = 0;
323         m_loader = resourceLoadScheduler()->scheduleSubresourceLoad(m_document->frame(), this, request, ResourceLoadPriorityMedium, securityCheck, sendLoadCallbacks, sniffContent);
324         return;
325     }
326     
327     // FIXME: ThreadableLoaderOptions.sniffContent is not supported for synchronous requests.
328     StoredCredentials storedCredentials = m_options.allowCredentials ? AllowStoredCredentials : DoNotAllowStoredCredentials;
329
330     Vector<char> data;
331     ResourceError error;
332     ResourceResponse response;
333     unsigned long identifier = std::numeric_limits<unsigned long>::max();
334     if (m_document->frame())
335         identifier = m_document->frame()->loader()->loadResourceSynchronously(request, storedCredentials, error, response, data);
336
337     // No exception for file:/// resources, see <rdar://problem/4962298>.
338     // Also, if we have an HTTP response, then it wasn't a network error in fact.
339     if (!error.isNull() && !requestURL.isLocalFile() && response.httpStatusCode() <= 0) {
340         m_client->didFail(error);
341         return;
342     }
343
344     // FIXME: FrameLoader::loadSynchronously() does not tell us whether a redirect happened or not, so we guess by comparing the
345     // request and response URLs. This isn't a perfect test though, since a server can serve a redirect to the same URL that was
346     // requested. Also comparing the request and response URLs as strings will fail if the requestURL still has its credentials.
347     if (requestURL != response.url() && !isAllowedRedirect(response.url())) {
348         m_client->didFailRedirectCheck();
349         return;
350     }
351
352     didReceiveResponse(0, response);
353
354     const char* bytes = static_cast<const char*>(data.data());
355     int len = static_cast<int>(data.size());
356     didReceiveData(0, bytes, len);
357
358     didFinishLoading(identifier);
359 }
360
361 bool DocumentThreadableLoader::isAllowedRedirect(const KURL& url)
362 {
363     if (m_options.crossOriginRequestPolicy == AllowCrossOriginRequests)
364         return true;
365
366     // FIXME: We need to implement access control for each redirect. This will require some refactoring though, because the code
367     // that processes redirects doesn't know about access control and expects a synchronous answer from its client about whether
368     // a redirect should proceed.
369     return m_sameOriginRequest && m_document->securityOrigin()->canRequest(url);
370 }
371
372 } // namespace WebCore