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