HTTPHeaderMap should not derive from HashMap
[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     auto it = response.httpHeaderFields().find("x-frame-options");
608     if (it != response.httpHeaderFields().end()) {
609         String content = it->value;
610         ASSERT(m_mainResource);
611         unsigned long identifier = m_identifierForLoadWithoutResourceLoader ? m_identifierForLoadWithoutResourceLoader : m_mainResource->identifier();
612         ASSERT(identifier);
613         if (frameLoader()->shouldInterruptLoadForXFrameOptions(content, response.url(), identifier)) {
614             InspectorInstrumentation::continueAfterXFrameOptionsDenied(m_frame, this, identifier, response);
615             String message = "Refused to display '" + response.url().stringCenterEllipsizedToLength() + "' in a frame because it set 'X-Frame-Options' to '" + content + "'.";
616             frame()->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, message, identifier);
617             frame()->document()->enforceSandboxFlags(SandboxOrigin);
618             if (HTMLFrameOwnerElement* ownerElement = frame()->ownerElement())
619                 ownerElement->dispatchEvent(Event::create(eventNames().loadEvent, false, false));
620
621             // The load event might have detached this frame. In that case, the load will already have been cancelled during detach.
622             if (frameLoader())
623                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
624             return;
625         }
626     }
627
628     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
629     // See <rdar://problem/6304600> for more details.
630 #if !USE(CF)
631     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
632 #endif
633
634     if (m_isLoadingMultipartContent) {
635         setupForReplace();
636         m_mainResource->clear();
637     } else if (response.isMultipart())
638         m_isLoadingMultipartContent = true;
639
640     m_response = response;
641
642     if (m_identifierForLoadWithoutResourceLoader) {
643         addResponse(m_response);
644         frameLoader()->notifier().dispatchDidReceiveResponse(this, m_identifierForLoadWithoutResourceLoader, m_response, 0);
645     }
646
647     ASSERT(!m_waitingForContentPolicy);
648     m_waitingForContentPolicy = true;
649
650     // Always show content with valid substitute data.
651     if (m_substituteData.isValid()) {
652         continueAfterContentPolicy(PolicyUse);
653         return;
654     }
655
656 #if ENABLE(FTPDIR)
657     // Respect the hidden FTP Directory Listing pref so it can be tested even if the policy delegate might otherwise disallow it
658     if (m_frame->settings().forceFTPDirectoryListings() && m_response.mimeType() == "application/x-ftp-directory") {
659         continueAfterContentPolicy(PolicyUse);
660         return;
661     }
662 #endif
663
664 #if USE(CONTENT_FILTERING)
665     if (response.url().protocolIsInHTTPFamily() && ContentFilter::isEnabled())
666         m_contentFilter = ContentFilter::create(response);
667 #endif
668
669     frameLoader()->policyChecker().checkContentPolicy(m_response, [this](PolicyAction policy) {
670         continueAfterContentPolicy(policy);
671     });
672 }
673
674 void DocumentLoader::continueAfterContentPolicy(PolicyAction policy)
675 {
676     ASSERT(m_waitingForContentPolicy);
677     m_waitingForContentPolicy = false;
678     if (isStopping())
679         return;
680
681     URL url = m_request.url();
682     const String& mimeType = m_response.mimeType();
683     
684     switch (policy) {
685     case PolicyUse: {
686         // Prevent remote web archives from loading because they can claim to be from any domain and thus avoid cross-domain security checks (4120255).
687         bool isRemoteWebArchive = (equalIgnoringCase("application/x-webarchive", mimeType)
688             || equalIgnoringCase("application/x-mimearchive", mimeType)
689 #if PLATFORM(GTK)
690             || equalIgnoringCase("message/rfc822", mimeType)
691 #endif
692             || equalIgnoringCase("multipart/related", mimeType))
693             && !m_substituteData.isValid() && !SchemeRegistry::shouldTreatURLSchemeAsLocal(url.protocol());
694         if (!frameLoader()->client().canShowMIMEType(mimeType) || isRemoteWebArchive) {
695             frameLoader()->policyChecker().cannotShowMIMEType(m_response);
696             // Check reachedTerminalState since the load may have already been canceled inside of _handleUnimplementablePolicyWithErrorCode::.
697             stopLoadingForPolicyChange();
698             return;
699         }
700         break;
701     }
702
703     case PolicyDownload: {
704         // m_mainResource can be null, e.g. when loading a substitute resource from application cache.
705         if (!m_mainResource) {
706             mainReceivedError(frameLoader()->client().cannotShowURLError(m_request));
707             return;
708         }
709
710         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
711             InspectorInstrumentation::continueWithPolicyDownload(m_frame, this, mainResourceLoader->identifier(), m_response);
712
713         // 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.
714         // Download may use this knowledge for purposes unrelated to cookies, notably for setting file quarantine data.
715         frameLoader()->setOriginalURLForDownloadRequest(m_request);
716         frameLoader()->client().convertMainResourceLoadToDownload(this, m_request, m_response);
717
718         // It might have gone missing
719         if (mainResourceLoader())
720             mainResourceLoader()->didFail(interruptedForPolicyChangeError());
721         return;
722     }
723     case PolicyIgnore:
724         if (ResourceLoader* mainResourceLoader = this->mainResourceLoader())
725             InspectorInstrumentation::continueWithPolicyIgnore(m_frame, this, mainResourceLoader->identifier(), m_response);
726         stopLoadingForPolicyChange();
727         return;
728     
729     default:
730         ASSERT_NOT_REACHED();
731     }
732
733     if (m_response.isHTTP()) {
734         int status = m_response.httpStatusCode(); // Status may be zero when loading substitute data, in particular from a WebArchive.
735         if (status && (status < 200 || status >= 300)) {
736             bool hostedByObject = frameLoader()->isHostedByObjectElement();
737
738             frameLoader()->handleFallbackContent();
739             // object elements are no longer rendered after we fallback, so don't
740             // keep trying to process data from their load
741
742             if (hostedByObject)
743                 cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
744         }
745     }
746
747     if (!isStopping() && m_substituteData.isValid() && isLoadingMainResource()) {
748         if (m_substituteData.content()->size())
749             dataReceived(0, m_substituteData.content()->data(), m_substituteData.content()->size());
750         if (isLoadingMainResource())
751             finishedLoading(0);
752     }
753 }
754
755 void DocumentLoader::commitLoad(const char* data, int length)
756 {
757     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
758     // by starting a new load, so retain temporarily.
759     RefPtr<Frame> protectFrame(m_frame);
760     Ref<DocumentLoader> protectLoader(*this);
761
762     commitIfReady();
763     FrameLoader* frameLoader = DocumentLoader::frameLoader();
764     if (!frameLoader)
765         return;
766 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
767     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
768         return;
769 #endif
770     frameLoader->client().committedLoad(this, data, length);
771 }
772
773 ResourceError DocumentLoader::interruptedForPolicyChangeError() const
774 {
775     return frameLoader()->client().interruptedForPolicyChangeError(request());
776 }
777
778 void DocumentLoader::stopLoadingForPolicyChange()
779 {
780     ResourceError error = interruptedForPolicyChangeError();
781     error.setIsCancellation(true);
782     cancelMainResourceLoad(error);
783 }
784
785 void DocumentLoader::commitData(const char* bytes, size_t length)
786 {
787     if (!m_gotFirstByte) {
788         m_gotFirstByte = true;
789         m_writer.begin(documentURL(), false);
790         m_writer.setDocumentWasLoadedAsPartOfNavigation();
791
792         if (SecurityPolicy::allowSubstituteDataAccessToLocal() && m_originalSubstituteDataWasValid) {
793             // If this document was loaded with substituteData, then the document can
794             // load local resources. See https://bugs.webkit.org/show_bug.cgi?id=16756
795             // and https://bugs.webkit.org/show_bug.cgi?id=19760 for further
796             // discussion.
797             m_frame->document()->securityOrigin()->grantLoadLocalResources();
798         }
799
800         if (frameLoader()->stateMachine().creatingInitialEmptyDocument())
801             return;
802         
803 #if ENABLE(MHTML)
804         // The origin is the MHTML file, we need to set the base URL to the document encoded in the MHTML so
805         // relative URLs are resolved properly.
806         if (m_archive && m_archive->type() == Archive::MHTML)
807             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
808 #endif
809
810         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
811         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
812         if (!isMultipartReplacingLoad())
813             frameLoader()->receivedFirstData();
814
815         bool userChosen;
816         String encoding;
817 #if USE(CONTENT_FILTERING)
818         // The content filter's replacement data has a known encoding that might
819         // differ from the response's encoding.
820         if (m_contentFilter && m_contentFilter->didBlockData()) {
821             ASSERT(!m_contentFilter->needsMoreData());
822             userChosen = false;
823         } else
824 #endif
825         if (overrideEncoding().isNull()) {
826             userChosen = false;
827             encoding = response().textEncodingName();
828 #if ENABLE(WEB_ARCHIVE)
829             if (m_archive && m_archive->type() == Archive::WebArchive)
830                 encoding = m_archive->mainResource()->textEncoding();
831 #endif
832         } else {
833             userChosen = true;
834             encoding = overrideEncoding();
835         }
836
837         m_writer.setEncoding(encoding, userChosen);
838     }
839     ASSERT(m_frame->document()->parsing());
840     m_writer.addData(bytes, length);
841 }
842
843 void DocumentLoader::dataReceived(CachedResource* resource, const char* data, int length)
844 {
845     ASSERT(data);
846     ASSERT(length);
847     ASSERT_UNUSED(resource, resource == m_mainResource);
848     ASSERT(!m_response.isNull());
849
850     // There is a bug in CFNetwork where callbacks can be dispatched even when loads are deferred.
851     // See <rdar://problem/6304600> for more details.
852 #if !USE(CF)
853     ASSERT(!mainResourceLoader() || !mainResourceLoader()->defersLoading());
854 #endif
855
856 #if USE(CONTENT_FILTERING)
857     bool loadWasBlockedBeforeFinishing = false;
858     if (m_contentFilter && m_contentFilter->needsMoreData()) {
859         m_contentFilter->addData(data, length);
860
861         if (m_contentFilter->needsMoreData()) {
862             // Since the filter still needs more data to make a decision,
863             // avoid committing this data to prevent partial rendering of
864             // content that might later be blocked.
865             return;
866         }
867
868         data = m_contentFilter->getReplacementData(length);
869         loadWasBlockedBeforeFinishing = m_contentFilter->didBlockData();
870
871         if (loadWasBlockedBeforeFinishing)
872             setContentFilterForBlockedLoad(m_contentFilter);
873     }
874 #endif
875
876     if (m_identifierForLoadWithoutResourceLoader)
877         frameLoader()->notifier().dispatchDidReceiveData(this, m_identifierForLoadWithoutResourceLoader, data, length, -1);
878
879     m_applicationCacheHost->mainResourceDataReceived(data, length, -1, false);
880     m_timeOfLastDataReceived = monotonicallyIncreasingTime();
881
882     if (!isMultipartReplacingLoad())
883         commitLoad(data, length);
884
885 #if USE(CONTENT_FILTERING)
886     if (loadWasBlockedBeforeFinishing)
887         cancelMainResourceLoad(frameLoader()->cancelledError(m_request));
888 #endif
889 }
890
891 void DocumentLoader::setupForReplace()
892 {
893     if (!mainResourceData())
894         return;
895     
896     maybeFinishLoadingMultipartContent();
897     maybeCreateArchive();
898     m_writer.end();
899     frameLoader()->setReplacing();
900     m_gotFirstByte = false;
901     
902     stopLoadingSubresources();
903     stopLoadingPlugIns();
904 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
905     clearArchiveResources();
906 #endif
907 }
908
909 void DocumentLoader::checkLoadComplete()
910 {
911     if (!m_frame || isLoading())
912         return;
913
914     ASSERT(this == frameLoader()->activeDocumentLoader());
915     m_frame->document()->domWindow()->finishedLoading();
916 }
917
918 void DocumentLoader::setFrame(Frame* frame)
919 {
920     if (m_frame == frame)
921         return;
922     ASSERT(frame && !m_frame);
923     m_frame = frame;
924     m_writer.setFrame(frame);
925     attachToFrame();
926 }
927
928 void DocumentLoader::attachToFrame()
929 {
930     ASSERT(m_frame);
931 }
932
933 void DocumentLoader::detachFromFrame()
934 {
935     ASSERT(m_frame);
936     RefPtr<Frame> protectFrame(m_frame);
937     Ref<DocumentLoader> protectLoader(*this);
938
939     // It never makes sense to have a document loader that is detached from its
940     // frame have any loads active, so go ahead and kill all the loads.
941     stopLoading();
942     if (m_mainResource && m_mainResource->hasClient(this))
943         m_mainResource->removeClient(this);
944
945     m_applicationCacheHost->setDOMApplicationCache(0);
946     InspectorInstrumentation::loaderDetachedFromFrame(m_frame, this);
947     m_frame = 0;
948 }
949
950 void DocumentLoader::clearMainResourceLoader()
951 {
952     m_loadingMainResource = false;
953
954 #if PLATFORM(IOS)
955     // FIXME: Remove PLATFORM(IOS)-guard once we upstream the iOS changes to ResourceRequest.h.
956     m_request.setMainResourceRequest(false);
957 #endif
958
959     if (this == frameLoader()->activeDocumentLoader())
960         checkLoadComplete();
961 }
962
963 bool DocumentLoader::isLoadingInAPISense() const
964 {
965     // Once a frame has loaded, we no longer need to consider subresources,
966     // but we still need to consider subframes.
967     if (frameLoader()->state() != FrameStateComplete) {
968         if (m_frame->settings().needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
969             return true;
970     
971         Document* doc = m_frame->document();
972         if ((isLoadingMainResource() || !m_frame->document()->loadEventFinished()) && isLoading())
973             return true;
974         if (m_cachedResourceLoader->requestCount())
975             return true;
976         if (doc->processingLoadEvent())
977             return true;
978         if (doc->hasActiveParser())
979             return true;
980     }
981     return frameLoader()->subframeIsLoading();
982 }
983
984 bool DocumentLoader::maybeCreateArchive()
985 {
986 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
987     return false;
988 #else
989     
990     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
991     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
992     m_archive = ArchiveFactory::create(m_response.url(), mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0, m_response.mimeType());
993     if (!m_archive)
994         return false;
995     
996     addAllArchiveResources(m_archive.get());
997     ArchiveResource* mainResource = m_archive->mainResource();
998     m_parsedArchiveData = mainResource->data();
999     m_writer.setMIMEType(mainResource->mimeType());
1000     
1001     ASSERT(m_frame->document());
1002     commitData(mainResource->data()->data(), mainResource->data()->size());
1003     return true;
1004 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
1005 }
1006
1007 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1008 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
1009 {
1010     m_archive = archive;
1011     addAllArchiveResources(m_archive.get());
1012 }
1013
1014 void DocumentLoader::addAllArchiveResources(Archive* archive)
1015 {
1016     if (!m_archiveResourceCollection)
1017         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
1018         
1019     ASSERT(archive);
1020     if (!archive)
1021         return;
1022         
1023     m_archiveResourceCollection->addAllResources(archive);
1024 }
1025
1026 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
1027 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
1028 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
1029 {
1030     if (!m_archiveResourceCollection)
1031         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
1032         
1033     ASSERT(resource);
1034     if (!resource)
1035         return;
1036         
1037     m_archiveResourceCollection->addResource(resource);
1038 }
1039
1040 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const URL& url)
1041 {
1042     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(0);
1043 }
1044
1045 void DocumentLoader::clearArchiveResources()
1046 {
1047     m_archiveResourceCollection.clear();
1048     m_substituteResourceDeliveryTimer.stop();
1049 }
1050
1051 SharedBuffer* DocumentLoader::parsedArchiveData() const
1052 {
1053     return m_parsedArchiveData.get();
1054 }
1055 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1056
1057 ArchiveResource* DocumentLoader::archiveResourceForURL(const URL& url) const
1058 {
1059     if (!m_archiveResourceCollection)
1060         return 0;
1061         
1062     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
1063
1064     return resource && !resource->shouldIgnoreWhenUnarchiving() ? resource : 0;
1065 }
1066
1067 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
1068 {
1069     const ResourceResponse& r = response();
1070     
1071     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
1072     RefPtr<SharedBuffer> data = mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0;
1073     if (!data)
1074         data = SharedBuffer::create();
1075         
1076     return ArchiveResource::create(data, r.url(), r.mimeType(), r.textEncodingName(), frame()->tree().uniqueName());
1077 }
1078
1079 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const URL& url) const
1080 {
1081     if (!isCommitted())
1082         return 0;
1083     
1084     CachedResource* resource = m_cachedResourceLoader->cachedResource(url);
1085     if (!resource || !resource->isLoaded())
1086         return archiveResourceForURL(url);
1087
1088     if (resource->type() == CachedResource::MainResource)
1089         return 0;
1090
1091     // FIXME: This has the side effect of making the resource non-purgeable.
1092     // It would be better if it didn't have this permanent effect.
1093     if (!resource->makePurgeable(false))
1094         return 0;
1095
1096     ResourceBuffer* data = resource->resourceBuffer();
1097     if (!data)
1098         return 0;
1099
1100     return ArchiveResource::create(data->sharedBuffer(), url, resource->response());
1101 }
1102
1103 void DocumentLoader::getSubresources(Vector<PassRefPtr<ArchiveResource>>& subresources) const
1104 {
1105     if (!isCommitted())
1106         return;
1107
1108     const CachedResourceLoader::DocumentResourceMap& allResources = m_cachedResourceLoader->allCachedResources();
1109     CachedResourceLoader::DocumentResourceMap::const_iterator end = allResources.end();
1110     for (CachedResourceLoader::DocumentResourceMap::const_iterator it = allResources.begin(); it != end; ++it) {
1111         RefPtr<ArchiveResource> subresource = this->subresource(URL(ParsedURLString, it->value->url()));
1112         if (subresource)
1113             subresources.append(subresource.release());
1114     }
1115
1116     return;
1117 }
1118
1119 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
1120 {
1121     if (m_pendingSubstituteResources.isEmpty())
1122         return;
1123     ASSERT(m_frame && m_frame->page());
1124     if (m_frame->page()->defersLoading())
1125         return;
1126     if (!m_substituteResourceDeliveryTimer.isActive())
1127         m_substituteResourceDeliveryTimer.startOneShot(0);
1128 }
1129
1130 void DocumentLoader::substituteResourceDeliveryTimerFired(Timer<DocumentLoader>&)
1131 {
1132     if (m_pendingSubstituteResources.isEmpty())
1133         return;
1134     ASSERT(m_frame && m_frame->page());
1135     if (m_frame->page()->defersLoading())
1136         return;
1137
1138     SubstituteResourceMap copy;
1139     copy.swap(m_pendingSubstituteResources);
1140
1141     SubstituteResourceMap::const_iterator end = copy.end();
1142     for (SubstituteResourceMap::const_iterator it = copy.begin(); it != end; ++it) {
1143         RefPtr<ResourceLoader> loader = it->key;
1144         SubstituteResource* resource = it->value.get();
1145         
1146         if (resource) {
1147             SharedBuffer* data = resource->data();
1148         
1149             loader->didReceiveResponse(resource->response());
1150
1151             // Calling ResourceLoader::didReceiveResponse can end up cancelling the load,
1152             // so we need to check if the loader has reached its terminal state.
1153             if (loader->reachedTerminalState())
1154                 return;
1155
1156             loader->didReceiveData(data->data(), data->size(), data->size(), DataPayloadWholeResource);
1157
1158             // Calling ResourceLoader::didReceiveData can end up cancelling the load,
1159             // so we need to check if the loader has reached its terminal state.
1160             if (loader->reachedTerminalState())
1161                 return;
1162
1163             loader->didFinishLoading(0);
1164         } else {
1165             // A null resource means that we should fail the load.
1166             // FIXME: Maybe we should use another error here - something like "not in cache".
1167             loader->didFail(loader->cannotShowURLError());
1168         }
1169     }
1170 }
1171
1172 #ifndef NDEBUG
1173 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
1174 {
1175     return m_pendingSubstituteResources.contains(loader);
1176 }
1177 #endif
1178
1179 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
1180 {
1181     if (m_pendingSubstituteResources.isEmpty())
1182         return;
1183     m_pendingSubstituteResources.remove(loader);
1184     if (m_pendingSubstituteResources.isEmpty())
1185         m_substituteResourceDeliveryTimer.stop();
1186 }
1187
1188 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1189 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader* loader, const ResourceRequest& request)
1190 {
1191     if (ArchiveResource* resource = archiveResourceForURL(request.url())) {
1192         m_pendingSubstituteResources.set(loader, resource);
1193         deliverSubstituteResourcesAfterDelay();
1194         return true;
1195     }
1196
1197     if (!m_archive)
1198         return false;
1199
1200     switch (m_archive->type()) {
1201 #if ENABLE(WEB_ARCHIVE)
1202     case Archive::WebArchive:
1203         // WebArchiveDebugMode means we fail loads instead of trying to fetch them from the network if they're not in the archive.
1204         return m_frame->settings().webArchiveDebugModeEnabled() && ArchiveFactory::isArchiveMimeType(responseMIMEType());
1205 #endif
1206 #if ENABLE(MHTML)
1207     case Archive::MHTML:
1208         return true; // Always fail the load for resources not included in the MHTML.
1209 #endif
1210     default:
1211         return false;
1212     }
1213 }
1214 #endif // ENABLE(WEB_ARCHIVE)
1215
1216 void DocumentLoader::addResponse(const ResourceResponse& r)
1217 {
1218     if (!m_stopRecordingResponses)
1219         m_responses.append(r);
1220 }
1221
1222 void DocumentLoader::stopRecordingResponses()
1223 {
1224     m_stopRecordingResponses = true;
1225     m_responses.shrinkToFit();
1226 }
1227
1228 void DocumentLoader::setTitle(const StringWithDirection& title)
1229 {
1230     if (m_pageTitle == title)
1231         return;
1232
1233     frameLoader()->willChangeTitle(this);
1234     m_pageTitle = title;
1235     frameLoader()->didChangeTitle(this);
1236 }
1237
1238 URL DocumentLoader::urlForHistory() const
1239 {
1240     // Return the URL to be used for history and B/F list.
1241     // Returns nil for WebDataProtocol URLs that aren't alternates
1242     // for unreachable URLs, because these can't be stored in history.
1243     if (m_substituteData.isValid() && !m_substituteData.shouldRevealToSessionHistory())
1244         return unreachableURL();
1245
1246     return m_originalRequestCopy.url();
1247 }
1248
1249 bool DocumentLoader::urlForHistoryReflectsFailure() const
1250 {
1251     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
1252 }
1253
1254 const URL& DocumentLoader::originalURL() const
1255 {
1256     return m_originalRequestCopy.url();
1257 }
1258
1259 const URL& DocumentLoader::requestURL() const
1260 {
1261     return request().url();
1262 }
1263
1264 const URL& DocumentLoader::responseURL() const
1265 {
1266     return m_response.url();
1267 }
1268
1269 URL DocumentLoader::documentURL() const
1270 {
1271     URL url = substituteData().responseURL();
1272 #if ENABLE(WEB_ARCHIVE)
1273     if (url.isEmpty() && m_archive && m_archive->type() == Archive::WebArchive)
1274         url = m_archive->mainResource()->url();
1275 #endif
1276     if (url.isEmpty())
1277         url = requestURL();
1278     if (url.isEmpty())
1279         url = m_response.url();
1280     return url;
1281 }
1282
1283 const String& DocumentLoader::responseMIMEType() const
1284 {
1285     return m_response.mimeType();
1286 }
1287
1288 #if PLATFORM(IOS)
1289 // FIXME: This method seems to violate the encapsulation of this class.
1290 void DocumentLoader::setResponseMIMEType(const String& responseMimeType)
1291 {
1292     m_response.setMimeType(responseMimeType);
1293 }
1294 #endif
1295
1296 const URL& DocumentLoader::unreachableURL() const
1297 {
1298     return m_substituteData.failingURL();
1299 }
1300
1301 void DocumentLoader::setDefersLoading(bool defers)
1302 {
1303     // Multiple frames may be loading the same main resource simultaneously. If deferral state changes,
1304     // each frame's DocumentLoader will try to send a setDefersLoading() to the same underlying ResourceLoader. Ensure only
1305     // the "owning" DocumentLoader does so, as setDefersLoading() is not resilient to setting the same value repeatedly.
1306     if (mainResourceLoader() && mainResourceLoader()->documentLoader() == this)
1307         mainResourceLoader()->setDefersLoading(defers);
1308
1309     setAllDefersLoading(m_subresourceLoaders, defers);
1310     setAllDefersLoading(m_plugInStreamLoaders, defers);
1311     if (!defers)
1312         deliverSubstituteResourcesAfterDelay();
1313 }
1314
1315 void DocumentLoader::setMainResourceDataBufferingPolicy(DataBufferingPolicy dataBufferingPolicy)
1316 {
1317     if (m_mainResource)
1318         m_mainResource->setDataBufferingPolicy(dataBufferingPolicy);
1319 }
1320
1321 void DocumentLoader::stopLoadingPlugIns()
1322 {
1323     cancelAll(m_plugInStreamLoaders);
1324 }
1325
1326 void DocumentLoader::stopLoadingSubresources()
1327 {
1328     cancelAll(m_subresourceLoaders);
1329 }
1330
1331 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
1332 {
1333     // The main resource's underlying ResourceLoader will ask to be added here.
1334     // It is much simpler to handle special casing of main resource loads if we don't
1335     // let it be added. In the main resource load case, mainResourceLoader()
1336     // will still be null at this point, but m_gotFirstByte should be false here if and only
1337     // if we are just starting the main resource load.
1338     if (!m_gotFirstByte)
1339         return;
1340     ASSERT(loader->identifier());
1341     ASSERT(!m_subresourceLoaders.contains(loader->identifier()));
1342     ASSERT(!mainResourceLoader() || mainResourceLoader() != loader);
1343
1344     m_subresourceLoaders.add(loader->identifier(), loader);
1345 }
1346
1347 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
1348 {
1349     ASSERT(loader->identifier());
1350
1351     if (!m_subresourceLoaders.remove(loader->identifier()))
1352         return;
1353     checkLoadComplete();
1354     if (Frame* frame = m_frame)
1355         frame->loader().checkLoadComplete();
1356 }
1357
1358 void DocumentLoader::addPlugInStreamLoader(ResourceLoader* loader)
1359 {
1360     ASSERT(loader->identifier());
1361     ASSERT(!m_plugInStreamLoaders.contains(loader->identifier()));
1362
1363     m_plugInStreamLoaders.add(loader->identifier(), loader);
1364 }
1365
1366 void DocumentLoader::removePlugInStreamLoader(ResourceLoader* loader)
1367 {
1368     ASSERT(loader->identifier());
1369     ASSERT(loader == m_plugInStreamLoaders.get(loader->identifier()));
1370
1371     m_plugInStreamLoaders.remove(loader->identifier());
1372     checkLoadComplete();
1373 }
1374
1375 bool DocumentLoader::isMultipartReplacingLoad() const
1376 {
1377     return isLoadingMultipartContent() && frameLoader()->isReplacing();
1378 }
1379
1380 bool DocumentLoader::maybeLoadEmpty()
1381 {
1382     bool shouldLoadEmpty = !m_substituteData.isValid() && (m_request.url().isEmpty() || SchemeRegistry::shouldLoadURLSchemeAsEmptyDocument(m_request.url().protocol()));
1383     if (!shouldLoadEmpty && !frameLoader()->client().representationExistsForURLScheme(m_request.url().protocol()))
1384         return false;
1385
1386     if (m_request.url().isEmpty() && !frameLoader()->stateMachine().creatingInitialEmptyDocument())
1387         m_request.setURL(blankURL());
1388     String mimeType = shouldLoadEmpty ? "text/html" : frameLoader()->client().generatedMIMETypeForURLScheme(m_request.url().protocol());
1389     m_response = ResourceResponse(m_request.url(), mimeType, 0, String(), String());
1390     finishedLoading(monotonicallyIncreasingTime());
1391     return true;
1392 }
1393
1394 void DocumentLoader::startLoadingMainResource()
1395 {
1396     m_mainDocumentError = ResourceError();
1397     timing()->markNavigationStart();
1398     ASSERT(!m_mainResource);
1399     ASSERT(!m_loadingMainResource);
1400     m_loadingMainResource = true;
1401
1402     if (maybeLoadEmpty())
1403         return;
1404
1405     // FIXME: Is there any way the extra fields could have not been added by now?
1406     // If not, it would be great to remove this line of code.
1407     // Note that currently, some requests may have incorrect extra fields even if this function has been called,
1408     // because we pass a wrong loadType (see FIXME in addExtraFieldsToMainResourceRequest()).
1409     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
1410
1411     ASSERT(timing()->navigationStart());
1412     ASSERT(!timing()->fetchStart());
1413     timing()->markFetchStart();
1414     willSendRequest(m_request, ResourceResponse());
1415
1416     // willSendRequest() may lead to our Frame being detached or cancelling the load via nulling the ResourceRequest.
1417     if (!m_frame || m_request.isNull())
1418         return;
1419
1420     m_applicationCacheHost->maybeLoadMainResource(m_request, m_substituteData);
1421
1422     if (m_substituteData.isValid()) {
1423         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1424         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, m_request);
1425         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, m_request, ResourceResponse());
1426         handleSubstituteDataLoadSoon();
1427         return;
1428     }
1429
1430 #if PLATFORM(IOS)
1431     // FIXME: Remove PLATFORM(IOS)-guard once we upstream the iOS changes to ResourceRequest.h.
1432     m_request.setMainResourceRequest(true);
1433 #endif
1434
1435     ResourceRequest request(m_request);
1436     static NeverDestroyed<ResourceLoaderOptions> mainResourceLoadOptions(SendCallbacks, SniffContent, BufferData, AllowStoredCredentials, AskClientForAllCredentials, SkipSecurityCheck, UseDefaultOriginRestrictionsForType);
1437     CachedResourceRequest cachedResourceRequest(request, mainResourceLoadOptions);
1438     m_mainResource = m_cachedResourceLoader->requestMainResource(cachedResourceRequest);
1439     if (!m_mainResource) {
1440         setRequest(ResourceRequest());
1441         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
1442         // is now in a state where starting an empty load will be inconsistent. Replace it with
1443         // a new ApplicationCacheHost.
1444         m_applicationCacheHost = adoptPtr(new ApplicationCacheHost(this));
1445         maybeLoadEmpty();
1446         return;
1447     }
1448
1449     if (!mainResourceLoader()) {
1450         m_identifierForLoadWithoutResourceLoader = m_frame->page()->progress().createUniqueIdentifier();
1451         frameLoader()->notifier().assignIdentifierToInitialRequest(m_identifierForLoadWithoutResourceLoader, this, request);
1452         frameLoader()->notifier().dispatchWillSendRequest(this, m_identifierForLoadWithoutResourceLoader, request, ResourceResponse());
1453     }
1454     m_mainResource->addClient(this);
1455
1456     // A bunch of headers are set when the underlying ResourceLoader is created, and m_request needs to include those.
1457     if (mainResourceLoader())
1458         request = mainResourceLoader()->originalRequest();
1459     // If there was a fragment identifier on m_request, the cache will have stripped it. m_request should include
1460     // the fragment identifier, so add that back in.
1461     if (equalIgnoringFragmentIdentifier(m_request.url(), request.url()))
1462         request.setURL(m_request.url());
1463     setRequest(request);
1464 }
1465
1466 void DocumentLoader::cancelMainResourceLoad(const ResourceError& resourceError)
1467 {
1468     Ref<DocumentLoader> protect(*this);
1469     ResourceError error = resourceError.isNull() ? frameLoader()->cancelledError(m_request) : resourceError;
1470
1471     m_dataLoadTimer.stop();
1472     if (m_waitingForContentPolicy) {
1473         frameLoader()->policyChecker().cancelCheck();
1474         ASSERT(m_waitingForContentPolicy);
1475         m_waitingForContentPolicy = false;
1476     }
1477
1478     if (mainResourceLoader())
1479         mainResourceLoader()->cancel(error);
1480
1481     clearMainResource();
1482
1483     mainReceivedError(error);
1484 }
1485
1486 void DocumentLoader::clearMainResource()
1487 {
1488     if (m_mainResource && m_mainResource->hasClient(this))
1489         m_mainResource->removeClient(this);
1490
1491     m_mainResource = 0;
1492 }
1493
1494 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
1495 {
1496     ASSERT(loader->identifier());
1497     ASSERT(!m_multipartSubresourceLoaders.contains(loader->identifier()));
1498     ASSERT(m_subresourceLoaders.contains(loader->identifier()));
1499
1500     m_multipartSubresourceLoaders.add(loader->identifier(), loader);
1501     m_subresourceLoaders.remove(loader->identifier());
1502     checkLoadComplete();
1503     if (Frame* frame = m_frame)
1504         frame->loader().checkLoadComplete();    
1505 }
1506
1507 void DocumentLoader::maybeFinishLoadingMultipartContent()
1508 {
1509     if (!isMultipartReplacingLoad())
1510         return;
1511
1512     frameLoader()->setupForReplace();
1513     m_committed = false;
1514     RefPtr<ResourceBuffer> resourceData = mainResourceData();
1515     commitLoad(resourceData->data(), resourceData->size());
1516 }
1517
1518 void DocumentLoader::iconLoadDecisionAvailable()
1519 {
1520     if (m_frame)
1521         m_frame->loader().icon().loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon().url(), this));
1522 }
1523
1524 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
1525 {
1526     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
1527 }
1528
1529 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
1530 {
1531     if (m_iconLoadDecisionCallback)
1532         m_iconLoadDecisionCallback->invalidate();
1533     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
1534     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
1535 }
1536
1537 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
1538 {
1539     ASSERT(m_iconLoadDecisionCallback);
1540     m_iconLoadDecisionCallback = 0;
1541     if (m_frame)
1542         m_frame->loader().icon().continueLoadWithDecision(decision);
1543 }
1544
1545 static void iconDataCallback(SharedBuffer*, void*)
1546 {
1547     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
1548 }
1549
1550 void DocumentLoader::getIconDataForIconURL(const String& urlString)
1551 {   
1552     if (m_iconDataCallback)
1553         m_iconDataCallback->invalidate();
1554     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
1555     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
1556 }
1557
1558 void DocumentLoader::handledOnloadEvents()
1559 {
1560     m_wasOnloadHandled = true;
1561     applicationCacheHost()->stopDeferringEvents();
1562 }
1563
1564 #if USE(CONTENT_FILTERING)
1565 void DocumentLoader::setContentFilterForBlockedLoad(PassRefPtr<ContentFilter> contentFilter)
1566 {
1567     ASSERT(!m_contentFilterForBlockedLoad);
1568     ASSERT(contentFilter);
1569     ASSERT(contentFilter->didBlockData());
1570     m_contentFilterForBlockedLoad = contentFilter;
1571 }
1572
1573 bool DocumentLoader::handleContentFilterRequest(const ResourceRequest& request)
1574 {
1575     // FIXME: Remove PLATFORM(IOS)-guard once we upstream ContentFilterIOS.mm and
1576     // implement ContentFilter::requestUnblockAndDispatchIfSuccessful() for Mac.
1577 #if PLATFORM(IOS)
1578     if (!m_contentFilterForBlockedLoad)
1579         return false;
1580
1581     if (!request.url().protocolIs(ContentFilter::scheme()))
1582         return false;
1583
1584     if (equalIgnoringCase(request.url().host(), "unblock")) {
1585         // Tell the FrameLoader to reload if the unblock is successful.
1586         m_contentFilterForBlockedLoad->requestUnblockAndDispatchIfSuccessful(bind(&FrameLoader::reload, &(m_frame->loader()), false));
1587         return true;
1588     }
1589
1590     return false;
1591 #else
1592     UNUSED_PARAM(request);
1593     return false;
1594 #endif
1595 }
1596 #endif
1597
1598 } // namespace WebCore