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