Source/WebCore: Make DocumentThreadableLoader a CachedResourceClient.
[WebKit-https.git] / Source / WebCore / loader / DocumentThreadableLoader.cpp
1 /*
2  * Copyright (C) 2011 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 "CrossOriginAccessControl.h"
37 #include "CrossOriginPreflightResultCache.h"
38 #include "Document.h"
39 #include "DocumentThreadableLoaderClient.h"
40 #include "Frame.h"
41 #include "FrameLoader.h"
42 #include "ResourceError.h"
43 #include "ResourceRequest.h"
44 #include "SecurityOrigin.h"
45 #include "ThreadableLoaderClient.h"
46 #include <wtf/Assertions.h>
47 #include <wtf/UnusedParam.h>
48
49 #if ENABLE(INSPECTOR)
50 #include "InspectorInstrumentation.h"
51 #include "ProgressTracker.h"
52 #endif
53
54 namespace WebCore {
55
56 void DocumentThreadableLoader::loadResourceSynchronously(Document* document, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
57 {
58     // The loader will be deleted as soon as this function exits.
59     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, &client, LoadSynchronously, request, options));
60     ASSERT(loader->hasOneRef());
61 }
62
63 PassRefPtr<DocumentThreadableLoader> DocumentThreadableLoader::create(Document* document, ThreadableLoaderClient* client, const ResourceRequest& request, const ThreadableLoaderOptions& options)
64 {
65     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadAsynchronously, request, options));
66     if (!loader->m_resource)
67         loader = 0;
68     return loader.release();
69 }
70
71 DocumentThreadableLoader::DocumentThreadableLoader(Document* document, ThreadableLoaderClient* client, BlockingBehavior blockingBehavior, const ResourceRequest& request, const ThreadableLoaderOptions& options)
72     : m_client(client)
73     , m_document(document)
74     , m_options(options)
75     , m_sameOriginRequest(securityOrigin()->canRequest(request.url()))
76     , m_async(blockingBehavior == LoadAsynchronously)
77 #if ENABLE(INSPECTOR)
78     , m_preflightRequestIdentifier(0)
79 #endif
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     ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
97
98     OwnPtr<ResourceRequest> crossOriginRequest = adoptPtr(new ResourceRequest(request));
99     updateRequestForAccessControl(*crossOriginRequest, securityOrigin(), m_options.allowCredentials);
100
101     if ((m_options.preflightPolicy == ConsiderPreflight && isSimpleCrossOriginAccessRequest(crossOriginRequest->httpMethod(), crossOriginRequest->httpHeaderFields())) || m_options.preflightPolicy == PreventPreflight)
102         makeSimpleCrossOriginAccessRequest(*crossOriginRequest);
103     else {
104         m_actualRequest = crossOriginRequest.release();
105
106         if (CrossOriginPreflightResultCache::shared().canSkipPreflight(securityOrigin()->toString(), m_actualRequest->url(), m_options.allowCredentials, m_actualRequest->httpMethod(), m_actualRequest->httpHeaderFields()))
107             preflightSuccess();
108         else
109             makeCrossOriginAccessRequestWithPreflight(*m_actualRequest);
110     }
111 }
112
113 void DocumentThreadableLoader::makeSimpleCrossOriginAccessRequest(const ResourceRequest& request)
114 {
115     ASSERT(m_options.preflightPolicy != ForcePreflight);
116     ASSERT(m_options.preflightPolicy == PreventPreflight || isSimpleCrossOriginAccessRequest(request.httpMethod(), request.httpHeaderFields()));
117
118     // 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.
119     // FIXME: Consider allowing simple CORS requests to non-HTTP URLs.
120     if (!request.url().protocolInHTTPFamily()) {
121         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are only supported for HTTP."));
122         return;
123     }
124
125     loadRequest(request, DoSecurityCheck);
126 }
127
128 void DocumentThreadableLoader::makeCrossOriginAccessRequestWithPreflight(const ResourceRequest& request)
129 {
130     ResourceRequest preflightRequest = createAccessControlPreflightRequest(request, securityOrigin(), m_options.allowCredentials);
131     loadRequest(preflightRequest, DoSecurityCheck);
132 }
133
134 DocumentThreadableLoader::~DocumentThreadableLoader()
135 {
136     if (m_resource)
137         m_resource->removeClient(this);
138 }
139
140 void DocumentThreadableLoader::cancel()
141 {
142     if (m_client) {
143         ResourceError error(errorDomainWebKitInternal, 0, m_resource->url(), "Load cancelled");
144         error.setIsCancellation(true);
145         didFail(error);
146     }
147     clearResource();
148     m_client = 0;
149 }
150
151 void DocumentThreadableLoader::setDefersLoading(bool value)
152 {
153     if (m_resource)
154         m_resource->setDefersLoading(value);
155 }
156
157 void DocumentThreadableLoader::clearResource()
158 {
159     if (m_resource) {
160         m_resource->removeClient(this);
161         m_resource = 0;
162     }
163 }
164
165 void DocumentThreadableLoader::redirectReceived(CachedResource* resource, ResourceRequest& request, const ResourceResponse& redirectResponse)
166 {
167     ASSERT(m_client);
168     ASSERT_UNUSED(resource, resource == m_resource);
169
170     if (!isAllowedRedirect(request.url())) {
171         RefPtr<DocumentThreadableLoader> protect(this);
172         m_client->didFailRedirectCheck();
173         request = ResourceRequest();
174     } else {
175         if (m_client->isDocumentThreadableLoaderClient())
176             static_cast<DocumentThreadableLoaderClient*>(m_client)->willSendRequest(request, redirectResponse);
177     }
178 }
179
180 void DocumentThreadableLoader::dataSent(CachedResource* resource, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
181 {
182     ASSERT(m_client);
183     ASSERT_UNUSED(resource, resource == m_resource);
184     m_client->didSendData(bytesSent, totalBytesToBeSent);
185 }
186
187 void DocumentThreadableLoader::responseReceived(CachedResource* resource, const ResourceResponse& response)
188 {
189     ASSERT_UNUSED(resource, resource == m_resource);
190     didReceiveResponse(m_resource->identifier(), response);
191 }
192
193 void DocumentThreadableLoader::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
194 {
195     ASSERT(m_client);
196
197 #if ENABLE(INSPECTOR)
198     if (m_preflightRequestIdentifier) {
199         DocumentLoader* loader = m_document->frame()->loader()->documentLoader();
200         InspectorInstrumentationCookie cookie = InspectorInstrumentation::willReceiveResourceResponse(m_document->frame(), m_preflightRequestIdentifier, response);
201         InspectorInstrumentation::didReceiveResourceResponse(cookie, m_preflightRequestIdentifier, loader, response);
202     }
203 #endif
204
205     String accessControlErrorDescription;
206     if (m_actualRequest) {
207         if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
208             preflightFailure(response.url(), accessControlErrorDescription);
209             return;
210         }
211
212         OwnPtr<CrossOriginPreflightResultCacheItem> preflightResult = adoptPtr(new CrossOriginPreflightResultCacheItem(m_options.allowCredentials));
213         if (!preflightResult->parse(response, accessControlErrorDescription)
214             || !preflightResult->allowsCrossOriginMethod(m_actualRequest->httpMethod(), accessControlErrorDescription)
215             || !preflightResult->allowsCrossOriginHeaders(m_actualRequest->httpHeaderFields(), accessControlErrorDescription)) {
216             preflightFailure(response.url(), accessControlErrorDescription);
217             return;
218         }
219
220         CrossOriginPreflightResultCache::shared().appendEntry(securityOrigin()->toString(), m_actualRequest->url(), preflightResult.release());
221     } else {
222         if (!m_sameOriginRequest && m_options.crossOriginRequestPolicy == UseAccessControl) {
223             if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
224                 m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, response.url().string(), accessControlErrorDescription));
225                 return;
226             }
227         }
228
229         m_client->didReceiveResponse(identifier, response);
230     }
231 }
232
233 void DocumentThreadableLoader::dataReceived(CachedResource* resource, const char* data, int dataLength)
234 {
235     ASSERT(m_client);
236     ASSERT_UNUSED(resource, resource == m_resource);
237
238 #if ENABLE(INSPECTOR)
239     if (m_preflightRequestIdentifier)
240         InspectorInstrumentation::didReceiveData(m_document->frame(), m_preflightRequestIdentifier, 0, 0, dataLength);
241 #endif
242
243     // Preflight data should be invisible to clients.
244     if (m_actualRequest)
245         return;
246
247     m_client->didReceiveData(data, dataLength);
248 }
249
250 void DocumentThreadableLoader::notifyFinished(CachedResource* resource)
251 {
252     ASSERT(m_client);
253     ASSERT_UNUSED(resource, resource == m_resource);
254         
255     if (m_resource && (m_resource->errorOccurred() || m_resource->wasCanceled())) {
256         ResourceError error("Network Request Failed", 0, m_resource->url(), "Resource failed to load");
257         if (m_resource->wasCanceled())
258             error.setIsCancellation(true);
259         didFail(error);
260     } else
261         didFinishLoading(m_resource->identifier(), m_resource->loadFinishTime());
262 }
263
264 void DocumentThreadableLoader::didFinishLoading(unsigned long identifier, double finishTime)
265 {
266 #if ENABLE(INSPECTOR)
267     if (m_preflightRequestIdentifier)
268         InspectorInstrumentation::didFinishLoading(m_document->frame(), m_document->frame()->loader()->documentLoader(), m_preflightRequestIdentifier, finishTime);
269 #endif
270
271     if (m_actualRequest) {
272         ASSERT(!m_sameOriginRequest);
273         ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
274         preflightSuccess();
275     } else
276         m_client->didFinishLoading(identifier, finishTime);
277 }
278
279 void DocumentThreadableLoader::didFail(const ResourceError& error)
280 {
281 #if ENABLE(INSPECTOR)
282     if (m_preflightRequestIdentifier)
283         InspectorInstrumentation::didFailLoading(m_document->frame(), m_document->frame()->loader()->documentLoader(), m_preflightRequestIdentifier, error);
284 #endif
285
286     m_client->didFail(error);
287 }
288
289 void DocumentThreadableLoader::preflightSuccess()
290 {
291     OwnPtr<ResourceRequest> actualRequest;
292     actualRequest.swap(m_actualRequest);
293
294     actualRequest->setHTTPOrigin(securityOrigin()->toString());
295
296     clearResource();
297
298     // It should be ok to skip the security check since we already asked about the preflight request.
299     loadRequest(*actualRequest, SkipSecurityCheck);
300 }
301
302 void DocumentThreadableLoader::preflightFailure(const String& url, const String& errorDescription)
303 {
304     m_actualRequest = nullptr; // Prevent didFinishLoading() from bypassing access check.
305     m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, url, errorDescription));
306 }
307
308 void DocumentThreadableLoader::loadRequest(const ResourceRequest& request, SecurityCheckPolicy securityCheck)
309 {
310     // Any credential should have been removed from the cross-site requests.
311     const KURL& requestURL = request.url();
312     m_options.securityCheck = securityCheck;
313     ASSERT(m_sameOriginRequest || requestURL.user().isEmpty());
314     ASSERT(m_sameOriginRequest || requestURL.pass().isEmpty());
315
316     if (m_async) {
317         ThreadableLoaderOptions options = m_options;
318         options.crossOriginCredentialPolicy = DoNotAskClientForCrossOriginCredentials;
319         if (m_actualRequest) {
320             // Don't sniff content or send load callbacks for the preflight request.
321             options.sendLoadCallbacks = DoNotSendCallbacks;
322             options.sniffContent = DoNotSniffContent;
323             // Keep buffering the data for the preflight request.
324             options.shouldBufferData = BufferData;
325         }
326
327         ResourceRequest newRequest(request);
328 #if ENABLE(INSPECTOR)
329         if (m_actualRequest) {
330             // Because willSendRequest only gets called during redirects, we initialize the identifier and the first willSendRequest here.
331             m_preflightRequestIdentifier = m_document->frame()->page()->progress()->createUniqueIdentifier();
332             ResourceResponse redirectResponse = ResourceResponse();
333             InspectorInstrumentation::willSendRequest(m_document->frame(), m_preflightRequestIdentifier, m_document->frame()->loader()->documentLoader(), newRequest, redirectResponse);
334         }
335 #endif
336         ASSERT(!m_resource);
337         m_resource = m_document->cachedResourceLoader()->requestRawResource(newRequest, options);
338         if (m_resource)
339             m_resource->addClient(this);
340         return;
341     }
342     
343     // FIXME: ThreadableLoaderOptions.sniffContent is not supported for synchronous requests.
344     Vector<char> data;
345     ResourceError error;
346     ResourceResponse response;
347     unsigned long identifier = std::numeric_limits<unsigned long>::max();
348     if (m_document->frame())
349         identifier = m_document->frame()->loader()->loadResourceSynchronously(request, m_options.allowCredentials, error, response, data);
350
351     // No exception for file:/// resources, see <rdar://problem/4962298>.
352     // Also, if we have an HTTP response, then it wasn't a network error in fact.
353     if (!error.isNull() && !requestURL.isLocalFile() && response.httpStatusCode() <= 0) {
354         m_client->didFail(error);
355         return;
356     }
357
358     // FIXME: FrameLoader::loadSynchronously() does not tell us whether a redirect happened or not, so we guess by comparing the
359     // request and response URLs. This isn't a perfect test though, since a server can serve a redirect to the same URL that was
360     // requested. Also comparing the request and response URLs as strings will fail if the requestURL still has its credentials.
361     if (requestURL != response.url() && !isAllowedRedirect(response.url())) {
362         m_client->didFailRedirectCheck();
363         return;
364     }
365
366     didReceiveResponse(identifier, response);
367
368     const char* bytes = static_cast<const char*>(data.data());
369     int len = static_cast<int>(data.size());
370     dataReceived(0, bytes, len);
371
372     didFinishLoading(identifier, 0.0);
373 }
374
375 bool DocumentThreadableLoader::isAllowedRedirect(const KURL& url)
376 {
377     if (m_options.crossOriginRequestPolicy == AllowCrossOriginRequests)
378         return true;
379
380     // FIXME: We need to implement access control for each redirect. This will require some refactoring though, because the code
381     // that processes redirects doesn't know about access control and expects a synchronous answer from its client about whether
382     // a redirect should proceed.
383     return m_sameOriginRequest && securityOrigin()->canRequest(url);
384 }
385
386 SecurityOrigin* DocumentThreadableLoader::securityOrigin() const
387 {
388     return m_options.securityOrigin ? m_options.securityOrigin.get() : m_document->securityOrigin();
389 }
390
391 } // namespace WebCore