[iOS] Upstream WebCore/loader changes
[WebKit-https.git] / Source / WebCore / loader / DocumentLoader.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include "config.h"
31 #include "DocumentLoader.h"
32
33 #include "ApplicationCacheHost.h"
34 #include "ArchiveResourceCollection.h"
35 #include "CachedPage.h"
36 #include "CachedRawResource.h"
37 #include "CachedResourceLoader.h"
38 #include "DOMWindow.h"
39 #include "Document.h"
40 #include "DocumentParser.h"
41 #include "DocumentWriter.h"
42 #include "Event.h"
43 #include "FormState.h"
44 #include "FrameLoader.h"
45 #include "FrameLoaderClient.h"
46 #include "FrameTree.h"
47 #include "HTMLFormElement.h"
48 #include "HTMLFrameOwnerElement.h"
49 #include "HistoryItem.h"
50 #include "IconController.h"
51 #include "InspectorInstrumentation.h"
52 #include "Logging.h"
53 #include "MainFrame.h"
54 #include "MemoryCache.h"
55 #include "Page.h"
56 #include "PolicyChecker.h"
57 #include "ProgressTracker.h"
58 #include "ResourceBuffer.h"
59 #include "ResourceHandle.h"
60 #include "SchemeRegistry.h"
61 #include "SecurityPolicy.h"
62 #include "Settings.h"
63 #include "SubresourceLoader.h"
64 #include "TextResourceDecoder.h"
65 #include <wtf/Assertions.h>
66 #include <wtf/NeverDestroyed.h>
67 #include <wtf/Ref.h>
68 #include <wtf/text/CString.h>
69 #include <wtf/text/WTFString.h>
70 #include <wtf/unicode/Unicode.h>
71
72 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
73 #include "ArchiveFactory.h"
74 #endif
75
76 #if USE(CONTENT_FILTERING)
77 #include "ContentFilter.h"
78 #endif
79
80 namespace WebCore {
81
82 static void cancelAll(const ResourceLoaderSet& loaders)
83 {
84     Vector<RefPtr<ResourceLoader>> loadersCopy;
85     copyToVector(loaders, loadersCopy);
86     size_t size = loadersCopy.size();
87     for (size_t i = 0; i < size; ++i)
88         loadersCopy[i]->cancel();
89 }
90
91 static void setAllDefersLoading(const ResourceLoaderSet& loaders, bool defers)
92 {
93     Vector<RefPtr<ResourceLoader>> loadersCopy;
94     copyToVector(loaders, loadersCopy);
95     size_t size = loadersCopy.size();
96     for (size_t i = 0; i < size; ++i)
97         loadersCopy[i]->setDefersLoading(defers);
98 }
99
100 static bool areAllLoadersPageCacheAcceptable(const ResourceLoaderSet& loaders)
101 {
102     Vector<RefPtr<ResourceLoader>> loadersCopy;
103     copyToVector(loaders, loadersCopy);
104     for (auto& loader : loadersCopy) {
105         ResourceHandle* handle = loader->handle();
106         if (!handle)
107             return false;
108
109         CachedResource* cachedResource = memoryCache()->resourceForURL(handle->firstRequest().url());
110         if (!cachedResource)
111             return false;
112
113         // All non-image loads will prevent the page from entering the PageCache.
114         if (!cachedResource->isImage())
115             return false;
116     }
117     return true;
118 }
119
120 DocumentLoader::DocumentLoader(const ResourceRequest& req, const SubstituteData& substituteData)
121     : m_deferMainResourceDataLoad(true)
122     , m_frame(0)
123     , m_cachedResourceLoader(CachedResourceLoader::create(this))
124     , m_writer(m_frame)
125     , m_originalRequest(req)
126     , m_substituteData(substituteData)
127     , m_originalRequestCopy(req)
128     , m_request(req)
129     , m_originalSubstituteDataWasValid(substituteData.isValid())
130     , m_committed(false)
131     , m_isStopping(false)
132     , m_gotFirstByte(false)
133     , m_isClientRedirect(false)
134     , m_isLoadingMultipartContent(false)
135     , m_wasOnloadHandled(false)
136     , m_stopRecordingResponses(false)
137     , m_substituteResourceDeliveryTimer(this, &DocumentLoader::substituteResourceDeliveryTimerFired)
138     , m_didCreateGlobalHistoryEntry(false)
139     , m_loadingMainResource(false)
140     , m_timeOfLastDataReceived(0.0)
141     , m_identifierForLoadWithoutResourceLoader(0)
142     , m_dataLoadTimer(this, &DocumentLoader::handleSubstituteDataLoadNow)
143     , m_waitingForContentPolicy(false)
144     , m_subresourceLoadersArePageCacheAcceptable(false)
145     , m_applicationCacheHost(adoptPtr(new ApplicationCacheHost(this)))
146 {
147 }
148
149 FrameLoader* DocumentLoader::frameLoader() const
150 {
151     if (!m_frame)
152         return 0;
153     return &m_frame->loader();
154 }
155
156 ResourceLoader* DocumentLoader::mainResourceLoader() const
157 {
158     return m_mainResource ? m_mainResource->loader() : 0;
159 }
160
161 DocumentLoader::~DocumentLoader()
162 {
163     ASSERT(!m_frame || frameLoader()->activeDocumentLoader() != this || !isLoading());
164     if (m_iconLoadDecisionCallback)
165         m_iconLoadDecisionCallback->invalidate();
166     if (m_iconDataCallback)
167         m_iconDataCallback->invalidate();
168     m_cachedResourceLoader->clearDocumentLoader();
169     
170     clearMainResource();
171 }
172
173 PassRefPtr<ResourceBuffer> DocumentLoader::mainResourceData() const
174 {
175     if (m_substituteData.isValid())
176         return ResourceBuffer::create(m_substituteData.content()->data(), m_substituteData.content()->size());
177     if (m_mainResource)
178         return m_mainResource->resourceBuffer();
179     return 0;
180 }
181
182 Document* DocumentLoader::document() const
183 {
184     if (m_frame && m_frame->loader().documentLoader() == this)
185         return m_frame->document();
186     return 0;
187 }
188
189 const ResourceRequest& DocumentLoader::originalRequest() const
190 {
191     return m_originalRequest;
192 }
193
194 const ResourceRequest& DocumentLoader::originalRequestCopy() const
195 {
196     return m_originalRequestCopy;
197 }
198
199 const ResourceRequest& DocumentLoader::request() const
200 {
201     return m_request;
202 }
203
204 ResourceRequest& DocumentLoader::request()
205 {
206     return m_request;
207 }
208
209 const URL& DocumentLoader::url() const
210 {
211     return request().url();
212 }
213
214 void DocumentLoader::replaceRequestURLForSameDocumentNavigation(const URL& url)
215 {
216     m_originalRequestCopy.setURL(url);
217     m_request.setURL(url);
218 }
219
220 void DocumentLoader::setRequest(const ResourceRequest& req)
221 {
222     // Replacing an unreachable URL with alternate content looks like a server-side
223     // redirect at this point, but we can replace a committed dataSource.
224     bool handlingUnreachableURL = false;
225
226     handlingUnreachableURL = m_substituteData.isValid() && !m_substituteData.failingURL().isEmpty();
227
228     if (handlingUnreachableURL)
229         m_committed = false;
230
231     // We should never be getting a redirect callback after the data
232     // source is committed, except in the unreachable URL case. It 
233     // would be a WebFoundation bug if it sent a redirect callback after commit.
234     ASSERT(!m_committed);
235
236     m_request = req;
237 }
238
239 void DocumentLoader::setMainDocumentError(const ResourceError& error)
240 {
241     m_mainDocumentError = error;    
242     frameLoader()->client().setMainDocumentError(this, error);
243 }
244
245 void DocumentLoader::mainReceivedError(const ResourceError& error)
246 {
247     ASSERT(!error.isNull());
248
249     if (m_identifierForLoadWithoutResourceLoader) {
250         ASSERT(!mainResourceLoader());
251         frameLoader()->client().dispatchDidFailLoading(this, m_identifierForLoadWithoutResourceLoader, error);
252     }
253
254     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
255     // See <rdar://problem/6304600> for more details.
256 #if !USE(CF)
257     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
258 #endif
259
260     m_applicationCacheHost->failedLoadingMainResource();
261
262     if (!frameLoader())
263         return;
264     setMainDocumentError(error);
265     clearMainResourceLoader();
266     frameLoader()->receivedMainResourceError(error);
267 }
268
269 // Cancels the data source's pending loads.  Conceptually, a data source only loads
270 // one document at a time, but one document may have many related resources. 
271 // stopLoading will stop all loads initiated by the data source, 
272 // but not loads initiated by child frames' data sources -- that's the WebFrame's job.
273 void DocumentLoader::stopLoading()
274 {
275     RefPtr<Frame> protectFrame(m_frame);
276     Ref<DocumentLoader> protectLoader(*this);
277
278     // In some rare cases, calling FrameLoader::stopLoading could cause isLoading() to return false.
279     // (This can happen when there's a single XMLHttpRequest currently loading and stopLoading causes it
280     // to stop loading. Because of this, we need to save it so we don't return early.
281     bool loading = isLoading();
282
283     // We may want to audit the existing subresource loaders when we are on a page which has completed
284     // loading but there are subresource loads during cancellation. This must be done before the
285     // frame->stopLoading() call, which may evict the CachedResources, which we rely on to check
286     // the type of the resource loads.
287     if (loading && m_committed && !mainResourceLoader() && !m_subresourceLoaders.isEmpty())
288         m_subresourceLoadersArePageCacheAcceptable = areAllLoadersPageCacheAcceptable(m_subresourceLoaders);
289
290     if (m_committed) {
291         // Attempt to stop the frame if the document loader is loading, or if it is done loading but
292         // still  parsing. Failure to do so can cause a world leak.
293         Document* doc = m_frame->document();
294         
295         if (loading || doc->parsing())
296             m_frame->loader().stopLoading(UnloadEventPolicyNone);
297     }
298
299     // Always cancel multipart loaders
300     cancelAll(m_multipartSubresourceLoaders);
301
302     // Appcache uses ResourceHandle directly, DocumentLoader doesn't count these loads.
303     m_applicationCacheHost->stopLoadingInFrame(m_frame);
304     
305 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
306     clearArchiveResources();
307 #endif
308
309     if (!loading) {
310         // If something above restarted loading we might run into mysterious crashes like 
311         // https://bugs.webkit.org/show_bug.cgi?id=62764 and <rdar://problem/9328684>
312         ASSERT(!isLoading());
313         return;
314     }
315
316     // We might run in to infinite recursion if we're stopping loading as the result of 
317     // detaching from the frame, so break out of that recursion here.
318     // See <rdar://problem/9673866> for more details.
319     if (m_isStopping)
320         return;
321
322     m_isStopping = true;
323
324     FrameLoader* frameLoader = DocumentLoader::frameLoader();
325     
326     if (isLoadingMainResource()) {
327         // Stop the main resource loader and let it send the cancelled message.
328         cancelMainResourceLoad(frameLoader->cancelledError(m_request));
329     } else if (!m_subresourceLoaders.isEmpty())
330         // The main resource loader already finished loading. Set the cancelled error on the 
331         // document and let the subresourceLoaders send individual cancelled messages below.
332         setMainDocumentError(frameLoader->cancelledError(m_request));
333     else
334         // If there are no resource loaders, we need to manufacture a cancelled message.
335         // (A back/forward navigation has no resource loaders because its resources are cached.)
336         mainReceivedError(frameLoader->cancelledError(m_request));
337
338     // We always need to explicitly cancel the Document's parser when stopping the load.
339     // Otherwise cancelling the parser while starting the next page load might result
340     // in unexpected side effects such as erroneous event dispatch. ( http://webkit.org/b/117112 )
341     if (Document* document = this->document())
342         document->cancelParsing();
343     
344     stopLoadingSubresources();
345     stopLoadingPlugIns();
346     
347     m_isStopping = false;
348 }
349
350 void DocumentLoader::commitIfReady()
351 {
352     if (!m_committed) {
353         m_committed = true;
354         frameLoader()->commitProvisionalLoad();
355     }
356 }
357
358 bool DocumentLoader::isLoading() const
359 {
360     // FIXME: This should always be enabled, but it seems to cause
361     // http/tests/security/feed-urls-from-remote.html to timeout on Mac WK1
362     // see http://webkit.org/b/110554 and http://webkit.org/b/110401
363 #if ENABLE(THREADED_HTML_PARSER)
364     if (document() && document()->hasActiveParser())
365         return true;
366 #endif
367     return isLoadingMainResource() || !m_subresourceLoaders.isEmpty() || !m_plugInStreamLoaders.isEmpty();
368 }
369
370 void DocumentLoader::notifyFinished(CachedResource* resource)
371 {
372     ASSERT_UNUSED(resource, m_mainResource == resource);
373     ASSERT(m_mainResource);
374     if (!m_mainResource->errorOccurred() && !m_mainResource->wasCanceled()) {
375         finishedLoading(m_mainResource->loadFinishTime());
376         return;
377     }
378
379     if (m_request.cachePolicy() == ReturnCacheDataDontLoad && !m_mainResource->wasCanceled()) {
380         frameLoader()->retryAfterFailedCacheOnlyMainResourceLoad();
381         return;
382     }
383
384     mainReceivedError(m_mainResource->resourceError());
385 }
386
387 void DocumentLoader::finishedLoading(double finishTime)
388 {
389     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
390     // See <rdar://problem/6304600> for more details.
391 #if !USE(CF)
392     ASSERT(!m_frame->page()->defersLoading() || InspectorInstrumentation::isDebuggerPaused(m_frame));
393 #endif
394
395     Ref<DocumentLoader> protect(*this);
396
397     if (m_identifierForLoadWithoutResourceLoader) {
398         // A didFinishLoading delegate might try to cancel the load (despite it
399         // being finished). Clear m_identifierForLoadWithoutResourceLoader
400         // before calling dispatchDidFinishLoading so that we don't later try to
401         // cancel the already-finished substitute load.
402         unsigned long identifier = m_identifierForLoadWithoutResourceLoader;
403         m_identifierForLoadWithoutResourceLoader = 0;
404         frameLoader()->notifier().dispatchDidFinishLoading(this, identifier, finishTime);
405     }
406
407 #if USE(CONTENT_FILTERING)
408     if (m_contentFilter && m_contentFilter->needsMoreData()) {
409         m_contentFilter->finishedAddingData();
410         int length;
411         const char* data = m_contentFilter->getReplacementData(length);
412         if (data)
413             dataReceived(m_mainResource.get(), data, length);
414
415         if (m_contentFilter->didBlockData())
416             setContentFilterForBlockedLoad(m_contentFilter);
417     }
418 #endif
419
420     maybeFinishLoadingMultipartContent();
421
422     double responseEndTime = finishTime;
423     if (!responseEndTime)
424         responseEndTime = m_timeOfLastDataReceived;
425     if (!responseEndTime)
426         responseEndTime = monotonicallyIncreasingTime();
427     timing()->setResponseEnd(responseEndTime);
428
429     commitIfReady();
430     if (!frameLoader())
431         return;
432
433     if (!maybeCreateArchive()) {
434         // If this is an empty document, it will not have actually been created yet. Commit dummy data so that
435         // DocumentWriter::begin() gets called and creates the Document.
436         if (!m_gotFirstByte)
437             commitData(0, 0);
438         frameLoader()->client().finishedLoading(this);
439     }
440
441     m_writer.end();
442     if (!m_mainDocumentError.isNull())
443         return;
444     clearMainResourceLoader();
445     if (!frameLoader()->stateMachine()->creatingInitialEmptyDocument())
446         frameLoader()->checkLoadComplete();
447
448     // If the document specified an application cache manifest, it violates the author's intent if we store it in the memory cache
449     // and deny the appcache the chance to intercept it in the future, so remove from the memory cache.
450     if (m_frame) {
451         if (m_mainResource && m_frame->document()->hasManifest())
452             memoryCache()->remove(m_mainResource.get());
453     }
454     m_applicationCacheHost->finishedLoadingMainResource();
455 }
456
457 bool DocumentLoader::isPostOrRedirectAfterPost(const ResourceRequest& newRequest, const ResourceResponse& redirectResponse)
458 {
459     if (newRequest.httpMethod() == "POST")
460         return true;
461
462     int status = redirectResponse.httpStatusCode();
463     if (((status >= 301 && status <= 303) || status == 307)
464         && m_originalRequest.httpMethod() == "POST")
465         return true;
466
467     return false;
468 }
469
470 void DocumentLoader::handleSubstituteDataLoadNow(DocumentLoaderTimer*)
471 {
472     URL url = m_substituteData.responseURL();
473     if (url.isEmpty())
474         url = m_request.url();
475     ResourceResponse response(url, m_substituteData.mimeType(), m_substituteData.content()->size(), m_substituteData.textEncoding(), "");
476     responseReceived(0, response);
477 }
478
479 void DocumentLoader::startDataLoadTimer()
480 {
481     m_dataLoadTimer.startOneShot(0);
482
483 #if HAVE(RUNLOOP_TIMER)
484     if (SchedulePairHashSet* scheduledPairs = m_frame->page()->scheduledRunLoopPairs())
485         m_dataLoadTimer.schedule(*scheduledPairs);
486 #endif
487 }
488
489 void DocumentLoader::handleSubstituteDataLoadSoon()
490 {
491     if (!m_deferMainResourceDataLoad || frameLoader()->loadsSynchronously())
492         handleSubstituteDataLoadNow(0);
493     else
494         startDataLoadTimer();
495 }
496
497 void DocumentLoader::redirectReceived(CachedResource* resource, ResourceRequest& request, const ResourceResponse& redirectResponse)
498 {
499     ASSERT_UNUSED(resource, resource == m_mainResource);
500     willSendRequest(request, redirectResponse);
501 }
502
503 void DocumentLoader::willSendRequest(ResourceRequest& newRequest, const ResourceResponse& redirectResponse)
504 {
505     // Note that there are no asserts here as there are for the other callbacks. This is due to the
506     // fact that this "callback" is sent when starting every load, and the state of callback
507     // deferrals plays less of a part in this function in preventing the bad behavior deferring 
508     // callbacks is meant to prevent.
509     ASSERT(!newRequest.isNull());
510
511     if (!frameLoader()->checkIfFormActionAllowedByCSP(newRequest.url())) {
512         cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
513         return;
514     }
515
516     ASSERT(timing()->fetchStart());
517     if (!redirectResponse.isNull()) {
518         // If the redirecting url is not allowed to display content from the target origin,
519         // then block the redirect.
520         RefPtr<SecurityOrigin> redirectingOrigin = SecurityOrigin::create(redirectResponse.url());
521         if (!redirectingOrigin->canDisplay(newRequest.url())) {
522             FrameLoader::reportLocalLoadFailed(m_frame, newRequest.url().string());
523             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
524             return;
525         }
526         timing()->addRedirect(redirectResponse.url(), newRequest.url());
527     }
528
529     // Update cookie policy base URL as URL changes, except for subframes, which use the
530     // URL of the main frame which doesn't change when we redirect.
531     if (frameLoader()->frame().isMainFrame())
532         newRequest.setFirstPartyForCookies(newRequest.url());
533
534     // If we're fielding a redirect in response to a POST, force a load from origin, since
535     // this is a common site technique to return to a page viewing some data that the POST
536     // just modified.
537     // Also, POST requests always load from origin, but this does not affect subresources.
538     if (newRequest.cachePolicy() == UseProtocolCachePolicy && isPostOrRedirectAfterPost(newRequest, redirectResponse))
539         newRequest.setCachePolicy(ReloadIgnoringCacheData);
540
541     Frame& topFrame = m_frame->tree().top();
542     if (&topFrame != m_frame) {
543         if (!frameLoader()->mixedContentChecker().canDisplayInsecureContent(topFrame.document()->securityOrigin(), newRequest.url())) {
544             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
545             return;
546         }
547     }
548
549     setRequest(newRequest);
550
551     if (!redirectResponse.isNull()) {
552         // We checked application cache for initial URL, now we need to check it for redirected one.
553         ASSERT(!m_substituteData.isValid());
554         m_applicationCacheHost->maybeLoadMainResourceForRedirect(newRequest, m_substituteData);
555         if (m_substituteData.isValid())
556             m_identifierForLoadWithoutResourceLoader = mainResourceLoader()->identifier();
557     }
558
559     // FIXME: Ideally we'd stop the I/O until we hear back from the navigation policy delegate
560     // listener. But there's no way to do that in practice. So instead we cancel later if the
561     // listener tells us to. In practice that means the navigation policy needs to be decided
562     // synchronously for these redirect cases.
563     if (redirectResponse.isNull())
564         return;
565
566     frameLoader()->policyChecker().checkNavigationPolicy(newRequest, [this](const ResourceRequest& request, PassRefPtr<FormState>, bool shouldContinue) {
567         continueAfterNavigationPolicy(request, shouldContinue);
568     });
569 }
570
571 void DocumentLoader::continueAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue)
572 {
573     if (!shouldContinue)
574         stopLoadingForPolicyChange();
575     else if (m_substituteData.isValid()) {
576         // A redirect resulted in loading substitute data.
577         ASSERT(timing()->redirectCount());
578
579         // We need to remove our reference to the CachedResource in favor of a SubstituteData load.
580         // This will probably trigger the cancellation of the CachedResource's underlying ResourceLoader, though there is a
581         // small chance that the resource is being loaded by a different Frame, preventing the ResourceLoader from being cancelled.
582         // If the ResourceLoader is indeed cancelled, it would normally send resource load callbacks.
583         // However, from an API perspective, this isn't a cancellation. Therefore, sever our relationship with the network load,
584         // but prevent the ResourceLoader from sending ResourceLoadNotifier callbacks.
585         RefPtr<ResourceLoader> resourceLoader = mainResourceLoader();
586         ASSERT(resourceLoader->shouldSendResourceLoadCallbacks());
587         resourceLoader->setSendCallbackPolicy(DoNotSendCallbacks);
588         clearMainResource();
589         resourceLoader->setSendCallbackPolicy(SendCallbacks);
590         handleSubstituteDataLoadSoon();
591     }
592 }
593
594 void DocumentLoader::responseReceived(CachedResource* resource, const ResourceResponse& response)
595 {
596     ASSERT_UNUSED(resource, m_mainResource == resource);
597     Ref<DocumentLoader> protect(*this);
598     bool willLoadFallback = m_applicationCacheHost->maybeLoadFallbackForMainResponse(request(), response);
599
600     // The memory cache doesn't understand the application cache or its caching rules. So if a main resource is served
601     // from the application cache, ensure we don't save the result for future use.
602     if (willLoadFallback)
603         memoryCache()->remove(m_mainResource.get());
604
605     if (willLoadFallback)
606         return;
607
608     DEFINE_STATIC_LOCAL(AtomicString, xFrameOptionHeader, ("x-frame-options", AtomicString::ConstructFromLiteral));
609     HTTPHeaderMap::const_iterator it = response.httpHeaderFields().find(xFrameOptionHeader);
610     if (it != response.httpHeaderFields().end()) {
611         String content = it->value;
612         ASSERT(m_mainResource);
613         unsigned long identifier = m_identifierForLoadWithoutResourceLoader ? m_identifierForLoadWithoutResourceLoader : m_mainResource->identifier();
614         ASSERT(identifier);
615         if (frameLoader()->shouldInterruptLoadForXFrameOptions(content, response.url(), identifier)) {
616             InspectorInstrumentation::continueAfterXFrameOptionsDenied(m_frame, this, identifier, response);
617             String message = "Refused to display '" + response.url().stringCenterEllipsizedToLength() + "' in a frame because it set 'X-Frame-Options' to '" + content + "'.";
618             frame()->document()->addConsoleMessage(SecurityMessageSource, ErrorMessageLevel, message, identifier);
619             frame()->document()->enforceSandboxFlags(SandboxOrigin);
620             if (HTMLFrameOwnerElement* ownerElement = frame()->ownerElement())
621                 ownerElement->dispatchEvent(Event::create(eventNames().loadEvent, false, false));
622
623             // The load event might have detached this frame. In that case, the load will already have been cancelled during detach.
624             if (frameLoader())
625                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
626             return;
627         }
628     }
629
630     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
631     // See <rdar://problem/6304600> for more details.
632 #if !USE(CF)
633     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
634 #endif
635
636     if (m_isLoadingMultipartContent) {
637         setupForReplace();
638         m_mainResource->clear();
639     } else if (response.isMultipart()) {
640         FeatureObserver::observe(m_frame->document(), FeatureObserver::MultipartMainResource);
641         m_isLoadingMultipartContent = true;
642     }
643
644     m_response = response;
645
646     if (m_identifierForLoadWithoutResourceLoader) {
647         addResponse(m_response);
648         frameLoader()->notifier().dispatchDidReceiveResponse(this, m_identifierForLoadWithoutResourceLoader, m_response, 0);
649     }
650
651     ASSERT(!m_waitingForContentPolicy);
652     m_waitingForContentPolicy = true;
653
654     // Always show content with valid substitute data.
655     if (m_substituteData.isValid()) {
656         continueAfterContentPolicy(PolicyUse);
657         return;
658     }
659
660 #if ENABLE(FTPDIR)
661     // Respect the hidden FTP Directory Listing pref so it can be tested even if the policy delegate might otherwise disallow it
662     if (m_frame->settings().forceFTPDirectoryListings() && m_response.mimeType() == "application/x-ftp-directory") {
663         continueAfterContentPolicy(PolicyUse);
664         return;
665     }
666 #endif
667
668 #if USE(CONTENT_FILTERING)
669     if (response.url().protocolIsInHTTPFamily() && ContentFilter::isEnabled())
670         m_contentFilter = ContentFilter::create(response);
671 #endif
672
673     frameLoader()->policyChecker().checkContentPolicy(m_response, [this](PolicyAction policy) {
674         continueAfterContentPolicy(policy);
675     });
676 }
677
678 void DocumentLoader::continueAfterContentPolicy(PolicyAction policy)
679 {
680     ASSERT(m_waitingForContentPolicy);
681     m_waitingForContentPolicy = false;
682     if (isStopping())
683         return;
684
685     URL url = m_request.url();
686     const String& mimeType = m_response.mimeType();
687     
688     switch (policy) {
689     case PolicyUse: {
690         // Prevent remote web archives from loading because they can claim to be from any domain and thus avoid cross-domain security checks (4120255).
691         bool isRemoteWebArchive = (equalIgnoringCase("application/x-webarchive", mimeType)
692             || equalIgnoringCase("application/x-mimearchive", mimeType)
693 #if PLATFORM(GTK)
694             || equalIgnoringCase("message/rfc822", mimeType)
695 #endif
696             || equalIgnoringCase("multipart/related", mimeType))
697             && !m_substituteData.isValid() && !SchemeRegistry::shouldTreatURLSchemeAsLocal(url.protocol());
698         if (!frameLoader()->client().canShowMIMEType(mimeType) || isRemoteWebArchive) {
699             frameLoader()->policyChecker().cannotShowMIMEType(m_response);
700             // Check reachedTerminalState since the load may have already been canceled inside of _handleUnimplementablePolicyWithErrorCode::.
701             stopLoadingForPolicyChange();
702             return;
703         }
704         break;
705     }
706
707     case PolicyDownload: {
708         // m_mainResource can be null, e.g. when loading a substitute resource from application cache.
709         if (!m_mainResource) {
710             mainReceivedError(frameLoader()->client().cannotShowURLError(m_request));
711             return;
712         }
713
714         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
715             InspectorInstrumentation::continueWithPolicyDownload(m_frame, this, mainResourceLoader->identifier(), m_response);
716
717         // When starting the request, we didn't know that it would result in download and not navigation. Now we know that main document URL didn't change.
718         // Download may use this knowledge for purposes unrelated to cookies, notably for setting file quarantine data.
719         frameLoader()->setOriginalURLForDownloadRequest(m_request);
720         frameLoader()->client().convertMainResourceLoadToDownload(this, m_request, m_response);
721
722         // It might have gone missing
723         if (mainResourceLoader())
724             mainResourceLoader()->didFail(interruptedForPolicyChangeError());
725         return;
726     }
727     case PolicyIgnore:
728         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
729             InspectorInstrumentation::continueWithPolicyIgnore(m_frame, this, mainResourceLoader->identifier(), m_response);
730         stopLoadingForPolicyChange();
731         return;
732     
733     default:
734         ASSERT_NOT_REACHED();
735     }
736
737     if (m_response.isHTTP()) {
738         int status = m_response.httpStatusCode();
739         if (status < 200 || status >= 300) {
740             bool hostedByObject = frameLoader()->isHostedByObjectElement();
741
742             frameLoader()->handleFallbackContent();
743             // object elements are no longer rendered after we fallback, so don't
744             // keep trying to process data from their load
745
746             if (hostedByObject)
747                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
748         }
749     }
750
751     if (!isStopping() && m_substituteData.isValid()) {
752         if (m_substituteData.content()->size())
753             dataReceived(0, m_substituteData.content()->data(), m_substituteData.content()->size());
754         if (isLoadingMainResource())
755             finishedLoading(0);
756     }
757 }
758
759 void DocumentLoader::commitLoad(const char* data, int length)
760 {
761     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
762     // by starting a new load, so retain temporarily.
763     RefPtr<Frame> protectFrame(m_frame);
764     Ref<DocumentLoader> protectLoader(*this);
765
766     commitIfReady();
767     FrameLoader* frameLoader = DocumentLoader::frameLoader();
768     if (!frameLoader)
769         return;
770 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
771     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
772         return;
773 #endif
774     frameLoader->client().committedLoad(this, data, length);
775 }
776
777 ResourceError DocumentLoader::interruptedForPolicyChangeError() const
778 {
779     return frameLoader()->client().interruptedForPolicyChangeError(request());
780 }
781
782 void DocumentLoader::stopLoadingForPolicyChange()
783 {
784     ResourceError error = interruptedForPolicyChangeError();
785     error.setIsCancellation(true);
786     cancelMainResourceLoad(error);
787 }
788
789 void DocumentLoader::commitData(const char* bytes, size_t length)
790 {
791     if (!m_gotFirstByte) {
792         m_gotFirstByte = true;
793         m_writer.begin(documentURL(), false);
794         m_writer.setDocumentWasLoadedAsPartOfNavigation();
795
796         if (SecurityPolicy::allowSubstituteDataAccessToLocal() && m_originalSubstituteDataWasValid) {
797             // If this document was loaded with substituteData, then the document can
798             // load local resources. See https://bugs.webkit.org/show_bug.cgi?id=16756
799             // and https://bugs.webkit.org/show_bug.cgi?id=19760 for further
800             // discussion.
801             m_frame->document()->securityOrigin()->grantLoadLocalResources();
802         }
803
804         if (frameLoader()->stateMachine()->creatingInitialEmptyDocument())
805             return;
806         
807 #if ENABLE(MHTML)
808         // The origin is the MHTML file, we need to set the base URL to the document encoded in the MHTML so
809         // relative URLs are resolved properly.
810         if (m_archive && m_archive->type() == Archive::MHTML)
811             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
812 #endif
813
814         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
815         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
816         if (!isMultipartReplacingLoad())
817             frameLoader()->receivedFirstData();
818
819         bool userChosen;
820         String encoding;
821 #if USE(CONTENT_FILTERING)
822         // The content filter's replacement data has a known encoding that might
823         // differ from the response's encoding.
824         if (m_contentFilter && m_contentFilter->didBlockData()) {
825             ASSERT(!m_contentFilter->needsMoreData());
826             userChosen = false;
827         } else
828 #endif
829         if (overrideEncoding().isNull()) {
830             userChosen = false;
831             encoding = response().textEncodingName();
832 #if ENABLE(WEB_ARCHIVE)
833             if (m_archive && m_archive->type() == Archive::WebArchive)
834                 encoding = m_archive->mainResource()->textEncoding();
835 #endif
836         } else {
837             userChosen = true;
838             encoding = overrideEncoding();
839         }
840
841         m_writer.setEncoding(encoding, userChosen);
842     }
843     ASSERT(m_frame->document()->parsing());
844     m_writer.addData(bytes, length);
845 }
846
847 void DocumentLoader::dataReceived(CachedResource* resource, const char* data, int length)
848 {
849     ASSERT(data);
850     ASSERT(length);
851     ASSERT_UNUSED(resource, resource == m_mainResource);
852     ASSERT(!m_response.isNull());
853
854 #if USE(CFNETWORK) || PLATFORM(MAC)
855     // Workaround for <rdar://problem/6060782>
856     if (m_response.isNull())
857         m_response = ResourceResponse(URL(), "text/html", 0, String(), String());
858 #endif
859
860     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
861     // See <rdar://problem/6304600> for more details.
862 #if !USE(CF)
863     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
864 #endif
865
866 #if USE(CONTENT_FILTERING)
867     bool loadWasBlockedBeforeFinishing = false;
868     if (m_contentFilter && m_contentFilter->needsMoreData()) {
869         m_contentFilter->addData(data, length);
870
871         if (m_contentFilter->needsMoreData()) {
872             // Since the filter still needs more data to make a decision,
873             // avoid committing this data to prevent partial rendering of
874             // content that might later be blocked.
875             return;
876         }
877
878         data = m_contentFilter->getReplacementData(length);
879         loadWasBlockedBeforeFinishing = m_contentFilter->didBlockData();
880
881         if (loadWasBlockedBeforeFinishing)
882             setContentFilterForBlockedLoad(m_contentFilter);
883     }
884 #endif
885
886     if (m_identifierForLoadWithoutResourceLoader)
887         frameLoader()->notifier().dispatchDidReceiveData(this, m_identifierForLoadWithoutResourceLoader, data, length, -1);
888
889     m_applicationCacheHost->mainResourceDataReceived(data, length, -1, false);
890     m_timeOfLastDataReceived = monotonicallyIncreasingTime();
891
892     if (!isMultipartReplacingLoad())
893         commitLoad(data, length);
894
895 #if USE(CONTENT_FILTERING)
896     if (loadWasBlockedBeforeFinishing)
897         cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
898 #endif
899 }
900
901 void DocumentLoader::setupForReplace()
902 {
903     if (!mainResourceData())
904         return;
905     
906     maybeFinishLoadingMultipartContent();
907     maybeCreateArchive();
908     m_writer.end();
909     frameLoader()->setReplacing();
910     m_gotFirstByte = false;
911     
912     stopLoadingSubresources();
913     stopLoadingPlugIns();
914 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
915     clearArchiveResources();
916 #endif
917 }
918
919 void DocumentLoader::checkLoadComplete()
920 {
921     if (!m_frame || isLoading())
922         return;
923 #if !ENABLE(THREADED_HTML_PARSER)
924     // This ASSERT triggers with the threaded HTML parser.
925     // See https://bugs.webkit.org/show_bug.cgi?id=110937
926     ASSERT(this == frameLoader()->activeDocumentLoader());
927 #endif
928     m_frame->document()->domWindow()->finishedLoading();
929 }
930
931 void DocumentLoader::setFrame(Frame* frame)
932 {
933     if (m_frame == frame)
934         return;
935     ASSERT(frame && !m_frame);
936     m_frame = frame;
937     m_writer.setFrame(frame);
938     attachToFrame();
939 }
940
941 void DocumentLoader::attachToFrame()
942 {
943     ASSERT(m_frame);
944 }
945
946 void DocumentLoader::detachFromFrame()
947 {
948     ASSERT(m_frame);
949     RefPtr<Frame> protectFrame(m_frame);
950     Ref<DocumentLoader> protectLoader(*this);
951
952     // It never makes sense to have a document loader that is detached from its
953     // frame have any loads active, so go ahead and kill all the loads.
954     stopLoading();
955     if (m_mainResource && m_mainResource->hasClient(this))
956         m_mainResource->removeClient(this);
957
958     m_applicationCacheHost->setDOMApplicationCache(0);
959     InspectorInstrumentation::loaderDetachedFromFrame(m_frame, this);
960     m_frame = 0;
961 }
962
963 void DocumentLoader::clearMainResourceLoader()
964 {
965     m_loadingMainResource = false;
966
967 #if PLATFORM(IOS)
968     // FIXME: Remove PLATFORM(IOS)-guard once we upstream the iOS changes to ResourceRequest.h.
969     m_request.setMainResourceRequest(false);
970 #endif
971
972     if (this == frameLoader()->activeDocumentLoader())
973         checkLoadComplete();
974 }
975
976 bool DocumentLoader::isLoadingInAPISense() const
977 {
978     // Once a frame has loaded, we no longer need to consider subresources,
979     // but we still need to consider subframes.
980     if (frameLoader()->state() != FrameStateComplete) {
981         if (m_frame->settings().needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
982             return true;
983     
984         Document* doc = m_frame->document();
985         if ((isLoadingMainResource() || !m_frame->document()->loadEventFinished()) && isLoading())
986             return true;
987         if (m_cachedResourceLoader->requestCount())
988             return true;
989         if (doc->processingLoadEvent())
990             return true;
991         if (doc->hasActiveParser())
992             return true;
993     }
994     return frameLoader()->subframeIsLoading();
995 }
996
997 bool DocumentLoader::maybeCreateArchive()
998 {
999 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1000     return false;
1001 #else
1002     
1003     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
1004     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
1005     m_archive = ArchiveFactory::create(m_response.url(), mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0, m_response.mimeType());
1006     if (!m_archive)
1007         return false;
1008     
1009     addAllArchiveResources(m_archive.get());
1010     ArchiveResource* mainResource = m_archive->mainResource();
1011     m_parsedArchiveData = mainResource->data();
1012     m_writer.setMIMEType(mainResource->mimeType());
1013     
1014     ASSERT(m_frame->document());
1015     commitData(mainResource->data()->data(), mainResource->data()->size());
1016     return true;
1017 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1018 }
1019
1020 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1021 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
1022 {
1023     m_archive = archive;
1024     addAllArchiveResources(m_archive.get());
1025 }
1026
1027 void DocumentLoader::addAllArchiveResources(Archive* archive)
1028 {
1029     if (!m_archiveResourceCollection)
1030         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
1031         
1032     ASSERT(archive);
1033     if (!archive)
1034         return;
1035         
1036     m_archiveResourceCollection->addAllResources(archive);
1037 }
1038
1039 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
1040 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
1041 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
1042 {
1043     if (!m_archiveResourceCollection)
1044         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
1045         
1046     ASSERT(resource);
1047     if (!resource)
1048         return;
1049         
1050     m_archiveResourceCollection->addResource(resource);
1051 }
1052
1053 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const URL& url)
1054 {
1055     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(0);
1056 }
1057
1058 void DocumentLoader::clearArchiveResources()
1059 {
1060     m_archiveResourceCollection.clear();
1061     m_substituteResourceDeliveryTimer.stop();
1062 }
1063
1064 SharedBuffer* DocumentLoader::parsedArchiveData() const
1065 {
1066     return m_parsedArchiveData.get();
1067 }
1068 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1069
1070 ArchiveResource* DocumentLoader::archiveResourceForURL(const URL& url) const
1071 {
1072     if (!m_archiveResourceCollection)
1073         return 0;
1074         
1075     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
1076
1077     return resource && !resource->shouldIgnoreWhenUnarchiving() ? resource : 0;
1078 }
1079
1080 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
1081 {
1082     const ResourceResponse& r = response();
1083     
1084     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
1085     RefPtr<SharedBuffer> data = mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0;
1086     if (!data)
1087         data = SharedBuffer::create();
1088         
1089     return ArchiveResource::create(data, r.url(), r.mimeType(), r.textEncodingName(), frame()->tree().uniqueName());
1090 }
1091
1092 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const URL& url) const
1093 {
1094     if (!isCommitted())
1095         return 0;
1096     
1097     CachedResource* resource = m_cachedResourceLoader->cachedResource(url);
1098     if (!resource || !resource->isLoaded())
1099         return archiveResourceForURL(url);
1100
1101     if (resource->type() == CachedResource::MainResource)
1102         return 0;
1103
1104     // FIXME: This has the side effect of making the resource non-purgeable.
1105     // It would be better if it didn't have this permanent effect.
1106     if (!resource->makePurgeable(false))
1107         return 0;
1108
1109     ResourceBuffer* data = resource->resourceBuffer();
1110     if (!data)
1111         return 0;
1112
1113     return ArchiveResource::create(data->sharedBuffer(), url, resource->response());
1114 }
1115
1116 void DocumentLoader::getSubresources(Vector<PassRefPtr<ArchiveResource>>& subresources) const
1117 {
1118     if (!isCommitted())
1119         return;
1120
1121     const CachedResourceLoader::DocumentResourceMap& allResources = m_cachedResourceLoader->allCachedResources();
1122     CachedResourceLoader::DocumentResourceMap::const_iterator end = allResources.end();
1123     for (CachedResourceLoader::DocumentResourceMap::const_iterator it = allResources.begin(); it != end; ++it) {
1124         RefPtr<ArchiveResource> subresource = this->subresource(URL(ParsedURLString, it->value->url()));
1125         if (subresource)
1126             subresources.append(subresource.release());
1127     }
1128
1129     return;
1130 }
1131
1132 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
1133 {
1134     if (m_pendingSubstituteResources.isEmpty())
1135         return;
1136     ASSERT(m_frame && m_frame->page());
1137     if (m_frame->page()->defersLoading())
1138         return;
1139     if (!m_substituteResourceDeliveryTimer.isActive())
1140         m_substituteResourceDeliveryTimer.startOneShot(0);
1141 }
1142
1143 void DocumentLoader::substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*)
1144 {
1145     if (m_pendingSubstituteResources.isEmpty())
1146         return;
1147     ASSERT(m_frame && m_frame->page());
1148     if (m_frame->page()->defersLoading())
1149         return;
1150
1151     SubstituteResourceMap copy;
1152     copy.swap(m_pendingSubstituteResources);
1153
1154     SubstituteResourceMap::const_iterator end = copy.end();
1155     for (SubstituteResourceMap::const_iterator it = copy.begin(); it != end; ++it) {
1156         RefPtr<ResourceLoader> loader = it->key;
1157         SubstituteResource* resource = it->value.get();
1158         
1159         if (resource) {
1160             SharedBuffer* data = resource->data();
1161         
1162             loader->didReceiveResponse(resource->response());
1163
1164             // Calling ResourceLoader::didReceiveResponse can end up cancelling the load,
1165             // so we need to check if the loader has reached its terminal state.
1166             if (loader->reachedTerminalState())
1167                 return;
1168
1169             loader->didReceiveData(data->data(), data->size(), data->size(), DataPayloadWholeResource);
1170
1171             // Calling ResourceLoader::didReceiveData can end up cancelling the load,
1172             // so we need to check if the loader has reached its terminal state.
1173             if (loader->reachedTerminalState())
1174                 return;
1175
1176             loader->didFinishLoading(0);
1177         } else {
1178             // A null resource means that we should fail the load.
1179             // FIXME: Maybe we should use another error here - something like "not in cache".
1180             loader->didFail(loader->cannotShowURLError());
1181         }
1182     }
1183 }
1184
1185 #ifndef NDEBUG
1186 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
1187 {
1188     return m_pendingSubstituteResources.contains(loader);
1189 }
1190 #endif
1191
1192 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
1193 {
1194     if (m_pendingSubstituteResources.isEmpty())
1195         return;
1196     m_pendingSubstituteResources.remove(loader);
1197     if (m_pendingSubstituteResources.isEmpty())
1198         m_substituteResourceDeliveryTimer.stop();
1199 }
1200
1201 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1202 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader* loader, const ResourceRequest& request)
1203 {
1204     if (ArchiveResource* resource = archiveResourceForURL(request.url())) {
1205         m_pendingSubstituteResources.set(loader, resource);
1206         deliverSubstituteResourcesAfterDelay();
1207         return true;
1208     }
1209
1210     if (!m_archive)
1211         return false;
1212
1213     switch (m_archive->type()) {
1214 #if ENABLE(WEB_ARCHIVE)
1215     case Archive::WebArchive:
1216         // WebArchiveDebugMode means we fail loads instead of trying to fetch them from the network if they're not in the archive.
1217         return m_frame->settings().webArchiveDebugModeEnabled() && ArchiveFactory::isArchiveMimeType(responseMIMEType());
1218 #endif
1219 #if ENABLE(MHTML)
1220     case Archive::MHTML:
1221         return true; // Always fail the load for resources not included in the MHTML.
1222 #endif
1223     default:
1224         return false;
1225     }
1226 }
1227 #endif // ENABLE(WEB_ARCHIVE)
1228
1229 void DocumentLoader::addResponse(const ResourceResponse& r)
1230 {
1231     if (!m_stopRecordingResponses)
1232         m_responses.append(r);
1233 }
1234
1235 void DocumentLoader::stopRecordingResponses()
1236 {
1237     m_stopRecordingResponses = true;
1238     m_responses.shrinkToFit();
1239 }
1240
1241 void DocumentLoader::setTitle(const StringWithDirection& title)
1242 {
1243     if (m_pageTitle == title)
1244         return;
1245
1246     frameLoader()->willChangeTitle(this);
1247     m_pageTitle = title;
1248     frameLoader()->didChangeTitle(this);
1249 }
1250
1251 URL DocumentLoader::urlForHistory() const
1252 {
1253     // Return the URL to be used for history and B/F list.
1254     // Returns nil for WebDataProtocol URLs that aren't alternates
1255     // for unreachable URLs, because these can't be stored in history.
1256     if (m_substituteData.isValid() && !m_substituteData.shouldRevealToSessionHistory())
1257         return unreachableURL();
1258
1259     return m_originalRequestCopy.url();
1260 }
1261
1262 bool DocumentLoader::urlForHistoryReflectsFailure() const
1263 {
1264     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
1265 }
1266
1267 const URL& DocumentLoader::originalURL() const
1268 {
1269     return m_originalRequestCopy.url();
1270 }
1271
1272 const URL& DocumentLoader::requestURL() const
1273 {
1274     return request().url();
1275 }
1276
1277 const URL& DocumentLoader::responseURL() const
1278 {
1279     return m_response.url();
1280 }
1281
1282 URL DocumentLoader::documentURL() const
1283 {
1284     URL url = substituteData().responseURL();
1285 #if ENABLE(WEB_ARCHIVE)
1286     if (url.isEmpty() && m_archive && m_archive->type() == Archive::WebArchive)
1287         url = m_archive->mainResource()->url();
1288 #endif
1289     if (url.isEmpty())
1290         url = requestURL();
1291     if (url.isEmpty())
1292         url = m_response.url();
1293     return url;
1294 }
1295
1296 const String& DocumentLoader::responseMIMEType() const
1297 {
1298     return m_response.mimeType();
1299 }
1300
1301 #if PLATFORM(IOS)
1302 // FIXME: This method seems to violate the encapsulation of this class.
1303 void DocumentLoader::setResponseMIMEType(const String& responseMimeType)
1304 {
1305     m_response.setMimeType(responseMimeType);
1306 }
1307 #endif
1308
1309 const URL& DocumentLoader::unreachableURL() const
1310 {
1311     return m_substituteData.failingURL();
1312 }
1313
1314 void DocumentLoader::setDefersLoading(bool defers)
1315 {
1316     // Multiple frames may be loading the same main resource simultaneously. If deferral state changes,
1317     // each frame's DocumentLoader will try to send a setDefersLoading() to the same underlying ResourceLoader. Ensure only
1318     // the "owning" DocumentLoader does so, as setDefersLoading() is not resilient to setting the same value repeatedly.
1319     if (mainResourceLoader() && mainResourceLoader()->documentLoader() == this)
1320         mainResourceLoader()->setDefersLoading(defers);
1321
1322     setAllDefersLoading(m_subresourceLoaders, defers);
1323     setAllDefersLoading(m_plugInStreamLoaders, defers);
1324     if (!defers)
1325         deliverSubstituteResourcesAfterDelay();
1326 }
1327
1328 void DocumentLoader::setMainResourceDataBufferingPolicy(DataBufferingPolicy dataBufferingPolicy)
1329 {
1330     if (m_mainResource)
1331         m_mainResource->setDataBufferingPolicy(dataBufferingPolicy);
1332 }
1333
1334 void DocumentLoader::stopLoadingPlugIns()
1335 {
1336     cancelAll(m_plugInStreamLoaders);
1337 }
1338
1339 void DocumentLoader::stopLoadingSubresources()
1340 {
1341     cancelAll(m_subresourceLoaders);
1342 }
1343
1344 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
1345 {
1346     // The main resource's underlying ResourceLoader will ask to be added here.
1347     // It is much simpler to handle special casing of main resource loads if we don't
1348     // let it be added. In the main resource load case, mainResourceLoader()
1349     // will still be null at this point, but m_gotFirstByte should be false here if and only
1350     // if we are just starting the main resource load.
1351     if (!m_gotFirstByte)
1352         return;
1353     ASSERT(!m_subresourceLoaders.contains(loader));
1354     ASSERT(!mainResourceLoader() || mainResourceLoader() != loader);
1355     m_subresourceLoaders.add(loader);
1356 }
1357
1358 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
1359 {
1360     if (!m_subresourceLoaders.remove(loader))
1361         return;
1362     checkLoadComplete();
1363     if (Frame* frame = m_frame)
1364         frame->loader().checkLoadComplete();
1365 }
1366
1367 void DocumentLoader::addPlugInStreamLoader(ResourceLoader* loader)
1368 {
1369     m_plugInStreamLoaders.add(loader);
1370 }
1371
1372 void DocumentLoader::removePlugInStreamLoader(ResourceLoader* loader)
1373 {
1374     m_plugInStreamLoaders.remove(loader);
1375     checkLoadComplete();
1376 }
1377
1378 bool DocumentLoader::isMultipartReplacingLoad() const
1379 {
1380     return isLoadingMultipartContent() && frameLoader()->isReplacing();
1381 }
1382
1383 bool DocumentLoader::maybeLoadEmpty()
1384 {
1385     bool shouldLoadEmpty = !m_substituteData.isValid() && (m_request.url().isEmpty() || SchemeRegistry::shouldLoadURLSchemeAsEmptyDocument(m_request.url().protocol()));
1386     if (!shouldLoadEmpty && !frameLoader()->client().representationExistsForURLScheme(m_request.url().protocol()))
1387         return false;
1388
1389     if (m_request.url().isEmpty() && !frameLoader()->stateMachine()->creatingInitialEmptyDocument())
1390         m_request.setURL(blankURL());
1391     String mimeType = shouldLoadEmpty ? "text/html" : frameLoader()->client().generatedMIMETypeForURLScheme(m_request.url().protocol());
1392     m_response = ResourceResponse(m_request.url(), mimeType, 0, String(), String());
1393     finishedLoading(monotonicallyIncreasingTime());
1394     return true;
1395 }
1396
1397 void DocumentLoader::startLoadingMainResource()
1398 {
1399     m_mainDocumentError = ResourceError();
1400     timing()->markNavigationStart();
1401     ASSERT(!m_mainResource);
1402     ASSERT(!m_loadingMainResource);
1403     m_loadingMainResource = true;
1404
1405     if (maybeLoadEmpty())
1406         return;
1407
1408     // FIXME: Is there any way the extra fields could have not been added by now?
1409     // If not, it would be great to remove this line of code.
1410     // Note that currently, some requests may have incorrect extra fields even if this function has been called,
1411     // because we pass a wrong loadType (see FIXME in addExtraFieldsToMainResourceRequest()).
1412     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
1413
1414     ASSERT(timing()->navigationStart());
1415     ASSERT(!timing()->fetchStart());
1416     timing()->markFetchStart();
1417     willSendRequest(m_request, ResourceResponse());
1418
1419     // willSendRequest() may lead to our Frame being detached or cancelling the load via nulling the ResourceRequest.
1420     if (!m_frame || m_request.isNull())
1421         return;
1422
1423     m_applicationCacheHost->maybeLoadMainResource(m_request, m_substituteData);
1424
1425     if (m_substituteData.isValid()) {
1426         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1427         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, m_request);
1428         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, m_request, ResourceResponse());
1429         handleSubstituteDataLoadSoon();
1430         return;
1431     }
1432
1433 #if PLATFORM(IOS)
1434     // FIXME: Remove PLATFORM(IOS)-guard once we upstream the iOS changes to ResourceRequest.h.
1435     m_request.setMainResourceRequest(true);
1436 #endif
1437
1438     ResourceRequest request(m_request);
1439     static NeverDestroyed<ResourceLoaderOptions> mainResourceLoadOptions(SendCallbacks, SniffContent, BufferData, AllowStoredCredentials, AskClientForAllCredentials, SkipSecurityCheck, UseDefaultOriginRestrictionsForType);
1440     CachedResourceRequest cachedResourceRequest(request, mainResourceLoadOptions);
1441     m_mainResource = m_cachedResourceLoader->requestMainResource(cachedResourceRequest);
1442     if (!m_mainResource) {
1443         setRequest(ResourceRequest());
1444         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
1445         // is now in a state where starting an empty load will be inconsistent. Replace it with
1446         // a new ApplicationCacheHost.
1447         m_applicationCacheHost = adoptPtr(new ApplicationCacheHost(this));
1448         maybeLoadEmpty();
1449         return;
1450     }
1451
1452     if (!mainResourceLoader()) {
1453         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1454         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, request);
1455         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, request, ResourceResponse());
1456     }
1457     m_mainResource->addClient(this);
1458
1459     // A bunch of headers are set when the underlying ResourceLoader is created, and m_request needs to include those.
1460     if (mainResourceLoader())
1461         request = mainResourceLoader()->originalRequest();
1462     // If there was a fragment identifier on m_request, the cache will have stripped it. m_request should include
1463     // the fragment identifier, so add that back in.
1464     if (equalIgnoringFragmentIdentifier(m_request.url(), request.url()))
1465         request.setURL(m_request.url());
1466     setRequest(request);
1467 }
1468
1469 void DocumentLoader::cancelMainResourceLoad(const ResourceError& resourceError)
1470 {
1471     Ref<DocumentLoader> protect(*this);
1472     ResourceError error = resourceError.isNull() ? frameLoader()->cancelledError(m_request) : resourceError;
1473
1474     m_dataLoadTimer.stop();
1475     if (m_waitingForContentPolicy) {
1476         frameLoader()->policyChecker().cancelCheck();
1477         ASSERT(m_waitingForContentPolicy);
1478         m_waitingForContentPolicy = false;
1479     }
1480
1481     if (mainResourceLoader())
1482         mainResourceLoader()->cancel(error);
1483
1484     clearMainResource();
1485
1486     mainReceivedError(error);
1487 }
1488
1489 void DocumentLoader::clearMainResource()
1490 {
1491     if (m_mainResource && m_mainResource->hasClient(this))
1492         m_mainResource->removeClient(this);
1493
1494     m_mainResource = 0;
1495 }
1496
1497 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
1498 {
1499     m_multipartSubresourceLoaders.add(loader);
1500     m_subresourceLoaders.remove(loader);
1501     checkLoadComplete();
1502     if (Frame* frame = m_frame)
1503         frame->loader().checkLoadComplete();    
1504 }
1505
1506 void DocumentLoader::maybeFinishLoadingMultipartContent()
1507 {
1508     if (!isMultipartReplacingLoad())
1509         return;
1510
1511     frameLoader()->setupForReplace();
1512     m_committed = false;
1513     RefPtr<ResourceBuffer> resourceData = mainResourceData();
1514     commitLoad(resourceData->data(), resourceData->size());
1515 }
1516
1517 void DocumentLoader::iconLoadDecisionAvailable()
1518 {
1519     if (m_frame)
1520         m_frame->loader().icon().loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon().url(), this));
1521 }
1522
1523 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
1524 {
1525     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
1526 }
1527
1528 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
1529 {
1530     if (m_iconLoadDecisionCallback)
1531         m_iconLoadDecisionCallback->invalidate();
1532     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
1533     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
1534 }
1535
1536 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
1537 {
1538     ASSERT(m_iconLoadDecisionCallback);
1539     m_iconLoadDecisionCallback = 0;
1540     if (m_frame)
1541         m_frame->loader().icon().continueLoadWithDecision(decision);
1542 }
1543
1544 static void iconDataCallback(SharedBuffer*, void*)
1545 {
1546     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
1547 }
1548
1549 void DocumentLoader::getIconDataForIconURL(const String& urlString)
1550 {   
1551     if (m_iconDataCallback)
1552         m_iconDataCallback->invalidate();
1553     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
1554     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
1555 }
1556
1557 void DocumentLoader::handledOnloadEvents()
1558 {
1559     m_wasOnloadHandled = true;
1560     applicationCacheHost()->stopDeferringEvents();
1561 }
1562
1563 #if USE(CONTENT_FILTERING)
1564 void DocumentLoader::setContentFilterForBlockedLoad(PassRefPtr<ContentFilter> contentFilter)
1565 {
1566     ASSERT(!m_contentFilterForBlockedLoad);
1567     ASSERT(contentFilter);
1568     ASSERT(contentFilter->didBlockData());
1569     m_contentFilterForBlockedLoad = contentFilter;
1570 }
1571
1572 bool DocumentLoader::handleContentFilterRequest(const ResourceRequest& request)
1573 {
1574     // FIXME: Remove PLATFORM(IOS)-guard once we upstream ContentFilterIOS.mm and
1575     // implement ContentFilter::requestUnblockAndDispatchIfSuccessful() for Mac.
1576 #if PLATFORM(IOS)
1577     if (!m_contentFilterForBlockedLoad)
1578         return false;
1579
1580     if (!request.url().protocolIs(ContentFilter::scheme()))
1581         return false;
1582
1583     if (equalIgnoringCase(request.url().host(), "unblock")) {
1584         // Tell the FrameLoader to reload if the unblock is successful.
1585         m_contentFilterForBlockedLoad->requestUnblockAndDispatchIfSuccessful(bind(&FrameLoader::reload, &(m_frame->loader()), false));
1586         return true;
1587     }
1588
1589     return false;
1590 #else
1591     UNUSED_PARAM(request);
1592     return false;
1593 #endif
1594 }
1595 #endif
1596
1597 } // namespace WebCore