d219b5e2ad8a2104289d2036f5a973d769c4f750
[WebKit-https.git] / Source / WebCore / loader / DocumentLoader.cpp
1 /*
2  * Copyright (C) 2006-2017 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 "Archive.h"
35 #include "ArchiveResourceCollection.h"
36 #include "CachedPage.h"
37 #include "CachedRawResource.h"
38 #include "CachedResourceLoader.h"
39 #include "ContentExtensionError.h"
40 #include "ContentSecurityPolicy.h"
41 #include "DOMWindow.h"
42 #include "Document.h"
43 #include "DocumentParser.h"
44 #include "DocumentWriter.h"
45 #include "ElementChildIterator.h"
46 #include "Event.h"
47 #include "EventNames.h"
48 #include "ExtensionStyleSheets.h"
49 #include "FormState.h"
50 #include "FrameLoader.h"
51 #include "FrameLoaderClient.h"
52 #include "FrameTree.h"
53 #include "HTMLFormElement.h"
54 #include "HTMLFrameOwnerElement.h"
55 #include "HTTPHeaderField.h"
56 #include "HTTPHeaderNames.h"
57 #include "HistoryItem.h"
58 #include "IconLoader.h"
59 #include "InspectorInstrumentation.h"
60 #include "LinkIconCollector.h"
61 #include "LinkIconType.h"
62 #include "Logging.h"
63 #include "MainFrame.h"
64 #include "MemoryCache.h"
65 #include "NetworkLoadMetrics.h"
66 #include "Page.h"
67 #include "PolicyChecker.h"
68 #include "ProgressTracker.h"
69 #include "ResourceHandle.h"
70 #include "ResourceLoadObserver.h"
71 #include "SWClientConnection.h"
72 #include "SchemeRegistry.h"
73 #include "ScriptableDocumentParser.h"
74 #include "SecurityPolicy.h"
75 #include "ServiceWorker.h"
76 #include "ServiceWorkerProvider.h"
77 #include "Settings.h"
78 #include "SubresourceLoader.h"
79 #include "TextResourceDecoder.h"
80 #include <wtf/Assertions.h>
81 #include <wtf/CompletionHandler.h>
82 #include <wtf/NeverDestroyed.h>
83 #include <wtf/Ref.h>
84 #include <wtf/text/CString.h>
85 #include <wtf/text/WTFString.h>
86
87 #if ENABLE(APPLICATION_MANIFEST)
88 #include "ApplicationManifestLoader.h"
89 #include "HTMLHeadElement.h"
90 #include "HTMLLinkElement.h"
91 #endif
92
93 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
94 #include "ArchiveFactory.h"
95 #endif
96
97 #if ENABLE(CONTENT_FILTERING)
98 #include "ContentFilter.h"
99 #endif
100
101 #if USE(QUICK_LOOK)
102 #include "PreviewConverter.h"
103 #include "QuickLook.h"
104 #endif
105
106 #define RELEASE_LOG_IF_ALLOWED(fmt, ...) RELEASE_LOG_IF(isAlwaysOnLoggingAllowed(), Network, "%p - DocumentLoader::" fmt, this, ##__VA_ARGS__)
107
108 namespace WebCore {
109
110 static void cancelAll(const ResourceLoaderMap& loaders)
111 {
112     for (auto& loader : copyToVector(loaders.values()))
113         loader->cancel();
114 }
115
116 static void setAllDefersLoading(const ResourceLoaderMap& loaders, bool defers)
117 {
118     for (auto& loader : copyToVector(loaders.values()))
119         loader->setDefersLoading(defers);
120 }
121
122 static bool areAllLoadersPageCacheAcceptable(const ResourceLoaderMap& loaders)
123 {
124     for (auto& loader : copyToVector(loaders.values())) {
125         if (!loader->frameLoader() || !loader->frameLoader()->frame().page())
126             return false;
127
128         CachedResource* cachedResource = MemoryCache::singleton().resourceForRequest(loader->request(), loader->frameLoader()->frame().page()->sessionID());
129         if (!cachedResource)
130             return false;
131
132         // Only image and XHR loads do prevent the page from entering the PageCache.
133         // All non-image loads will prevent the page from entering the PageCache.
134         if (!cachedResource->isImage() && !cachedResource->areAllClientsXMLHttpRequests())
135             return false;
136     }
137     return true;
138 }
139
140 DocumentLoader::DocumentLoader(const ResourceRequest& request, const SubstituteData& substituteData)
141     : FrameDestructionObserver(nullptr)
142     , m_cachedResourceLoader(CachedResourceLoader::create(this))
143     , m_writer(m_frame)
144     , m_originalRequest(request)
145     , m_substituteData(substituteData)
146     , m_originalRequestCopy(request)
147     , m_request(request)
148     , m_originalSubstituteDataWasValid(substituteData.isValid())
149     , m_substituteResourceDeliveryTimer(*this, &DocumentLoader::substituteResourceDeliveryTimerFired)
150     , m_dataLoadTimer(*this, &DocumentLoader::handleSubstituteDataLoadNow)
151     , m_applicationCacheHost(std::make_unique<ApplicationCacheHost>(*this))
152 {
153 }
154
155 FrameLoader* DocumentLoader::frameLoader() const
156 {
157     if (!m_frame)
158         return nullptr;
159     return &m_frame->loader();
160 }
161
162 SubresourceLoader* DocumentLoader::mainResourceLoader() const
163 {
164     if (!m_mainResource)
165         return nullptr;
166     return m_mainResource->loader();
167 }
168
169 DocumentLoader::~DocumentLoader()
170 {
171     ASSERT(!m_frame || !isLoading() || frameLoader()->activeDocumentLoader() != this);
172     ASSERT_WITH_MESSAGE(!m_waitingForContentPolicy, "The content policy callback should never outlive its DocumentLoader.");
173     ASSERT_WITH_MESSAGE(!m_waitingForNavigationPolicy, "The navigation policy callback should never outlive its DocumentLoader.");
174
175     m_cachedResourceLoader->clearDocumentLoader();
176     clearMainResource();
177 }
178
179 RefPtr<SharedBuffer> DocumentLoader::mainResourceData() const
180 {
181     if (m_substituteData.isValid())
182         return m_substituteData.content()->copy();
183     if (m_mainResource)
184         return m_mainResource->resourceBuffer();
185     return nullptr;
186 }
187
188 Document* DocumentLoader::document() const
189 {
190     if (m_frame && m_frame->loader().documentLoader() == this)
191         return m_frame->document();
192     return nullptr;
193 }
194
195 void DocumentLoader::replaceRequestURLForSameDocumentNavigation(const URL& url)
196 {
197     m_originalRequestCopy.setURL(url);
198     m_request.setURL(url);
199 }
200
201 void DocumentLoader::setRequest(const ResourceRequest& req)
202 {
203     // Replacing an unreachable URL with alternate content looks like a server-side
204     // redirect at this point, but we can replace a committed dataSource.
205     bool handlingUnreachableURL = false;
206
207     handlingUnreachableURL = m_substituteData.isValid() && !m_substituteData.failingURL().isEmpty();
208
209     bool shouldNotifyAboutProvisionalURLChange = false;
210     if (handlingUnreachableURL)
211         m_committed = false;
212     else if (isLoadingMainResource() && req.url() != m_request.url())
213         shouldNotifyAboutProvisionalURLChange = true;
214
215     // We should never be getting a redirect callback after the data
216     // source is committed, except in the unreachable URL case. It 
217     // would be a WebFoundation bug if it sent a redirect callback after commit.
218     ASSERT(!m_committed);
219
220     m_request = req;
221     if (shouldNotifyAboutProvisionalURLChange)
222         frameLoader()->client().dispatchDidChangeProvisionalURL();
223 }
224
225 void DocumentLoader::setMainDocumentError(const ResourceError& error)
226 {
227     m_mainDocumentError = error;    
228     frameLoader()->client().setMainDocumentError(this, error);
229 }
230
231 void DocumentLoader::mainReceivedError(const ResourceError& error)
232 {
233     ASSERT(!error.isNull());
234
235     if (!frameLoader())
236         return;
237
238     if (m_identifierForLoadWithoutResourceLoader) {
239         ASSERT(!mainResourceLoader());
240         frameLoader()->client().dispatchDidFailLoading(this, m_identifierForLoadWithoutResourceLoader, error);
241     }
242
243     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
244     // See <rdar://problem/6304600> for more details.
245 #if !USE(CF)
246     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
247 #endif
248
249     m_applicationCacheHost->failedLoadingMainResource();
250
251     setMainDocumentError(error);
252     clearMainResourceLoader();
253     frameLoader()->receivedMainResourceError(error);
254 }
255
256 // Cancels the data source's pending loads.  Conceptually, a data source only loads
257 // one document at a time, but one document may have many related resources. 
258 // stopLoading will stop all loads initiated by the data source, 
259 // but not loads initiated by child frames' data sources -- that's the WebFrame's job.
260 void DocumentLoader::stopLoading()
261 {
262     RefPtr<Frame> protectedFrame(m_frame);
263     Ref<DocumentLoader> protectedThis(*this);
264
265     // In some rare cases, calling FrameLoader::stopLoading could cause isLoading() to return false.
266     // (This can happen when there's a single XMLHttpRequest currently loading and stopLoading causes it
267     // to stop loading. Because of this, we need to save it so we don't return early.
268     bool loading = isLoading();
269
270     // We may want to audit the existing subresource loaders when we are on a page which has completed
271     // loading but there are subresource loads during cancellation. This must be done before the
272     // frame->stopLoading() call, which may evict the CachedResources, which we rely on to check
273     // the type of the resource loads.
274     if (loading && m_committed && !mainResourceLoader() && !m_subresourceLoaders.isEmpty())
275         m_subresourceLoadersArePageCacheAcceptable = areAllLoadersPageCacheAcceptable(m_subresourceLoaders);
276
277     if (m_committed) {
278         // Attempt to stop the frame if the document loader is loading, or if it is done loading but
279         // still  parsing. Failure to do so can cause a world leak.
280         Document* doc = m_frame->document();
281         
282         if (loading || doc->parsing())
283             m_frame->loader().stopLoading(UnloadEventPolicyNone);
284     }
285
286     for (auto callbackIdentifier : m_iconLoaders.values())
287         notifyFinishedLoadingIcon(callbackIdentifier, nullptr);
288     m_iconLoaders.clear();
289     m_iconsPendingLoadDecision.clear();
290     
291 #if ENABLE(APPLICATION_MANIFEST)
292     for (auto callbackIdentifier : m_applicationManifestLoaders.values())
293         notifyFinishedLoadingApplicationManifest(callbackIdentifier, std::nullopt);
294     m_applicationManifestLoaders.clear();
295 #endif
296
297     // Always cancel multipart loaders
298     cancelAll(m_multipartSubresourceLoaders);
299
300     // Appcache uses ResourceHandle directly, DocumentLoader doesn't count these loads.
301     m_applicationCacheHost->stopLoadingInFrame(*m_frame);
302     
303 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
304     clearArchiveResources();
305 #endif
306
307     if (!loading) {
308         // If something above restarted loading we might run into mysterious crashes like 
309         // https://bugs.webkit.org/show_bug.cgi?id=62764 and <rdar://problem/9328684>
310         ASSERT(!isLoading());
311         return;
312     }
313
314     // We might run in to infinite recursion if we're stopping loading as the result of 
315     // detaching from the frame, so break out of that recursion here.
316     // See <rdar://problem/9673866> for more details.
317     if (m_isStopping)
318         return;
319
320     m_isStopping = true;
321
322     // The frame may have been detached from this document by the onunload handler
323     if (auto* frameLoader = DocumentLoader::frameLoader()) {
324         if (isLoadingMainResource()) {
325             // Stop the main resource loader and let it send the cancelled message.
326             cancelMainResourceLoad(frameLoader->cancelledError(m_request));
327         } else if (!m_subresourceLoaders.isEmpty() || !m_plugInStreamLoaders.isEmpty()) {
328             // The main resource loader already finished loading. Set the cancelled error on the
329             // document and let the subresourceLoaders and pluginLoaders send individual cancelled messages below.
330             setMainDocumentError(frameLoader->cancelledError(m_request));
331         } else {
332             // If there are no resource loaders, we need to manufacture a cancelled message.
333             // (A back/forward navigation has no resource loaders because its resources are cached.)
334             mainReceivedError(frameLoader->cancelledError(m_request));
335         }
336     }
337
338     // We always need to explicitly cancel the Document's parser when stopping the load.
339     // Otherwise cancelling the parser while starting the next page load might result
340     // in unexpected side effects such as erroneous event dispatch. ( http://webkit.org/b/117112 )
341     if (Document* document = this->document())
342         document->cancelParsing();
343     
344     stopLoadingSubresources();
345     stopLoadingPlugIns();
346     
347     m_isStopping = false;
348 }
349
350 void DocumentLoader::commitIfReady()
351 {
352     if (!m_committed) {
353         m_committed = true;
354         frameLoader()->commitProvisionalLoad();
355     }
356 }
357
358 bool DocumentLoader::isLoading() const
359 {
360     // if (document() && document()->hasActiveParser())
361     //     return true;
362     // FIXME: The above code should be enabled, but it seems to cause
363     // http/tests/security/feed-urls-from-remote.html to timeout on Mac WK1
364     // see http://webkit.org/b/110554 and http://webkit.org/b/110401
365
366     return isLoadingMainResource() || !m_subresourceLoaders.isEmpty() || !m_plugInStreamLoaders.isEmpty();
367 }
368
369 void DocumentLoader::notifyFinished(CachedResource& resource)
370 {
371 #if ENABLE(CONTENT_FILTERING)
372     if (m_contentFilter && !m_contentFilter->continueAfterNotifyFinished(resource))
373         return;
374 #endif
375
376     ASSERT_UNUSED(resource, m_mainResource == &resource);
377     ASSERT(m_mainResource);
378     if (!m_mainResource->errorOccurred() && !m_mainResource->wasCanceled()) {
379         finishedLoading();
380         return;
381     }
382
383     if (m_request.cachePolicy() == ReturnCacheDataDontLoad && !m_mainResource->wasCanceled()) {
384         frameLoader()->retryAfterFailedCacheOnlyMainResourceLoad();
385         return;
386     }
387
388     mainReceivedError(m_mainResource->resourceError());
389 }
390
391 void DocumentLoader::finishedLoading()
392 {
393     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
394     // See <rdar://problem/6304600> for more details.
395 #if !USE(CF)
396     ASSERT(!m_frame->page()->defersLoading() || frameLoader()->stateMachine().creatingInitialEmptyDocument() || InspectorInstrumentation::isDebuggerPaused(m_frame));
397 #endif
398
399     Ref<DocumentLoader> protectedThis(*this);
400
401     if (m_identifierForLoadWithoutResourceLoader) {
402         // A didFinishLoading delegate might try to cancel the load (despite it
403         // being finished). Clear m_identifierForLoadWithoutResourceLoader
404         // before calling dispatchDidFinishLoading so that we don't later try to
405         // cancel the already-finished substitute load.
406         NetworkLoadMetrics emptyMetrics;
407         unsigned long identifier = m_identifierForLoadWithoutResourceLoader;
408         m_identifierForLoadWithoutResourceLoader = 0;
409         frameLoader()->notifier().dispatchDidFinishLoading(this, identifier, emptyMetrics, nullptr);
410     }
411
412     maybeFinishLoadingMultipartContent();
413
414     MonotonicTime responseEndTime = m_timeOfLastDataReceived ? m_timeOfLastDataReceived : MonotonicTime::now();
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(response);
465 }
466
467 void DocumentLoader::startDataLoadTimer()
468 {
469     m_dataLoadTimer.startOneShot(0_s);
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 #if ENABLE(SERVICE_WORKER)
486 void DocumentLoader::matchRegistration(const URL& url, SWClientConnection::RegistrationCallback&& callback)
487 {
488     auto shouldTryLoadingThroughServiceWorker = !frameLoader()->isReloadingFromOrigin() && m_frame->page() && RuntimeEnabledFeatures::sharedFeatures().serviceWorkerEnabled() && SchemeRegistry::canServiceWorkersHandleURLScheme(url.protocol().toStringWithoutCopying());
489     if (!shouldTryLoadingThroughServiceWorker) {
490         callback(std::nullopt);
491         return;
492     }
493
494     auto origin = (!m_frame->isMainFrame() && m_frame->document()) ? makeRef(m_frame->document()->topOrigin()) : SecurityOrigin::create(url);
495     auto sessionID = m_frame->page()->sessionID();
496     auto& provider = ServiceWorkerProvider::singleton();
497     if (!provider.mayHaveServiceWorkerRegisteredForOrigin(sessionID, origin)) {
498         callback(std::nullopt);
499         return;
500     }
501
502     auto& connection = ServiceWorkerProvider::singleton().serviceWorkerConnectionForSession(sessionID);
503     connection.matchRegistration(origin, url, WTFMove(callback));
504 }
505
506 static inline bool areRegistrationsEqual(const std::optional<ServiceWorkerRegistrationData>& a, const std::optional<ServiceWorkerRegistrationData>& b)
507 {
508     if (!a)
509         return !b;
510     if (!b)
511         return false;
512     return a->identifier == b->identifier;
513 }
514 #endif
515
516 void DocumentLoader::redirectReceived(CachedResource& resource, ResourceRequest&& request, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&& completionHandler)
517 {
518     ASSERT_UNUSED(resource, &resource == m_mainResource);
519 #if ENABLE(SERVICE_WORKER)
520     willSendRequest(WTFMove(request), redirectResponse, [completionHandler = WTFMove(completionHandler), protectedThis = makeRef(*this), this] (auto&& request) mutable {
521         if (request.isNull() || !m_mainDocumentError.isNull() || !m_frame) {
522             completionHandler({ });
523             return;
524         }
525         auto url = request.url();
526         matchRegistration(url, [request = WTFMove(request), completionHandler = WTFMove(completionHandler), protectedThis = WTFMove(protectedThis), this] (auto&& registrationData) mutable {
527             if (!m_mainDocumentError.isNull() || !m_frame) {
528                 completionHandler({ });
529                 return;
530             }
531
532             if (areRegistrationsEqual(m_serviceWorkerRegistrationData, registrationData)) {
533                 completionHandler(WTFMove(request));
534                 return;
535             }
536
537             // Service worker registration changed, we need to cancel the current load to restart a new one.
538             clearMainResource();
539             completionHandler({ });
540
541             m_serviceWorkerRegistrationData = WTFMove(registrationData);
542             loadMainResource(WTFMove(request));
543             return;
544         });
545     });
546 #else
547     willSendRequest(WTFMove(request), redirectResponse, WTFMove(completionHandler));
548 #endif
549 }
550
551 void DocumentLoader::willSendRequest(ResourceRequest&& newRequest, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&& completionHandler)
552 {
553     // Note that there are no asserts here as there are for the other callbacks. This is due to the
554     // fact that this "callback" is sent when starting every load, and the state of callback
555     // deferrals plays less of a part in this function in preventing the bad behavior deferring 
556     // callbacks is meant to prevent.
557     ASSERT(!newRequest.isNull());
558
559     bool didReceiveRedirectResponse = !redirectResponse.isNull();
560     if (!frameLoader()->checkIfFormActionAllowedByCSP(newRequest.url(), didReceiveRedirectResponse)) {
561         cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
562         return completionHandler(WTFMove(newRequest));
563     }
564
565     ASSERT(timing().fetchStart());
566     if (didReceiveRedirectResponse) {
567         // If the redirecting url is not allowed to display content from the target origin,
568         // then block the redirect.
569         Ref<SecurityOrigin> redirectingOrigin(SecurityOrigin::create(redirectResponse.url()));
570         if (!redirectingOrigin.get().canDisplay(newRequest.url())) {
571             FrameLoader::reportLocalLoadFailed(m_frame, newRequest.url().string());
572             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
573             return completionHandler(WTFMove(newRequest));
574         }
575         if (!portAllowed(newRequest.url())) {
576             FrameLoader::reportBlockedPortFailed(m_frame, newRequest.url().string());
577             cancelMainResourceLoad(frameLoader()->blockedError(newRequest));
578             return completionHandler(WTFMove(newRequest));
579         }
580         timing().addRedirect(redirectResponse.url(), newRequest.url());
581     }
582
583     ASSERT(m_frame);
584
585     Frame& topFrame = m_frame->tree().top();
586
587     ASSERT(m_frame->document());
588     ASSERT(topFrame.document());
589
590     ResourceLoadObserver::shared().logFrameNavigation(*m_frame, topFrame, newRequest, redirectResponse.url());
591     
592     // Update cookie policy base URL as URL changes, except for subframes, which use the
593     // URL of the main frame which doesn't change when we redirect.
594     if (m_frame->isMainFrame())
595         newRequest.setFirstPartyForCookies(newRequest.url());
596
597     if (!didReceiveRedirectResponse)
598         frameLoader()->client().dispatchWillChangeDocument();
599
600     // If we're fielding a redirect in response to a POST, force a load from origin, since
601     // this is a common site technique to return to a page viewing some data that the POST
602     // just modified.
603     // Also, POST requests always load from origin, but this does not affect subresources.
604     if (newRequest.cachePolicy() == UseProtocolCachePolicy && isPostOrRedirectAfterPost(newRequest, redirectResponse))
605         newRequest.setCachePolicy(ReloadIgnoringCacheData);
606
607     if (&topFrame != m_frame) {
608         if (!m_frame->loader().mixedContentChecker().canDisplayInsecureContent(m_frame->document()->securityOrigin(), MixedContentChecker::ContentType::Active, newRequest.url(), MixedContentChecker::AlwaysDisplayInNonStrictMode::Yes)) {
609             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
610             return completionHandler(WTFMove(newRequest));
611         }
612         if (!frameLoader()->mixedContentChecker().canDisplayInsecureContent(topFrame.document()->securityOrigin(), MixedContentChecker::ContentType::Active, newRequest.url())) {
613             cancelMainResourceLoad(frameLoader()->cancelledError(newRequest));
614             return completionHandler(WTFMove(newRequest));
615         }
616     }
617
618 #if ENABLE(CONTENT_FILTERING)
619     if (m_contentFilter && !m_contentFilter->continueAfterWillSendRequest(newRequest, redirectResponse))
620         return completionHandler(WTFMove(newRequest));
621 #endif
622
623     setRequest(newRequest);
624
625     if (didReceiveRedirectResponse) {
626         // We checked application cache for initial URL, now we need to check it for redirected one.
627         ASSERT(!m_substituteData.isValid());
628         m_applicationCacheHost->maybeLoadMainResourceForRedirect(newRequest, m_substituteData);
629         if (m_substituteData.isValid()) {
630             RELEASE_ASSERT(m_mainResource);
631             ResourceLoader* loader = m_mainResource->loader();
632             m_identifierForLoadWithoutResourceLoader = loader ? loader->identifier() : m_mainResource->identifierForLoadWithoutResourceLoader();
633         }
634     }
635
636     // FIXME: Ideally we'd stop the I/O until we hear back from the navigation policy delegate
637     // listener. But there's no way to do that in practice. So instead we cancel later if the
638     // listener tells us to. In practice that means the navigation policy needs to be decided
639     // synchronously for these redirect cases.
640     if (!didReceiveRedirectResponse)
641         return completionHandler(WTFMove(newRequest));
642
643     ASSERT(!m_waitingForNavigationPolicy);
644     m_waitingForNavigationPolicy = true;
645     frameLoader()->policyChecker().checkNavigationPolicy(ResourceRequest(newRequest), didReceiveRedirectResponse, [this, protectedThis = makeRef(*this), completionHandler = WTFMove(completionHandler)] (ResourceRequest&& request, FormState*, bool shouldContinue) mutable {
646         continueAfterNavigationPolicy(request, shouldContinue);
647         completionHandler(WTFMove(request));
648     });
649 }
650
651 void DocumentLoader::continueAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue)
652 {
653     ASSERT(m_waitingForNavigationPolicy);
654     m_waitingForNavigationPolicy = false;
655     if (!shouldContinue)
656         stopLoadingForPolicyChange();
657     else if (m_substituteData.isValid()) {
658         // A redirect resulted in loading substitute data.
659         ASSERT(timing().redirectCount());
660
661         // We need to remove our reference to the CachedResource in favor of a SubstituteData load.
662         // This will probably trigger the cancellation of the CachedResource's underlying ResourceLoader, though there is a
663         // small chance that the resource is being loaded by a different Frame, preventing the ResourceLoader from being cancelled.
664         // If the ResourceLoader is indeed cancelled, it would normally send resource load callbacks.
665         // However, from an API perspective, this isn't a cancellation. Therefore, sever our relationship with the network load,
666         // but prevent the ResourceLoader from sending ResourceLoadNotifier callbacks.
667         RefPtr<ResourceLoader> resourceLoader = mainResourceLoader();
668         if (resourceLoader) {
669             ASSERT(resourceLoader->shouldSendResourceLoadCallbacks());
670             resourceLoader->setSendCallbackPolicy(DoNotSendCallbacks);
671         }
672
673         clearMainResource();
674
675         if (resourceLoader)
676             resourceLoader->setSendCallbackPolicy(SendCallbacks);
677         handleSubstituteDataLoadSoon();
678     }
679 }
680
681 void DocumentLoader::stopLoadingAfterXFrameOptionsOrContentSecurityPolicyDenied(unsigned long identifier, const ResourceResponse& response)
682 {
683     InspectorInstrumentation::continueAfterXFrameOptionsDenied(*m_frame, identifier, *this, response);
684     m_frame->document()->enforceSandboxFlags(SandboxOrigin);
685     if (HTMLFrameOwnerElement* ownerElement = m_frame->ownerElement())
686         ownerElement->dispatchEvent(Event::create(eventNames().loadEvent, false, false));
687
688     // The load event might have detached this frame. In that case, the load will already have been cancelled during detach.
689     if (FrameLoader* frameLoader = this->frameLoader())
690         cancelMainResourceLoad(frameLoader->cancelledError(m_request));
691 }
692
693 void DocumentLoader::responseReceived(CachedResource& resource, const ResourceResponse& response)
694 {
695     ASSERT_UNUSED(resource, m_mainResource == &resource);
696     responseReceived(response);
697 }
698
699 void DocumentLoader::responseReceived(const ResourceResponse& response)
700 {
701 #if ENABLE(CONTENT_FILTERING)
702     if (m_contentFilter && !m_contentFilter->continueAfterResponseReceived(response))
703         return;
704 #endif
705
706     Ref<DocumentLoader> protectedThis(*this);
707     bool willLoadFallback = m_applicationCacheHost->maybeLoadFallbackForMainResponse(request(), response);
708
709     // The memory cache doesn't understand the application cache or its caching rules. So if a main resource is served
710     // from the application cache, ensure we don't save the result for future use.
711     if (willLoadFallback)
712         MemoryCache::singleton().remove(*m_mainResource);
713
714     if (willLoadFallback)
715         return;
716
717     ASSERT(m_identifierForLoadWithoutResourceLoader || m_mainResource);
718     unsigned long identifier = m_identifierForLoadWithoutResourceLoader ? m_identifierForLoadWithoutResourceLoader : m_mainResource->identifier();
719     ASSERT(identifier);
720     
721     auto url = response.url();
722
723     ContentSecurityPolicy contentSecurityPolicy(SecurityOrigin::create(url), m_frame);
724     contentSecurityPolicy.didReceiveHeaders(ContentSecurityPolicyResponseHeaders(response));
725     if (!contentSecurityPolicy.allowFrameAncestors(*m_frame, url)) {
726         stopLoadingAfterXFrameOptionsOrContentSecurityPolicyDenied(identifier, response);
727         return;
728     }
729
730     const auto& commonHeaders = response.httpHeaderFields().commonHeaders();
731     auto it = commonHeaders.find(HTTPHeaderName::XFrameOptions);
732     if (it != commonHeaders.end()) {
733         String content = it->value;
734         if (frameLoader()->shouldInterruptLoadForXFrameOptions(content, url, identifier)) {
735             String message = "Refused to display '" + url.stringCenterEllipsizedToLength() + "' in a frame because it set 'X-Frame-Options' to '" + content + "'.";
736             m_frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, message, identifier);
737             stopLoadingAfterXFrameOptionsOrContentSecurityPolicyDenied(identifier, response);
738             return;
739         }
740     }
741
742     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
743     // See <rdar://problem/6304600> for more details.
744 #if !USE(CF)
745     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
746 #endif
747
748     if (m_isLoadingMultipartContent) {
749         setupForReplace();
750         m_mainResource->clear();
751     } else if (response.isMultipart())
752         m_isLoadingMultipartContent = true;
753
754     ASSERT(!response.url().isNull());
755     m_response = response;
756
757     if (m_identifierForLoadWithoutResourceLoader) {
758         if (m_mainResource && m_mainResource->wasRedirected()) {
759             ASSERT(m_mainResource->status() == CachedResource::Status::Cached);
760             frameLoader()->client().dispatchDidReceiveServerRedirectForProvisionalLoad();
761         }
762         addResponse(m_response);
763         frameLoader()->notifier().dispatchDidReceiveResponse(this, m_identifierForLoadWithoutResourceLoader, m_response, 0);
764     }
765
766     ASSERT(!m_waitingForContentPolicy);
767     ASSERT(frameLoader());
768     m_waitingForContentPolicy = true;
769
770     // Always show content with valid substitute data.
771     if (m_substituteData.isValid()) {
772         continueAfterContentPolicy(PolicyAction::Use);
773         return;
774     }
775
776 #if ENABLE(FTPDIR)
777     // Respect the hidden FTP Directory Listing pref so it can be tested even if the policy delegate might otherwise disallow it
778     if (m_frame->settings().forceFTPDirectoryListings() && m_response.mimeType() == "application/x-ftp-directory") {
779         continueAfterContentPolicy(PolicyAction::Use);
780         return;
781     }
782 #endif
783
784     frameLoader()->checkContentPolicy(m_response, [this, protectedThis = makeRef(*this)](PolicyAction policy) {
785         continueAfterContentPolicy(policy);
786     });
787 }
788
789 static bool isRemoteWebArchive(const DocumentLoader& documentLoader)
790 {
791     using MIMETypeHashSet = HashSet<String, ASCIICaseInsensitiveHash>;
792     static NeverDestroyed<MIMETypeHashSet> webArchiveMIMETypes {
793         MIMETypeHashSet {
794             ASCIILiteral("application/x-webarchive"),
795             ASCIILiteral("application/x-mimearchive"),
796             ASCIILiteral("multipart/related"),
797 #if PLATFORM(GTK)
798             ASCIILiteral("message/rfc822"),
799 #endif
800         }
801     };
802
803     const ResourceResponse& response = documentLoader.response();
804     String mimeType = response.mimeType();
805     if (mimeType.isNull() || !webArchiveMIMETypes.get().contains(mimeType))
806         return false;
807
808 #if USE(QUICK_LOOK)
809     if (isQuickLookPreviewURL(response.url()))
810         return false;
811 #endif
812
813     return !documentLoader.substituteData().isValid() && !SchemeRegistry::shouldTreatURLSchemeAsLocal(documentLoader.request().url().protocol().toStringWithoutCopying());
814 }
815
816 void DocumentLoader::continueAfterContentPolicy(PolicyAction policy)
817 {
818     ASSERT(m_waitingForContentPolicy);
819     m_waitingForContentPolicy = false;
820     if (isStopping())
821         return;
822
823     switch (policy) {
824     case PolicyAction::Use: {
825         // Prevent remote web archives from loading because they can claim to be from any domain and thus avoid cross-domain security checks (4120255).
826         if (!frameLoader()->client().canShowMIMEType(m_response.mimeType()) || isRemoteWebArchive(*this)) {
827             frameLoader()->policyChecker().cannotShowMIMEType(m_response);
828             // Check reachedTerminalState since the load may have already been canceled inside of _handleUnimplementablePolicyWithErrorCode::.
829             stopLoadingForPolicyChange();
830             return;
831         }
832         break;
833     }
834
835     case PolicyAction::Download: {
836         // m_mainResource can be null, e.g. when loading a substitute resource from application cache.
837         if (!m_mainResource) {
838             mainReceivedError(frameLoader()->client().cannotShowURLError(m_request));
839             return;
840         }
841
842         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
843             InspectorInstrumentation::continueWithPolicyDownload(*m_frame, mainResourceLoader->identifier(), *this, m_response);
844
845         // 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.
846         // Download may use this knowledge for purposes unrelated to cookies, notably for setting file quarantine data.
847         frameLoader()->setOriginalURLForDownloadRequest(m_request);
848
849         PAL::SessionID sessionID = PAL::SessionID::defaultSessionID();
850         if (frame() && frame()->page())
851             sessionID = frame()->page()->sessionID();
852
853         if (m_request.url().protocolIsData()) {
854             // We decode data URL internally, there is no resource load to convert.
855             frameLoader()->client().startDownload(m_request);
856         } else
857             frameLoader()->client().convertMainResourceLoadToDownload(this, sessionID, m_request, m_response);
858
859         // It might have gone missing
860         if (mainResourceLoader())
861             static_cast<ResourceLoader*>(mainResourceLoader())->didFail(interruptedForPolicyChangeError());
862         return;
863     }
864     case PolicyAction::Ignore:
865         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
866             InspectorInstrumentation::continueWithPolicyIgnore(*m_frame, mainResourceLoader->identifier(), *this, m_response);
867         stopLoadingForPolicyChange();
868         return;
869     }
870
871     if (m_response.isHTTP()) {
872         int status = m_response.httpStatusCode(); // Status may be zero when loading substitute data, in particular from a WebArchive.
873         if (status && (status < 200 || status >= 300)) {
874             bool hostedByObject = frameLoader()->isHostedByObjectElement();
875
876             frameLoader()->handleFallbackContent();
877             // object elements are no longer rendered after we fallback, so don't
878             // keep trying to process data from their load
879
880             if (hostedByObject)
881                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
882         }
883     }
884
885     if (!isStopping() && m_substituteData.isValid() && isLoadingMainResource()) {
886         auto content = m_substituteData.content();
887         if (content && content->size())
888             dataReceived(content->data(), content->size());
889         if (isLoadingMainResource())
890             finishedLoading();
891     }
892 }
893
894 void DocumentLoader::commitLoad(const char* data, int length)
895 {
896     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
897     // by starting a new load, so retain temporarily.
898     RefPtr<Frame> protectedFrame(m_frame);
899     Ref<DocumentLoader> protectedThis(*this);
900
901     commitIfReady();
902     FrameLoader* frameLoader = DocumentLoader::frameLoader();
903     if (!frameLoader)
904         return;
905 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
906     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
907         return;
908 #endif
909     frameLoader->client().committedLoad(this, data, length);
910
911     if (isMultipartReplacingLoad())
912         frameLoader->client().didReplaceMultipartContent();
913 }
914
915 ResourceError DocumentLoader::interruptedForPolicyChangeError() const
916 {
917     return frameLoader()->client().interruptedForPolicyChangeError(request());
918 }
919
920 void DocumentLoader::stopLoadingForPolicyChange()
921 {
922     ResourceError error = interruptedForPolicyChangeError();
923     error.setType(ResourceError::Type::Cancellation);
924     cancelMainResourceLoad(error);
925 }
926
927 #if ENABLE(SERVICE_WORKER)
928 static inline bool isLocalURL(const URL& url)
929 {
930     // https://fetch.spec.whatwg.org/#is-local
931     auto protocol = url.protocol().toStringWithoutCopying();
932     return equalLettersIgnoringASCIICase(protocol, "data") || equalLettersIgnoringASCIICase(protocol, "blob") || equalLettersIgnoringASCIICase(protocol, "about");
933 }
934 #endif
935
936 void DocumentLoader::commitData(const char* bytes, size_t length)
937 {
938     if (!m_gotFirstByte) {
939         m_gotFirstByte = true;
940         m_writer.begin(documentURL(), false);
941         m_writer.setDocumentWasLoadedAsPartOfNavigation();
942
943         if (SecurityPolicy::allowSubstituteDataAccessToLocal() && m_originalSubstituteDataWasValid) {
944             // If this document was loaded with substituteData, then the document can
945             // load local resources. See https://bugs.webkit.org/show_bug.cgi?id=16756
946             // and https://bugs.webkit.org/show_bug.cgi?id=19760 for further
947             // discussion.
948             m_frame->document()->securityOrigin().grantLoadLocalResources();
949         }
950
951         if (frameLoader()->stateMachine().creatingInitialEmptyDocument())
952             return;
953
954 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
955         if (m_archive && m_archive->shouldOverrideBaseURL())
956             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
957 #endif
958 #if ENABLE(SERVICE_WORKER)
959         if (RuntimeEnabledFeatures::sharedFeatures().serviceWorkerEnabled()) {
960             // FIXME: We should probably register the client as soon as we do the related navigation fetch.
961             // We can probably implement this when supporting FetchEvent.reservedClientId.
962             if (m_serviceWorkerRegistrationData && m_serviceWorkerRegistrationData->activeWorker) {
963                 m_frame->document()->setActiveServiceWorker(ServiceWorker::getOrCreate(*m_frame->document(), WTFMove(m_serviceWorkerRegistrationData->activeWorker.value())));
964                 m_serviceWorkerRegistrationData = { };
965             } else if (isLocalURL(m_frame->document()->url())) {
966                 if (auto* parent = m_frame->document()->parentDocument())
967                     m_frame->document()->setActiveServiceWorker(parent->activeServiceWorker());
968             }
969
970             if (m_frame->document()->activeServiceWorker() || SchemeRegistry::canServiceWorkersHandleURLScheme(m_frame->document()->url().protocol().toStringWithoutCopying()))
971                 m_frame->document()->setServiceWorkerConnection(ServiceWorkerProvider::singleton().existingServiceWorkerConnectionForSession(m_frame->page()->sessionID()));
972         }
973 #endif
974         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
975         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
976         if (!isMultipartReplacingLoad())
977             frameLoader()->receivedFirstData();
978
979         // The load could be canceled under receivedFirstData(), which makes delegate calls and even sometimes dispatches DOM events.
980         if (!isLoading())
981             return;
982
983         bool userChosen;
984         String encoding;
985         if (overrideEncoding().isNull()) {
986             userChosen = false;
987             encoding = response().textEncodingName();
988 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
989             if (m_archive && m_archive->shouldUseMainResourceEncoding())
990                 encoding = m_archive->mainResource()->textEncoding();
991 #endif
992         } else {
993             userChosen = true;
994             encoding = overrideEncoding();
995         }
996
997         m_writer.setEncoding(encoding, userChosen);
998     }
999
1000 #if ENABLE(CONTENT_EXTENSIONS)
1001     auto& extensionStyleSheets = m_frame->document()->extensionStyleSheets();
1002
1003     for (auto& pendingStyleSheet : m_pendingNamedContentExtensionStyleSheets)
1004         extensionStyleSheets.maybeAddContentExtensionSheet(pendingStyleSheet.key, *pendingStyleSheet.value);
1005     for (auto& pendingSelectorEntry : m_pendingContentExtensionDisplayNoneSelectors) {
1006         for (const auto& pendingSelector : pendingSelectorEntry.value)
1007             extensionStyleSheets.addDisplayNoneSelector(pendingSelectorEntry.key, pendingSelector.first, pendingSelector.second);
1008     }
1009
1010     m_pendingNamedContentExtensionStyleSheets.clear();
1011     m_pendingContentExtensionDisplayNoneSelectors.clear();
1012 #endif
1013
1014     ASSERT(m_frame->document()->parsing());
1015     m_writer.addData(bytes, length);
1016 }
1017
1018 void DocumentLoader::dataReceived(CachedResource& resource, const char* data, int length)
1019 {
1020     ASSERT_UNUSED(resource, &resource == m_mainResource);
1021     dataReceived(data, length);
1022 }
1023
1024 void DocumentLoader::dataReceived(const char* data, int length)
1025 {
1026 #if ENABLE(CONTENT_FILTERING)
1027     if (m_contentFilter && !m_contentFilter->continueAfterDataReceived(data, length))
1028         return;
1029 #endif
1030
1031     ASSERT(data);
1032     ASSERT(length);
1033     ASSERT(!m_response.isNull());
1034
1035     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
1036     // See <rdar://problem/6304600> for more details.
1037 #if !USE(CF)
1038     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
1039 #endif
1040
1041     if (m_identifierForLoadWithoutResourceLoader)
1042         frameLoader()->notifier().dispatchDidReceiveData(this, m_identifierForLoadWithoutResourceLoader, data, length, -1);
1043
1044     m_applicationCacheHost->mainResourceDataReceived(data, length, -1, false);
1045     m_timeOfLastDataReceived = MonotonicTime::now();
1046
1047     if (!isMultipartReplacingLoad())
1048         commitLoad(data, length);
1049 }
1050
1051 void DocumentLoader::setupForReplace()
1052 {
1053     if (!mainResourceData())
1054         return;
1055
1056     frameLoader()->client().willReplaceMultipartContent();
1057     
1058     maybeFinishLoadingMultipartContent();
1059     maybeCreateArchive();
1060     m_writer.end();
1061     frameLoader()->setReplacing();
1062     m_gotFirstByte = false;
1063     
1064     stopLoadingSubresources();
1065     stopLoadingPlugIns();
1066 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1067     clearArchiveResources();
1068 #endif
1069 }
1070
1071 void DocumentLoader::checkLoadComplete()
1072 {
1073     if (!m_frame || isLoading())
1074         return;
1075
1076     ASSERT(this == frameLoader()->activeDocumentLoader());
1077     m_frame->document()->domWindow()->finishedLoading();
1078 }
1079
1080 void DocumentLoader::attachToFrame(Frame& frame)
1081 {
1082     if (m_frame == &frame)
1083         return;
1084
1085     ASSERT(!m_frame);
1086     observeFrame(&frame);
1087     m_writer.setFrame(&frame);
1088     attachToFrame();
1089
1090 #ifndef NDEBUG
1091     m_hasEverBeenAttached = true;
1092 #endif
1093 }
1094
1095 void DocumentLoader::attachToFrame()
1096 {
1097     ASSERT(m_frame);
1098 }
1099
1100 void DocumentLoader::detachFromFrame()
1101 {
1102 #ifndef NDEBUG
1103     if (m_hasEverBeenAttached)
1104         ASSERT_WITH_MESSAGE(m_frame, "detachFromFrame() is being called on a DocumentLoader twice without an attachToFrame() inbetween");
1105     else
1106         ASSERT_WITH_MESSAGE(m_frame, "detachFromFrame() is being called on a DocumentLoader that has never attached to any Frame");
1107 #endif
1108     RefPtr<Frame> protectedFrame(m_frame);
1109     Ref<DocumentLoader> protectedThis(*this);
1110
1111     // It never makes sense to have a document loader that is detached from its
1112     // frame have any loads active, so kill all the loads.
1113     stopLoading();
1114     if (m_mainResource && m_mainResource->hasClient(*this))
1115         m_mainResource->removeClient(*this);
1116 #if ENABLE(CONTENT_FILTERING)
1117     if (m_contentFilter)
1118         m_contentFilter->stopFilteringMainResource();
1119 #endif
1120
1121     m_applicationCacheHost->setDOMApplicationCache(nullptr);
1122
1123     cancelPolicyCheckIfNeeded();
1124
1125     InspectorInstrumentation::loaderDetachedFromFrame(*m_frame, *this);
1126
1127     observeFrame(nullptr);
1128 }
1129
1130 void DocumentLoader::clearMainResourceLoader()
1131 {
1132     m_loadingMainResource = false;
1133
1134     if (this == frameLoader()->activeDocumentLoader())
1135         checkLoadComplete();
1136 }
1137
1138 #if ENABLE(APPLICATION_MANIFEST)
1139 uint64_t DocumentLoader::loadApplicationManifest()
1140 {
1141     static uint64_t nextCallbackID = 1;
1142
1143     auto* document = this->document();
1144     if (!document)
1145         return 0;
1146
1147     if (!m_frame->isMainFrame())
1148         return 0;
1149
1150     if (document->url().isEmpty() || document->url().isBlankURL())
1151         return 0;
1152
1153     auto head = document->head();
1154     if (!head)
1155         return 0;
1156
1157     URL manifestURL;
1158     bool useCredentials = false;
1159     for (const auto& link : childrenOfType<HTMLLinkElement>(*head)) {
1160         if (link.isApplicationManifest()) {
1161             manifestURL = link.href();
1162             useCredentials = equalIgnoringASCIICase(link.attributeWithoutSynchronization(HTMLNames::crossoriginAttr), "use-credentials");
1163             break;
1164         }
1165     }
1166
1167     if (manifestURL.isEmpty() || !manifestURL.isValid())
1168         return 0;
1169
1170     auto manifestLoader = std::make_unique<ApplicationManifestLoader>(*this, manifestURL, useCredentials);
1171     auto* rawManifestLoader = manifestLoader.get();
1172     auto callbackID = nextCallbackID++;
1173     m_applicationManifestLoaders.set(WTFMove(manifestLoader), callbackID);
1174
1175     if (!rawManifestLoader->startLoading()) {
1176         m_applicationManifestLoaders.remove(rawManifestLoader);
1177         return 0;
1178     }
1179
1180     return callbackID;
1181 }
1182
1183 void DocumentLoader::finishedLoadingApplicationManifest(ApplicationManifestLoader& loader)
1184 {
1185     // If the DocumentLoader has detached from its frame, all manifest loads should have already been canceled.
1186     ASSERT(m_frame);
1187
1188     auto callbackIdentifier = m_applicationManifestLoaders.get(&loader);
1189     notifyFinishedLoadingApplicationManifest(callbackIdentifier, loader.processManifest());
1190     m_applicationManifestLoaders.remove(&loader);
1191 }
1192
1193 void DocumentLoader::notifyFinishedLoadingApplicationManifest(uint64_t callbackIdentifier, std::optional<ApplicationManifest> manifest)
1194 {
1195     RELEASE_ASSERT(callbackIdentifier);
1196     RELEASE_ASSERT(m_frame);
1197     m_frame->loader().client().finishedLoadingApplicationManifest(callbackIdentifier, manifest);
1198 }
1199 #endif
1200
1201 void DocumentLoader::setCustomHeaderFields(Vector<HTTPHeaderField>&& fields)
1202 {
1203     m_customHeaderFields = WTFMove(fields);
1204 }
1205
1206 bool DocumentLoader::isLoadingInAPISense() const
1207 {
1208     // Once a frame has loaded, we no longer need to consider subresources,
1209     // but we still need to consider subframes.
1210     if (frameLoader()->state() != FrameStateComplete) {
1211         if (m_frame->settings().needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
1212             return true;
1213
1214         ASSERT(m_frame->document());
1215         auto& document = *m_frame->document();
1216         if ((isLoadingMainResource() || !document.loadEventFinished()) && isLoading())
1217             return true;
1218         if (m_cachedResourceLoader->requestCount())
1219             return true;
1220         if (document.isDelayingLoadEvent())
1221             return true;
1222         if (document.processingLoadEvent())
1223             return true;
1224         if (document.hasActiveParser())
1225             return true;
1226         auto* scriptableParser = document.scriptableDocumentParser();
1227         if (scriptableParser && scriptableParser->hasScriptsWaitingForStylesheets())
1228             return true;
1229     }
1230     return frameLoader()->subframeIsLoading();
1231 }
1232
1233 bool DocumentLoader::maybeCreateArchive()
1234 {
1235 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1236     return false;
1237 #else
1238     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
1239     m_archive = ArchiveFactory::create(m_response.url(), mainResourceData().get(), m_response.mimeType());
1240     if (!m_archive)
1241         return false;
1242     
1243     addAllArchiveResources(*m_archive);
1244     ASSERT(m_archive->mainResource());
1245     auto& mainResource = *m_archive->mainResource();
1246     m_parsedArchiveData = &mainResource.data();
1247     m_writer.setMIMEType(mainResource.mimeType());
1248
1249     ASSERT(m_frame->document());
1250     commitData(mainResource.data().data(), mainResource.data().size());
1251     return true;
1252 #endif
1253 }
1254
1255 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1256
1257 void DocumentLoader::setArchive(Ref<Archive>&& archive)
1258 {
1259     m_archive = WTFMove(archive);
1260     addAllArchiveResources(*m_archive);
1261 }
1262
1263 void DocumentLoader::addAllArchiveResources(Archive& archive)
1264 {
1265     if (!m_archiveResourceCollection)
1266         m_archiveResourceCollection = std::make_unique<ArchiveResourceCollection>();
1267     m_archiveResourceCollection->addAllResources(archive);
1268 }
1269
1270 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
1271 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
1272 void DocumentLoader::addArchiveResource(Ref<ArchiveResource>&& resource)
1273 {
1274     if (!m_archiveResourceCollection)
1275         m_archiveResourceCollection = std::make_unique<ArchiveResourceCollection>();
1276     m_archiveResourceCollection->addResource(WTFMove(resource));
1277 }
1278
1279 RefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const URL& url)
1280 {
1281     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : nullptr;
1282 }
1283
1284 void DocumentLoader::clearArchiveResources()
1285 {
1286     m_archiveResourceCollection = nullptr;
1287     m_substituteResourceDeliveryTimer.stop();
1288 }
1289
1290 SharedBuffer* DocumentLoader::parsedArchiveData() const
1291 {
1292     return m_parsedArchiveData.get();
1293 }
1294
1295 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1296
1297 ArchiveResource* DocumentLoader::archiveResourceForURL(const URL& url) const
1298 {
1299     if (!m_archiveResourceCollection)
1300         return nullptr;
1301     auto* resource = m_archiveResourceCollection->archiveResourceForURL(url);
1302     if (!resource || resource->shouldIgnoreWhenUnarchiving())
1303         return nullptr;
1304     return resource;
1305 }
1306
1307 RefPtr<ArchiveResource> DocumentLoader::mainResource() const
1308 {
1309     RefPtr<SharedBuffer> data = mainResourceData();
1310     if (!data)
1311         data = SharedBuffer::create();
1312     auto& response = this->response();
1313     return ArchiveResource::create(WTFMove(data), response.url(), response.mimeType(), response.textEncodingName(), frame()->tree().uniqueName());
1314 }
1315
1316 RefPtr<ArchiveResource> DocumentLoader::subresource(const URL& url) const
1317 {
1318     if (!isCommitted())
1319         return nullptr;
1320     
1321     auto* resource = m_cachedResourceLoader->cachedResource(url);
1322     if (!resource || !resource->isLoaded())
1323         return archiveResourceForURL(url);
1324
1325     if (resource->type() == CachedResource::MainResource)
1326         return nullptr;
1327
1328     auto* data = resource->resourceBuffer();
1329     if (!data)
1330         return nullptr;
1331
1332     return ArchiveResource::create(data, url, resource->response());
1333 }
1334
1335 Vector<Ref<ArchiveResource>> DocumentLoader::subresources() const
1336 {
1337     if (!isCommitted())
1338         return { };
1339
1340     Vector<Ref<ArchiveResource>> subresources;
1341     for (auto& handle : m_cachedResourceLoader->allCachedResources().values()) {
1342         if (auto subresource = this->subresource({ ParsedURLString, handle->url() }))
1343             subresources.append(subresource.releaseNonNull());
1344     }
1345     return subresources;
1346 }
1347
1348 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
1349 {
1350     if (m_pendingSubstituteResources.isEmpty())
1351         return;
1352     ASSERT(m_frame);
1353     ASSERT(m_frame->page());
1354     if (m_frame->page()->defersLoading())
1355         return;
1356
1357     if (!m_substituteResourceDeliveryTimer.isActive())
1358         m_substituteResourceDeliveryTimer.startOneShot(0_s);
1359 }
1360
1361 void DocumentLoader::substituteResourceDeliveryTimerFired()
1362 {
1363     if (m_pendingSubstituteResources.isEmpty())
1364         return;
1365     ASSERT(m_frame);
1366     ASSERT(m_frame->page());
1367     if (m_frame->page()->defersLoading())
1368         return;
1369
1370     auto pendingSubstituteResources = WTFMove(m_pendingSubstituteResources);
1371     for (auto& pendingSubstituteResource : pendingSubstituteResources) {
1372         auto& loader = pendingSubstituteResource.key;
1373         if (auto& resource = pendingSubstituteResource.value)
1374             resource->deliver(*loader);
1375         else {
1376             // A null resource means that we should fail the load.
1377             // FIXME: Maybe we should use another error here - something like "not in cache".
1378             loader->didFail(loader->cannotShowURLError());
1379         }
1380     }
1381 }
1382
1383 #ifndef NDEBUG
1384
1385 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
1386 {
1387     return m_pendingSubstituteResources.contains(loader);
1388 }
1389
1390 #endif
1391
1392 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
1393 {
1394     if (m_pendingSubstituteResources.isEmpty())
1395         return;
1396     m_pendingSubstituteResources.remove(loader);
1397     if (m_pendingSubstituteResources.isEmpty())
1398         m_substituteResourceDeliveryTimer.stop();
1399 }
1400
1401 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1402
1403 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader& loader, const ResourceRequest& request)
1404 {
1405     if (auto* resource = archiveResourceForURL(request.url())) {
1406         scheduleSubstituteResourceLoad(loader, *resource);
1407         return true;
1408     }
1409
1410     if (!m_archive)
1411         return false;
1412
1413 #if ENABLE(WEB_ARCHIVE)
1414     // The idea of WebArchiveDebugMode is that we should fail instead of trying to fetch from the network.
1415     // Returning true ensures the caller will not try to fetch from the network.
1416     if (m_frame->settings().webArchiveDebugModeEnabled() && responseMIMEType() == "application/x-webarchive")
1417         return true;
1418 #endif
1419
1420     // If we want to load from the archive only, then we should always return true so that the caller
1421     // does not try to fetch form the network.
1422     return m_archive->shouldLoadFromArchiveOnly();
1423 }
1424
1425 #endif
1426
1427 void DocumentLoader::scheduleSubstituteResourceLoad(ResourceLoader& loader, SubstituteResource& resource)
1428 {
1429     m_pendingSubstituteResources.set(&loader, &resource);
1430     deliverSubstituteResourcesAfterDelay();
1431 }
1432
1433 void DocumentLoader::addResponse(const ResourceResponse& response)
1434 {
1435     if (!m_stopRecordingResponses)
1436         m_responses.append(response);
1437 }
1438
1439 void DocumentLoader::stopRecordingResponses()
1440 {
1441     m_stopRecordingResponses = true;
1442     m_responses.shrinkToFit();
1443 }
1444
1445 void DocumentLoader::setTitle(const StringWithDirection& title)
1446 {
1447     if (m_pageTitle == title)
1448         return;
1449
1450     frameLoader()->willChangeTitle(this);
1451     m_pageTitle = title;
1452     frameLoader()->didChangeTitle(this);
1453 }
1454
1455 URL DocumentLoader::urlForHistory() const
1456 {
1457     // Return the URL to be used for history and B/F list.
1458     // Returns nil for WebDataProtocol URLs that aren't alternates
1459     // for unreachable URLs, because these can't be stored in history.
1460     if (m_substituteData.isValid() && !m_substituteData.shouldRevealToSessionHistory())
1461         return unreachableURL();
1462
1463     return m_originalRequestCopy.url();
1464 }
1465
1466 bool DocumentLoader::urlForHistoryReflectsFailure() const
1467 {
1468     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
1469 }
1470
1471 URL DocumentLoader::documentURL() const
1472 {
1473     URL url = substituteData().response().url();
1474 #if ENABLE(WEB_ARCHIVE)
1475     if (url.isEmpty() && m_archive && m_archive->shouldUseMainResourceURL())
1476         url = m_archive->mainResource()->url();
1477 #endif
1478     if (url.isEmpty())
1479         url = m_request.url();
1480     if (url.isEmpty())
1481         url = m_response.url();
1482     return url;
1483 }
1484
1485 #if PLATFORM(IOS)
1486
1487 // FIXME: This method seems to violate the encapsulation of this class.
1488 void DocumentLoader::setResponseMIMEType(const String& responseMimeType)
1489 {
1490     m_response.setMimeType(responseMimeType);
1491 }
1492
1493 #endif
1494
1495 void DocumentLoader::setDefersLoading(bool defers)
1496 {
1497     // Multiple frames may be loading the same main resource simultaneously. If deferral state changes,
1498     // each frame's DocumentLoader will try to send a setDefersLoading() to the same underlying ResourceLoader. Ensure only
1499     // the "owning" DocumentLoader does so, as setDefersLoading() is not resilient to setting the same value repeatedly.
1500     if (mainResourceLoader() && mainResourceLoader()->documentLoader() == this)
1501         mainResourceLoader()->setDefersLoading(defers);
1502
1503     setAllDefersLoading(m_subresourceLoaders, defers);
1504     setAllDefersLoading(m_plugInStreamLoaders, defers);
1505     if (!defers)
1506         deliverSubstituteResourcesAfterDelay();
1507 }
1508
1509 void DocumentLoader::setMainResourceDataBufferingPolicy(DataBufferingPolicy dataBufferingPolicy)
1510 {
1511     if (m_mainResource)
1512         m_mainResource->setDataBufferingPolicy(dataBufferingPolicy);
1513 }
1514
1515 void DocumentLoader::stopLoadingPlugIns()
1516 {
1517     cancelAll(m_plugInStreamLoaders);
1518 }
1519
1520 void DocumentLoader::stopLoadingSubresources()
1521 {
1522     cancelAll(m_subresourceLoaders);
1523     ASSERT(m_subresourceLoaders.isEmpty());
1524 }
1525
1526 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
1527 {
1528     // The main resource's underlying ResourceLoader will ask to be added here.
1529     // It is much simpler to handle special casing of main resource loads if we don't
1530     // let it be added. In the main resource load case, mainResourceLoader()
1531     // will still be null at this point, but m_gotFirstByte should be false here if and only
1532     // if we are just starting the main resource load.
1533     if (!m_gotFirstByte)
1534         return;
1535     ASSERT(loader->identifier());
1536     ASSERT(!m_subresourceLoaders.contains(loader->identifier()));
1537     ASSERT(!mainResourceLoader() || mainResourceLoader() != loader);
1538
1539     // A page in the PageCache or about to enter PageCache should not be able to start loads.
1540     ASSERT_WITH_SECURITY_IMPLICATION(!document() || document()->pageCacheState() == Document::NotInPageCache);
1541
1542     m_subresourceLoaders.add(loader->identifier(), loader);
1543 }
1544
1545 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
1546 {
1547     ASSERT(loader->identifier());
1548
1549     if (!m_subresourceLoaders.remove(loader->identifier()))
1550         return;
1551     checkLoadComplete();
1552     if (Frame* frame = m_frame)
1553         frame->loader().checkLoadComplete();
1554 }
1555
1556 void DocumentLoader::addPlugInStreamLoader(ResourceLoader& loader)
1557 {
1558     ASSERT(loader.identifier());
1559     ASSERT(!m_plugInStreamLoaders.contains(loader.identifier()));
1560
1561     m_plugInStreamLoaders.add(loader.identifier(), &loader);
1562 }
1563
1564 void DocumentLoader::removePlugInStreamLoader(ResourceLoader& loader)
1565 {
1566     ASSERT(loader.identifier());
1567     ASSERT(&loader == m_plugInStreamLoaders.get(loader.identifier()));
1568
1569     m_plugInStreamLoaders.remove(loader.identifier());
1570     checkLoadComplete();
1571 }
1572
1573 bool DocumentLoader::isMultipartReplacingLoad() const
1574 {
1575     return isLoadingMultipartContent() && frameLoader()->isReplacing();
1576 }
1577
1578 bool DocumentLoader::maybeLoadEmpty()
1579 {
1580     bool shouldLoadEmpty = !m_substituteData.isValid() && (m_request.url().isEmpty() || SchemeRegistry::shouldLoadURLSchemeAsEmptyDocument(m_request.url().protocol().toStringWithoutCopying()));
1581     if (!shouldLoadEmpty && !frameLoader()->client().representationExistsForURLScheme(m_request.url().protocol().toStringWithoutCopying()))
1582         return false;
1583
1584     if (m_request.url().isEmpty() && !frameLoader()->stateMachine().creatingInitialEmptyDocument()) {
1585         m_request.setURL(blankURL());
1586         if (isLoadingMainResource())
1587             frameLoader()->client().dispatchDidChangeProvisionalURL();
1588     }
1589
1590     String mimeType = shouldLoadEmpty ? "text/html" : frameLoader()->client().generatedMIMETypeForURLScheme(m_request.url().protocol().toStringWithoutCopying());
1591     m_response = ResourceResponse(m_request.url(), mimeType, 0, String());
1592     finishedLoading();
1593     return true;
1594 }
1595
1596 void DocumentLoader::startLoadingMainResource()
1597 {
1598     m_mainDocumentError = ResourceError();
1599     timing().markStartTimeAndFetchStart();
1600     ASSERT(!m_mainResource);
1601     ASSERT(!m_loadingMainResource);
1602     m_loadingMainResource = true;
1603
1604     if (maybeLoadEmpty()) {
1605         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Returning empty document (frame = %p, main = %d)", m_frame, m_frame ? m_frame->isMainFrame() : false);
1606         return;
1607     }
1608
1609 #if ENABLE(CONTENT_FILTERING)
1610     m_contentFilter = !m_substituteData.isValid() ? ContentFilter::create(*this) : nullptr;
1611 #endif
1612
1613     // FIXME: Is there any way the extra fields could have not been added by now?
1614     // If not, it would be great to remove this line of code.
1615     // Note that currently, some requests may have incorrect extra fields even if this function has been called,
1616     // because we pass a wrong loadType (see FIXME in addExtraFieldsToMainResourceRequest()).
1617     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
1618
1619     ASSERT(timing().startTime());
1620     ASSERT(timing().fetchStart());
1621
1622     willSendRequest(ResourceRequest(m_request), ResourceResponse(), [this, protectedThis = makeRef(*this)] (ResourceRequest&& request) mutable {
1623         m_request = request;
1624
1625         // willSendRequest() may lead to our Frame being detached or cancelling the load via nulling the ResourceRequest.
1626         if (!m_frame || m_request.isNull()) {
1627             RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Load canceled after willSendRequest (frame = %p, main = %d)", m_frame, m_frame ? m_frame->isMainFrame() : false);
1628             return;
1629         }
1630
1631         m_applicationCacheHost->maybeLoadMainResource(m_request, m_substituteData);
1632
1633         if (m_substituteData.isValid() && m_frame->page()) {
1634             RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Returning cached main resource (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1635             m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1636             frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, m_request);
1637             frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, m_request, ResourceResponse());
1638             handleSubstituteDataLoadSoon();
1639             return;
1640         }
1641
1642         request.setRequester(ResourceRequest::Requester::Main);
1643         // If this is a reload the cache layer might have made the previous request conditional. DocumentLoader can't handle 304 responses itself.
1644         request.makeUnconditional();
1645
1646         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Starting load (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1647
1648 #if ENABLE(SERVICE_WORKER)
1649         // FIXME: Implement local URL interception by getting the service worker of the parent.
1650         auto url = request.url();
1651         matchRegistration(url, [request = WTFMove(request), protectedThis = WTFMove(protectedThis), this] (auto&& registrationData) mutable {
1652             if (!m_mainDocumentError.isNull() || !m_frame)
1653                 return;
1654
1655             m_serviceWorkerRegistrationData = WTFMove(registrationData);
1656             loadMainResource(WTFMove(request));
1657         });
1658 #else
1659         loadMainResource(WTFMove(request));
1660 #endif
1661     });
1662 }
1663
1664 static inline FetchOptions::Cache toFetchOptionsCache(ResourceRequestCachePolicy policy)
1665 {
1666     // We are setting FetchOptions::Cache values to keep current behavior consistency.
1667     // FIXME: We should merge FetchOptions::Cache with ResourceRequestCachePolicy and merge related class members.
1668     switch (policy) {
1669     case UseProtocolCachePolicy:
1670         return FetchOptions::Cache::Default;
1671     case ReloadIgnoringCacheData:
1672         return FetchOptions::Cache::Reload;
1673     case ReturnCacheDataElseLoad:
1674         return FetchOptions::Cache::Default;
1675     case ReturnCacheDataDontLoad:
1676         return FetchOptions::Cache::Default;
1677     case DoNotUseAnyCache:
1678         return FetchOptions::Cache::NoStore;
1679     case RefreshAnyCacheData:
1680         return FetchOptions::Cache::NoCache;
1681     }
1682     return FetchOptions::Cache::Default;
1683 }
1684
1685 void DocumentLoader::loadMainResource(ResourceRequest&& request)
1686 {
1687     ResourceLoaderOptions mainResourceLoadOptions { SendCallbacks, SniffContent, BufferData, StoredCredentialsPolicy::Use, ClientCredentialPolicy::MayAskClientForCredentials, FetchOptions::Credentials::Include, SkipSecurityCheck, FetchOptions::Mode::Navigate, IncludeCertificateInfo, ContentSecurityPolicyImposition::SkipPolicyCheck, DefersLoadingPolicy::AllowDefersLoading, CachingPolicy::AllowCaching };
1688     mainResourceLoadOptions.cache = toFetchOptionsCache(request.cachePolicy());
1689
1690     CachedResourceRequest mainResourceRequest(ResourceRequest(request), mainResourceLoadOptions);
1691     if (!m_frame->isMainFrame() && m_frame->document()) {
1692         // If we are loading the main resource of a subframe, use the cache partition of the main document.
1693         mainResourceRequest.setDomainForCachePartition(*m_frame->document());
1694     } else {
1695         auto origin = SecurityOrigin::create(request.url());
1696         origin->setStorageBlockingPolicy(frameLoader()->frame().settings().storageBlockingPolicy());
1697         mainResourceRequest.setDomainForCachePartition(origin->domainForCachePartition());
1698     }
1699
1700 #if ENABLE(SERVICE_WORKER)
1701     mainResourceRequest.setNavigationServiceWorkerRegistrationData(m_serviceWorkerRegistrationData);
1702 #endif
1703
1704     m_mainResource = m_cachedResourceLoader->requestMainResource(WTFMove(mainResourceRequest)).value_or(nullptr);
1705
1706 #if ENABLE(CONTENT_EXTENSIONS)
1707     if (m_mainResource && m_mainResource->errorOccurred() && m_frame->page() && m_mainResource->resourceError().domain() == ContentExtensions::WebKitContentBlockerDomain) {
1708         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Blocked by content blocker error (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1709         cancelMainResourceLoad(frameLoader()->blockedByContentBlockerError(m_request));
1710         return;
1711     }
1712 #endif
1713
1714     if (!m_mainResource) {
1715         if (!m_request.url().isValid()) {
1716             RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Unable to load main resource, URL is invalid (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1717             cancelMainResourceLoad(frameLoader()->client().cannotShowURLError(m_request));
1718             return;
1719         }
1720
1721         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Unable to load main resource, returning empty document (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1722
1723         setRequest(ResourceRequest());
1724         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
1725         // is now in a state where starting an empty load will be inconsistent. Replace it with
1726         // a new ApplicationCacheHost.
1727         m_applicationCacheHost = std::make_unique<ApplicationCacheHost>(*this);
1728         maybeLoadEmpty();
1729         return;
1730     }
1731
1732     if (!mainResourceLoader()) {
1733         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1734         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, request);
1735         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, request, ResourceResponse());
1736     }
1737
1738     becomeMainResourceClient();
1739
1740     // A bunch of headers are set when the underlying ResourceLoader is created, and m_request needs to include those.
1741     if (mainResourceLoader())
1742         request = mainResourceLoader()->originalRequest();
1743     // If there was a fragment identifier on m_request, the cache will have stripped it. m_request should include
1744     // the fragment identifier, so add that back in.
1745     if (equalIgnoringFragmentIdentifier(m_request.url(), request.url()))
1746         request.setURL(m_request.url());
1747     setRequest(request);
1748 }
1749
1750 void DocumentLoader::cancelPolicyCheckIfNeeded()
1751 {
1752     RELEASE_ASSERT(frameLoader());
1753
1754     if (m_waitingForContentPolicy || m_waitingForNavigationPolicy) {
1755         frameLoader()->policyChecker().stopCheck();
1756         m_waitingForContentPolicy = false;
1757         m_waitingForNavigationPolicy = false;
1758     }
1759 }
1760
1761 void DocumentLoader::cancelMainResourceLoad(const ResourceError& resourceError)
1762 {
1763     Ref<DocumentLoader> protectedThis(*this);
1764     ResourceError error = resourceError.isNull() ? frameLoader()->cancelledError(m_request) : resourceError;
1765
1766     m_dataLoadTimer.stop();
1767
1768     cancelPolicyCheckIfNeeded();
1769
1770     if (mainResourceLoader())
1771         mainResourceLoader()->cancel(error);
1772
1773     clearMainResource();
1774
1775     mainReceivedError(error);
1776 }
1777
1778 void DocumentLoader::willContinueMainResourceLoadAfterRedirect(const ResourceRequest& newRequest)
1779 {
1780     setRequest(newRequest);
1781 }
1782
1783 void DocumentLoader::clearMainResource()
1784 {
1785     if (m_mainResource && m_mainResource->hasClient(*this))
1786         m_mainResource->removeClient(*this);
1787 #if ENABLE(CONTENT_FILTERING)
1788     if (m_contentFilter)
1789         m_contentFilter->stopFilteringMainResource();
1790 #endif
1791
1792     m_mainResource = nullptr;
1793 }
1794
1795 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
1796 {
1797     unsigned long identifier = loader->identifier();
1798     ASSERT(identifier);
1799
1800     if (!m_multipartSubresourceLoaders.add(identifier, loader).isNewEntry) {
1801         ASSERT(m_multipartSubresourceLoaders.get(identifier) == loader);
1802         ASSERT(!m_subresourceLoaders.contains(identifier));
1803     } else {
1804         ASSERT(m_subresourceLoaders.contains(identifier));
1805         m_subresourceLoaders.remove(identifier);
1806     }
1807
1808     checkLoadComplete();
1809     if (Frame* frame = m_frame)
1810         frame->loader().checkLoadComplete();    
1811 }
1812
1813 void DocumentLoader::maybeFinishLoadingMultipartContent()
1814 {
1815     if (!isMultipartReplacingLoad())
1816         return;
1817
1818     frameLoader()->setupForReplace();
1819     m_committed = false;
1820     RefPtr<SharedBuffer> resourceData = mainResourceData();
1821     commitLoad(resourceData->data(), resourceData->size());
1822 }
1823
1824 void DocumentLoader::startIconLoading()
1825 {
1826     static uint64_t nextIconCallbackID = 1;
1827
1828     auto* document = this->document();
1829     if (!document)
1830         return;
1831
1832     if (!m_frame->isMainFrame())
1833         return;
1834
1835     if (document->url().isEmpty() || document->url().isBlankURL())
1836         return;
1837
1838     m_linkIcons = LinkIconCollector { *document }.iconsOfTypes({ LinkIconType::Favicon, LinkIconType::TouchIcon, LinkIconType::TouchPrecomposedIcon });
1839
1840     auto findResult = m_linkIcons.findMatching([](auto& icon) { return icon.type == LinkIconType::Favicon; });
1841     if (findResult == notFound)
1842         m_linkIcons.append({ document->completeURL(ASCIILiteral("/favicon.ico")), LinkIconType::Favicon, String(), std::nullopt });
1843
1844     if (!m_linkIcons.size())
1845         return;
1846
1847     Vector<std::pair<WebCore::LinkIcon&, uint64_t>> iconDecisions;
1848     iconDecisions.reserveInitialCapacity(m_linkIcons.size());
1849     for (auto& icon : m_linkIcons) {
1850         auto result = m_iconsPendingLoadDecision.add(nextIconCallbackID++, icon);
1851         iconDecisions.uncheckedAppend({ icon, result.iterator->key });
1852     }
1853
1854     m_frame->loader().client().getLoadDecisionForIcons(iconDecisions);
1855 }
1856
1857 void DocumentLoader::didGetLoadDecisionForIcon(bool decision, uint64_t loadIdentifier, uint64_t newCallbackID)
1858 {
1859     auto icon = m_iconsPendingLoadDecision.take(loadIdentifier);
1860
1861     // If the decision was not to load or this DocumentLoader is already detached, there is no load to perform.
1862     if (!decision || !m_frame)
1863         return;
1864
1865     // If the LinkIcon we just took is empty, then the DocumentLoader had all of its loaders stopped
1866     // while this icon load decision was pending.
1867     // In this case we need to notify the client that the icon finished loading with empty data.
1868     if (icon.url.isEmpty()) {
1869         notifyFinishedLoadingIcon(newCallbackID, nullptr);
1870         return;
1871     }
1872
1873     auto iconLoader = std::make_unique<IconLoader>(*this, icon.url);
1874     auto* rawIconLoader = iconLoader.get();
1875     m_iconLoaders.set(WTFMove(iconLoader), newCallbackID);
1876
1877     rawIconLoader->startLoading();
1878 }
1879
1880 void DocumentLoader::finishedLoadingIcon(IconLoader& loader, SharedBuffer* buffer)
1881 {
1882     // If the DocumentLoader has detached from its frame, all icon loads should have already been cancelled.
1883     ASSERT(m_frame);
1884
1885     auto callbackIdentifier = m_iconLoaders.take(&loader);
1886     notifyFinishedLoadingIcon(callbackIdentifier, buffer);
1887 }
1888
1889 void DocumentLoader::notifyFinishedLoadingIcon(uint64_t callbackIdentifier, SharedBuffer* buffer)
1890 {
1891     RELEASE_ASSERT(callbackIdentifier);
1892     RELEASE_ASSERT(m_frame);
1893     m_frame->loader().client().finishedLoadingIcon(callbackIdentifier, buffer);
1894 }
1895
1896 void DocumentLoader::dispatchOnloadEvents()
1897 {
1898     m_wasOnloadDispatched = true;
1899     m_applicationCacheHost->stopDeferringEvents();
1900 }
1901
1902 void DocumentLoader::setTriggeringAction(const NavigationAction& action)
1903 {
1904     m_triggeringAction = action.copyWithShouldOpenExternalURLsPolicy(m_frame ? shouldOpenExternalURLsPolicyToPropagate() : m_shouldOpenExternalURLsPolicy);
1905 }
1906
1907 ShouldOpenExternalURLsPolicy DocumentLoader::shouldOpenExternalURLsPolicyToPropagate() const
1908 {
1909     if (!m_frame || !m_frame->isMainFrame())
1910         return ShouldOpenExternalURLsPolicy::ShouldNotAllow;
1911
1912     return m_shouldOpenExternalURLsPolicy;
1913 }
1914
1915 void DocumentLoader::becomeMainResourceClient()
1916 {
1917 #if ENABLE(CONTENT_FILTERING)
1918     if (m_contentFilter)
1919         m_contentFilter->startFilteringMainResource(*m_mainResource);
1920 #endif
1921     m_mainResource->addClient(*this);
1922 }
1923
1924 #if ENABLE(CONTENT_EXTENSIONS)
1925 void DocumentLoader::addPendingContentExtensionSheet(const String& identifier, StyleSheetContents& sheet)
1926 {
1927     ASSERT(!m_gotFirstByte);
1928     m_pendingNamedContentExtensionStyleSheets.set(identifier, &sheet);
1929 }
1930
1931 void DocumentLoader::addPendingContentExtensionDisplayNoneSelector(const String& identifier, const String& selector, uint32_t selectorID)
1932 {
1933     ASSERT(!m_gotFirstByte);
1934     auto addResult = m_pendingContentExtensionDisplayNoneSelectors.add(identifier, Vector<std::pair<String, uint32_t>>());
1935     addResult.iterator->value.append(std::make_pair(selector, selectorID));
1936 }
1937 #endif
1938
1939 bool DocumentLoader::isAlwaysOnLoggingAllowed() const
1940 {
1941     return !m_frame || m_frame->isAlwaysOnLoggingAllowed();
1942 }
1943
1944 #if USE(QUICK_LOOK)
1945
1946 void DocumentLoader::setPreviewConverter(std::unique_ptr<PreviewConverter>&& previewConverter)
1947 {
1948     m_previewConverter = WTFMove(previewConverter);
1949 }
1950
1951 PreviewConverter* DocumentLoader::previewConverter() const
1952 {
1953     return m_previewConverter.get();
1954 }
1955
1956 #endif
1957
1958 } // namespace WebCore