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