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