4537b936f677a4336689900b60ff7be50e3c4d39
[WebKit-https.git] / Source / WebCore / loader / DocumentLoader.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include "config.h"
31 #include "DocumentLoader.h"
32
33 #include "ApplicationCacheHost.h"
34 #include "ArchiveResourceCollection.h"
35 #include "CachedPage.h"
36 #include "CachedResourceLoader.h"
37 #include "DOMWindow.h"
38 #include "Document.h"
39 #include "DocumentParser.h"
40 #include "DocumentWriter.h"
41 #include "Event.h"
42 #include "Frame.h"
43 #include "FrameLoader.h"
44 #include "FrameLoaderClient.h"
45 #include "FrameTree.h"
46 #include "HistoryItem.h"
47 #include "InspectorInstrumentation.h"
48 #include "Logging.h"
49 #include "MainResourceLoader.h"
50 #include "Page.h"
51 #include "ResourceBuffer.h"
52 #include "SchemeRegistry.h"
53 #include "Settings.h"
54 #include "TextResourceDecoder.h"
55 #include "WebCoreMemoryInstrumentation.h"
56 #include <wtf/Assertions.h>
57 #include <wtf/MemoryInstrumentationHashMap.h>
58 #include <wtf/MemoryInstrumentationHashSet.h>
59 #include <wtf/MemoryInstrumentationVector.h>
60 #include <wtf/text/CString.h>
61 #include <wtf/text/WTFString.h>
62 #include <wtf/unicode/Unicode.h>
63
64 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
65 #include "ArchiveFactory.h"
66 #endif
67
68 namespace WebCore {
69
70 static void cancelAll(const ResourceLoaderSet& loaders)
71 {
72     Vector<RefPtr<ResourceLoader> > loadersCopy;
73     copyToVector(loaders, loadersCopy);
74     size_t size = loadersCopy.size();
75     for (size_t i = 0; i < size; ++i)
76         loadersCopy[i]->cancel();
77 }
78
79 static void setAllDefersLoading(const ResourceLoaderSet& loaders, bool defers)
80 {
81     Vector<RefPtr<ResourceLoader> > loadersCopy;
82     copyToVector(loaders, loadersCopy);
83     size_t size = loadersCopy.size();
84     for (size_t i = 0; i < size; ++i)
85         loadersCopy[i]->setDefersLoading(defers);
86 }
87
88 DocumentLoader::DocumentLoader(const ResourceRequest& req, const SubstituteData& substituteData)
89     : m_deferMainResourceDataLoad(true)
90     , m_frame(0)
91     , m_cachedResourceLoader(CachedResourceLoader::create(this))
92     , m_writer(m_frame)
93     , m_originalRequest(req)
94     , m_substituteData(substituteData)
95     , m_originalRequestCopy(req)
96     , m_request(req)
97     , m_committed(false)
98     , m_isStopping(false)
99     , m_gotFirstByte(false)
100     , m_isClientRedirect(false)
101     , m_loadingEmptyDocument(false)
102     , m_wasOnloadHandled(false)
103     , m_stopRecordingResponses(false)
104     , m_substituteResourceDeliveryTimer(this, &DocumentLoader::substituteResourceDeliveryTimerFired)
105     , m_didCreateGlobalHistoryEntry(false)
106     , m_applicationCacheHost(adoptPtr(new ApplicationCacheHost(this)))
107 {
108 }
109
110 FrameLoader* DocumentLoader::frameLoader() const
111 {
112     if (!m_frame)
113         return 0;
114     return m_frame->loader();
115 }
116
117 DocumentLoader::~DocumentLoader()
118 {
119     ASSERT(!m_frame || frameLoader()->activeDocumentLoader() != this || !isLoading());
120     if (m_iconLoadDecisionCallback)
121         m_iconLoadDecisionCallback->invalidate();
122     if (m_iconDataCallback)
123         m_iconDataCallback->invalidate();
124     m_cachedResourceLoader->clearDocumentLoader();
125 }
126
127 PassRefPtr<ResourceBuffer> DocumentLoader::mainResourceData() const
128 {
129     if (m_mainResourceData)
130         return m_mainResourceData;
131     if (m_mainResourceLoader)
132         return m_mainResourceLoader->resourceData();
133     return 0;
134 }
135
136 const ResourceRequest& DocumentLoader::originalRequest() const
137 {
138     return m_originalRequest;
139 }
140
141 const ResourceRequest& DocumentLoader::originalRequestCopy() const
142 {
143     return m_originalRequestCopy;
144 }
145
146 const ResourceRequest& DocumentLoader::request() const
147 {
148     return m_request;
149 }
150
151 ResourceRequest& DocumentLoader::request()
152 {
153     return m_request;
154 }
155
156 const KURL& DocumentLoader::url() const
157 {
158     return request().url();
159 }
160
161 void DocumentLoader::replaceRequestURLForSameDocumentNavigation(const KURL& url)
162 {
163     m_originalRequestCopy.setURL(url);
164     m_request.setURL(url);
165 }
166
167 void DocumentLoader::setRequest(const ResourceRequest& req)
168 {
169     // Replacing an unreachable URL with alternate content looks like a server-side
170     // redirect at this point, but we can replace a committed dataSource.
171     bool handlingUnreachableURL = false;
172
173     handlingUnreachableURL = m_substituteData.isValid() && !m_substituteData.failingURL().isEmpty();
174
175     if (handlingUnreachableURL)
176         m_committed = false;
177
178     // We should never be getting a redirect callback after the data
179     // source is committed, except in the unreachable URL case. It 
180     // would be a WebFoundation bug if it sent a redirect callback after commit.
181     ASSERT(!m_committed);
182
183     m_request = req;
184 }
185
186 void DocumentLoader::setMainDocumentError(const ResourceError& error)
187 {
188     m_mainDocumentError = error;    
189     frameLoader()->client()->setMainDocumentError(this, error);
190 }
191
192 void DocumentLoader::mainReceivedError(const ResourceError& error)
193 {
194     ASSERT(!error.isNull());
195
196     m_applicationCacheHost->failedLoadingMainResource();
197
198     if (!frameLoader())
199         return;
200     setMainDocumentError(error);
201     clearMainResourceLoader();
202     frameLoader()->receivedMainResourceError(error);
203 }
204
205 // Cancels the data source's pending loads.  Conceptually, a data source only loads
206 // one document at a time, but one document may have many related resources. 
207 // stopLoading will stop all loads initiated by the data source, 
208 // but not loads initiated by child frames' data sources -- that's the WebFrame's job.
209 void DocumentLoader::stopLoading()
210 {
211     RefPtr<Frame> protectFrame(m_frame);
212     RefPtr<DocumentLoader> protectLoader(this);
213
214     // In some rare cases, calling FrameLoader::stopLoading could cause isLoading() to return false.
215     // (This can happen when there's a single XMLHttpRequest currently loading and stopLoading causes it
216     // to stop loading. Because of this, we need to save it so we don't return early.
217     bool loading = isLoading();
218     
219     if (m_committed) {
220         // Attempt to stop the frame if the document loader is loading, or if it is done loading but
221         // still  parsing. Failure to do so can cause a world leak.
222         Document* doc = m_frame->document();
223         
224         if (loading || doc->parsing())
225             m_frame->loader()->stopLoading(UnloadEventPolicyNone);
226     }
227
228     // Always cancel multipart loaders
229     cancelAll(m_multipartSubresourceLoaders);
230
231     // Appcache uses ResourceHandle directly, DocumentLoader doesn't count these loads.
232     m_applicationCacheHost->stopLoadingInFrame(m_frame);
233     
234 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
235     clearArchiveResources();
236 #endif
237
238     if (!loading) {
239         // If something above restarted loading we might run into mysterious crashes like 
240         // https://bugs.webkit.org/show_bug.cgi?id=62764 and <rdar://problem/9328684>
241         ASSERT(!isLoading());
242         return;
243     }
244
245     // We might run in to infinite recursion if we're stopping loading as the result of 
246     // detaching from the frame, so break out of that recursion here.
247     // See <rdar://problem/9673866> for more details.
248     if (m_isStopping)
249         return;
250
251     m_isStopping = true;
252
253     FrameLoader* frameLoader = DocumentLoader::frameLoader();
254     
255     if (m_mainResourceLoader)
256         // Stop the main resource loader and let it send the cancelled message.
257         m_mainResourceLoader->cancel();
258     else if (!m_subresourceLoaders.isEmpty())
259         // The main resource loader already finished loading. Set the cancelled error on the 
260         // document and let the subresourceLoaders send individual cancelled messages below.
261         setMainDocumentError(frameLoader->cancelledError(m_request));
262     else
263         // If there are no resource loaders, we need to manufacture a cancelled message.
264         // (A back/forward navigation has no resource loaders because its resources are cached.)
265         mainReceivedError(frameLoader->cancelledError(m_request));
266     
267     stopLoadingSubresources();
268     stopLoadingPlugIns();
269     
270     m_isStopping = false;
271 }
272
273 void DocumentLoader::commitIfReady()
274 {
275     if (!m_committed) {
276         m_committed = true;
277         frameLoader()->commitProvisionalLoad();
278     }
279 }
280
281 void DocumentLoader::finishedLoading()
282 {
283     commitIfReady();
284     if (!frameLoader())
285         return;
286
287     if (!maybeCreateArchive()) {
288         // If this is an empty document, it will not have actually been created yet. Commit dummy data so that
289         // DocumentWriter::begin() gets called and creates the Document.
290         if (!m_gotFirstByte)
291             commitData(0, 0);
292         frameLoader()->client()->finishedLoading(this);
293     }
294
295     m_writer.end();
296     if (!m_mainDocumentError.isNull())
297         return;
298     clearMainResourceLoader();
299     if (!frameLoader()->stateMachine()->creatingInitialEmptyDocument())
300         frameLoader()->checkLoadComplete();
301 }
302
303 void DocumentLoader::commitLoad(const char* data, int length)
304 {
305     // Both unloading the old page and parsing the new page may execute JavaScript which destroys the datasource
306     // by starting a new load, so retain temporarily.
307     RefPtr<Frame> protectFrame(m_frame);
308     RefPtr<DocumentLoader> protectLoader(this);
309
310     commitIfReady();
311     FrameLoader* frameLoader = DocumentLoader::frameLoader();
312     if (!frameLoader)
313         return;
314 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
315     if (ArchiveFactory::isArchiveMimeType(response().mimeType()))
316         return;
317 #endif
318     frameLoader->client()->committedLoad(this, data, length);
319 }
320
321 void DocumentLoader::commitData(const char* bytes, size_t length)
322 {
323     if (!m_gotFirstByte) {
324         m_gotFirstByte = true;
325         m_writer.begin(documentURL(), false);
326         m_writer.setDocumentWasLoadedAsPartOfNavigation();
327
328         if (frameLoader()->stateMachine()->creatingInitialEmptyDocument())
329             return;
330         
331 #if ENABLE(MHTML)
332         // The origin is the MHTML file, we need to set the base URL to the document encoded in the MHTML so
333         // relative URLs are resolved properly.
334         if (m_archive && m_archive->type() == Archive::MHTML)
335             m_frame->document()->setBaseURLOverride(m_archive->mainResource()->url());
336 #endif
337
338         // Call receivedFirstData() exactly once per load. We should only reach this point multiple times
339         // for multipart loads, and FrameLoader::isReplacing() will be true after the first time.
340         if (!isMultipartReplacingLoad())
341             frameLoader()->receivedFirstData();
342
343         bool userChosen = true;
344         String encoding = overrideEncoding();
345         if (encoding.isNull()) {
346             userChosen = false;
347             encoding = response().textEncodingName();
348 #if ENABLE(WEB_ARCHIVE)
349             if (m_archive && m_archive->type() == Archive::WebArchive)
350                 encoding = m_archive->mainResource()->textEncoding();
351 #endif
352         }
353         m_writer.setEncoding(encoding, userChosen);
354     }
355     ASSERT(m_frame->document()->parsing());
356     m_writer.addData(bytes, length);
357 }
358
359 void DocumentLoader::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
360 {
361     MemoryClassInfo info(memoryObjectInfo, this, WebCoreMemoryTypes::Loader);
362     info.addMember(m_frame);
363     info.addMember(m_mainResourceLoader);
364     info.addMember(m_subresourceLoaders);
365     info.addMember(m_multipartSubresourceLoaders);
366     info.addMember(m_plugInStreamLoaders);
367     info.addMember(m_substituteData);
368     info.addMember(m_pageTitle.string());
369     info.addMember(m_overrideEncoding);
370     info.addMember(m_responses);
371     info.addMember(m_originalRequest);
372     info.addMember(m_originalRequestCopy);
373     info.addMember(m_request);
374     info.addMember(m_response);
375     info.addMember(m_lastCheckedRequest);
376     info.addMember(m_responses);
377     info.addMember(m_pendingSubstituteResources);
378     info.addMember(m_resourcesClientKnowsAbout);
379     info.addMember(m_resourcesLoadedFromMemoryCacheForClientNotification);
380     info.addMember(m_clientRedirectSourceForHistory);
381     info.addMember(m_mainResourceData);
382 }
383
384 void DocumentLoader::receivedData(const char* data, int length)
385 {
386     if (!isMultipartReplacingLoad())
387         commitLoad(data, length);
388 }
389
390 void DocumentLoader::setupForReplace()
391 {
392     if (!mainResourceData())
393         return;
394     
395     maybeFinishLoadingMultipartContent();
396     maybeCreateArchive();
397     m_writer.end();
398     frameLoader()->setReplacing();
399     m_gotFirstByte = false;
400     
401     stopLoadingSubresources();
402     stopLoadingPlugIns();
403 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
404     clearArchiveResources();
405 #endif
406 }
407
408 void DocumentLoader::checkLoadComplete()
409 {
410     if (!m_frame || isLoading())
411         return;
412     ASSERT(this == frameLoader()->activeDocumentLoader());
413     m_frame->document()->domWindow()->finishedLoading();
414 }
415
416 void DocumentLoader::setFrame(Frame* frame)
417 {
418     if (m_frame == frame)
419         return;
420     ASSERT(frame && !m_frame);
421     m_frame = frame;
422     m_writer.setFrame(frame);
423     attachToFrame();
424 }
425
426 void DocumentLoader::attachToFrame()
427 {
428     ASSERT(m_frame);
429 }
430
431 void DocumentLoader::detachFromFrame()
432 {
433     ASSERT(m_frame);
434     RefPtr<Frame> protectFrame(m_frame);
435     RefPtr<DocumentLoader> protectLoader(this);
436
437     // It never makes sense to have a document loader that is detached from its
438     // frame have any loads active, so go ahead and kill all the loads.
439     stopLoading();
440
441     m_applicationCacheHost->setDOMApplicationCache(0);
442     InspectorInstrumentation::loaderDetachedFromFrame(m_frame, this);
443     m_frame = 0;
444 }
445
446 void DocumentLoader::clearMainResourceLoader()
447 {
448     if (m_mainResourceLoader) {
449         m_mainResourceData = m_mainResourceLoader->resourceData();
450         m_mainResourceLoader = 0;
451     }
452     m_loadingEmptyDocument = false;
453
454     if (this == frameLoader()->activeDocumentLoader())
455         checkLoadComplete();
456 }
457
458 bool DocumentLoader::isLoadingInAPISense() const
459 {
460     // Once a frame has loaded, we no longer need to consider subresources,
461     // but we still need to consider subframes.
462     if (frameLoader()->state() != FrameStateComplete) {
463         if (m_frame->settings()->needsIsLoadingInAPISenseQuirk() && !m_subresourceLoaders.isEmpty())
464             return true;
465     
466         Document* doc = m_frame->document();
467         if ((isLoadingMainResource() || !m_frame->document()->loadEventFinished()) && isLoading())
468             return true;
469         if (m_cachedResourceLoader->requestCount())
470             return true;
471         if (DocumentParser* parser = doc->parser())
472             if (parser->processingData())
473                 return true;
474     }
475     return frameLoader()->subframeIsLoading();
476 }
477
478 bool DocumentLoader::maybeCreateArchive()
479 {
480 #if !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
481     return false;
482 #else
483     
484     // Give the archive machinery a crack at this document. If the MIME type is not an archive type, it will return 0.
485     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
486     m_archive = ArchiveFactory::create(m_response.url(), mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0, m_response.mimeType());
487     if (!m_archive)
488         return false;
489     
490     addAllArchiveResources(m_archive.get());
491     ArchiveResource* mainResource = m_archive->mainResource();
492     m_parsedArchiveData = mainResource->data();
493     m_writer.setMIMEType(mainResource->mimeType());
494     
495     ASSERT(m_frame->document());
496     commitData(mainResource->data()->data(), mainResource->data()->size());
497     return true;
498 #endif // !ENABLE(WEB_ARCHIVE) && !ENABLE(MHTML)
499 }
500
501 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
502 void DocumentLoader::setArchive(PassRefPtr<Archive> archive)
503 {
504     m_archive = archive;
505     addAllArchiveResources(m_archive.get());
506 }
507
508 void DocumentLoader::addAllArchiveResources(Archive* archive)
509 {
510     if (!m_archiveResourceCollection)
511         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
512         
513     ASSERT(archive);
514     if (!archive)
515         return;
516         
517     m_archiveResourceCollection->addAllResources(archive);
518 }
519
520 // FIXME: Adding a resource directly to a DocumentLoader/ArchiveResourceCollection seems like bad design, but is API some apps rely on.
521 // Can we change the design in a manner that will let us deprecate that API without reducing functionality of those apps?
522 void DocumentLoader::addArchiveResource(PassRefPtr<ArchiveResource> resource)
523 {
524     if (!m_archiveResourceCollection)
525         m_archiveResourceCollection = adoptPtr(new ArchiveResourceCollection);
526         
527     ASSERT(resource);
528     if (!resource)
529         return;
530         
531     m_archiveResourceCollection->addResource(resource);
532 }
533
534 PassRefPtr<Archive> DocumentLoader::popArchiveForSubframe(const String& frameName, const KURL& url)
535 {
536     return m_archiveResourceCollection ? m_archiveResourceCollection->popSubframeArchive(frameName, url) : PassRefPtr<Archive>(0);
537 }
538
539 void DocumentLoader::clearArchiveResources()
540 {
541     m_archiveResourceCollection.clear();
542     m_substituteResourceDeliveryTimer.stop();
543 }
544
545 SharedBuffer* DocumentLoader::parsedArchiveData() const
546 {
547     return m_parsedArchiveData.get();
548 }
549 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
550
551 ArchiveResource* DocumentLoader::archiveResourceForURL(const KURL& url) const
552 {
553     if (!m_archiveResourceCollection)
554         return 0;
555         
556     ArchiveResource* resource = m_archiveResourceCollection->archiveResourceForURL(url);
557
558     return resource && !resource->shouldIgnoreWhenUnarchiving() ? resource : 0;
559 }
560
561 PassRefPtr<ArchiveResource> DocumentLoader::mainResource() const
562 {
563     const ResourceResponse& r = response();
564     
565     RefPtr<ResourceBuffer> mainResourceBuffer = mainResourceData();
566     RefPtr<SharedBuffer> data = mainResourceBuffer ? mainResourceBuffer->sharedBuffer() : 0;
567     if (!data)
568         data = SharedBuffer::create();
569         
570     return ArchiveResource::create(data, r.url(), r.mimeType(), r.textEncodingName(), frame()->tree()->uniqueName());
571 }
572
573 PassRefPtr<ArchiveResource> DocumentLoader::subresource(const KURL& url) const
574 {
575     if (!isCommitted())
576         return 0;
577     
578     CachedResource* resource = m_cachedResourceLoader->cachedResource(url);
579     if (!resource || !resource->isLoaded())
580         return archiveResourceForURL(url);
581
582     if (resource->type() == CachedResource::MainResource)
583         return 0;
584
585     // FIXME: This has the side effect of making the resource non-purgeable.
586     // It would be better if it didn't have this permanent effect.
587     if (!resource->makePurgeable(false))
588         return 0;
589
590     ResourceBuffer* data = resource->resourceBuffer();
591     if (!data)
592         return 0;
593
594     return ArchiveResource::create(data->sharedBuffer(), url, resource->response());
595 }
596
597 void DocumentLoader::getSubresources(Vector<PassRefPtr<ArchiveResource> >& subresources) const
598 {
599     if (!isCommitted())
600         return;
601
602     const CachedResourceLoader::DocumentResourceMap& allResources = m_cachedResourceLoader->allCachedResources();
603     CachedResourceLoader::DocumentResourceMap::const_iterator end = allResources.end();
604     for (CachedResourceLoader::DocumentResourceMap::const_iterator it = allResources.begin(); it != end; ++it) {
605         RefPtr<ArchiveResource> subresource = this->subresource(KURL(ParsedURLString, it->value->url()));
606         if (subresource)
607             subresources.append(subresource.release());
608     }
609
610     return;
611 }
612
613 void DocumentLoader::deliverSubstituteResourcesAfterDelay()
614 {
615     if (m_pendingSubstituteResources.isEmpty())
616         return;
617     ASSERT(m_frame && m_frame->page());
618     if (m_frame->page()->defersLoading())
619         return;
620     if (!m_substituteResourceDeliveryTimer.isActive())
621         m_substituteResourceDeliveryTimer.startOneShot(0);
622 }
623
624 void DocumentLoader::substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*)
625 {
626     if (m_pendingSubstituteResources.isEmpty())
627         return;
628     ASSERT(m_frame && m_frame->page());
629     if (m_frame->page()->defersLoading())
630         return;
631
632     SubstituteResourceMap copy;
633     copy.swap(m_pendingSubstituteResources);
634
635     SubstituteResourceMap::const_iterator end = copy.end();
636     for (SubstituteResourceMap::const_iterator it = copy.begin(); it != end; ++it) {
637         RefPtr<ResourceLoader> loader = it->key;
638         SubstituteResource* resource = it->value.get();
639         
640         if (resource) {
641             SharedBuffer* data = resource->data();
642         
643             loader->didReceiveResponse(resource->response());
644
645             // Calling ResourceLoader::didReceiveResponse can end up cancelling the load,
646             // so we need to check if the loader has reached its terminal state.
647             if (loader->reachedTerminalState())
648                 return;
649
650             loader->didReceiveData(data->data(), data->size(), data->size(), true);
651
652             // Calling ResourceLoader::didReceiveData can end up cancelling the load,
653             // so we need to check if the loader has reached its terminal state.
654             if (loader->reachedTerminalState())
655                 return;
656
657             loader->didFinishLoading(0);
658         } else {
659             // A null resource means that we should fail the load.
660             // FIXME: Maybe we should use another error here - something like "not in cache".
661             loader->didFail(loader->cannotShowURLError());
662         }
663     }
664 }
665
666 #ifndef NDEBUG
667 bool DocumentLoader::isSubstituteLoadPending(ResourceLoader* loader) const
668 {
669     return m_pendingSubstituteResources.contains(loader);
670 }
671 #endif
672
673 void DocumentLoader::cancelPendingSubstituteLoad(ResourceLoader* loader)
674 {
675     if (m_pendingSubstituteResources.isEmpty())
676         return;
677     m_pendingSubstituteResources.remove(loader);
678     if (m_pendingSubstituteResources.isEmpty())
679         m_substituteResourceDeliveryTimer.stop();
680 }
681
682 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
683 bool DocumentLoader::scheduleArchiveLoad(ResourceLoader* loader, const ResourceRequest& request, const KURL& originalURL)
684 {
685     if (request.url() == originalURL) {
686         if (ArchiveResource* resource = archiveResourceForURL(originalURL)) {
687             m_pendingSubstituteResources.set(loader, resource);
688             deliverSubstituteResourcesAfterDelay();
689             return true;
690         }
691     }
692
693     if (!m_archive)
694         return false;
695
696     switch (m_archive->type()) {
697 #if ENABLE(WEB_ARCHIVE)
698     case Archive::WebArchive:
699         // WebArchiveDebugMode means we fail loads instead of trying to fetch them from the network if they're not in the archive.
700         return m_frame->settings() && m_frame->settings()->webArchiveDebugModeEnabled() && ArchiveFactory::isArchiveMimeType(responseMIMEType());
701 #endif
702 #if ENABLE(MHTML)
703     case Archive::MHTML:
704         return true; // Always fail the load for resources not included in the MHTML.
705 #endif
706     default:
707         return false;
708     }
709 }
710 #endif // ENABLE(WEB_ARCHIVE)
711
712 void DocumentLoader::addResponse(const ResourceResponse& r)
713 {
714     if (!m_stopRecordingResponses)
715         m_responses.append(r);
716 }
717
718 void DocumentLoader::stopRecordingResponses()
719 {
720     m_stopRecordingResponses = true;
721     m_responses.shrinkToFit();
722 }
723
724 void DocumentLoader::setTitle(const StringWithDirection& title)
725 {
726     if (m_pageTitle == title)
727         return;
728
729     frameLoader()->willChangeTitle(this);
730     m_pageTitle = title;
731     frameLoader()->didChangeTitle(this);
732 }
733
734 KURL DocumentLoader::urlForHistory() const
735 {
736     // Return the URL to be used for history and B/F list.
737     // Returns nil for WebDataProtocol URLs that aren't alternates 
738     // for unreachable URLs, because these can't be stored in history.
739     if (m_substituteData.isValid())
740         return unreachableURL();
741
742     return m_originalRequestCopy.url();
743 }
744
745 bool DocumentLoader::urlForHistoryReflectsFailure() const
746 {
747     return m_substituteData.isValid() || m_response.httpStatusCode() >= 400;
748 }
749
750 const KURL& DocumentLoader::originalURL() const
751 {
752     return m_originalRequestCopy.url();
753 }
754
755 const KURL& DocumentLoader::requestURL() const
756 {
757     return request().url();
758 }
759
760 const KURL& DocumentLoader::responseURL() const
761 {
762     return m_response.url();
763 }
764
765 KURL DocumentLoader::documentURL() const
766 {
767     KURL url = substituteData().responseURL();
768 #if ENABLE(WEB_ARCHIVE)
769     if (url.isEmpty() && m_archive && m_archive->type() == Archive::WebArchive)
770         url = m_archive->mainResource()->url();
771 #endif
772     if (url.isEmpty())
773         url = requestURL();
774     if (url.isEmpty())
775         url = responseURL();
776     return url;
777 }
778
779 const String& DocumentLoader::responseMIMEType() const
780 {
781     return m_response.mimeType();
782 }
783
784 const KURL& DocumentLoader::unreachableURL() const
785 {
786     return m_substituteData.failingURL();
787 }
788
789 void DocumentLoader::setDefersLoading(bool defers)
790 {
791     if (m_mainResourceLoader)
792         m_mainResourceLoader->setDefersLoading(defers);
793     setAllDefersLoading(m_subresourceLoaders, defers);
794     setAllDefersLoading(m_plugInStreamLoaders, defers);
795     if (!defers)
796         deliverSubstituteResourcesAfterDelay();
797 }
798
799 void DocumentLoader::stopLoadingPlugIns()
800 {
801     cancelAll(m_plugInStreamLoaders);
802 }
803
804 void DocumentLoader::stopLoadingSubresources()
805 {
806     cancelAll(m_subresourceLoaders);
807 }
808
809 void DocumentLoader::addSubresourceLoader(ResourceLoader* loader)
810 {
811     // The main resource's underlying ResourceLoader will ask to be added here.
812     // It is much simpler to handle special casing of main resource loads if we don't
813     // let it be added. In the main resource load case, m_mainResourceLoader->loader()
814     // will still be null at this point, but m_gotFirstByte should be false here if and only
815     // if we are just starting the main resource load.
816     if (!m_gotFirstByte)
817         return;
818     ASSERT(!m_subresourceLoaders.contains(loader));
819     ASSERT(!m_mainResourceLoader || m_mainResourceLoader->loader() != loader);
820     m_subresourceLoaders.add(loader);
821 }
822
823 void DocumentLoader::removeSubresourceLoader(ResourceLoader* loader)
824 {
825     if (!m_subresourceLoaders.contains(loader))
826         return;
827     m_subresourceLoaders.remove(loader);
828     checkLoadComplete();
829     if (Frame* frame = m_frame)
830         frame->loader()->checkLoadComplete();
831 }
832
833 void DocumentLoader::addPlugInStreamLoader(ResourceLoader* loader)
834 {
835     m_plugInStreamLoaders.add(loader);
836 }
837
838 void DocumentLoader::removePlugInStreamLoader(ResourceLoader* loader)
839 {
840     m_plugInStreamLoaders.remove(loader);
841     checkLoadComplete();
842 }
843
844 bool DocumentLoader::isLoadingMainResource() const
845 {
846     return !!m_mainResourceLoader || m_loadingEmptyDocument;
847 }
848
849 bool DocumentLoader::isLoadingMultipartContent() const
850 {
851     return m_mainResourceLoader && m_mainResourceLoader->isLoadingMultipartContent();
852 }
853
854 bool DocumentLoader::isMultipartReplacingLoad() const
855 {
856     return isLoadingMultipartContent() && frameLoader()->isReplacing();
857 }
858
859 bool DocumentLoader::maybeLoadEmpty()
860 {
861     bool shouldLoadEmpty = !m_substituteData.isValid() && (m_request.url().isEmpty() || SchemeRegistry::shouldLoadURLSchemeAsEmptyDocument(m_request.url().protocol()));
862     if (!shouldLoadEmpty && !frameLoader()->client()->representationExistsForURLScheme(m_request.url().protocol()))
863         return false;
864
865     m_loadingEmptyDocument = true;
866     if (m_request.url().isEmpty() && !frameLoader()->stateMachine()->creatingInitialEmptyDocument())
867         m_request.setURL(blankURL());
868     String mimeType = shouldLoadEmpty ? "text/html" : frameLoader()->client()->generatedMIMETypeForURLScheme(m_request.url().protocol());
869     setResponse(ResourceResponse(m_request.url(), mimeType, 0, String(), String()));
870     finishedLoading();
871     return true;
872 }
873
874 void DocumentLoader::startLoadingMainResource()
875 {
876     m_mainDocumentError = ResourceError();
877     timing()->markNavigationStart();
878     ASSERT(!m_mainResourceLoader);
879
880     if (maybeLoadEmpty())
881         return;
882
883     m_mainResourceLoader = MainResourceLoader::create(this);
884
885     // FIXME: Is there any way the extra fields could have not been added by now?
886     // If not, it would be great to remove this line of code.
887     // Note that currently, some requests may have incorrect extra fields even if this function has been called,
888     // because we pass a wrong loadType (see FIXME in addExtraFieldsToMainResourceRequest()).
889     frameLoader()->addExtraFieldsToMainResourceRequest(m_request);
890     m_mainResourceLoader->load(m_request, m_substituteData);
891
892     if (m_request.isNull()) {
893         m_mainResourceLoader = 0;
894         // If the load was aborted by clearing m_request, it's possible the ApplicationCacheHost
895         // is now in a state where starting an empty load will be inconsistent. Replace it with
896         // a new ApplicationCacheHost.
897         m_applicationCacheHost = adoptPtr(new ApplicationCacheHost(this));
898         maybeLoadEmpty();
899     }
900 }
901
902 void DocumentLoader::cancelMainResourceLoad(const ResourceError& error)
903 {
904     m_mainResourceLoader->cancel(error);
905 }
906
907 void DocumentLoader::subresourceLoaderFinishedLoadingOnePart(ResourceLoader* loader)
908 {
909     m_multipartSubresourceLoaders.add(loader);
910     m_subresourceLoaders.remove(loader);
911     checkLoadComplete();
912     if (Frame* frame = m_frame)
913         frame->loader()->checkLoadComplete();    
914 }
915
916 void DocumentLoader::maybeFinishLoadingMultipartContent()
917 {
918     if (!frameLoader()->isReplacing())
919         return;
920
921     frameLoader()->setupForReplace();
922     m_committed = false;
923     RefPtr<ResourceBuffer> resourceData = mainResourceData();
924     commitLoad(resourceData->data(), resourceData->size());
925 }
926
927 void DocumentLoader::iconLoadDecisionAvailable()
928 {
929     if (m_frame)
930         m_frame->loader()->icon()->loadDecisionReceived(iconDatabase().synchronousLoadDecisionForIconURL(frameLoader()->icon()->url(), this));
931 }
932
933 static void iconLoadDecisionCallback(IconLoadDecision decision, void* context)
934 {
935     static_cast<DocumentLoader*>(context)->continueIconLoadWithDecision(decision);
936 }
937
938 void DocumentLoader::getIconLoadDecisionForIconURL(const String& urlString)
939 {
940     if (m_iconLoadDecisionCallback)
941         m_iconLoadDecisionCallback->invalidate();
942     m_iconLoadDecisionCallback = IconLoadDecisionCallback::create(this, iconLoadDecisionCallback);
943     iconDatabase().loadDecisionForIconURL(urlString, m_iconLoadDecisionCallback);
944 }
945
946 void DocumentLoader::continueIconLoadWithDecision(IconLoadDecision decision)
947 {
948     ASSERT(m_iconLoadDecisionCallback);
949     m_iconLoadDecisionCallback = 0;
950     if (m_frame)
951         m_frame->loader()->icon()->continueLoadWithDecision(decision);
952 }
953
954 static void iconDataCallback(SharedBuffer*, void*)
955 {
956     // FIXME: Implement this once we know what parts of WebCore actually need the icon data returned.
957 }
958
959 void DocumentLoader::getIconDataForIconURL(const String& urlString)
960 {   
961     if (m_iconDataCallback)
962         m_iconDataCallback->invalidate();
963     m_iconDataCallback = IconDataCallback::create(this, iconDataCallback);
964     iconDatabase().iconDataForIconURL(urlString, m_iconDataCallback);
965 }
966
967 void DocumentLoader::handledOnloadEvents()
968 {
969     m_wasOnloadHandled = true;
970     applicationCacheHost()->stopDeferringEvents();
971 }
972
973 } // namespace WebCore