5d9836a98e52375707140f6d9a17609f879aa04d
[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 "ContentExtensionError.h"
39 #include "DOMWindow.h"
40 #include "Document.h"
41 #include "DocumentParser.h"
42 #include "DocumentWriter.h"
43 #include "Event.h"
44 #include "ExtensionStyleSheets.h"
45 #include "FormState.h"
46 #include "FrameLoader.h"
47 #include "FrameLoaderClient.h"
48 #include "FrameTree.h"
49 #include "HTMLFormElement.h"
50 #include "HTMLFrameOwnerElement.h"
51 #include "HTTPHeaderNames.h"
52 #include "HistoryItem.h"
53 #include "IconController.h"
54 #include "InspectorInstrumentation.h"
55 #include "Logging.h"
56 #include "MainFrame.h"
57 #include "MemoryCache.h"
58 #include "Page.h"
59 #include "PolicyChecker.h"
60 #include "ProgressTracker.h"
61 #include "ResourceHandle.h"
62 #include "SchemeRegistry.h"
63 #include "ScriptController.h"
64 #include "SecurityPolicy.h"
65 #include "Settings.h"
66 #include "SubresourceLoader.h"
67 #include "TextResourceDecoder.h"
68 #include <wtf/Assertions.h>
69 #include <wtf/NeverDestroyed.h>
70 #include <wtf/Ref.h>
71 #include <wtf/text/CString.h>
72 #include <wtf/text/WTFString.h>
73
74 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
75 #include "ArchiveFactory.h"
76 #endif
77
78 #if ENABLE(CONTENT_FILTERING)
79 #include "ContentFilter.h"
80 #endif
81
82 namespace WebCore {
83
84 static void cancelAll(const ResourceLoaderMap& loaders)
85 {
86     Vector<RefPtr<ResourceLoader>> loadersCopy;
87     copyValuesToVector(loaders, loadersCopy);
88     for (auto& loader : loadersCopy)
89         loader->cancel();
90 }
91
92 static void setAllDefersLoading(const ResourceLoaderMap& loaders, bool defers)
93 {
94     Vector<RefPtr<ResourceLoader>> loadersCopy;
95     copyValuesToVector(loaders, loadersCopy);
96     for (auto& loader : loadersCopy)
97         loader->setDefersLoading(defers);
98 }
99
100 static bool areAllLoadersPageCacheAcceptable(const ResourceLoaderMap& loaders)
101 {
102     Vector<RefPtr<ResourceLoader>> loadersCopy;
103     copyValuesToVector(loaders, loadersCopy);
104     for (auto& loader : loadersCopy) {
105         if (!loader->frameLoader() || !loader->frameLoader()->frame().page())
106             return false;
107
108         CachedResource* cachedResource = MemoryCache::singleton().resourceForRequest(loader->request(), loader->frameLoader()->frame().page()->sessionID());
109         if (!cachedResource)
110             return false;
111
112         // Only image and XHR loads do prevent the page from entering the PageCache.
113         // All non-image loads will prevent the page from entering the PageCache.
114         if (!cachedResource->isImage() && !cachedResource->areAllClientsXMLHttpRequests())
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(nullptr)
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_wasOnloadDispatched(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_subresourceLoadersArePageCacheAcceptable(false)
144     , m_applicationCacheHost(std::make_unique<ApplicationCacheHost>(*this))
145 {
146 }
147
148 FrameLoader* DocumentLoader::frameLoader() const
149 {
150     if (!m_frame)
151         return nullptr;
152     return &m_frame->loader();
153 }
154
155 SubresourceLoader* DocumentLoader::mainResourceLoader() const
156 {
157     return m_mainResource ? m_mainResource->loader() : 0;
158 }
159
160 DocumentLoader::~DocumentLoader()
161 {
162     ASSERT(!m_frame || frameLoader()->activeDocumentLoader() != this || !isLoading());
163     ASSERT_WITH_MESSAGE(!m_waitingForContentPolicy, "The content policy callback should never outlive its DocumentLoader.");
164     ASSERT_WITH_MESSAGE(!m_waitingForNavigationPolicy, "The navigation policy callback should never outlive its DocumentLoader.");
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() || !m_plugInStreamLoaders.isEmpty()) {
331         // The main resource loader already finished loading. Set the cancelled error on the
332         // document and let the subresourceLoaders and pluginLoaders 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
340     // We always need to explicitly cancel the Document's parser when stopping the load.
341     // Otherwise cancelling the parser while starting the next page load might result
342     // in unexpected side effects such as erroneous event dispatch. ( http://webkit.org/b/117112 )
343     if (Document* document = this->document())
344         document->cancelParsing();
345     
346     stopLoadingSubresources();
347     stopLoadingPlugIns();
348     
349     m_isStopping = false;
350 }
351
352 void DocumentLoader::commitIfReady()
353 {
354     if (!m_committed) {
355         m_committed = true;
356         frameLoader()->commitProvisionalLoad();
357     }
358 }
359
360 bool DocumentLoader::isLoading() const
361 {
362     // if (document() && document()->hasActiveParser())
363     //     return true;
364     // FIXME: The above code should be enabled, but it seems to cause
365     // http/tests/security/feed-urls-from-remote.html to timeout on Mac WK1
366     // see http://webkit.org/b/110554 and http://webkit.org/b/110401
367
368     return isLoadingMainResource() || !m_subresourceLoaders.isEmpty() || !m_plugInStreamLoaders.isEmpty();
369 }
370
371 void DocumentLoader::notifyFinished(CachedResource* resource)
372 {
373     ASSERT_UNUSED(resource, m_mainResource == resource);
374     ASSERT(m_mainResource);
375     if (!m_mainResource->errorOccurred() && !m_mainResource->wasCanceled()) {
376         finishedLoading(m_mainResource->loadFinishTime());
377         return;
378     }
379
380     if (m_request.cachePolicy() == ReturnCacheDataDontLoad && !m_mainResource->wasCanceled()) {
381         frameLoader()->retryAfterFailedCacheOnlyMainResourceLoad();
382         return;
383     }
384
385     mainReceivedError(m_mainResource->resourceError());
386 }
387
388 void DocumentLoader::finishedLoading(double finishTime)
389 {
390     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
391     // See <rdar://problem/6304600> for more details.
392 #if !USE(CF)
393     ASSERT(!m_frame->page()->defersLoading() || InspectorInstrumentation::isDebuggerPaused(m_frame));
394 #endif
395
396     Ref<DocumentLoader> protect(*this);
397
398     if (m_identifierForLoadWithoutResourceLoader) {
399         // A didFinishLoading delegate might try to cancel the load (despite it
400         // being finished). Clear m_identifierForLoadWithoutResourceLoader
401         // before calling dispatchDidFinishLoading so that we don't later try to
402         // cancel the already-finished substitute load.
403         unsigned long identifier = m_identifierForLoadWithoutResourceLoader;
404         m_identifierForLoadWithoutResourceLoader = 0;
405         frameLoader()->notifier().dispatchDidFinishLoading(this, identifier, finishTime);
406     }
407
408     maybeFinishLoadingMultipartContent();
409
410     double responseEndTime = finishTime;
411     if (!responseEndTime)
412         responseEndTime = m_timeOfLastDataReceived;
413     if (!responseEndTime)
414         responseEndTime = monotonicallyIncreasingTime();
415     timing().setResponseEnd(responseEndTime);
416
417     commitIfReady();
418     if (!frameLoader())
419         return;
420
421     if (!maybeCreateArchive()) {
422         // If this is an empty document, it will not have actually been created yet. Commit dummy data so that
423         // DocumentWriter::begin() gets called and creates the Document.
424         if (!m_gotFirstByte)
425             commitData(0, 0);
426         frameLoader()->client().finishedLoading(this);
427     }
428
429     m_writer.end();
430     if (!m_mainDocumentError.isNull())
431         return;
432     clearMainResourceLoader();
433     if (!frameLoader()->stateMachine().creatingInitialEmptyDocument())
434         frameLoader()->checkLoadComplete();
435
436     // If the document specified an application cache manifest, it violates the author's intent if we store it in the memory cache
437     // and deny the appcache the chance to intercept it in the future, so remove from the memory cache.
438     if (m_frame) {
439         if (m_mainResource && m_frame->document()->hasManifest())
440             MemoryCache::singleton().remove(*m_mainResource);
441     }
442     m_applicationCacheHost->finishedLoadingMainResource();
443 }
444
445 bool DocumentLoader::isPostOrRedirectAfterPost(const ResourceRequest& newRequest, const ResourceResponse& redirectResponse)
446 {
447     if (newRequest.httpMethod() == "POST")
448         return true;
449
450     int status = redirectResponse.httpStatusCode();
451     if (((status >= 301 && status <= 303) || status == 307)
452         && m_originalRequest.httpMethod() == "POST")
453         return true;
454
455     return false;
456 }
457
458 void DocumentLoader::handleSubstituteDataLoadNow()
459 {
460     ResourceResponse response = m_substituteData.response();
461     if (response.url().isEmpty())
462         response = ResourceResponse(m_request.url(), m_substituteData.mimeType(), m_substituteData.content()->size(), m_substituteData.textEncoding());
463
464     responseReceived(0, response);
465 }
466
467 void DocumentLoader::startDataLoadTimer()
468 {
469     m_dataLoadTimer.startOneShot(0);
470
471 #if HAVE(RUNLOOP_TIMER)
472     if (SchedulePairHashSet* scheduledPairs = m_frame->page()->scheduledRunLoopPairs())
473         m_dataLoadTimer.schedule(*scheduledPairs);
474 #endif
475 }
476
477 void DocumentLoader::handleSubstituteDataLoadSoon()
478 {
479     if (!m_deferMainResourceDataLoad || frameLoader()->loadsSynchronously())
480         handleSubstituteDataLoadNow();
481     else
482         startDataLoadTimer();
483 }
484
485 void DocumentLoader::redirectReceived(CachedResource* resource, ResourceRequest& request, const ResourceResponse& redirectResponse)
486 {
487     ASSERT_UNUSED(resource, resource == m_mainResource);
488     willSendRequest(request, redirectResponse);
489 }
490
491 void DocumentLoader::willSendRequest(ResourceRequest& newRequest, const ResourceResponse& redirectResponse)
492 {
493     // Note that there are no asserts here as there are for the other callbacks. This is due to the
494     // fact that this "callback" is sent when starting every load, and the state of callback
495     // deferrals plays less of a part in this function in preventing the bad behavior deferring 
496     // callbacks is meant to prevent.
497     ASSERT(!newRequest.isNull());
498
499     if (!frameLoader()->checkIfFormActionAllowedByCSP(newRequest.url())) {
500         cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
501         return;
502     }
503
504     ASSERT(timing().fetchStart());
505     if (!redirectResponse.isNull()) {
506         // If the redirecting url is not allowed to display content from the target origin,
507         // then block the redirect.
508         Ref<SecurityOrigin> redirectingOrigin(SecurityOrigin::create(redirectResponse.url()));
509         if (!redirectingOrigin.get().canDisplay(newRequest.url())) {
510             FrameLoader::reportLocalLoadFailed(m_frame, newRequest.url().string());
511             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
512             return;
513         }
514         timing().addRedirect(redirectResponse.url(), newRequest.url());
515     }
516
517     // Update cookie policy base URL as URL changes, except for subframes, which use the
518     // URL of the main frame which doesn't change when we redirect.
519     if (frameLoader()->frame().isMainFrame())
520         newRequest.setFirstPartyForCookies(newRequest.url());
521
522     // If we're fielding a redirect in response to a POST, force a load from origin, since
523     // this is a common site technique to return to a page viewing some data that the POST
524     // just modified.
525     // Also, POST requests always load from origin, but this does not affect subresources.
526     if (newRequest.cachePolicy() == UseProtocolCachePolicy && isPostOrRedirectAfterPost(newRequest, redirectResponse))
527         newRequest.setCachePolicy(ReloadIgnoringCacheData);
528
529     Frame& topFrame = m_frame->tree().top();
530     if (&topFrame != m_frame) {
531         if (!frameLoader()->mixedContentChecker().canDisplayInsecureContent(topFrame.document()->securityOrigin(), MixedContentChecker::ContentType::Active, newRequest.url())) {
532             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
533             return;
534         }
535     }
536
537 #if ENABLE(CONTENT_FILTERING)
538     if (m_contentFilter && redirectResponse.isNull()) {
539         m_contentFilter->willSendRequest(newRequest, redirectResponse);
540         if (newRequest.isNull())
541             return;
542     }
543 #endif
544
545     setRequest(newRequest);
546
547     if (!redirectResponse.isNull()) {
548         // We checked application cache for initial URL, now we need to check it for redirected one.
549         ASSERT(!m_substituteData.isValid());
550         m_applicationCacheHost->maybeLoadMainResourceForRedirect(newRequest, m_substituteData);
551         if (m_substituteData.isValid()) {
552             RELEASE_ASSERT(m_mainResource);
553             ResourceLoader* loader = m_mainResource->loader();
554             m_identifierForLoadWithoutResourceLoader = loader ? loader->identifier() : m_mainResource->identifierForLoadWithoutResourceLoader();
555         }
556     }
557
558     // FIXME: Ideally we'd stop the I/O until we hear back from the navigation policy delegate
559     // listener. But there's no way to do that in practice. So instead we cancel later if the
560     // listener tells us to. In practice that means the navigation policy needs to be decided
561     // synchronously for these redirect cases.
562     if (redirectResponse.isNull())
563         return;
564
565     ASSERT(!m_waitingForNavigationPolicy);
566     m_waitingForNavigationPolicy = true;
567     frameLoader()->policyChecker().checkNavigationPolicy(newRequest, [this](const ResourceRequest& request, PassRefPtr<FormState>, bool shouldContinue) {
568         continueAfterNavigationPolicy(request, shouldContinue);
569     });
570 }
571
572 void DocumentLoader::continueAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue)
573 {
574     ASSERT(m_waitingForNavigationPolicy);
575     m_waitingForNavigationPolicy = false;
576     if (!shouldContinue)
577         stopLoadingForPolicyChange();
578     else if (m_substituteData.isValid()) {
579         // A redirect resulted in loading substitute data.
580         ASSERT(timing().redirectCount());
581
582         // We need to remove our reference to the CachedResource in favor of a SubstituteData load.
583         // This will probably trigger the cancellation of the CachedResource's underlying ResourceLoader, though there is a
584         // small chance that the resource is being loaded by a different Frame, preventing the ResourceLoader from being cancelled.
585         // If the ResourceLoader is indeed cancelled, it would normally send resource load callbacks.
586         // However, from an API perspective, this isn't a cancellation. Therefore, sever our relationship with the network load,
587         // but prevent the ResourceLoader from sending ResourceLoadNotifier callbacks.
588         RefPtr<ResourceLoader> resourceLoader = mainResourceLoader();
589         if (resourceLoader) {
590             ASSERT(resourceLoader->shouldSendResourceLoadCallbacks());
591             resourceLoader->setSendCallbackPolicy(DoNotSendCallbacks);
592         }
593
594         clearMainResource();
595
596         if (resourceLoader)
597             resourceLoader->setSendCallbackPolicy(SendCallbacks);
598         handleSubstituteDataLoadSoon();
599     }
600 }
601
602 void DocumentLoader::responseReceived(CachedResource* resource, const ResourceResponse& response)
603 {
604     ASSERT_UNUSED(resource, m_mainResource == resource);
605     Ref<DocumentLoader> protect(*this);
606     bool willLoadFallback = m_applicationCacheHost->maybeLoadFallbackForMainResponse(request(), response);
607
608     // The memory cache doesn't understand the application cache or its caching rules. So if a main resource is served
609     // from the application cache, ensure we don't save the result for future use.
610     if (willLoadFallback)
611         MemoryCache::singleton().remove(*m_mainResource);
612
613     if (willLoadFallback)
614         return;
615
616     const auto& commonHeaders = response.httpHeaderFields().commonHeaders();
617     auto it = commonHeaders.find(HTTPHeaderName::XFrameOptions);
618     if (it != commonHeaders.end()) {
619         String content = it->value;
620         ASSERT(m_identifierForLoadWithoutResourceLoader || m_mainResource);
621         unsigned long identifier = m_identifierForLoadWithoutResourceLoader ? m_identifierForLoadWithoutResourceLoader : m_mainResource->identifier();
622         ASSERT(identifier);
623         if (frameLoader()->shouldInterruptLoadForXFrameOptions(content, response.url(), identifier)) {
624             InspectorInstrumentation::continueAfterXFrameOptionsDenied(m_frame, *this, identifier, response);
625             String message = "Refused to display '" + response.url().stringCenterEllipsizedToLength() + "' in a frame because it set 'X-Frame-Options' to '" + content + "'.";
626             frame()->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, message, identifier);
627             frame()->document()->enforceSandboxFlags(SandboxOrigin);
628             if (HTMLFrameOwnerElement* ownerElement = frame()->ownerElement())
629                 ownerElement->dispatchEvent(Event::create(eventNames().loadEvent, false, false));
630
631             // The load event might have detached this frame. In that case, the load will already have been cancelled during detach.
632             if (frameLoader())
633                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
634             return;
635         }
636     }
637
638     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
639     // See <rdar://problem/6304600> for more details.
640 #if !USE(CF)
641     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
642 #endif
643
644     if (m_isLoadingMultipartContent) {
645         setupForReplace();
646         m_mainResource->clear();
647     } else if (response.isMultipart())
648         m_isLoadingMultipartContent = true;
649
650     m_response = response;
651
652     if (m_identifierForLoadWithoutResourceLoader) {
653         addResponse(m_response);
654         frameLoader()->notifier().dispatchDidReceiveResponse(this, m_identifierForLoadWithoutResourceLoader, m_response, 0);
655     }
656
657     ASSERT(!m_waitingForContentPolicy);
658     ASSERT(frameLoader());
659     m_waitingForContentPolicy = true;
660
661     // Always show content with valid substitute data.
662     if (m_substituteData.isValid()) {
663         continueAfterContentPolicy(PolicyUse);
664         return;
665     }
666
667 #if ENABLE(FTPDIR)
668     // Respect the hidden FTP Directory Listing pref so it can be tested even if the policy delegate might otherwise disallow it
669     if (m_frame->settings().forceFTPDirectoryListings() && m_response.mimeType() == "application/x-ftp-directory") {
670         continueAfterContentPolicy(PolicyUse);
671         return;
672     }
673 #endif
674
675     frameLoader()->policyChecker().checkContentPolicy(m_response, [this](PolicyAction policy) {
676         continueAfterContentPolicy(policy);
677     });
678 }
679
680 void DocumentLoader::continueAfterContentPolicy(PolicyAction policy)
681 {
682     ASSERT(m_waitingForContentPolicy);
683     m_waitingForContentPolicy = false;
684     if (isStopping())
685         return;
686
687     URL url = m_request.url();
688     const String& mimeType = m_response.mimeType();
689     
690     switch (policy) {
691     case PolicyUse: {
692         // Prevent remote web archives from loading because they can claim to be from any domain and thus avoid cross-domain security checks (4120255).
693         bool isRemoteWebArchive = (equalIgnoringCase("application/x-webarchive", mimeType)
694             || equalIgnoringCase("application/x-mimearchive", mimeType)
695 #if PLATFORM(GTK)
696             || equalIgnoringCase("message/rfc822", mimeType)
697 #endif
698             || equalIgnoringCase("multipart/related", mimeType))
699             && !m_substituteData.isValid() && !SchemeRegistry::shouldTreatURLSchemeAsLocal(url.protocol());
700         if (!frameLoader()->client().canShowMIMEType(mimeType) || isRemoteWebArchive) {
701             frameLoader()->policyChecker().cannotShowMIMEType(m_response);
702             // Check reachedTerminalState since the load may have already been canceled inside of _handleUnimplementablePolicyWithErrorCode::.
703             stopLoadingForPolicyChange();
704             return;
705         }
706         break;
707     }
708
709     case PolicyDownload: {
710         // m_mainResource can be null, e.g. when loading a substitute resource from application cache.
711         if (!m_mainResource) {
712             mainReceivedError(frameLoader()->client().cannotShowURLError(m_request));
713             return;
714         }
715
716         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
717             InspectorInstrumentation::continueWithPolicyDownload(m_frame, *this, mainResourceLoader->identifier(), m_response);
718
719         // 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.
720         // Download may use this knowledge for purposes unrelated to cookies, notably for setting file quarantine data.
721         frameLoader()->setOriginalURLForDownloadRequest(m_request);
722
723         SessionID sessionID = SessionID::defaultSessionID();
724         if (frame() && frame()->page())
725             sessionID = frame()->page()->sessionID();
726
727         if (m_request.url().protocolIsData()) {
728             // We decode data URL internally, there is no resource load to convert.
729             frameLoader()->client().startDownload(m_request);
730         } else
731             frameLoader()->client().convertMainResourceLoadToDownload(this, sessionID, m_request, m_response);
732
733         // It might have gone missing
734         if (mainResourceLoader())
735             static_cast<ResourceLoader*>(mainResourceLoader())->didFail(interruptedForPolicyChangeError());
736         return;
737     }
738     case PolicyIgnore:
739         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
740             InspectorInstrumentation::continueWithPolicyIgnore(m_frame, *this, mainResourceLoader->identifier(), m_response);
741         stopLoadingForPolicyChange();
742         return;
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     auto& extensionStyleSheets = m_frame->document()->extensionStyleSheets();
853
854     for (auto& pendingStyleSheet : m_pendingNamedContentExtensionStyleSheets)
855         extensionStyleSheets.maybeAddContentExtensionSheet(pendingStyleSheet.key, *pendingStyleSheet.value);
856     for (auto& pendingSelectorEntry : m_pendingContentExtensionDisplayNoneSelectors) {
857         for (const auto& pendingSelector : pendingSelectorEntry.value)
858             extensionStyleSheets.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     if (m_contentFilter)
959         m_contentFilter->stopFilteringMainResource();
960 #endif
961
962     m_applicationCacheHost->setDOMApplicationCache(nullptr);
963
964     cancelPolicyCheckIfNeeded();
965
966     // 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.
967     // This means either that a DocumentLoader is detaching twice, or is detaching before ever having attached.
968     // Until we figure out how that is happening, null check m_frame before dereferencing it here.
969     // <rdar://problem/21293082> and https://bugs.webkit.org/show_bug.cgi?id=146786
970     if (m_frame)
971         InspectorInstrumentation::loaderDetachedFromFrame(*m_frame, *this);
972
973     m_frame = nullptr;
974 }
975
976 void DocumentLoader::clearMainResourceLoader()
977 {
978     m_loadingMainResource = false;
979
980     if (this == frameLoader()->activeDocumentLoader())
981         checkLoadComplete();
982 }
983
984 bool DocumentLoader::isLoadingInAPISense() const
985 {
986     // Once a frame has loaded, we no longer need to consider subresources,
987     // but we still need to consider subframes.
988     if (frameLoader()->state() != FrameStateComplete) {
989         if (m_frame->settings().needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
990             return true;
991     
992         Document* doc = m_frame->document();
993         if ((isLoadingMainResource() || !m_frame->document()->loadEventFinished()) && isLoading())
994             return true;
995         if (m_cachedResourceLoader->requestCount())
996             return true;
997         if (doc->processingLoadEvent())
998             return true;
999         if (doc->hasActiveParser())
1000             return true;
1001     }
1002     return frameLoader()->subframeIsLoading();
1003 }
1004
1005 bool DocumentLoader::maybeCreateArchive()
1006 {
1007 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1008     return false;
1009 #else
1010     
1011     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
1012     m_archive = ArchiveFactory::create(m_response.url(), mainResourceData().get(), m_response.mimeType());
1013     if (!m_archive)
1014         return false;
1015     
1016     addAllArchiveResources(m_archive.get());
1017     ArchiveResource* mainResource = m_archive->mainResource();
1018     m_parsedArchiveData = mainResource->data();
1019     m_writer.setMIMEType(mainResource->mimeType());
1020     
1021     ASSERT(m_frame->document());
1022     commitData(mainResource->data()->data(), mainResource->data()->size());
1023     return true;
1024 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1025 }
1026
1027 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1028
1029 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
1030 {
1031     m_archive = archive;
1032     addAllArchiveResources(m_archive.get());
1033 }
1034
1035 void DocumentLoader::addAllArchiveResources(Archive* archive)
1036 {
1037     if (!m_archiveResourceCollection)
1038         m_archiveResourceCollection = std::make_unique<ArchiveResourceCollection>();
1039         
1040     ASSERT(archive);
1041     if (!archive)
1042         return;
1043         
1044     m_archiveResourceCollection->addAllResources(archive);
1045 }
1046
1047 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
1048 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
1049 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
1050 {
1051     if (!m_archiveResourceCollection)
1052         m_archiveResourceCollection = std::make_unique<ArchiveResourceCollection>();
1053         
1054     ASSERT(resource);
1055     if (!resource)
1056         return;
1057         
1058     m_archiveResourceCollection->addResource(resource);
1059 }
1060
1061 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const URL& url)
1062 {
1063     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(nullptr);
1064 }
1065
1066 void DocumentLoader::clearArchiveResources()
1067 {
1068     m_archiveResourceCollection = nullptr;
1069     m_substituteResourceDeliveryTimer.stop();
1070 }
1071
1072 SharedBuffer* DocumentLoader::parsedArchiveData() const
1073 {
1074     return m_parsedArchiveData.get();
1075 }
1076
1077 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1078
1079 ArchiveResource* DocumentLoader::archiveResourceForURL(const URL& url) const
1080 {
1081     if (!m_archiveResourceCollection)
1082         return nullptr;
1083     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
1084     if (!resource || resource->shouldIgnoreWhenUnarchiving())
1085         return nullptr;
1086     return resource;
1087 }
1088
1089 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
1090 {
1091     RefPtr<SharedBuffer> data = mainResourceData();
1092     if (!data)
1093         data = SharedBuffer::create();
1094         
1095     auto& response = this->response();
1096     return ArchiveResource::create(data, response.url(), response.mimeType(), response.textEncodingName(), frame()->tree().uniqueName());
1097 }
1098
1099 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const URL& url) const
1100 {
1101     if (!isCommitted())
1102         return nullptr;
1103     
1104     CachedResource* resource = m_cachedResourceLoader->cachedResource(url);
1105     if (!resource || !resource->isLoaded())
1106         return archiveResourceForURL(url);
1107
1108     if (resource->type() == CachedResource::MainResource)
1109         return nullptr;
1110
1111     auto* data = resource->resourceBuffer();
1112     if (!data)
1113         return nullptr;
1114
1115     return ArchiveResource::create(data, url, resource->response());
1116 }
1117
1118 Vector<RefPtr<ArchiveResource>> DocumentLoader::subresources() const
1119 {
1120     if (!isCommitted())
1121         return { };
1122
1123     Vector<RefPtr<ArchiveResource>> subresources;
1124
1125     for (auto& cachedResourceHandle : m_cachedResourceLoader->allCachedResources().values()) {
1126         if (RefPtr<ArchiveResource> subresource = this->subresource(URL(ParsedURLString, cachedResourceHandle->url())))
1127             subresources.append(WTFMove(subresource));
1128     }
1129
1130     return subresources;
1131 }
1132
1133 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
1134 {
1135     if (m_pendingSubstituteResources.isEmpty())
1136         return;
1137     ASSERT(m_frame && m_frame->page());
1138     if (m_frame->page()->defersLoading())
1139         return;
1140     if (!m_substituteResourceDeliveryTimer.isActive())
1141         m_substituteResourceDeliveryTimer.startOneShot(0);
1142 }
1143
1144 void DocumentLoader::substituteResourceDeliveryTimerFired()
1145 {
1146     if (m_pendingSubstituteResources.isEmpty())
1147         return;
1148     ASSERT(m_frame && m_frame->page());
1149     if (m_frame->page()->defersLoading())
1150         return;
1151
1152     SubstituteResourceMap copy;
1153     copy.swap(m_pendingSubstituteResources);
1154
1155     for (auto& entry : copy) {
1156         auto& loader = entry.key;
1157         SubstituteResource* resource = entry.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 #if ENABLE(CONTENT_FILTERING)
1416     m_contentFilter = !m_originalSubstituteDataWasValid ? ContentFilter::createIfEnabled(*this) : nullptr;
1417 #endif
1418
1419     // FIXME: Is there any way the extra fields could have not been added by now?
1420     // If not, it would be great to remove this line of code.
1421     // Note that currently, some requests may have incorrect extra fields even if this function has been called,
1422     // because we pass a wrong loadType (see FIXME in addExtraFieldsToMainResourceRequest()).
1423     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
1424
1425     ASSERT(timing().navigationStart());
1426     ASSERT(!timing().fetchStart());
1427     timing().markFetchStart();
1428     willSendRequest(m_request, ResourceResponse());
1429
1430     // willSendRequest() may lead to our Frame being detached or cancelling the load via nulling the ResourceRequest.
1431     if (!m_frame || m_request.isNull())
1432         return;
1433
1434     m_applicationCacheHost->maybeLoadMainResource(m_request, m_substituteData);
1435
1436     if (m_substituteData.isValid() && m_frame->page()) {
1437         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1438         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, m_request);
1439         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, m_request, ResourceResponse());
1440         handleSubstituteDataLoadSoon();
1441         return;
1442     }
1443
1444     ResourceRequest request(m_request);
1445     request.setRequester(ResourceRequest::Requester::Main);
1446     // If this is a reload the cache layer might have made the previous request conditional. DocumentLoader can't handle 304 responses itself.
1447     request.makeUnconditional();
1448
1449     static NeverDestroyed<ResourceLoaderOptions> mainResourceLoadOptions(SendCallbacks, SniffContent, BufferData, AllowStoredCredentials, AskClientForAllCredentials, SkipSecurityCheck, UseDefaultOriginRestrictionsForType, IncludeCertificateInfo, ContentSecurityPolicyImposition::DoPolicyCheck, DefersLoadingPolicy::AllowDefersLoading);
1450     CachedResourceRequest cachedResourceRequest(request, mainResourceLoadOptions);
1451     cachedResourceRequest.setInitiator(*this);
1452     m_mainResource = m_cachedResourceLoader->requestMainResource(cachedResourceRequest);
1453
1454 #if ENABLE(CONTENT_EXTENSIONS)
1455     if (m_mainResource && m_mainResource->errorOccurred() && m_frame->page() && m_mainResource->resourceError().domain() == ContentExtensions::WebKitContentBlockerDomain) {
1456         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1457         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, request);
1458         frameLoader()->notifier().dispatchDidFailLoading(this, m_identifierForLoadWithoutResourceLoader, frameLoader()->blockedByContentBlockerError(m_request));
1459         m_mainResource = nullptr;
1460     }
1461 #endif
1462
1463     if (!m_mainResource) {
1464         setRequest(ResourceRequest());
1465         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
1466         // is now in a state where starting an empty load will be inconsistent. Replace it with
1467         // a new ApplicationCacheHost.
1468         m_applicationCacheHost = std::make_unique<ApplicationCacheHost>(*this);
1469         maybeLoadEmpty();
1470         return;
1471     }
1472
1473     if (!mainResourceLoader()) {
1474         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1475         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, request);
1476         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, request, ResourceResponse());
1477     }
1478
1479     becomeMainResourceClient();
1480
1481     // A bunch of headers are set when the underlying ResourceLoader is created, and m_request needs to include those.
1482     if (mainResourceLoader())
1483         request = mainResourceLoader()->originalRequest();
1484     // If there was a fragment identifier on m_request, the cache will have stripped it. m_request should include
1485     // the fragment identifier, so add that back in.
1486     if (equalIgnoringFragmentIdentifier(m_request.url(), request.url()))
1487         request.setURL(m_request.url());
1488     setRequest(request);
1489 }
1490
1491 void DocumentLoader::cancelPolicyCheckIfNeeded()
1492 {
1493     RELEASE_ASSERT(frameLoader());
1494
1495     if (m_waitingForContentPolicy || m_waitingForNavigationPolicy) {
1496         frameLoader()->policyChecker().cancelCheck();
1497         m_waitingForContentPolicy = false;
1498         m_waitingForNavigationPolicy = false;
1499     }
1500 }
1501
1502 void DocumentLoader::cancelMainResourceLoad(const ResourceError& resourceError)
1503 {
1504     Ref<DocumentLoader> protect(*this);
1505     ResourceError error = resourceError.isNull() ? frameLoader()->cancelledError(m_request) : resourceError;
1506
1507     m_dataLoadTimer.stop();
1508
1509     cancelPolicyCheckIfNeeded();
1510
1511     if (mainResourceLoader())
1512         mainResourceLoader()->cancel(error);
1513
1514     clearMainResource();
1515
1516     mainReceivedError(error);
1517 }
1518
1519 void DocumentLoader::clearMainResource()
1520 {
1521     if (m_mainResource && m_mainResource->hasClient(this))
1522         m_mainResource->removeClient(this);
1523 #if ENABLE(CONTENT_FILTERING)
1524     if (m_contentFilter)
1525         m_contentFilter->stopFilteringMainResource();
1526 #endif
1527
1528     m_mainResource = nullptr;
1529 }
1530
1531 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
1532 {
1533     unsigned long identifier = loader->identifier();
1534     ASSERT(identifier);
1535
1536     if (!m_multipartSubresourceLoaders.add(identifier, loader).isNewEntry) {
1537         ASSERT(m_multipartSubresourceLoaders.get(identifier) == loader);
1538         ASSERT(!m_subresourceLoaders.contains(identifier));
1539     } else {
1540         ASSERT(m_subresourceLoaders.contains(identifier));
1541         m_subresourceLoaders.remove(identifier);
1542     }
1543
1544     checkLoadComplete();
1545     if (Frame* frame = m_frame)
1546         frame->loader().checkLoadComplete();    
1547 }
1548
1549 void DocumentLoader::maybeFinishLoadingMultipartContent()
1550 {
1551     if (!isMultipartReplacingLoad())
1552         return;
1553
1554     frameLoader()->setupForReplace();
1555     m_committed = false;
1556     RefPtr<SharedBuffer> resourceData = mainResourceData();
1557     commitLoad(resourceData->data(), resourceData->size());
1558 }
1559
1560 void DocumentLoader::iconLoadDecisionAvailable()
1561 {
1562     if (m_frame)
1563         m_frame->loader().icon().loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon().url(), this));
1564 }
1565
1566 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
1567 {
1568     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
1569 }
1570
1571 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
1572 {
1573     if (m_iconLoadDecisionCallback)
1574         m_iconLoadDecisionCallback->invalidate();
1575     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
1576     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
1577 }
1578
1579 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
1580 {
1581     ASSERT(m_iconLoadDecisionCallback);
1582     m_iconLoadDecisionCallback = nullptr;
1583     if (m_frame)
1584         m_frame->loader().icon().continueLoadWithDecision(decision);
1585 }
1586
1587 static void iconDataCallback(SharedBuffer*, void*)
1588 {
1589     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
1590 }
1591
1592 void DocumentLoader::getIconDataForIconURL(const String& urlString)
1593 {   
1594     if (m_iconDataCallback)
1595         m_iconDataCallback->invalidate();
1596     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
1597     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
1598 }
1599
1600 void DocumentLoader::dispatchOnloadEvents()
1601 {
1602     m_wasOnloadDispatched = true;
1603     applicationCacheHost()->stopDeferringEvents();
1604 }
1605
1606 void DocumentLoader::setTriggeringAction(const NavigationAction& action)
1607 {
1608     m_triggeringAction = action.copyWithShouldOpenExternalURLsPolicy(m_frame ? shouldOpenExternalURLsPolicyToPropagate() : m_shouldOpenExternalURLsPolicy);
1609 }
1610
1611 ShouldOpenExternalURLsPolicy DocumentLoader::shouldOpenExternalURLsPolicyToPropagate() const
1612 {
1613     if (!m_frame || !m_frame->isMainFrame())
1614         return ShouldOpenExternalURLsPolicy::ShouldNotAllow;
1615
1616     return m_shouldOpenExternalURLsPolicy;
1617 }
1618
1619 void DocumentLoader::becomeMainResourceClient()
1620 {
1621 #if ENABLE(CONTENT_FILTERING)
1622     if (m_contentFilter && m_contentFilter->state() == ContentFilter::State::Initialized) {
1623         // ContentFilter will synthesize CachedRawResourceClient callbacks.
1624         m_contentFilter->startFilteringMainResource(*m_mainResource);
1625         return;
1626     }
1627 #endif
1628     m_mainResource->addClient(this);
1629 }
1630
1631 #if ENABLE(CONTENT_EXTENSIONS)
1632 void DocumentLoader::addPendingContentExtensionSheet(const String& identifier, StyleSheetContents& sheet)
1633 {
1634     ASSERT(!m_gotFirstByte);
1635     m_pendingNamedContentExtensionStyleSheets.set(identifier, &sheet);
1636 }
1637
1638 void DocumentLoader::addPendingContentExtensionDisplayNoneSelector(const String& identifier, const String& selector, uint32_t selectorID)
1639 {
1640     ASSERT(!m_gotFirstByte);
1641     auto addResult = m_pendingContentExtensionDisplayNoneSelectors.add(identifier, Vector<std::pair<String, uint32_t>>());
1642     addResult.iterator->value.append(std::make_pair(selector, selectorID));
1643 }
1644 #endif
1645
1646 #if ENABLE(CONTENT_FILTERING)
1647 void DocumentLoader::installContentFilterUnblockHandler(ContentFilter& contentFilter)
1648 {
1649     ContentFilterUnblockHandler unblockHandler { contentFilter.unblockHandler() };
1650     unblockHandler.setUnreachableURL(documentURL());
1651     RefPtr<Frame> frame { this->frame() };
1652     String unblockRequestDeniedScript { contentFilter.unblockRequestDeniedScript() };
1653     if (!unblockRequestDeniedScript.isEmpty() && frame) {
1654         static_assert(std::is_base_of<ThreadSafeRefCounted<Frame>, Frame>::value, "Frame must be ThreadSafeRefCounted.");
1655         StringCapture capturedScript { unblockRequestDeniedScript };
1656         unblockHandler.wrapWithDecisionHandler([frame, capturedScript](bool unblocked) {
1657             if (!unblocked)
1658                 frame->script().executeScript(capturedScript.string());
1659         });
1660     }
1661     frameLoader()->client().contentFilterDidBlockLoad(WTFMove(unblockHandler));
1662 }
1663
1664 void DocumentLoader::contentFilterDidDecide()
1665 {
1666     using State = ContentFilter::State;
1667     ASSERT(m_contentFilter);
1668     ASSERT(m_contentFilter->state() == State::Blocked || m_contentFilter->state() == State::Allowed);
1669     if (m_contentFilter->state() == State::Allowed)
1670         return;
1671
1672     installContentFilterUnblockHandler(*m_contentFilter);
1673
1674     URL blockedURL;
1675     blockedURL.setProtocol(ContentFilter::urlScheme());
1676     blockedURL.setHost(ASCIILiteral("blocked-page"));
1677     auto replacementData = m_contentFilter->replacementData();
1678     ResourceResponse response(URL(), ASCIILiteral("text/html"), replacementData->size(), ASCIILiteral("UTF-8"));
1679     SubstituteData substituteData { adoptRef(&replacementData.leakRef()), documentURL(), response, SubstituteData::SessionHistoryVisibility::Hidden };
1680     frame()->navigationScheduler().scheduleSubstituteDataLoad(blockedURL, substituteData);
1681 }
1682 #endif
1683
1684
1685 } // namespace WebCore