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