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