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