Add assertion to help track down WebCore::DocumentLoader::stopLoadingForPolicyChange...
[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 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 "HTTPHeaderNames.h"
50 #include "HistoryItem.h"
51 #include "IconController.h"
52 #include "InspectorInstrumentation.h"
53 #include "Logging.h"
54 #include "MainFrame.h"
55 #include "MemoryCache.h"
56 #include "Page.h"
57 #include "PolicyChecker.h"
58 #include "ProgressTracker.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
71 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
72 #include "ArchiveFactory.h"
73 #endif
74
75 #if ENABLE(CONTENT_FILTERING)
76 #include "ContentFilter.h"
77 #endif
78
79 namespace WebCore {
80
81 static void cancelAll(const ResourceLoaderMap& loaders)
82 {
83     Vector<RefPtr<ResourceLoader>> loadersCopy;
84     copyValuesToVector(loaders, loadersCopy);
85     for (auto& loader : loadersCopy)
86         loader->cancel();
87 }
88
89 static void setAllDefersLoading(const ResourceLoaderMap& loaders, bool defers)
90 {
91     Vector<RefPtr<ResourceLoader>> loadersCopy;
92     copyValuesToVector(loaders, loadersCopy);
93     for (auto& loader : loadersCopy)
94         loader->setDefersLoading(defers);
95 }
96
97 static bool areAllLoadersPageCacheAcceptable(const ResourceLoaderMap& loaders)
98 {
99     Vector<RefPtr<ResourceLoader>> loadersCopy;
100     copyValuesToVector(loaders, loadersCopy);
101     for (auto& loader : loadersCopy) {
102         ResourceHandle* handle = loader->handle();
103         if (!handle)
104             return false;
105
106         if (!loader->frameLoader())
107             return false;
108
109         CachedResource* cachedResource = MemoryCache::singleton().resourceForURL(handle->firstRequest().url(), loader->frameLoader()->frame().page()->sessionID());
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     ASSERT(!m_waitingForContentPolicy);
165     if (m_iconLoadDecisionCallback)
166         m_iconLoadDecisionCallback->invalidate();
167     if (m_iconDataCallback)
168         m_iconDataCallback->invalidate();
169     m_cachedResourceLoader->clearDocumentLoader();
170     
171     clearMainResource();
172 }
173
174 PassRefPtr<SharedBuffer> DocumentLoader::mainResourceData() const
175 {
176     if (m_substituteData.isValid())
177         return m_substituteData.content()->copy();
178     if (m_mainResource)
179         return m_mainResource->resourceBuffer();
180     return nullptr;
181 }
182
183 Document* DocumentLoader::document() const
184 {
185     if (m_frame && m_frame->loader().documentLoader() == this)
186         return m_frame->document();
187     return nullptr;
188 }
189
190 const ResourceRequest& DocumentLoader::originalRequest() const
191 {
192     return m_originalRequest;
193 }
194
195 const ResourceRequest& DocumentLoader::originalRequestCopy() const
196 {
197     return m_originalRequestCopy;
198 }
199
200 const ResourceRequest& DocumentLoader::request() const
201 {
202     return m_request;
203 }
204
205 ResourceRequest& DocumentLoader::request()
206 {
207     return m_request;
208 }
209
210 const URL& DocumentLoader::url() const
211 {
212     return request().url();
213 }
214
215 void DocumentLoader::replaceRequestURLForSameDocumentNavigation(const URL& url)
216 {
217     m_originalRequestCopy.setURL(url);
218     m_request.setURL(url);
219 }
220
221 void DocumentLoader::setRequest(const ResourceRequest& req)
222 {
223     // Replacing an unreachable URL with alternate content looks like a server-side
224     // redirect at this point, but we can replace a committed dataSource.
225     bool handlingUnreachableURL = false;
226
227     handlingUnreachableURL = m_substituteData.isValid() && !m_substituteData.failingURL().isEmpty();
228
229     if (handlingUnreachableURL)
230         m_committed = false;
231
232     // We should never be getting a redirect callback after the data
233     // source is committed, except in the unreachable URL case. It 
234     // would be a WebFoundation bug if it sent a redirect callback after commit.
235     ASSERT(!m_committed);
236
237     m_request = req;
238 }
239
240 void DocumentLoader::setMainDocumentError(const ResourceError& error)
241 {
242     m_mainDocumentError = error;    
243     frameLoader()->client().setMainDocumentError(this, error);
244 }
245
246 void DocumentLoader::mainReceivedError(const ResourceError& error)
247 {
248     ASSERT(!error.isNull());
249
250     if (m_identifierForLoadWithoutResourceLoader) {
251         ASSERT(!mainResourceLoader());
252         frameLoader()->client().dispatchDidFailLoading(this, m_identifierForLoadWithoutResourceLoader, error);
253     }
254
255     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
256     // See <rdar://problem/6304600> for more details.
257 #if !USE(CF)
258     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
259 #endif
260
261     m_applicationCacheHost->failedLoadingMainResource();
262
263     if (!frameLoader())
264         return;
265     setMainDocumentError(error);
266     clearMainResourceLoader();
267     frameLoader()->receivedMainResourceError(error);
268 }
269
270 // Cancels the data source's pending loads.  Conceptually, a data source only loads
271 // one document at a time, but one document may have many related resources. 
272 // stopLoading will stop all loads initiated by the data source, 
273 // but not loads initiated by child frames' data sources -- that's the WebFrame's job.
274 void DocumentLoader::stopLoading()
275 {
276     RefPtr<Frame> protectFrame(m_frame);
277     Ref<DocumentLoader> protectLoader(*this);
278
279     // In some rare cases, calling FrameLoader::stopLoading could cause isLoading() to return false.
280     // (This can happen when there's a single XMLHttpRequest currently loading and stopLoading causes it
281     // to stop loading. Because of this, we need to save it so we don't return early.
282     bool loading = isLoading();
283
284     // We may want to audit the existing subresource loaders when we are on a page which has completed
285     // loading but there are subresource loads during cancellation. This must be done before the
286     // frame->stopLoading() call, which may evict the CachedResources, which we rely on to check
287     // the type of the resource loads.
288     if (loading && m_committed && !mainResourceLoader() && !m_subresourceLoaders.isEmpty())
289         m_subresourceLoadersArePageCacheAcceptable = areAllLoadersPageCacheAcceptable(m_subresourceLoaders);
290
291     if (m_committed) {
292         // Attempt to stop the frame if the document loader is loading, or if it is done loading but
293         // still  parsing. Failure to do so can cause a world leak.
294         Document* doc = m_frame->document();
295         
296         if (loading || doc->parsing())
297             m_frame->loader().stopLoading(UnloadEventPolicyNone);
298     }
299
300     // Always cancel multipart loaders
301     cancelAll(m_multipartSubresourceLoaders);
302
303     // Appcache uses ResourceHandle directly, DocumentLoader doesn't count these loads.
304     m_applicationCacheHost->stopLoadingInFrame(m_frame);
305     
306 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
307     clearArchiveResources();
308 #endif
309
310     if (!loading) {
311         // If something above restarted loading we might run into mysterious crashes like 
312         // https://bugs.webkit.org/show_bug.cgi?id=62764 and <rdar://problem/9328684>
313         ASSERT(!isLoading());
314         return;
315     }
316
317     // We might run in to infinite recursion if we're stopping loading as the result of 
318     // detaching from the frame, so break out of that recursion here.
319     // See <rdar://problem/9673866> for more details.
320     if (m_isStopping)
321         return;
322
323     m_isStopping = true;
324
325     FrameLoader* frameLoader = DocumentLoader::frameLoader();
326     
327     if (isLoadingMainResource()) {
328         // Stop the main resource loader and let it send the cancelled message.
329         cancelMainResourceLoad(frameLoader->cancelledError(m_request));
330     } else if (!m_subresourceLoaders.isEmpty())
331         // The main resource loader already finished loading. Set the cancelled error on the 
332         // document and let the subresourceLoaders send individual cancelled messages below.
333         setMainDocumentError(frameLoader->cancelledError(m_request));
334     else
335         // If there are no resource loaders, we need to manufacture a cancelled message.
336         // (A back/forward navigation has no resource loaders because its resources are cached.)
337         mainReceivedError(frameLoader->cancelledError(m_request));
338
339     // We always need to explicitly cancel the Document's parser when stopping the load.
340     // Otherwise cancelling the parser while starting the next page load might result
341     // in unexpected side effects such as erroneous event dispatch. ( http://webkit.org/b/117112 )
342     if (Document* document = this->document())
343         document->cancelParsing();
344     
345     stopLoadingSubresources();
346     stopLoadingPlugIns();
347     
348     m_isStopping = false;
349 }
350
351 void DocumentLoader::commitIfReady()
352 {
353     if (!m_committed) {
354         m_committed = true;
355         frameLoader()->commitProvisionalLoad();
356     }
357 }
358
359 bool DocumentLoader::isLoading() const
360 {
361     // if (document() && document()->hasActiveParser())
362     //     return true;
363     // FIXME: The above code should be enabled, but it seems to cause
364     // http/tests/security/feed-urls-from-remote.html to timeout on Mac WK1
365     // see http://webkit.org/b/110554 and http://webkit.org/b/110401
366
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 ENABLE(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             frameLoader()->client().contentFilterDidBlockLoad(WTF::move(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::singleton().remove(*m_mainResource);
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()
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();
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         Ref<SecurityOrigin> redirectingOrigin(SecurityOrigin::create(redirectResponse.url()));
521         if (!redirectingOrigin.get().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::singleton().remove(*m_mainResource);
604
605     if (willLoadFallback)
606         return;
607
608     const auto& commonHeaders = response.httpHeaderFields().commonHeaders();
609     auto it = commonHeaders.find(HTTPHeaderName::XFrameOptions);
610     if (it != commonHeaders.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(MessageSource::Security, MessageLevel::Error, 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         m_isLoadingMultipartContent = true;
641
642     m_response = response;
643
644     if (m_identifierForLoadWithoutResourceLoader) {
645         addResponse(m_response);
646         frameLoader()->notifier().dispatchDidReceiveResponse(this, m_identifierForLoadWithoutResourceLoader, m_response, 0);
647     }
648
649     ASSERT(!m_waitingForContentPolicy);
650     m_waitingForContentPolicy = true;
651
652     // Always show content with valid substitute data.
653     if (m_substituteData.isValid()) {
654         continueAfterContentPolicy(PolicyUse);
655         return;
656     }
657
658 #if ENABLE(FTPDIR)
659     // Respect the hidden FTP Directory Listing pref so it can be tested even if the policy delegate might otherwise disallow it
660     if (m_frame->settings().forceFTPDirectoryListings() && m_response.mimeType() == "application/x-ftp-directory") {
661         continueAfterContentPolicy(PolicyUse);
662         return;
663     }
664 #endif
665
666 #if ENABLE(CONTENT_FILTERING)
667     if (ContentFilter::canHandleResponse(response))
668         m_contentFilter = std::make_unique<ContentFilter>(response);
669 #endif
670
671     frameLoader()->policyChecker().checkContentPolicy(m_response, [this](PolicyAction policy) {
672         continueAfterContentPolicy(policy);
673     });
674 }
675
676 void DocumentLoader::continueAfterContentPolicy(PolicyAction policy)
677 {
678     ASSERT(m_waitingForContentPolicy);
679     m_waitingForContentPolicy = false;
680     if (isStopping())
681         return;
682
683     URL url = m_request.url();
684     const String& mimeType = m_response.mimeType();
685     
686     switch (policy) {
687     case PolicyUse: {
688         // Prevent remote web archives from loading because they can claim to be from any domain and thus avoid cross-domain security checks (4120255).
689         bool isRemoteWebArchive = (equalIgnoringCase("application/x-webarchive", mimeType)
690             || equalIgnoringCase("application/x-mimearchive", mimeType)
691 #if PLATFORM(GTK)
692             || equalIgnoringCase("message/rfc822", mimeType)
693 #endif
694             || equalIgnoringCase("multipart/related", mimeType))
695             && !m_substituteData.isValid() && !SchemeRegistry::shouldTreatURLSchemeAsLocal(url.protocol());
696         if (!frameLoader()->client().canShowMIMEType(mimeType) || isRemoteWebArchive) {
697             frameLoader()->policyChecker().cannotShowMIMEType(m_response);
698             // Check reachedTerminalState since the load may have already been canceled inside of _handleUnimplementablePolicyWithErrorCode::.
699             stopLoadingForPolicyChange();
700             return;
701         }
702         break;
703     }
704
705     case PolicyDownload: {
706         // m_mainResource can be null, e.g. when loading a substitute resource from application cache.
707         if (!m_mainResource) {
708             mainReceivedError(frameLoader()->client().cannotShowURLError(m_request));
709             return;
710         }
711
712         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
713             InspectorInstrumentation::continueWithPolicyDownload(m_frame, *this, mainResourceLoader->identifier(), m_response);
714
715         // 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.
716         // Download may use this knowledge for purposes unrelated to cookies, notably for setting file quarantine data.
717         frameLoader()->setOriginalURLForDownloadRequest(m_request);
718         frameLoader()->client().convertMainResourceLoadToDownload(this, m_request, m_response);
719
720         // It might have gone missing
721         if (mainResourceLoader())
722             mainResourceLoader()->didFail(interruptedForPolicyChangeError());
723         return;
724     }
725     case PolicyIgnore:
726         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
727             InspectorInstrumentation::continueWithPolicyIgnore(m_frame, *this, mainResourceLoader->identifier(), m_response);
728         stopLoadingForPolicyChange();
729         return;
730     
731     default:
732         ASSERT_NOT_REACHED();
733     }
734
735     if (m_response.isHTTP()) {
736         int status = m_response.httpStatusCode(); // Status may be zero when loading substitute data, in particular from a WebArchive.
737         if (status && (status < 200 || status >= 300)) {
738             bool hostedByObject = frameLoader()->isHostedByObjectElement();
739
740             frameLoader()->handleFallbackContent();
741             // object elements are no longer rendered after we fallback, so don't
742             // keep trying to process data from their load
743
744             if (hostedByObject)
745                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
746         }
747     }
748
749     if (!isStopping() && m_substituteData.isValid() && isLoadingMainResource()) {
750         if (m_substituteData.content()->size())
751             dataReceived(0, m_substituteData.content()->data(), m_substituteData.content()->size());
752         if (isLoadingMainResource())
753             finishedLoading(0);
754     }
755 }
756
757 void DocumentLoader::commitLoad(const char* data, int length)
758 {
759     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
760     // by starting a new load, so retain temporarily.
761     RefPtr<Frame> protectFrame(m_frame);
762     Ref<DocumentLoader> protectLoader(*this);
763
764     commitIfReady();
765     FrameLoader* frameLoader = DocumentLoader::frameLoader();
766     if (!frameLoader)
767         return;
768 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
769     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
770         return;
771 #endif
772     frameLoader->client().committedLoad(this, data, length);
773 }
774
775 ResourceError DocumentLoader::interruptedForPolicyChangeError() const
776 {
777     return frameLoader()->client().interruptedForPolicyChangeError(request());
778 }
779
780 void DocumentLoader::stopLoadingForPolicyChange()
781 {
782     ResourceError error = interruptedForPolicyChangeError();
783     error.setIsCancellation(true);
784     cancelMainResourceLoad(error);
785 }
786
787 void DocumentLoader::commitData(const char* bytes, size_t length)
788 {
789     if (!m_gotFirstByte) {
790         m_gotFirstByte = true;
791         m_writer.begin(documentURL(), false);
792         m_writer.setDocumentWasLoadedAsPartOfNavigation();
793
794         if (SecurityPolicy::allowSubstituteDataAccessToLocal() && m_originalSubstituteDataWasValid) {
795             // If this document was loaded with substituteData, then the document can
796             // load local resources. See https://bugs.webkit.org/show_bug.cgi?id=16756
797             // and https://bugs.webkit.org/show_bug.cgi?id=19760 for further
798             // discussion.
799             m_frame->document()->securityOrigin()->grantLoadLocalResources();
800         }
801
802         if (frameLoader()->stateMachine().creatingInitialEmptyDocument())
803             return;
804         
805 #if ENABLE(MHTML)
806         // The origin is the MHTML file, we need to set the base URL to the document encoded in the MHTML so
807         // relative URLs are resolved properly.
808         if (m_archive && m_archive->type() == Archive::MHTML)
809             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
810 #endif
811
812         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
813         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
814         if (!isMultipartReplacingLoad())
815             frameLoader()->receivedFirstData();
816
817         // The load could be canceled under receivedFirstData(), which makes delegate calls and even sometimes dispatches DOM events.
818         if (!isLoading())
819             return;
820
821         bool userChosen;
822         String encoding;
823 #if ENABLE(CONTENT_FILTERING)
824         // The content filter's replacement data has a known encoding that might
825         // differ from the response's encoding.
826         if (m_contentFilter && m_contentFilter->didBlockData()) {
827             ASSERT(!m_contentFilter->needsMoreData());
828             userChosen = false;
829         } else
830 #endif
831         if (overrideEncoding().isNull()) {
832             userChosen = false;
833             encoding = response().textEncodingName();
834 #if ENABLE(WEB_ARCHIVE)
835             if (m_archive && m_archive->type() == Archive::WebArchive)
836                 encoding = m_archive->mainResource()->textEncoding();
837 #endif
838         } else {
839             userChosen = true;
840             encoding = overrideEncoding();
841         }
842
843         m_writer.setEncoding(encoding, userChosen);
844     }
845     ASSERT(m_frame->document()->parsing());
846     m_writer.addData(bytes, length);
847 }
848
849 void DocumentLoader::dataReceived(CachedResource* resource, const char* data, int length)
850 {
851     ASSERT(data);
852     ASSERT(length);
853     ASSERT_UNUSED(resource, resource == m_mainResource);
854     ASSERT(!m_response.isNull());
855
856     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
857     // See <rdar://problem/6304600> for more details.
858 #if !USE(CF)
859     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
860 #endif
861
862 #if ENABLE(CONTENT_FILTERING)
863     bool loadWasBlockedBeforeFinishing = false;
864     if (m_contentFilter && m_contentFilter->needsMoreData()) {
865         m_contentFilter->addData(data, length);
866
867         if (m_contentFilter->needsMoreData()) {
868             // Since the filter still needs more data to make a decision,
869             // avoid committing this data to prevent partial rendering of
870             // content that might later be blocked.
871             return;
872         }
873
874         data = m_contentFilter->getReplacementData(length);
875         loadWasBlockedBeforeFinishing = m_contentFilter->didBlockData();
876
877         if (loadWasBlockedBeforeFinishing)
878             frameLoader()->client().contentFilterDidBlockLoad(WTF::move(m_contentFilter));
879     }
880 #endif
881
882     if (m_identifierForLoadWithoutResourceLoader)
883         frameLoader()->notifier().dispatchDidReceiveData(this, m_identifierForLoadWithoutResourceLoader, data, length, -1);
884
885     m_applicationCacheHost->mainResourceDataReceived(data, length, -1, false);
886     m_timeOfLastDataReceived = monotonicallyIncreasingTime();
887
888     if (!isMultipartReplacingLoad())
889         commitLoad(data, length);
890
891 #if ENABLE(CONTENT_FILTERING)
892     if (loadWasBlockedBeforeFinishing)
893         cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
894 #endif
895 }
896
897 void DocumentLoader::setupForReplace()
898 {
899     if (!mainResourceData())
900         return;
901     
902     maybeFinishLoadingMultipartContent();
903     maybeCreateArchive();
904     m_writer.end();
905     frameLoader()->setReplacing();
906     m_gotFirstByte = false;
907     
908     stopLoadingSubresources();
909     stopLoadingPlugIns();
910 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
911     clearArchiveResources();
912 #endif
913 }
914
915 void DocumentLoader::checkLoadComplete()
916 {
917     if (!m_frame || isLoading())
918         return;
919
920     ASSERT(this == frameLoader()->activeDocumentLoader());
921     m_frame->document()->domWindow()->finishedLoading();
922 }
923
924 void DocumentLoader::setFrame(Frame* frame)
925 {
926     if (m_frame == frame)
927         return;
928     ASSERT(frame && !m_frame);
929     m_frame = frame;
930     m_writer.setFrame(frame);
931     attachToFrame();
932 }
933
934 void DocumentLoader::attachToFrame()
935 {
936     ASSERT(m_frame);
937 }
938
939 void DocumentLoader::detachFromFrame()
940 {
941     ASSERT(m_frame);
942     RefPtr<Frame> protectFrame(m_frame);
943     Ref<DocumentLoader> protectLoader(*this);
944
945     // It never makes sense to have a document loader that is detached from its
946     // frame have any loads active, so go ahead and kill all the loads.
947     stopLoading();
948     if (m_mainResource && m_mainResource->hasClient(this))
949         m_mainResource->removeClient(this);
950
951     m_applicationCacheHost->setDOMApplicationCache(0);
952     InspectorInstrumentation::loaderDetachedFromFrame(*m_frame, *this);
953     m_frame = 0;
954 }
955
956 void DocumentLoader::clearMainResourceLoader()
957 {
958     m_loadingMainResource = false;
959
960 #if PLATFORM(IOS)
961     // FIXME: Remove PLATFORM(IOS)-guard once we upstream the iOS changes to ResourceRequest.h.
962     m_request.deprecatedSetMainResourceRequest(false);
963 #endif
964
965     if (this == frameLoader()->activeDocumentLoader())
966         checkLoadComplete();
967 }
968
969 bool DocumentLoader::isLoadingInAPISense() const
970 {
971     // Once a frame has loaded, we no longer need to consider subresources,
972     // but we still need to consider subframes.
973     if (frameLoader()->state() != FrameStateComplete) {
974         if (m_frame->settings().needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
975             return true;
976     
977         Document* doc = m_frame->document();
978         if ((isLoadingMainResource() || !m_frame->document()->loadEventFinished()) && isLoading())
979             return true;
980         if (m_cachedResourceLoader->requestCount())
981             return true;
982         if (doc->processingLoadEvent())
983             return true;
984         if (doc->hasActiveParser())
985             return true;
986     }
987     return frameLoader()->subframeIsLoading();
988 }
989
990 bool DocumentLoader::maybeCreateArchive()
991 {
992 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
993     return false;
994 #else
995     
996     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
997     m_archive = ArchiveFactory::create(m_response.url(), mainResourceData().get(), m_response.mimeType());
998     if (!m_archive)
999         return false;
1000     
1001     addAllArchiveResources(m_archive.get());
1002     ArchiveResource* mainResource = m_archive->mainResource();
1003     m_parsedArchiveData = mainResource->data();
1004     m_writer.setMIMEType(mainResource->mimeType());
1005     
1006     ASSERT(m_frame->document());
1007     commitData(mainResource->data()->data(), mainResource->data()->size());
1008     return true;
1009 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1010 }
1011
1012 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1013
1014 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
1015 {
1016     m_archive = archive;
1017     addAllArchiveResources(m_archive.get());
1018 }
1019
1020 void DocumentLoader::addAllArchiveResources(Archive* archive)
1021 {
1022     if (!m_archiveResourceCollection)
1023         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
1024         
1025     ASSERT(archive);
1026     if (!archive)
1027         return;
1028         
1029     m_archiveResourceCollection->addAllResources(archive);
1030 }
1031
1032 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
1033 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
1034 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
1035 {
1036     if (!m_archiveResourceCollection)
1037         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
1038         
1039     ASSERT(resource);
1040     if (!resource)
1041         return;
1042         
1043     m_archiveResourceCollection->addResource(resource);
1044 }
1045
1046 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const URL& url)
1047 {
1048     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(0);
1049 }
1050
1051 void DocumentLoader::clearArchiveResources()
1052 {
1053     m_archiveResourceCollection.clear();
1054     m_substituteResourceDeliveryTimer.stop();
1055 }
1056
1057 SharedBuffer* DocumentLoader::parsedArchiveData() const
1058 {
1059     return m_parsedArchiveData.get();
1060 }
1061
1062 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1063
1064 ArchiveResource* DocumentLoader::archiveResourceForURL(const URL& url) const
1065 {
1066     if (!m_archiveResourceCollection)
1067         return nullptr;
1068     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
1069     if (!resource || resource->shouldIgnoreWhenUnarchiving())
1070         return nullptr;
1071     return resource;
1072 }
1073
1074 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
1075 {
1076     RefPtr<SharedBuffer> data = mainResourceData();
1077     if (!data)
1078         data = SharedBuffer::create();
1079         
1080     auto& response = this->response();
1081     return ArchiveResource::create(data, response.url(), response.mimeType(), response.textEncodingName(), frame()->tree().uniqueName());
1082 }
1083
1084 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const URL& url) const
1085 {
1086     if (!isCommitted())
1087         return nullptr;
1088     
1089     CachedResource* resource = m_cachedResourceLoader->cachedResource(url);
1090     if (!resource || !resource->isLoaded())
1091         return archiveResourceForURL(url);
1092
1093     if (resource->type() == CachedResource::MainResource)
1094         return nullptr;
1095
1096     auto* data = resource->resourceBuffer();
1097     if (!data)
1098         return nullptr;
1099
1100     return ArchiveResource::create(data, url, resource->response());
1101 }
1102
1103 Vector<RefPtr<ArchiveResource>> DocumentLoader::subresources() const
1104 {
1105     if (!isCommitted())
1106         return { };
1107
1108     Vector<RefPtr<ArchiveResource>> subresources;
1109
1110     for (auto& cachedResourceHandle : m_cachedResourceLoader->allCachedResources().values()) {
1111         if (RefPtr<ArchiveResource> subresource = this->subresource(URL(ParsedURLString, cachedResourceHandle->url())))
1112             subresources.append(WTF::move(subresource));
1113     }
1114
1115     return subresources;
1116 }
1117
1118 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
1119 {
1120     if (m_pendingSubstituteResources.isEmpty())
1121         return;
1122     ASSERT(m_frame && m_frame->page());
1123     if (m_frame->page()->defersLoading())
1124         return;
1125     if (!m_substituteResourceDeliveryTimer.isActive())
1126         m_substituteResourceDeliveryTimer.startOneShot(0);
1127 }
1128
1129 void DocumentLoader::substituteResourceDeliveryTimerFired()
1130 {
1131     if (m_pendingSubstituteResources.isEmpty())
1132         return;
1133     ASSERT(m_frame && m_frame->page());
1134     if (m_frame->page()->defersLoading())
1135         return;
1136
1137     SubstituteResourceMap copy;
1138     copy.swap(m_pendingSubstituteResources);
1139
1140     SubstituteResourceMap::const_iterator end = copy.end();
1141     for (SubstituteResourceMap::const_iterator it = copy.begin(); it != end; ++it) {
1142         RefPtr<ResourceLoader> loader = it->key;
1143         SubstituteResource* resource = it->value.get();
1144         
1145         if (resource) {
1146             SharedBuffer* data = resource->data();
1147         
1148             loader->didReceiveResponse(resource->response());
1149
1150             // Calling ResourceLoader::didReceiveResponse can end up cancelling the load,
1151             // so we need to check if the loader has reached its terminal state.
1152             if (loader->reachedTerminalState())
1153                 return;
1154
1155             loader->didReceiveData(data->data(), data->size(), data->size(), DataPayloadWholeResource);
1156
1157             // Calling ResourceLoader::didReceiveData can end up cancelling the load,
1158             // so we need to check if the loader has reached its terminal state.
1159             if (loader->reachedTerminalState())
1160                 return;
1161
1162             loader->didFinishLoading(0);
1163         } else {
1164             // A null resource means that we should fail the load.
1165             // FIXME: Maybe we should use another error here - something like "not in cache".
1166             loader->didFail(loader->cannotShowURLError());
1167         }
1168     }
1169 }
1170
1171 #ifndef NDEBUG
1172 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
1173 {
1174     return m_pendingSubstituteResources.contains(loader);
1175 }
1176 #endif
1177
1178 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
1179 {
1180     if (m_pendingSubstituteResources.isEmpty())
1181         return;
1182     m_pendingSubstituteResources.remove(loader);
1183     if (m_pendingSubstituteResources.isEmpty())
1184         m_substituteResourceDeliveryTimer.stop();
1185 }
1186
1187 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1188 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader* loader, const ResourceRequest& request)
1189 {
1190     if (ArchiveResource* resource = archiveResourceForURL(request.url())) {
1191         m_pendingSubstituteResources.set(loader, resource);
1192         deliverSubstituteResourcesAfterDelay();
1193         return true;
1194     }
1195
1196     if (!m_archive)
1197         return false;
1198
1199     switch (m_archive->type()) {
1200 #if ENABLE(WEB_ARCHIVE)
1201     case Archive::WebArchive:
1202         // WebArchiveDebugMode means we fail loads instead of trying to fetch them from the network if they're not in the archive.
1203         return m_frame->settings().webArchiveDebugModeEnabled() && ArchiveFactory::isArchiveMimeType(responseMIMEType());
1204 #endif
1205 #if ENABLE(MHTML)
1206     case Archive::MHTML:
1207         return true; // Always fail the load for resources not included in the MHTML.
1208 #endif
1209     default:
1210         return false;
1211     }
1212 }
1213 #endif // ENABLE(WEB_ARCHIVE)
1214
1215 void DocumentLoader::addResponse(const ResourceResponse& r)
1216 {
1217     if (!m_stopRecordingResponses)
1218         m_responses.append(r);
1219 }
1220
1221 void DocumentLoader::stopRecordingResponses()
1222 {
1223     m_stopRecordingResponses = true;
1224     m_responses.shrinkToFit();
1225 }
1226
1227 void DocumentLoader::setTitle(const StringWithDirection& title)
1228 {
1229     if (m_pageTitle == title)
1230         return;
1231
1232     frameLoader()->willChangeTitle(this);
1233     m_pageTitle = title;
1234     frameLoader()->didChangeTitle(this);
1235 }
1236
1237 URL DocumentLoader::urlForHistory() const
1238 {
1239     // Return the URL to be used for history and B/F list.
1240     // Returns nil for WebDataProtocol URLs that aren't alternates
1241     // for unreachable URLs, because these can't be stored in history.
1242     if (m_substituteData.isValid() && !m_substituteData.shouldRevealToSessionHistory())
1243         return unreachableURL();
1244
1245     return m_originalRequestCopy.url();
1246 }
1247
1248 bool DocumentLoader::urlForHistoryReflectsFailure() const
1249 {
1250     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
1251 }
1252
1253 const URL& DocumentLoader::originalURL() const
1254 {
1255     return m_originalRequestCopy.url();
1256 }
1257
1258 const URL& DocumentLoader::requestURL() const
1259 {
1260     return request().url();
1261 }
1262
1263 const URL& DocumentLoader::responseURL() const
1264 {
1265     return m_response.url();
1266 }
1267
1268 URL DocumentLoader::documentURL() const
1269 {
1270     URL url = substituteData().responseURL();
1271 #if ENABLE(WEB_ARCHIVE)
1272     if (url.isEmpty() && m_archive && m_archive->type() == Archive::WebArchive)
1273         url = m_archive->mainResource()->url();
1274 #endif
1275     if (url.isEmpty())
1276         url = requestURL();
1277     if (url.isEmpty())
1278         url = m_response.url();
1279     return url;
1280 }
1281
1282 const String& DocumentLoader::responseMIMEType() const
1283 {
1284     return m_response.mimeType();
1285 }
1286
1287 const String& DocumentLoader::currentContentType() const
1288 {
1289     return m_writer.mimeType();
1290 }
1291
1292 #if PLATFORM(IOS)
1293 // FIXME: This method seems to violate the encapsulation of this class.
1294 void DocumentLoader::setResponseMIMEType(const String& responseMimeType)
1295 {
1296     m_response.setMimeType(responseMimeType);
1297 }
1298 #endif
1299
1300 const URL& DocumentLoader::unreachableURL() const
1301 {
1302     return m_substituteData.failingURL();
1303 }
1304
1305 void DocumentLoader::setDefersLoading(bool defers)
1306 {
1307     // Multiple frames may be loading the same main resource simultaneously. If deferral state changes,
1308     // each frame's DocumentLoader will try to send a setDefersLoading() to the same underlying ResourceLoader. Ensure only
1309     // the "owning" DocumentLoader does so, as setDefersLoading() is not resilient to setting the same value repeatedly.
1310     if (mainResourceLoader() && mainResourceLoader()->documentLoader() == this)
1311         mainResourceLoader()->setDefersLoading(defers);
1312
1313     setAllDefersLoading(m_subresourceLoaders, defers);
1314     setAllDefersLoading(m_plugInStreamLoaders, defers);
1315     if (!defers)
1316         deliverSubstituteResourcesAfterDelay();
1317 }
1318
1319 void DocumentLoader::setMainResourceDataBufferingPolicy(DataBufferingPolicy dataBufferingPolicy)
1320 {
1321     if (m_mainResource)
1322         m_mainResource->setDataBufferingPolicy(dataBufferingPolicy);
1323 }
1324
1325 void DocumentLoader::stopLoadingPlugIns()
1326 {
1327     cancelAll(m_plugInStreamLoaders);
1328 }
1329
1330 void DocumentLoader::stopLoadingSubresources()
1331 {
1332     cancelAll(m_subresourceLoaders);
1333 }
1334
1335 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
1336 {
1337     // The main resource's underlying ResourceLoader will ask to be added here.
1338     // It is much simpler to handle special casing of main resource loads if we don't
1339     // let it be added. In the main resource load case, mainResourceLoader()
1340     // will still be null at this point, but m_gotFirstByte should be false here if and only
1341     // if we are just starting the main resource load.
1342     if (!m_gotFirstByte)
1343         return;
1344     ASSERT(loader->identifier());
1345     ASSERT(!m_subresourceLoaders.contains(loader->identifier()));
1346     ASSERT(!mainResourceLoader() || mainResourceLoader() != loader);
1347
1348     m_subresourceLoaders.add(loader->identifier(), loader);
1349 }
1350
1351 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
1352 {
1353     ASSERT(loader->identifier());
1354
1355     if (!m_subresourceLoaders.remove(loader->identifier()))
1356         return;
1357     checkLoadComplete();
1358     if (Frame* frame = m_frame)
1359         frame->loader().checkLoadComplete();
1360 }
1361
1362 void DocumentLoader::addPlugInStreamLoader(ResourceLoader* loader)
1363 {
1364     ASSERT(loader->identifier());
1365     ASSERT(!m_plugInStreamLoaders.contains(loader->identifier()));
1366
1367     m_plugInStreamLoaders.add(loader->identifier(), loader);
1368 }
1369
1370 void DocumentLoader::removePlugInStreamLoader(ResourceLoader* loader)
1371 {
1372     ASSERT(loader->identifier());
1373     ASSERT(loader == m_plugInStreamLoaders.get(loader->identifier()));
1374
1375     m_plugInStreamLoaders.remove(loader->identifier());
1376     checkLoadComplete();
1377 }
1378
1379 bool DocumentLoader::isMultipartReplacingLoad() const
1380 {
1381     return isLoadingMultipartContent() && frameLoader()->isReplacing();
1382 }
1383
1384 bool DocumentLoader::maybeLoadEmpty()
1385 {
1386     bool shouldLoadEmpty = !m_substituteData.isValid() && (m_request.url().isEmpty() || SchemeRegistry::shouldLoadURLSchemeAsEmptyDocument(m_request.url().protocol()));
1387     if (!shouldLoadEmpty && !frameLoader()->client().representationExistsForURLScheme(m_request.url().protocol()))
1388         return false;
1389
1390     if (m_request.url().isEmpty() && !frameLoader()->stateMachine().creatingInitialEmptyDocument())
1391         m_request.setURL(blankURL());
1392     String mimeType = shouldLoadEmpty ? "text/html" : frameLoader()->client().generatedMIMETypeForURLScheme(m_request.url().protocol());
1393     m_response = ResourceResponse(m_request.url(), mimeType, 0, String());
1394     finishedLoading(monotonicallyIncreasingTime());
1395     return true;
1396 }
1397
1398 void DocumentLoader::startLoadingMainResource()
1399 {
1400     m_mainDocumentError = ResourceError();
1401     timing().markNavigationStart();
1402     ASSERT(!m_mainResource);
1403     ASSERT(!m_loadingMainResource);
1404     m_loadingMainResource = true;
1405
1406     if (maybeLoadEmpty())
1407         return;
1408
1409     // FIXME: Is there any way the extra fields could have not been added by now?
1410     // If not, it would be great to remove this line of code.
1411     // Note that currently, some requests may have incorrect extra fields even if this function has been called,
1412     // because we pass a wrong loadType (see FIXME in addExtraFieldsToMainResourceRequest()).
1413     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
1414
1415     ASSERT(timing().navigationStart());
1416     ASSERT(!timing().fetchStart());
1417     timing().markFetchStart();
1418     willSendRequest(m_request, ResourceResponse());
1419
1420     // willSendRequest() may lead to our Frame being detached or cancelling the load via nulling the ResourceRequest.
1421     if (!m_frame || m_request.isNull())
1422         return;
1423
1424     m_applicationCacheHost->maybeLoadMainResource(m_request, m_substituteData);
1425
1426     if (m_substituteData.isValid()) {
1427         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1428         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, m_request);
1429         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, m_request, ResourceResponse());
1430         handleSubstituteDataLoadSoon();
1431         return;
1432     }
1433
1434 #if PLATFORM(IOS)
1435     // FIXME: Remove PLATFORM(IOS)-guard once we upstream the iOS changes to ResourceRequest.h.
1436     m_request.deprecatedSetMainResourceRequest(true);
1437 #endif
1438
1439     ResourceRequest request(m_request);
1440     static NeverDestroyed<ResourceLoaderOptions> mainResourceLoadOptions(SendCallbacks, SniffContent, BufferData, AllowStoredCredentials, AskClientForAllCredentials, SkipSecurityCheck, UseDefaultOriginRestrictionsForType, IncludeCertificateInfo);
1441     CachedResourceRequest cachedResourceRequest(request, mainResourceLoadOptions);
1442     m_mainResource = m_cachedResourceLoader->requestMainResource(cachedResourceRequest);
1443     if (!m_mainResource) {
1444         setRequest(ResourceRequest());
1445         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
1446         // is now in a state where starting an empty load will be inconsistent. Replace it with
1447         // a new ApplicationCacheHost.
1448         m_applicationCacheHost = adoptPtr(new ApplicationCacheHost(*this));
1449         maybeLoadEmpty();
1450         return;
1451     }
1452
1453     if (!mainResourceLoader()) {
1454         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1455         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, request);
1456         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, request, ResourceResponse());
1457     }
1458     m_mainResource->addClient(this);
1459
1460     // A bunch of headers are set when the underlying ResourceLoader is created, and m_request needs to include those.
1461     if (mainResourceLoader())
1462         request = mainResourceLoader()->originalRequest();
1463     // If there was a fragment identifier on m_request, the cache will have stripped it. m_request should include
1464     // the fragment identifier, so add that back in.
1465     if (equalIgnoringFragmentIdentifier(m_request.url(), request.url()))
1466         request.setURL(m_request.url());
1467     setRequest(request);
1468 }
1469
1470 void DocumentLoader::cancelMainResourceLoad(const ResourceError& resourceError)
1471 {
1472     Ref<DocumentLoader> protect(*this);
1473     ResourceError error = resourceError.isNull() ? frameLoader()->cancelledError(m_request) : resourceError;
1474
1475     m_dataLoadTimer.stop();
1476     if (m_waitingForContentPolicy) {
1477         frameLoader()->policyChecker().cancelCheck();
1478         ASSERT(m_waitingForContentPolicy);
1479         m_waitingForContentPolicy = false;
1480     }
1481
1482     if (mainResourceLoader())
1483         mainResourceLoader()->cancel(error);
1484
1485     clearMainResource();
1486
1487     mainReceivedError(error);
1488 }
1489
1490 void DocumentLoader::clearMainResource()
1491 {
1492     if (m_mainResource && m_mainResource->hasClient(this))
1493         m_mainResource->removeClient(this);
1494
1495     m_mainResource = 0;
1496 }
1497
1498 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
1499 {
1500     unsigned long identifier = loader->identifier();
1501     ASSERT(identifier);
1502
1503     if (!m_multipartSubresourceLoaders.add(identifier, loader).isNewEntry) {
1504         ASSERT(m_multipartSubresourceLoaders.get(identifier) == loader);
1505         ASSERT(!m_subresourceLoaders.contains(identifier));
1506     } else {
1507         ASSERT(m_subresourceLoaders.contains(identifier));
1508         m_subresourceLoaders.remove(identifier);
1509     }
1510
1511     checkLoadComplete();
1512     if (Frame* frame = m_frame)
1513         frame->loader().checkLoadComplete();    
1514 }
1515
1516 void DocumentLoader::maybeFinishLoadingMultipartContent()
1517 {
1518     if (!isMultipartReplacingLoad())
1519         return;
1520
1521     frameLoader()->setupForReplace();
1522     m_committed = false;
1523     RefPtr<SharedBuffer> resourceData = mainResourceData();
1524     commitLoad(resourceData->data(), resourceData->size());
1525 }
1526
1527 void DocumentLoader::iconLoadDecisionAvailable()
1528 {
1529     if (m_frame)
1530         m_frame->loader().icon().loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon().url(), this));
1531 }
1532
1533 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
1534 {
1535     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
1536 }
1537
1538 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
1539 {
1540     if (m_iconLoadDecisionCallback)
1541         m_iconLoadDecisionCallback->invalidate();
1542     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
1543     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
1544 }
1545
1546 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
1547 {
1548     ASSERT(m_iconLoadDecisionCallback);
1549     m_iconLoadDecisionCallback = 0;
1550     if (m_frame)
1551         m_frame->loader().icon().continueLoadWithDecision(decision);
1552 }
1553
1554 static void iconDataCallback(SharedBuffer*, void*)
1555 {
1556     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
1557 }
1558
1559 void DocumentLoader::getIconDataForIconURL(const String& urlString)
1560 {   
1561     if (m_iconDataCallback)
1562         m_iconDataCallback->invalidate();
1563     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
1564     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
1565 }
1566
1567 void DocumentLoader::handledOnloadEvents()
1568 {
1569     m_wasOnloadHandled = true;
1570     applicationCacheHost()->stopDeferringEvents();
1571 }
1572
1573 } // namespace WebCore