<https://webkit.org/b/119859> Frame::loader() should return a reference
[WebKit-https.git] / Source / WebCore / loader / DocumentThreadableLoader.cpp
1 /*
2  * Copyright (C) 2011, 2012 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 "CachedRawResource.h"
35 #include "CachedResourceLoader.h"
36 #include "CachedResourceRequest.h"
37 #include "CrossOriginAccessControl.h"
38 #include "CrossOriginPreflightResultCache.h"
39 #include "Document.h"
40 #include "DocumentThreadableLoaderClient.h"
41 #include "Frame.h"
42 #include "FrameLoader.h"
43 #include "InspectorInstrumentation.h"
44 #include "ResourceError.h"
45 #include "ResourceRequest.h"
46 #include "SchemeRegistry.h"
47 #include "SecurityOrigin.h"
48 #include "SubresourceLoader.h"
49 #include "ThreadableLoaderClient.h"
50 #include <wtf/Assertions.h>
51
52 #if ENABLE(INSPECTOR)
53 #include "ProgressTracker.h"
54 #endif
55
56 namespace WebCore {
57
58 void DocumentThreadableLoader::loadResourceSynchronously(Document* document, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
59 {
60     // The loader will be deleted as soon as this function exits.
61     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, &client, LoadSynchronously, request, options));
62     ASSERT(loader->hasOneRef());
63 }
64
65 PassRefPtr<DocumentThreadableLoader> DocumentThreadableLoader::create(Document* document, ThreadableLoaderClient* client, const ResourceRequest& request, const ThreadableLoaderOptions& options)
66 {
67     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadAsynchronously, request, options));
68     if (!loader->m_resource)
69         loader = 0;
70     return loader.release();
71 }
72
73 DocumentThreadableLoader::DocumentThreadableLoader(Document* document, ThreadableLoaderClient* client, BlockingBehavior blockingBehavior, const ResourceRequest& request, const ThreadableLoaderOptions& options)
74     : m_client(client)
75     , m_document(document)
76     , m_options(options)
77     , m_sameOriginRequest(securityOrigin()->canRequest(request.url()))
78     , m_simpleRequest(true)
79     , m_async(blockingBehavior == LoadAsynchronously)
80 {
81     ASSERT(document);
82     ASSERT(client);
83     // Setting an outgoing referer is only supported in the async code path.
84     ASSERT(m_async || request.httpReferrer().isEmpty());
85
86     if (m_sameOriginRequest || m_options.crossOriginRequestPolicy == AllowCrossOriginRequests) {
87         loadRequest(request, DoSecurityCheck);
88         return;
89     }
90
91     if (m_options.crossOriginRequestPolicy == DenyCrossOriginRequests) {
92         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are not supported."));
93         return;
94     }
95
96     makeCrossOriginAccessRequest(request);
97 }
98
99 void DocumentThreadableLoader::makeCrossOriginAccessRequest(const ResourceRequest& request)
100 {
101     ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
102
103     OwnPtr<ResourceRequest> crossOriginRequest = adoptPtr(new ResourceRequest(request));
104     updateRequestForAccessControl(*crossOriginRequest, securityOrigin(), m_options.allowCredentials);
105
106     if ((m_options.preflightPolicy == ConsiderPreflight && isSimpleCrossOriginAccessRequest(crossOriginRequest->httpMethod(), crossOriginRequest->httpHeaderFields())) || m_options.preflightPolicy == PreventPreflight)
107         makeSimpleCrossOriginAccessRequest(*crossOriginRequest);
108     else {
109         m_simpleRequest = false;
110         m_actualRequest = crossOriginRequest.release();
111
112         if (CrossOriginPreflightResultCache::shared().canSkipPreflight(securityOrigin()->toString(), m_actualRequest->url(), m_options.allowCredentials, m_actualRequest->httpMethod(), m_actualRequest->httpHeaderFields()))
113             preflightSuccess();
114         else
115             makeCrossOriginAccessRequestWithPreflight(*m_actualRequest);
116     }
117 }
118
119 void DocumentThreadableLoader::makeSimpleCrossOriginAccessRequest(const ResourceRequest& request)
120 {
121     ASSERT(m_options.preflightPolicy != ForcePreflight);
122     ASSERT(m_options.preflightPolicy == PreventPreflight || isSimpleCrossOriginAccessRequest(request.httpMethod(), request.httpHeaderFields()));
123
124     // Cross-origin requests are only allowed for HTTP and registered schemes. We would catch this when checking response headers later, but there is no reason to send a request that's guaranteed to be denied.
125     if (!SchemeRegistry::shouldTreatURLSchemeAsCORSEnabled(request.url().protocol())) {
126         m_client->didFailAccessControlCheck(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are only supported for HTTP."));
127         return;
128     }
129
130     loadRequest(request, DoSecurityCheck);
131 }
132
133 void DocumentThreadableLoader::makeCrossOriginAccessRequestWithPreflight(const ResourceRequest& request)
134 {
135     ResourceRequest preflightRequest = createAccessControlPreflightRequest(request, securityOrigin());
136     loadRequest(preflightRequest, DoSecurityCheck);
137 }
138
139 DocumentThreadableLoader::~DocumentThreadableLoader()
140 {
141     if (m_resource)
142         m_resource->removeClient(this);
143 }
144
145 void DocumentThreadableLoader::cancel()
146 {
147     RefPtr<DocumentThreadableLoader> protect(this);
148
149     // Cancel can re-enter and m_resource might be null here as a result.
150     if (m_client && m_resource) {
151         // FIXME: This error is sent to the client in didFail(), so it should not be an internal one. Use FrameLoaderClient::cancelledError() instead.
152         ResourceError error(errorDomainWebKitInternal, 0, m_resource->url(), "Load cancelled");
153         error.setIsCancellation(true);
154         didFail(m_resource->identifier(), error);
155     }
156     clearResource();
157     m_client = 0;
158 }
159
160 void DocumentThreadableLoader::setDefersLoading(bool value)
161 {
162     if (m_resource)
163         m_resource->setDefersLoading(value);
164 }
165
166 void DocumentThreadableLoader::clearResource()
167 {
168     // Script can cancel and restart a request reentrantly within removeClient(),
169     // which could lead to calling CachedResource::removeClient() multiple times for
170     // this DocumentThreadableLoader. Save off a copy of m_resource and clear it to
171     // prevent the reentrancy.
172     if (CachedResourceHandle<CachedRawResource> resource = m_resource) {
173         m_resource = 0;
174         resource->removeClient(this);
175     }
176 }
177
178 void DocumentThreadableLoader::redirectReceived(CachedResource* resource, ResourceRequest& request, const ResourceResponse& redirectResponse)
179 {
180     ASSERT(m_client);
181     ASSERT_UNUSED(resource, resource == m_resource);
182
183     RefPtr<DocumentThreadableLoader> protect(this);
184     // Allow same origin requests to continue after allowing clients to audit the redirect.
185     if (isAllowedRedirect(request.url())) {
186         if (m_client->isDocumentThreadableLoaderClient())
187             static_cast<DocumentThreadableLoaderClient*>(m_client)->willSendRequest(request, redirectResponse);
188         return;
189     }
190
191     // When using access control, only simple cross origin requests are allowed to redirect. The new request URL must have a supported
192     // scheme and not contain the userinfo production. In addition, the redirect response must pass the access control check.
193     if (m_options.crossOriginRequestPolicy == UseAccessControl) {
194         bool allowRedirect = false;
195         if (m_simpleRequest) {
196             String accessControlErrorDescription;
197             allowRedirect = SchemeRegistry::shouldTreatURLSchemeAsCORSEnabled(request.url().protocol())
198                             && request.url().user().isEmpty()
199                             && request.url().pass().isEmpty()
200                             && passesAccessControlCheck(redirectResponse, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription);
201         }
202
203         if (allowRedirect) {
204             if (m_resource)
205                 clearResource();
206
207             RefPtr<SecurityOrigin> originalOrigin = SecurityOrigin::createFromString(redirectResponse.url());
208             RefPtr<SecurityOrigin> requestOrigin = SecurityOrigin::createFromString(request.url());
209             // If the request URL origin is not same origin with the original URL origin, set source origin to a globally unique identifier.
210             if (!originalOrigin->isSameSchemeHostPort(requestOrigin.get()))
211                 m_options.securityOrigin = SecurityOrigin::createUnique();
212             // Force any subsequent requests to use these checks.
213             m_sameOriginRequest = false;
214
215             // Remove any headers that may have been added by the network layer that cause access control to fail.
216             request.clearHTTPContentType();
217             request.clearHTTPReferrer();
218             request.clearHTTPOrigin();
219             request.clearHTTPUserAgent();
220             request.clearHTTPAccept();
221             makeCrossOriginAccessRequest(request);
222             return;
223         }
224     }
225
226     m_client->didFailRedirectCheck();
227     request = ResourceRequest();
228 }
229
230 void DocumentThreadableLoader::dataSent(CachedResource* resource, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
231 {
232     ASSERT(m_client);
233     ASSERT_UNUSED(resource, resource == m_resource);
234     m_client->didSendData(bytesSent, totalBytesToBeSent);
235 }
236
237 void DocumentThreadableLoader::responseReceived(CachedResource* resource, const ResourceResponse& response)
238 {
239     ASSERT_UNUSED(resource, resource == m_resource);
240     didReceiveResponse(m_resource->identifier(), response);
241 }
242
243 void DocumentThreadableLoader::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
244 {
245     ASSERT(m_client);
246
247     String accessControlErrorDescription;
248     if (m_actualRequest) {
249 #if ENABLE(INSPECTOR)
250         DocumentLoader* loader = m_document->frame()->loader().documentLoader();
251         InspectorInstrumentationCookie cookie = InspectorInstrumentation::willReceiveResourceResponse(m_document->frame(), identifier, response);
252         InspectorInstrumentation::didReceiveResourceResponse(cookie, identifier, loader, response, 0);
253 #endif
254
255         if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
256             preflightFailure(identifier, response.url(), accessControlErrorDescription);
257             return;
258         }
259
260         OwnPtr<CrossOriginPreflightResultCacheItem> preflightResult = adoptPtr(new CrossOriginPreflightResultCacheItem(m_options.allowCredentials));
261         if (!preflightResult->parse(response, accessControlErrorDescription)
262             || !preflightResult->allowsCrossOriginMethod(m_actualRequest->httpMethod(), accessControlErrorDescription)
263             || !preflightResult->allowsCrossOriginHeaders(m_actualRequest->httpHeaderFields(), accessControlErrorDescription)) {
264             preflightFailure(identifier, response.url(), accessControlErrorDescription);
265             return;
266         }
267
268         CrossOriginPreflightResultCache::shared().appendEntry(securityOrigin()->toString(), m_actualRequest->url(), preflightResult.release());
269     } else {
270         if (!m_sameOriginRequest && m_options.crossOriginRequestPolicy == UseAccessControl) {
271             if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
272                 m_client->didFailAccessControlCheck(ResourceError(errorDomainWebKitInternal, 0, response.url().string(), accessControlErrorDescription));
273                 return;
274             }
275         }
276
277         m_client->didReceiveResponse(identifier, response);
278     }
279 }
280
281 void DocumentThreadableLoader::dataReceived(CachedResource* resource, const char* data, int dataLength)
282 {
283     ASSERT_UNUSED(resource, resource == m_resource);
284     didReceiveData(m_resource->identifier(), data, dataLength);
285 }
286
287 void DocumentThreadableLoader::didReceiveData(unsigned long identifier, const char* data, int dataLength)
288 {
289     ASSERT(m_client);
290
291     // Preflight data should be invisible to clients.
292     if (m_actualRequest) {
293 #if ENABLE(INSPECTOR)
294         InspectorInstrumentation::didReceiveData(m_document->frame(), identifier, 0, 0, dataLength);
295 #endif
296         return;
297     }
298
299     m_client->didReceiveData(data, dataLength);
300 }
301
302 void DocumentThreadableLoader::notifyFinished(CachedResource* resource)
303 {
304     ASSERT(m_client);
305     ASSERT_UNUSED(resource, resource == m_resource);
306         
307     if (m_resource->errorOccurred())
308         didFail(m_resource->identifier(), m_resource->resourceError());
309     else
310         didFinishLoading(m_resource->identifier(), m_resource->loadFinishTime());
311 }
312
313 void DocumentThreadableLoader::didFinishLoading(unsigned long identifier, double finishTime)
314 {
315     if (m_actualRequest) {
316 #if ENABLE(INSPECTOR)
317         InspectorInstrumentation::didFinishLoading(m_document->frame(), m_document->frame()->loader().documentLoader(), identifier, finishTime);
318 #endif
319         ASSERT(!m_sameOriginRequest);
320         ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
321         preflightSuccess();
322     } else
323         m_client->didFinishLoading(identifier, finishTime);
324 }
325
326 void DocumentThreadableLoader::didFail(unsigned long identifier, const ResourceError& error)
327 {
328 #if ENABLE(INSPECTOR)
329     if (m_actualRequest)
330         InspectorInstrumentation::didFailLoading(m_document->frame(), m_document->frame()->loader().documentLoader(), identifier, error);
331 #endif
332
333     m_client->didFail(error);
334 }
335
336 void DocumentThreadableLoader::preflightSuccess()
337 {
338     OwnPtr<ResourceRequest> actualRequest;
339     actualRequest.swap(m_actualRequest);
340
341     actualRequest->setHTTPOrigin(securityOrigin()->toString());
342
343     clearResource();
344
345     // It should be ok to skip the security check since we already asked about the preflight request.
346     loadRequest(*actualRequest, SkipSecurityCheck);
347 }
348
349 void DocumentThreadableLoader::preflightFailure(unsigned long identifier, const String& url, const String& errorDescription)
350 {
351     ResourceError error(errorDomainWebKitInternal, 0, url, errorDescription);
352 #if ENABLE(INSPECTOR)
353     if (m_actualRequest)
354         InspectorInstrumentation::didFailLoading(m_document->frame(), m_document->frame()->loader().documentLoader(), identifier, error);
355 #endif
356     m_actualRequest = nullptr; // Prevent didFinishLoading() from bypassing access check.
357     m_client->didFailAccessControlCheck(error);
358 }
359
360 void DocumentThreadableLoader::loadRequest(const ResourceRequest& request, SecurityCheckPolicy securityCheck)
361 {
362     // Any credential should have been removed from the cross-site requests.
363     const KURL& requestURL = request.url();
364     m_options.securityCheck = securityCheck;
365     ASSERT(m_sameOriginRequest || requestURL.user().isEmpty());
366     ASSERT(m_sameOriginRequest || requestURL.pass().isEmpty());
367
368     if (m_async) {
369         ThreadableLoaderOptions options = m_options;
370         options.clientCredentialPolicy = DoNotAskClientForCrossOriginCredentials;
371         if (m_actualRequest) {
372             // Don't sniff content or send load callbacks for the preflight request.
373             options.sendLoadCallbacks = DoNotSendCallbacks;
374             options.sniffContent = DoNotSniffContent;
375             // Keep buffering the data for the preflight request.
376             options.dataBufferingPolicy = BufferData;
377         }
378
379         CachedResourceRequest newRequest(request, options);
380 #if ENABLE(RESOURCE_TIMING)
381         newRequest.setInitiator(m_options.initiator);
382 #endif
383         ASSERT(!m_resource);
384         m_resource = m_document->cachedResourceLoader()->requestRawResource(newRequest);
385         if (m_resource) {
386 #if ENABLE(INSPECTOR)
387             if (m_resource->loader()) {
388                 unsigned long identifier = m_resource->loader()->identifier();
389                 InspectorInstrumentation::documentThreadableLoaderStartedLoadingForClient(m_document, identifier, m_client);
390             }
391 #endif
392             m_resource->addClient(this);
393         }
394         return;
395     }
396     
397     // FIXME: ThreadableLoaderOptions.sniffContent is not supported for synchronous requests.
398     Vector<char> data;
399     ResourceError error;
400     ResourceResponse response;
401     unsigned long identifier = std::numeric_limits<unsigned long>::max();
402     if (m_document->frame())
403         identifier = m_document->frame()->loader().loadResourceSynchronously(request, m_options.allowCredentials, m_options.clientCredentialPolicy, error, response, data);
404
405     InspectorInstrumentation::documentThreadableLoaderStartedLoadingForClient(m_document, identifier, m_client);
406
407     // No exception for file:/// resources, see <rdar://problem/4962298>.
408     // Also, if we have an HTTP response, then it wasn't a network error in fact.
409     if (!error.isNull() && !requestURL.isLocalFile() && response.httpStatusCode() <= 0) {
410         m_client->didFail(error);
411         return;
412     }
413
414     // FIXME: FrameLoader::loadSynchronously() does not tell us whether a redirect happened or not, so we guess by comparing the
415     // request and response URLs. This isn't a perfect test though, since a server can serve a redirect to the same URL that was
416     // requested. Also comparing the request and response URLs as strings will fail if the requestURL still has its credentials.
417     if (requestURL != response.url() && !isAllowedRedirect(response.url())) {
418         m_client->didFailRedirectCheck();
419         return;
420     }
421
422     didReceiveResponse(identifier, response);
423
424     const char* bytes = static_cast<const char*>(data.data());
425     int len = static_cast<int>(data.size());
426     didReceiveData(identifier, bytes, len);
427
428     didFinishLoading(identifier, 0.0);
429 }
430
431 bool DocumentThreadableLoader::isAllowedRedirect(const KURL& url)
432 {
433     if (m_options.crossOriginRequestPolicy == AllowCrossOriginRequests)
434         return true;
435
436     return m_sameOriginRequest && securityOrigin()->canRequest(url);
437 }
438
439 SecurityOrigin* DocumentThreadableLoader::securityOrigin() const
440 {
441     return m_options.securityOrigin ? m_options.securityOrigin.get() : m_document->securityOrigin();
442 }
443
444 } // namespace WebCore