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