Disallow loading webarchives as iframes
[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 // Prevent web archives from loading if it is remote or it is not the main frame because they
845 // can claim to be from any domain and thus avoid cross-domain security checks (4120255, 45524528).
846 bool DocumentLoader::disallowWebArchive() const
847 {
848     using MIMETypeHashSet = HashSet<String, ASCIICaseInsensitiveHash>;
849     static NeverDestroyed<MIMETypeHashSet> webArchiveMIMETypes {
850         MIMETypeHashSet {
851             "application/x-webarchive"_s,
852             "application/x-mimearchive"_s,
853             "multipart/related"_s,
854 #if PLATFORM(GTK)
855             "message/rfc822"_s,
856 #endif
857         }
858     };
859
860     String mimeType = m_response.mimeType();
861     if (mimeType.isNull() || !webArchiveMIMETypes.get().contains(mimeType))
862         return false;
863
864 #if USE(QUICK_LOOK)
865     if (isQuickLookPreviewURL(m_response.url()))
866         return false;
867 #endif
868
869     if (m_substituteData.isValid())
870         return false;
871
872     if (!SchemeRegistry::shouldTreatURLSchemeAsLocal(m_request.url().protocol().toStringWithoutCopying()))
873         return true;
874
875     if (!frame() || frame()->isMainFrame())
876         return false;
877
878     // On purpose of maintaining existing tests.
879     if (!frame()->document() || frame()->document()->topDocument().alwaysAllowLocalWebarchive())
880         return false;
881     return true;
882 }
883
884 void DocumentLoader::continueAfterContentPolicy(PolicyAction policy)
885 {
886     ASSERT(m_waitingForContentPolicy);
887     m_waitingForContentPolicy = false;
888     if (isStopping())
889         return;
890
891     switch (policy) {
892     case PolicyAction::Use: {
893         if (!frameLoader()->client().canShowMIMEType(m_response.mimeType()) || disallowWebArchive()) {
894             frameLoader()->policyChecker().cannotShowMIMEType(m_response);
895             // Check reachedTerminalState since the load may have already been canceled inside of _handleUnimplementablePolicyWithErrorCode::.
896             stopLoadingForPolicyChange();
897             return;
898         }
899         break;
900     }
901
902     case PolicyAction::Download: {
903         // m_mainResource can be null, e.g. when loading a substitute resource from application cache.
904         if (!m_mainResource) {
905             mainReceivedError(frameLoader()->client().cannotShowURLError(m_request));
906             return;
907         }
908
909         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
910             InspectorInstrumentation::continueWithPolicyDownload(*m_frame, mainResourceLoader->identifier(), *this, m_response);
911
912         // 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.
913         // Download may use this knowledge for purposes unrelated to cookies, notably for setting file quarantine data.
914         frameLoader()->setOriginalURLForDownloadRequest(m_request);
915
916         PAL::SessionID sessionID = PAL::SessionID::defaultSessionID();
917         if (frame() && frame()->page())
918             sessionID = frame()->page()->sessionID();
919
920         if (m_request.url().protocolIsData()) {
921             // We decode data URL internally, there is no resource load to convert.
922             frameLoader()->client().startDownload(m_request);
923         } else
924             frameLoader()->client().convertMainResourceLoadToDownload(this, sessionID, m_request, m_response);
925
926         // It might have gone missing
927         if (mainResourceLoader())
928             static_cast<ResourceLoader*>(mainResourceLoader())->didFail(interruptedForPolicyChangeError());
929         return;
930     }
931     case PolicyAction::Suspend:
932         // It is invalid to get a Suspend policy based on navigation response.
933         RELEASE_ASSERT_NOT_REACHED();
934     case PolicyAction::Ignore:
935         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
936             InspectorInstrumentation::continueWithPolicyIgnore(*m_frame, mainResourceLoader->identifier(), *this, m_response);
937         stopLoadingForPolicyChange();
938         return;
939     }
940
941     if (m_response.isHTTP()) {
942         int status = m_response.httpStatusCode(); // Status may be zero when loading substitute data, in particular from a WebArchive.
943         if (status && (status < 200 || status >= 300)) {
944             bool hostedByObject = frameLoader()->isHostedByObjectElement();
945
946             frameLoader()->handleFallbackContent();
947             // object elements are no longer rendered after we fallback, so don't
948             // keep trying to process data from their load
949
950             if (hostedByObject)
951                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
952         }
953     }
954
955     if (!isStopping() && m_substituteData.isValid() && isLoadingMainResource()) {
956         auto content = m_substituteData.content();
957         if (content && content->size())
958             dataReceived(content->data(), content->size());
959         if (isLoadingMainResource())
960             finishedLoading();
961
962         // Remove ourselves as a client of this CachedResource as we've decided to commit substitute data but the
963         // load may keep going and be useful to other clients of the CachedResource. If we did not do this, we
964         // may receive data later on even though this DocumentLoader has finished loading.
965         clearMainResource();
966     }
967 }
968
969 void DocumentLoader::commitLoad(const char* data, int length)
970 {
971     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
972     // by starting a new load, so retain temporarily.
973     RefPtr<Frame> protectedFrame(m_frame);
974     Ref<DocumentLoader> protectedThis(*this);
975
976     commitIfReady();
977     FrameLoader* frameLoader = DocumentLoader::frameLoader();
978     if (!frameLoader)
979         return;
980 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
981     if (ArchiveFactory::isArchiveMIMEType(response().mimeType()))
982         return;
983 #endif
984     frameLoader->client().committedLoad(this, data, length);
985
986     if (isMultipartReplacingLoad())
987         frameLoader->client().didReplaceMultipartContent();
988 }
989
990 ResourceError DocumentLoader::interruptedForPolicyChangeError() const
991 {
992     return frameLoader()->client().interruptedForPolicyChangeError(request());
993 }
994
995 void DocumentLoader::stopLoadingForPolicyChange()
996 {
997     ResourceError error = interruptedForPolicyChangeError();
998     error.setType(ResourceError::Type::Cancellation);
999     cancelMainResourceLoad(error);
1000 }
1001
1002 #if ENABLE(SERVICE_WORKER)
1003 static inline bool isLocalURL(const URL& url)
1004 {
1005     // https://fetch.spec.whatwg.org/#is-local
1006     auto protocol = url.protocol().toStringWithoutCopying();
1007     return equalLettersIgnoringASCIICase(protocol, "data") || equalLettersIgnoringASCIICase(protocol, "blob") || equalLettersIgnoringASCIICase(protocol, "about");
1008 }
1009 #endif
1010
1011 void DocumentLoader::commitData(const char* bytes, size_t length)
1012 {
1013     if (!m_gotFirstByte) {
1014         m_gotFirstByte = true;
1015         bool hasBegun = m_writer.begin(documentURL(), false);
1016         m_writer.setDocumentWasLoadedAsPartOfNavigation();
1017
1018         if (SecurityPolicy::allowSubstituteDataAccessToLocal() && m_originalSubstituteDataWasValid) {
1019             // If this document was loaded with substituteData, then the document can
1020             // load local resources. See https://bugs.webkit.org/show_bug.cgi?id=16756
1021             // and https://bugs.webkit.org/show_bug.cgi?id=19760 for further
1022             // discussion.
1023             m_frame->document()->securityOrigin().grantLoadLocalResources();
1024         }
1025
1026         if (frameLoader()->stateMachine().creatingInitialEmptyDocument())
1027             return;
1028
1029 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1030         if (m_archive && m_archive->shouldOverrideBaseURL())
1031             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
1032 #endif
1033 #if ENABLE(SERVICE_WORKER)
1034         if (RuntimeEnabledFeatures::sharedFeatures().serviceWorkerEnabled()) {
1035             // FIXME: We should probably register the client as soon as we do the related navigation fetch.
1036             // We can probably implement this when supporting FetchEvent.reservedClientId.
1037             if (m_serviceWorkerRegistrationData && m_serviceWorkerRegistrationData->activeWorker) {
1038                 m_frame->document()->setActiveServiceWorker(ServiceWorker::getOrCreate(*m_frame->document(), WTFMove(m_serviceWorkerRegistrationData->activeWorker.value())));
1039                 m_serviceWorkerRegistrationData = { };
1040             } else if (isLocalURL(m_frame->document()->url())) {
1041                 if (auto* parent = m_frame->document()->parentDocument())
1042                     m_frame->document()->setActiveServiceWorker(parent->activeServiceWorker());
1043             }
1044
1045             if (m_frame->document()->activeServiceWorker() || SchemeRegistry::canServiceWorkersHandleURLScheme(m_frame->document()->url().protocol().toStringWithoutCopying()))
1046                 m_frame->document()->setServiceWorkerConnection(ServiceWorkerProvider::singleton().existingServiceWorkerConnectionForSession(m_frame->page()->sessionID()));
1047         }
1048 #endif
1049         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
1050         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
1051         if (!isMultipartReplacingLoad())
1052             frameLoader()->receivedFirstData();
1053
1054         // The load could be canceled under receivedFirstData(), which makes delegate calls and even sometimes dispatches DOM events.
1055         if (!isLoading())
1056             return;
1057
1058         bool userChosen;
1059         String encoding;
1060         if (overrideEncoding().isNull()) {
1061             userChosen = false;
1062             encoding = response().textEncodingName();
1063 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1064             if (m_archive && m_archive->shouldUseMainResourceEncoding())
1065                 encoding = m_archive->mainResource()->textEncoding();
1066 #endif
1067         } else {
1068             userChosen = true;
1069             encoding = overrideEncoding();
1070         }
1071
1072         m_writer.setEncoding(encoding, userChosen);
1073
1074         RELEASE_ASSERT(hasBegun);
1075     }
1076
1077 #if ENABLE(CONTENT_EXTENSIONS)
1078     auto& extensionStyleSheets = m_frame->document()->extensionStyleSheets();
1079
1080     for (auto& pendingStyleSheet : m_pendingNamedContentExtensionStyleSheets)
1081         extensionStyleSheets.maybeAddContentExtensionSheet(pendingStyleSheet.key, *pendingStyleSheet.value);
1082     for (auto& pendingSelectorEntry : m_pendingContentExtensionDisplayNoneSelectors) {
1083         for (const auto& pendingSelector : pendingSelectorEntry.value)
1084             extensionStyleSheets.addDisplayNoneSelector(pendingSelectorEntry.key, pendingSelector.first, pendingSelector.second);
1085     }
1086
1087     m_pendingNamedContentExtensionStyleSheets.clear();
1088     m_pendingContentExtensionDisplayNoneSelectors.clear();
1089 #endif
1090
1091     ASSERT(m_frame->document()->parsing());
1092     m_writer.addData(bytes, length);
1093 }
1094
1095 void DocumentLoader::dataReceived(CachedResource& resource, const char* data, int length)
1096 {
1097     ASSERT_UNUSED(resource, &resource == m_mainResource);
1098     dataReceived(data, length);
1099 }
1100
1101 void DocumentLoader::dataReceived(const char* data, int length)
1102 {
1103 #if ENABLE(CONTENT_FILTERING)
1104     if (m_contentFilter && !m_contentFilter->continueAfterDataReceived(data, length))
1105         return;
1106 #endif
1107
1108     ASSERT(data);
1109     ASSERT(length);
1110     ASSERT(!m_response.isNull());
1111
1112     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
1113     // See <rdar://problem/6304600> for more details.
1114 #if !USE(CF)
1115     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
1116 #endif
1117
1118     if (m_identifierForLoadWithoutResourceLoader)
1119         frameLoader()->notifier().dispatchDidReceiveData(this, m_identifierForLoadWithoutResourceLoader, data, length, -1);
1120
1121     m_applicationCacheHost->mainResourceDataReceived(data, length, -1, false);
1122     m_timeOfLastDataReceived = MonotonicTime::now();
1123
1124     if (!isMultipartReplacingLoad())
1125         commitLoad(data, length);
1126 }
1127
1128 void DocumentLoader::setupForReplace()
1129 {
1130     if (!mainResourceData())
1131         return;
1132
1133     frameLoader()->client().willReplaceMultipartContent();
1134     
1135     maybeFinishLoadingMultipartContent();
1136     maybeCreateArchive();
1137     m_writer.end();
1138     frameLoader()->setReplacing();
1139     m_gotFirstByte = false;
1140     
1141     stopLoadingSubresources();
1142     stopLoadingPlugIns();
1143 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1144     clearArchiveResources();
1145 #endif
1146 }
1147
1148 void DocumentLoader::checkLoadComplete()
1149 {
1150     if (!m_frame || isLoading())
1151         return;
1152
1153     ASSERT(this == frameLoader()->activeDocumentLoader());
1154     m_frame->document()->domWindow()->finishedLoading();
1155 }
1156
1157 void DocumentLoader::attachToFrame(Frame& frame)
1158 {
1159     if (m_frame == &frame)
1160         return;
1161
1162     ASSERT(!m_frame);
1163     observeFrame(&frame);
1164     m_writer.setFrame(&frame);
1165     attachToFrame();
1166
1167 #ifndef NDEBUG
1168     m_hasEverBeenAttached = true;
1169 #endif
1170 }
1171
1172 void DocumentLoader::attachToFrame()
1173 {
1174     ASSERT(m_frame);
1175 }
1176
1177 void DocumentLoader::detachFromFrame()
1178 {
1179 #ifndef NDEBUG
1180     if (m_hasEverBeenAttached)
1181         ASSERT_WITH_MESSAGE(m_frame, "detachFromFrame() is being called on a DocumentLoader twice without an attachToFrame() inbetween");
1182     else
1183         ASSERT_WITH_MESSAGE(m_frame, "detachFromFrame() is being called on a DocumentLoader that has never attached to any Frame");
1184 #endif
1185     RefPtr<Frame> protectedFrame(m_frame);
1186     Ref<DocumentLoader> protectedThis(*this);
1187
1188     // It never makes sense to have a document loader that is detached from its
1189     // frame have any loads active, so kill all the loads.
1190     stopLoading();
1191     if (m_mainResource && m_mainResource->hasClient(*this))
1192         m_mainResource->removeClient(*this);
1193 #if ENABLE(CONTENT_FILTERING)
1194     if (m_contentFilter)
1195         m_contentFilter->stopFilteringMainResource();
1196 #endif
1197
1198     m_applicationCacheHost->setDOMApplicationCache(nullptr);
1199
1200     cancelPolicyCheckIfNeeded();
1201
1202     // cancelPolicyCheckIfNeeded can clear m_frame if the policy check
1203     // is stopped, resulting in a recursive call into this detachFromFrame.
1204     // If m_frame is nullptr after cancelPolicyCheckIfNeeded, our work is
1205     // already done so just return.
1206     if (!m_frame)
1207         return;
1208
1209     InspectorInstrumentation::loaderDetachedFromFrame(*m_frame, *this);
1210
1211     observeFrame(nullptr);
1212 }
1213
1214 void DocumentLoader::clearMainResourceLoader()
1215 {
1216     m_loadingMainResource = false;
1217
1218     if (this == frameLoader()->activeDocumentLoader())
1219         checkLoadComplete();
1220 }
1221
1222 #if ENABLE(APPLICATION_MANIFEST)
1223 uint64_t DocumentLoader::loadApplicationManifest()
1224 {
1225     static uint64_t nextCallbackID = 1;
1226
1227     auto* document = this->document();
1228     if (!document)
1229         return 0;
1230
1231     if (!m_frame->isMainFrame())
1232         return 0;
1233
1234     if (document->url().isEmpty() || document->url().protocolIsAbout())
1235         return 0;
1236
1237     auto head = document->head();
1238     if (!head)
1239         return 0;
1240
1241     URL manifestURL;
1242     bool useCredentials = false;
1243     for (const auto& link : childrenOfType<HTMLLinkElement>(*head)) {
1244         if (link.isApplicationManifest()) {
1245             manifestURL = link.href();
1246             useCredentials = equalIgnoringASCIICase(link.attributeWithoutSynchronization(HTMLNames::crossoriginAttr), "use-credentials");
1247             break;
1248         }
1249     }
1250
1251     if (manifestURL.isEmpty() || !manifestURL.isValid())
1252         return 0;
1253
1254     auto manifestLoader = std::make_unique<ApplicationManifestLoader>(*this, manifestURL, useCredentials);
1255     auto* rawManifestLoader = manifestLoader.get();
1256     auto callbackID = nextCallbackID++;
1257     m_applicationManifestLoaders.set(WTFMove(manifestLoader), callbackID);
1258
1259     if (!rawManifestLoader->startLoading()) {
1260         m_applicationManifestLoaders.remove(rawManifestLoader);
1261         return 0;
1262     }
1263
1264     return callbackID;
1265 }
1266
1267 void DocumentLoader::finishedLoadingApplicationManifest(ApplicationManifestLoader& loader)
1268 {
1269     // If the DocumentLoader has detached from its frame, all manifest loads should have already been canceled.
1270     ASSERT(m_frame);
1271
1272     auto callbackIdentifier = m_applicationManifestLoaders.get(&loader);
1273     notifyFinishedLoadingApplicationManifest(callbackIdentifier, loader.processManifest());
1274     m_applicationManifestLoaders.remove(&loader);
1275 }
1276
1277 void DocumentLoader::notifyFinishedLoadingApplicationManifest(uint64_t callbackIdentifier, std::optional<ApplicationManifest> manifest)
1278 {
1279     RELEASE_ASSERT(callbackIdentifier);
1280     RELEASE_ASSERT(m_frame);
1281     m_frame->loader().client().finishedLoadingApplicationManifest(callbackIdentifier, manifest);
1282 }
1283 #endif
1284
1285 void DocumentLoader::setCustomHeaderFields(Vector<HTTPHeaderField>&& fields)
1286 {
1287     m_customHeaderFields = WTFMove(fields);
1288 }
1289
1290 bool DocumentLoader::isLoadingInAPISense() const
1291 {
1292     // Once a frame has loaded, we no longer need to consider subresources,
1293     // but we still need to consider subframes.
1294     if (frameLoader()->state() != FrameStateComplete) {
1295         if (m_frame->settings().needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
1296             return true;
1297
1298         ASSERT(m_frame->document());
1299         auto& document = *m_frame->document();
1300         if ((isLoadingMainResource() || !document.loadEventFinished()) && isLoading())
1301             return true;
1302         if (m_cachedResourceLoader->requestCount())
1303             return true;
1304         if (document.isDelayingLoadEvent())
1305             return true;
1306         if (document.processingLoadEvent())
1307             return true;
1308         if (document.hasActiveParser())
1309             return true;
1310         auto* scriptableParser = document.scriptableDocumentParser();
1311         if (scriptableParser && scriptableParser->hasScriptsWaitingForStylesheets())
1312             return true;
1313     }
1314     return frameLoader()->subframeIsLoading();
1315 }
1316
1317 bool DocumentLoader::maybeCreateArchive()
1318 {
1319 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1320     return false;
1321 #else
1322     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
1323     m_archive = ArchiveFactory::create(m_response.url(), mainResourceData().get(), m_response.mimeType());
1324     if (!m_archive)
1325         return false;
1326     
1327     addAllArchiveResources(*m_archive);
1328     ASSERT(m_archive->mainResource());
1329     auto& mainResource = *m_archive->mainResource();
1330     m_parsedArchiveData = &mainResource.data();
1331     m_writer.setMIMEType(mainResource.mimeType());
1332
1333     ASSERT(m_frame->document());
1334     commitData(mainResource.data().data(), mainResource.data().size());
1335     return true;
1336 #endif
1337 }
1338
1339 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1340
1341 void DocumentLoader::setArchive(Ref<Archive>&& archive)
1342 {
1343     m_archive = WTFMove(archive);
1344     addAllArchiveResources(*m_archive);
1345 }
1346
1347 void DocumentLoader::addAllArchiveResources(Archive& archive)
1348 {
1349     if (!m_archiveResourceCollection)
1350         m_archiveResourceCollection = std::make_unique<ArchiveResourceCollection>();
1351     m_archiveResourceCollection->addAllResources(archive);
1352 }
1353
1354 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
1355 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
1356 void DocumentLoader::addArchiveResource(Ref<ArchiveResource>&& resource)
1357 {
1358     if (!m_archiveResourceCollection)
1359         m_archiveResourceCollection = std::make_unique<ArchiveResourceCollection>();
1360     m_archiveResourceCollection->addResource(WTFMove(resource));
1361 }
1362
1363 RefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const URL& url)
1364 {
1365     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : nullptr;
1366 }
1367
1368 void DocumentLoader::clearArchiveResources()
1369 {
1370     m_archiveResourceCollection = nullptr;
1371     m_substituteResourceDeliveryTimer.stop();
1372 }
1373
1374 SharedBuffer* DocumentLoader::parsedArchiveData() const
1375 {
1376     return m_parsedArchiveData.get();
1377 }
1378
1379 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1380
1381 ArchiveResource* DocumentLoader::archiveResourceForURL(const URL& url) const
1382 {
1383     if (!m_archiveResourceCollection)
1384         return nullptr;
1385     auto* resource = m_archiveResourceCollection->archiveResourceForURL(url);
1386     if (!resource || resource->shouldIgnoreWhenUnarchiving())
1387         return nullptr;
1388     return resource;
1389 }
1390
1391 RefPtr<ArchiveResource> DocumentLoader::mainResource() const
1392 {
1393     RefPtr<SharedBuffer> data = mainResourceData();
1394     if (!data)
1395         data = SharedBuffer::create();
1396     auto& response = this->response();
1397     return ArchiveResource::create(WTFMove(data), response.url(), response.mimeType(), response.textEncodingName(), frame()->tree().uniqueName());
1398 }
1399
1400 RefPtr<ArchiveResource> DocumentLoader::subresource(const URL& url) const
1401 {
1402     if (!isCommitted())
1403         return nullptr;
1404     
1405     auto* resource = m_cachedResourceLoader->cachedResource(url);
1406     if (!resource || !resource->isLoaded())
1407         return archiveResourceForURL(url);
1408
1409     if (resource->type() == CachedResource::Type::MainResource)
1410         return nullptr;
1411
1412     auto* data = resource->resourceBuffer();
1413     if (!data)
1414         return nullptr;
1415
1416     return ArchiveResource::create(data, url, resource->response());
1417 }
1418
1419 Vector<Ref<ArchiveResource>> DocumentLoader::subresources() const
1420 {
1421     if (!isCommitted())
1422         return { };
1423
1424     Vector<Ref<ArchiveResource>> subresources;
1425     for (auto& handle : m_cachedResourceLoader->allCachedResources().values()) {
1426         if (auto subresource = this->subresource({ { }, handle->url() }))
1427             subresources.append(subresource.releaseNonNull());
1428     }
1429     return subresources;
1430 }
1431
1432 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
1433 {
1434     if (m_pendingSubstituteResources.isEmpty())
1435         return;
1436     ASSERT(m_frame);
1437     ASSERT(m_frame->page());
1438     if (m_frame->page()->defersLoading())
1439         return;
1440
1441     if (!m_substituteResourceDeliveryTimer.isActive())
1442         m_substituteResourceDeliveryTimer.startOneShot(0_s);
1443 }
1444
1445 void DocumentLoader::substituteResourceDeliveryTimerFired()
1446 {
1447     if (m_pendingSubstituteResources.isEmpty())
1448         return;
1449     ASSERT(m_frame);
1450     ASSERT(m_frame->page());
1451     if (m_frame->page()->defersLoading())
1452         return;
1453
1454     auto pendingSubstituteResources = WTFMove(m_pendingSubstituteResources);
1455     for (auto& pendingSubstituteResource : pendingSubstituteResources) {
1456         auto& loader = pendingSubstituteResource.key;
1457         if (auto& resource = pendingSubstituteResource.value)
1458             resource->deliver(*loader);
1459         else {
1460             // A null resource means that we should fail the load.
1461             // FIXME: Maybe we should use another error here - something like "not in cache".
1462             loader->didFail(loader->cannotShowURLError());
1463         }
1464     }
1465 }
1466
1467 #ifndef NDEBUG
1468
1469 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
1470 {
1471     return m_pendingSubstituteResources.contains(loader);
1472 }
1473
1474 #endif
1475
1476 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
1477 {
1478     if (m_pendingSubstituteResources.isEmpty())
1479         return;
1480     m_pendingSubstituteResources.remove(loader);
1481     if (m_pendingSubstituteResources.isEmpty())
1482         m_substituteResourceDeliveryTimer.stop();
1483 }
1484
1485 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1486
1487 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader& loader, const ResourceRequest& request)
1488 {
1489     if (auto* resource = archiveResourceForURL(request.url())) {
1490         scheduleSubstituteResourceLoad(loader, *resource);
1491         return true;
1492     }
1493
1494     if (!m_archive)
1495         return false;
1496
1497 #if ENABLE(WEB_ARCHIVE)
1498     // The idea of WebArchiveDebugMode is that we should fail instead of trying to fetch from the network.
1499     // Returning true ensures the caller will not try to fetch from the network.
1500     if (m_frame->settings().webArchiveDebugModeEnabled() && responseMIMEType() == "application/x-webarchive")
1501         return true;
1502 #endif
1503
1504     // If we want to load from the archive only, then we should always return true so that the caller
1505     // does not try to fetch form the network.
1506     return m_archive->shouldLoadFromArchiveOnly();
1507 }
1508
1509 #endif
1510
1511 void DocumentLoader::scheduleSubstituteResourceLoad(ResourceLoader& loader, SubstituteResource& resource)
1512 {
1513 #if ENABLE(SERVICE_WORKER)
1514     ASSERT(!loader.options().serviceWorkerRegistrationIdentifier);
1515 #endif
1516     m_pendingSubstituteResources.set(&loader, &resource);
1517     deliverSubstituteResourcesAfterDelay();
1518 }
1519
1520 void DocumentLoader::scheduleCannotShowURLError(ResourceLoader& loader)
1521 {
1522     m_pendingSubstituteResources.set(&loader, nullptr);
1523     deliverSubstituteResourcesAfterDelay();
1524 }
1525
1526 void DocumentLoader::addResponse(const ResourceResponse& response)
1527 {
1528     if (!m_stopRecordingResponses)
1529         m_responses.append(response);
1530 }
1531
1532 void DocumentLoader::stopRecordingResponses()
1533 {
1534     m_stopRecordingResponses = true;
1535     m_responses.shrinkToFit();
1536 }
1537
1538 void DocumentLoader::setTitle(const StringWithDirection& title)
1539 {
1540     if (m_pageTitle == title)
1541         return;
1542
1543     frameLoader()->willChangeTitle(this);
1544     m_pageTitle = title;
1545     frameLoader()->didChangeTitle(this);
1546 }
1547
1548 URL DocumentLoader::urlForHistory() const
1549 {
1550     // Return the URL to be used for history and B/F list.
1551     // Returns nil for WebDataProtocol URLs that aren't alternates
1552     // for unreachable URLs, because these can't be stored in history.
1553     if (m_substituteData.isValid() && !m_substituteData.shouldRevealToSessionHistory())
1554         return unreachableURL();
1555
1556     return m_originalRequestCopy.url();
1557 }
1558
1559 bool DocumentLoader::urlForHistoryReflectsFailure() const
1560 {
1561     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
1562 }
1563
1564 URL DocumentLoader::documentURL() const
1565 {
1566     URL url = substituteData().response().url();
1567 #if ENABLE(WEB_ARCHIVE)
1568     if (url.isEmpty() && m_archive && m_archive->shouldUseMainResourceURL())
1569         url = m_archive->mainResource()->url();
1570 #endif
1571     if (url.isEmpty())
1572         url = m_request.url();
1573     if (url.isEmpty())
1574         url = m_response.url();
1575     return url;
1576 }
1577
1578 #if PLATFORM(IOS_FAMILY)
1579
1580 // FIXME: This method seems to violate the encapsulation of this class.
1581 void DocumentLoader::setResponseMIMEType(const String& responseMimeType)
1582 {
1583     m_response.setMimeType(responseMimeType);
1584 }
1585
1586 #endif
1587
1588 void DocumentLoader::setDefersLoading(bool defers)
1589 {
1590     // Multiple frames may be loading the same main resource simultaneously. If deferral state changes,
1591     // each frame's DocumentLoader will try to send a setDefersLoading() to the same underlying ResourceLoader. Ensure only
1592     // the "owning" DocumentLoader does so, as setDefersLoading() is not resilient to setting the same value repeatedly.
1593     if (mainResourceLoader() && mainResourceLoader()->documentLoader() == this)
1594         mainResourceLoader()->setDefersLoading(defers);
1595
1596     setAllDefersLoading(m_subresourceLoaders, defers);
1597     setAllDefersLoading(m_plugInStreamLoaders, defers);
1598     if (!defers)
1599         deliverSubstituteResourcesAfterDelay();
1600 }
1601
1602 void DocumentLoader::setMainResourceDataBufferingPolicy(DataBufferingPolicy dataBufferingPolicy)
1603 {
1604     if (m_mainResource)
1605         m_mainResource->setDataBufferingPolicy(dataBufferingPolicy);
1606 }
1607
1608 void DocumentLoader::stopLoadingPlugIns()
1609 {
1610     cancelAll(m_plugInStreamLoaders);
1611 }
1612
1613 void DocumentLoader::stopLoadingSubresources()
1614 {
1615     cancelAll(m_subresourceLoaders);
1616     ASSERT(m_subresourceLoaders.isEmpty());
1617 }
1618
1619 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
1620 {
1621     // The main resource's underlying ResourceLoader will ask to be added here.
1622     // It is much simpler to handle special casing of main resource loads if we don't
1623     // let it be added. In the main resource load case, mainResourceLoader()
1624     // will still be null at this point, but m_gotFirstByte should be false here if and only
1625     // if we are just starting the main resource load.
1626     if (!m_gotFirstByte)
1627         return;
1628     ASSERT(loader->identifier());
1629     ASSERT(!m_subresourceLoaders.contains(loader->identifier()));
1630     ASSERT(!mainResourceLoader() || mainResourceLoader() != loader);
1631
1632     // Application Cache loaders are handled by their ApplicationCacheGroup directly.
1633     if (loader->options().applicationCacheMode == ApplicationCacheMode::Bypass)
1634         return;
1635
1636     // A page in the PageCache or about to enter PageCache should not be able to start loads.
1637     ASSERT_WITH_SECURITY_IMPLICATION(!document() || document()->pageCacheState() == Document::NotInPageCache);
1638
1639     m_subresourceLoaders.add(loader->identifier(), loader);
1640 }
1641
1642 void DocumentLoader::removeSubresourceLoader(LoadCompletionType type, ResourceLoader* loader)
1643 {
1644     ASSERT(loader->identifier());
1645
1646     if (!m_subresourceLoaders.remove(loader->identifier()))
1647         return;
1648     checkLoadComplete();
1649     if (Frame* frame = m_frame)
1650         frame->loader().subresourceLoadDone(type);
1651 }
1652
1653 void DocumentLoader::addPlugInStreamLoader(ResourceLoader& loader)
1654 {
1655     ASSERT(loader.identifier());
1656     ASSERT(!m_plugInStreamLoaders.contains(loader.identifier()));
1657
1658     m_plugInStreamLoaders.add(loader.identifier(), &loader);
1659 }
1660
1661 void DocumentLoader::removePlugInStreamLoader(ResourceLoader& loader)
1662 {
1663     ASSERT(loader.identifier());
1664     ASSERT(&loader == m_plugInStreamLoaders.get(loader.identifier()));
1665
1666     m_plugInStreamLoaders.remove(loader.identifier());
1667     checkLoadComplete();
1668 }
1669
1670 bool DocumentLoader::isMultipartReplacingLoad() const
1671 {
1672     return isLoadingMultipartContent() && frameLoader()->isReplacing();
1673 }
1674
1675 bool DocumentLoader::maybeLoadEmpty()
1676 {
1677     bool shouldLoadEmpty = !m_substituteData.isValid() && (m_request.url().isEmpty() || SchemeRegistry::shouldLoadURLSchemeAsEmptyDocument(m_request.url().protocol().toStringWithoutCopying()));
1678     if (!shouldLoadEmpty && !frameLoader()->client().representationExistsForURLScheme(m_request.url().protocol().toStringWithoutCopying()))
1679         return false;
1680
1681     if (m_request.url().isEmpty() && !frameLoader()->stateMachine().creatingInitialEmptyDocument()) {
1682         m_request.setURL(blankURL());
1683         if (isLoadingMainResource())
1684             frameLoader()->client().dispatchDidChangeProvisionalURL();
1685     }
1686
1687     String mimeType = shouldLoadEmpty ? "text/html" : frameLoader()->client().generatedMIMETypeForURLScheme(m_request.url().protocol().toStringWithoutCopying());
1688     m_response = ResourceResponse(m_request.url(), mimeType, 0, String());
1689     finishedLoading();
1690     return true;
1691 }
1692
1693 void DocumentLoader::startLoadingMainResource(ShouldContinue shouldContinue)
1694 {
1695     ASSERT(shouldContinue != ShouldContinue::No);
1696
1697     m_mainDocumentError = ResourceError();
1698     timing().markStartTimeAndFetchStart();
1699     ASSERT(!m_mainResource);
1700     ASSERT(!m_loadingMainResource);
1701     m_loadingMainResource = true;
1702
1703     Ref<DocumentLoader> protectedThis(*this);
1704
1705     if (maybeLoadEmpty()) {
1706         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Returning empty document (frame = %p, main = %d)", m_frame, m_frame ? m_frame->isMainFrame() : false);
1707         return;
1708     }
1709
1710 #if ENABLE(CONTENT_FILTERING)
1711     m_contentFilter = !m_substituteData.isValid() ? ContentFilter::create(*this) : nullptr;
1712 #endif
1713
1714     // Make sure we re-apply the user agent to the Document's ResourceRequest upon reload in case the embedding
1715     // application has changed it.
1716     m_request.clearHTTPUserAgent();
1717     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
1718
1719     ASSERT(timing().startTime());
1720     ASSERT(timing().fetchStart());
1721
1722     willSendRequest(ResourceRequest(m_request), ResourceResponse(), shouldContinue, [this, protectedThis = WTFMove(protectedThis)] (ResourceRequest&& request) mutable {
1723         m_request = request;
1724
1725         // willSendRequest() may lead to our Frame being detached or cancelling the load via nulling the ResourceRequest.
1726         if (!m_frame || m_request.isNull()) {
1727             RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Load canceled after willSendRequest (frame = %p, main = %d)", m_frame, m_frame ? m_frame->isMainFrame() : false);
1728             return;
1729         }
1730
1731         request.setRequester(ResourceRequest::Requester::Main);
1732         // If this is a reload the cache layer might have made the previous request conditional. DocumentLoader can't handle 304 responses itself.
1733         request.makeUnconditional();
1734
1735         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Starting load (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1736
1737 #if ENABLE(SERVICE_WORKER)
1738         // FIXME: Implement local URL interception by getting the service worker of the parent.
1739         auto url = request.url();
1740         matchRegistration(url, [request = WTFMove(request), protectedThis = WTFMove(protectedThis), this] (auto&& registrationData) mutable {
1741             if (!m_mainDocumentError.isNull() || !m_frame)
1742                 return;
1743
1744             m_serviceWorkerRegistrationData = WTFMove(registrationData);
1745
1746             // Prefer existing substitute data (from WKWebView.loadData etc) over service worker fetch.
1747             if (this->tryLoadingSubstituteData())
1748                 return;
1749             // Try app cache only if there is no service worker.
1750             if (!m_serviceWorkerRegistrationData && this->tryLoadingRequestFromApplicationCache())
1751                 return;
1752             this->loadMainResource(WTFMove(request));
1753         });
1754 #else
1755         if (tryLoadingRequestFromApplicationCache())
1756             return;
1757         loadMainResource(WTFMove(request));
1758 #endif
1759     });
1760 }
1761
1762 void DocumentLoader::loadMainResource(ResourceRequest&& request)
1763 {
1764     static NeverDestroyed<ResourceLoaderOptions> mainResourceLoadOptions(
1765         SendCallbackPolicy::SendCallbacks,
1766         ContentSniffingPolicy::SniffContent,
1767         DataBufferingPolicy::BufferData,
1768         StoredCredentialsPolicy::Use,
1769         ClientCredentialPolicy::MayAskClientForCredentials,
1770         FetchOptions::Credentials::Include,
1771         SecurityCheckPolicy::SkipSecurityCheck,
1772         FetchOptions::Mode::Navigate,
1773         CertificateInfoPolicy::IncludeCertificateInfo,
1774         ContentSecurityPolicyImposition::SkipPolicyCheck,
1775         DefersLoadingPolicy::AllowDefersLoading,
1776         CachingPolicy::AllowCaching);
1777     CachedResourceRequest mainResourceRequest(WTFMove(request), mainResourceLoadOptions);
1778     if (!m_frame->isMainFrame() && m_frame->document()) {
1779         // If we are loading the main resource of a subframe, use the cache partition of the main document.
1780         mainResourceRequest.setDomainForCachePartition(*m_frame->document());
1781     } else {
1782         auto origin = SecurityOrigin::create(mainResourceRequest.resourceRequest().url());
1783         origin->setStorageBlockingPolicy(frameLoader()->frame().settings().storageBlockingPolicy());
1784         mainResourceRequest.setDomainForCachePartition(origin->domainForCachePartition());
1785     }
1786
1787 #if ENABLE(SERVICE_WORKER)
1788     mainResourceRequest.setNavigationServiceWorkerRegistrationData(m_serviceWorkerRegistrationData);
1789 #endif
1790
1791     m_mainResource = m_cachedResourceLoader->requestMainResource(WTFMove(mainResourceRequest)).value_or(nullptr);
1792
1793     if (!m_mainResource) {
1794         // The frame may have gone away if this load was cancelled synchronously and this was the last pending load.
1795         // This is because we may have fired the load event in a parent frame.
1796         if (!m_frame)
1797             return;
1798
1799         if (!m_request.url().isValid()) {
1800             RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Unable to load main resource, URL is invalid (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1801             cancelMainResourceLoad(frameLoader()->client().cannotShowURLError(m_request));
1802             return;
1803         }
1804
1805         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Unable to load main resource, returning empty document (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1806
1807         setRequest(ResourceRequest());
1808         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
1809         // is now in a state where starting an empty load will be inconsistent. Replace it with
1810         // a new ApplicationCacheHost.
1811         m_applicationCacheHost = std::make_unique<ApplicationCacheHost>(*this);
1812         maybeLoadEmpty();
1813         return;
1814     }
1815
1816     ASSERT(m_frame);
1817
1818 #if ENABLE(CONTENT_EXTENSIONS)
1819     if (m_mainResource->errorOccurred() && m_frame->page() && m_mainResource->resourceError().domain() == ContentExtensions::WebKitContentBlockerDomain) {
1820         RELEASE_LOG_IF_ALLOWED("startLoadingMainResource: Blocked by content blocker error (frame = %p, main = %d)", m_frame, m_frame->isMainFrame());
1821         cancelMainResourceLoad(frameLoader()->blockedByContentBlockerError(m_request));
1822         return;
1823     }
1824 #endif
1825
1826     if (!mainResourceLoader()) {
1827         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1828         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, mainResourceRequest.resourceRequest());
1829         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, mainResourceRequest.resourceRequest(), ResourceResponse());
1830     }
1831
1832     becomeMainResourceClient();
1833
1834     // A bunch of headers are set when the underlying ResourceLoader is created, and m_request needs to include those.
1835     ResourceRequest updatedRequest = mainResourceLoader() ? mainResourceLoader()->originalRequest() : mainResourceRequest.resourceRequest();
1836     // If there was a fragment identifier on m_request, the cache will have stripped it. m_request should include
1837     // the fragment identifier, so add that back in.
1838     if (equalIgnoringFragmentIdentifier(m_request.url(), updatedRequest.url()))
1839         updatedRequest.setURL(m_request.url());
1840     setRequest(updatedRequest);
1841 }
1842
1843 void DocumentLoader::cancelPolicyCheckIfNeeded()
1844 {
1845     if (m_waitingForContentPolicy || m_waitingForNavigationPolicy) {
1846         RELEASE_ASSERT(frameLoader());
1847         frameLoader()->policyChecker().stopCheck();
1848         m_waitingForContentPolicy = false;
1849         m_waitingForNavigationPolicy = false;
1850     }
1851 }
1852
1853 void DocumentLoader::cancelMainResourceLoad(const ResourceError& resourceError)
1854 {
1855     Ref<DocumentLoader> protectedThis(*this);
1856     ResourceError error = resourceError.isNull() ? frameLoader()->cancelledError(m_request) : resourceError;
1857
1858     m_dataLoadTimer.stop();
1859
1860     cancelPolicyCheckIfNeeded();
1861
1862     if (mainResourceLoader())
1863         mainResourceLoader()->cancel(error);
1864
1865     clearMainResource();
1866
1867     mainReceivedError(error);
1868 }
1869
1870 void DocumentLoader::willContinueMainResourceLoadAfterRedirect(const ResourceRequest& newRequest)
1871 {
1872     setRequest(newRequest);
1873 }
1874
1875 void DocumentLoader::clearMainResource()
1876 {
1877     ASSERT(isMainThread());
1878     if (m_mainResource && m_mainResource->hasClient(*this))
1879         m_mainResource->removeClient(*this);
1880 #if ENABLE(CONTENT_FILTERING)
1881     if (m_contentFilter)
1882         m_contentFilter->stopFilteringMainResource();
1883 #endif
1884
1885     m_mainResource = nullptr;
1886 }
1887
1888 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
1889 {
1890     unsigned long identifier = loader->identifier();
1891     ASSERT(identifier);
1892
1893     if (!m_multipartSubresourceLoaders.add(identifier, loader).isNewEntry) {
1894         ASSERT(m_multipartSubresourceLoaders.get(identifier) == loader);
1895         ASSERT(!m_subresourceLoaders.contains(identifier));
1896     } else {
1897         ASSERT(m_subresourceLoaders.contains(identifier));
1898         m_subresourceLoaders.remove(identifier);
1899     }
1900
1901     checkLoadComplete();
1902     if (Frame* frame = m_frame)
1903         frame->loader().checkLoadComplete();    
1904 }
1905
1906 void DocumentLoader::maybeFinishLoadingMultipartContent()
1907 {
1908     if (!isMultipartReplacingLoad())
1909         return;
1910
1911     frameLoader()->setupForReplace();
1912     m_committed = false;
1913     RefPtr<SharedBuffer> resourceData = mainResourceData();
1914     commitLoad(resourceData->data(), resourceData->size());
1915 }
1916
1917 void DocumentLoader::startIconLoading()
1918 {
1919     static uint64_t nextIconCallbackID = 1;
1920
1921     auto* document = this->document();
1922     if (!document)
1923         return;
1924
1925     if (!m_frame->isMainFrame())
1926         return;
1927
1928     if (document->url().isEmpty() || document->url().protocolIsAbout())
1929         return;
1930
1931     m_linkIcons = LinkIconCollector { *document }.iconsOfTypes({ LinkIconType::Favicon, LinkIconType::TouchIcon, LinkIconType::TouchPrecomposedIcon });
1932
1933     auto findResult = m_linkIcons.findMatching([](auto& icon) { return icon.type == LinkIconType::Favicon; });
1934     if (findResult == notFound)
1935         m_linkIcons.append({ document->completeURL("/favicon.ico"_s), LinkIconType::Favicon, String(), std::nullopt, { } });
1936
1937     if (!m_linkIcons.size())
1938         return;
1939
1940     Vector<std::pair<WebCore::LinkIcon&, uint64_t>> iconDecisions;
1941     iconDecisions.reserveInitialCapacity(m_linkIcons.size());
1942     for (auto& icon : m_linkIcons) {
1943         auto result = m_iconsPendingLoadDecision.add(nextIconCallbackID++, icon);
1944         iconDecisions.uncheckedAppend({ icon, result.iterator->key });
1945     }
1946
1947     m_frame->loader().client().getLoadDecisionForIcons(iconDecisions);
1948 }
1949
1950 void DocumentLoader::didGetLoadDecisionForIcon(bool decision, uint64_t loadIdentifier, uint64_t newCallbackID)
1951 {
1952     auto icon = m_iconsPendingLoadDecision.take(loadIdentifier);
1953
1954     // If the decision was not to load or this DocumentLoader is already detached, there is no load to perform.
1955     if (!decision || !m_frame)
1956         return;
1957
1958     // If the LinkIcon we just took is empty, then the DocumentLoader had all of its loaders stopped
1959     // while this icon load decision was pending.
1960     // In this case we need to notify the client that the icon finished loading with empty data.
1961     if (icon.url.isEmpty()) {
1962         notifyFinishedLoadingIcon(newCallbackID, nullptr);
1963         return;
1964     }
1965
1966     auto iconLoader = std::make_unique<IconLoader>(*this, icon.url);
1967     auto* rawIconLoader = iconLoader.get();
1968     m_iconLoaders.set(WTFMove(iconLoader), newCallbackID);
1969
1970     rawIconLoader->startLoading();
1971 }
1972
1973 void DocumentLoader::finishedLoadingIcon(IconLoader& loader, SharedBuffer* buffer)
1974 {
1975     // If the DocumentLoader has detached from its frame, all icon loads should have already been cancelled.
1976     ASSERT(m_frame);
1977
1978     auto callbackIdentifier = m_iconLoaders.take(&loader);
1979     notifyFinishedLoadingIcon(callbackIdentifier, buffer);
1980 }
1981
1982 void DocumentLoader::notifyFinishedLoadingIcon(uint64_t callbackIdentifier, SharedBuffer* buffer)
1983 {
1984     RELEASE_ASSERT(callbackIdentifier);
1985     RELEASE_ASSERT(m_frame);
1986     m_frame->loader().client().finishedLoadingIcon(callbackIdentifier, buffer);
1987 }
1988
1989 void DocumentLoader::dispatchOnloadEvents()
1990 {
1991     m_wasOnloadDispatched = true;
1992     m_applicationCacheHost->stopDeferringEvents();
1993 }
1994
1995 void DocumentLoader::setTriggeringAction(NavigationAction&& action)
1996 {
1997     m_triggeringAction = WTFMove(action);
1998     m_triggeringAction.setShouldOpenExternalURLsPolicy(m_frame ? shouldOpenExternalURLsPolicyToPropagate() : m_shouldOpenExternalURLsPolicy);
1999 }
2000
2001 ShouldOpenExternalURLsPolicy DocumentLoader::shouldOpenExternalURLsPolicyToPropagate() const
2002 {
2003     if (!m_frame || !m_frame->isMainFrame())
2004         return ShouldOpenExternalURLsPolicy::ShouldNotAllow;
2005
2006     return m_shouldOpenExternalURLsPolicy;
2007 }
2008
2009 void DocumentLoader::becomeMainResourceClient()
2010 {
2011 #if ENABLE(CONTENT_FILTERING)
2012     if (m_contentFilter)
2013         m_contentFilter->startFilteringMainResource(*m_mainResource);
2014 #endif
2015     m_mainResource->addClient(*this);
2016 }
2017
2018 #if ENABLE(CONTENT_EXTENSIONS)
2019 void DocumentLoader::addPendingContentExtensionSheet(const String& identifier, StyleSheetContents& sheet)
2020 {
2021     ASSERT(!m_gotFirstByte);
2022     m_pendingNamedContentExtensionStyleSheets.set(identifier, &sheet);
2023 }
2024
2025 void DocumentLoader::addPendingContentExtensionDisplayNoneSelector(const String& identifier, const String& selector, uint32_t selectorID)
2026 {
2027     ASSERT(!m_gotFirstByte);
2028     auto addResult = m_pendingContentExtensionDisplayNoneSelectors.add(identifier, Vector<std::pair<String, uint32_t>>());
2029     addResult.iterator->value.append(std::make_pair(selector, selectorID));
2030 }
2031 #endif
2032
2033 bool DocumentLoader::isAlwaysOnLoggingAllowed() const
2034 {
2035     return !m_frame || m_frame->isAlwaysOnLoggingAllowed();
2036 }
2037
2038 #if USE(QUICK_LOOK)
2039
2040 void DocumentLoader::setPreviewConverter(std::unique_ptr<PreviewConverter>&& previewConverter)
2041 {
2042     m_previewConverter = WTFMove(previewConverter);
2043 }
2044
2045 PreviewConverter* DocumentLoader::previewConverter() const
2046 {
2047     return m_previewConverter.get();
2048 }
2049
2050 #endif
2051
2052 void DocumentLoader::addConsoleMessage(MessageSource messageSource, MessageLevel messageLevel, const String& message, unsigned long requestIdentifier)
2053 {
2054     static_cast<ScriptExecutionContext*>(m_frame->document())->addConsoleMessage(messageSource, messageLevel, message, requestIdentifier);
2055 }
2056
2057 void DocumentLoader::sendCSPViolationReport(URL&& reportURL, Ref<FormData>&& report)
2058 {
2059     PingLoader::sendViolationReport(*m_frame, WTFMove(reportURL), WTFMove(report), ViolationReportType::ContentSecurityPolicy);
2060 }
2061
2062 void DocumentLoader::enqueueSecurityPolicyViolationEvent(SecurityPolicyViolationEvent::Init&& eventInit)
2063 {
2064     m_frame->document()->enqueueSecurityPolicyViolationEvent(WTFMove(eventInit));
2065 }
2066
2067 } // namespace WebCore